WtEc2PCk

1{
2	"swagger": "2.0",
3	"info": {
4		"description": "Set of API's for interacting with the Transactional Workspace model.  This includes retreiving packages, signing, and manipulation of workspace level metadata. ",
5		"version": "1.0",
6		"title": "Transactional Workspace API"
7	},
8	"host": "localhost",
9	"basePath": "/",
10	"tags": [{
11		"name": "package-controller",
12		"description": "Package level operations"
13	}, {
14		"name": "package-management-controller",
15		"description": "Package Management Controller"
16	}, {
17		"name": "workspace-controller",
18		"description": "workspace level operations"
19	}],
20	"consumes": ["application/json", "application/xml"],
21	"produces": ["application/json", "application/xml"],
22	"paths": {
23		"/v1/customers/{customerId}/packagemanager/{workspaceId}": {
24			"get": {
25				"tags": ["package-management-controller"],
26				"summary": "get package manager",
27				"description": "Gets the current xml housed in the package manager for the current customer and workspace",
28				"operationId": "getCurrentPackageUsingGET",
29				"parameters": [{
30					"name": "fields",
31					"in": "query",
32					"description": "Fields to be included in the response",
33					"required": false,
34					"type": "string"
35				}, {
36					"name": "customerId",
37					"in": "path",
38					"description": "Customer ID to retrieve the package manager for",
39					"required": true,
40					"type": "integer",
41					"format": "int64"
42				}, {
43					"name": "workspaceId",
44					"in": "path",
45					"description": "ID of the package manager",
46					"required": true,
47					"type": "integer",
48					"format": "int64"
49				}],
50				"responses": {
51					"200": {
52						"description": "OK",
53						"schema": {
54							"$ref": "#/definitions/DeliveryPackageContainer"
55						}
56					},
57					"401": {
58						"description": "Unauthorized"
59					},
60					"403": {
61						"description": "Forbidden"
62					},
63					"404": {
64						"description": "Not Found"
65					}
66				}
67			},
68			"post": {
69				"tags": ["package-management-controller"],
70				"summary": "Post package manager",
71				"description": "Posts the current package in package manager, returns a 202 status code if succesful.  Actual processing of the package is done asynchronously.",
72				"operationId": "postCurrentPackageUsingPOST",
73				"parameters": [{
74					"name": "fields",
75					"in": "query",
76					"description": "Fields to be included in the response",
77					"required": false,
78					"type": "string"
79				}, {
80					"name": "customerId",
81					"in": "path",
82					"description": "Customer ID of the package manager to post",
83					"required": true,
84					"type": "integer",
85					"format": "int64"
86				}, {
87					"name": "workspaceId",
88					"in": "path",
89					"description": "ID of the package manager to post",
90					"required": true,
91					"type": "integer",
92					"format": "int64"
93				}],
94				"responses": {
95					"200": {
96						"description": "OK"
97					},
98					"201": {
99						"description": "Created"
100					},
101					"401": {
102						"description": "Unauthorized"
103					},
104					"403": {
105						"description": "Forbidden"
106					},
107					"404": {
108						"description": "Not Found"
109					}
110				}
111			},
112			"put": {
113				"tags": ["package-management-controller"],
114				"summary": "update package manager",
115				"description": "updates current xml housed in the package manager for the current customer and workspace",
116				"operationId": "updatePackageUsingPUT",
117				"parameters": [{
118					"name": "fields",
119					"in": "query",
120					"description": "Fields to be included in the response",
121					"required": false,
122					"type": "string"
123				}, {
124					"name": "customerId",
125					"in": "path",
126					"description": "Customer ID to retrieve the package manager for",
127					"required": true,
128					"type": "integer",
129					"format": "int64"
130				}, {
131					"name": "workspaceId",
132					"in": "path",
133					"description": "ID of the package manager",
134					"required": true,
135					"type": "integer",
136					"format": "int64"
137				}, {
138					"in": "body",
139					"name": "dpc",
140					"description": "Delivery package to replace the current package with",
141					"required": true,
142					"schema": {
143						"$ref": "#/definitions/DeliveryPackageContainer"
144					}
145				}],
146				"responses": {
147					"200": {
148						"description": "OK",
149						"schema": {
150							"$ref": "#/definitions/DeliveryPackageContainer"
151						}
152					},
153					"201": {
154						"description": "Created"
155					},
156					"401": {
157						"description": "Unauthorized"
158					},
159					"403": {
160						"description": "Forbidden"
161					},
162					"404": {
163						"description": "Not Found"
164					}
165				}
166			},
167			"delete": {
168				"tags": ["package-management-controller"],
169				"summary": "Delete package manager",
170				"description": "Clears out pending package in package managerand workspace",
171				"operationId": "deleteCurrentPackageUsingDELETE",
172				"parameters": [{
173					"name": "fields",
174					"in": "query",
175					"description": "Fields to be included in the response",
176					"required": false,
177					"type": "string"
178				}, {
179					"name": "customerId",
180					"in": "path",
181					"description": "Customer ID to retrieve the package manager for",
182					"required": true,
183					"type": "integer",
184					"format": "int64"
185				}, {
186					"name": "workspaceId",
187					"in": "path",
188					"description": "ID of the package manager to empty",
189					"required": true,
190					"type": "integer",
191					"format": "int64"
192				}],
193				"responses": {
194					"200": {
195						"description": "OK",
196						"schema": {
197							"$ref": "#/definitions/DeliveryPackageContainer"
198						}
199					},
200					"204": {
201						"description": "No Content"
202					},
203					"401": {
204						"description": "Unauthorized"
205					},
206					"403": {
207						"description": "Forbidden"
208					}
209				}
210			}
211		},
212		"/v1/customers/{customerId}/packagemanager/{workspaceId}/defaults": {
213			"get": {
214				"tags": ["package-management-controller"],
215				"summary": "gets Defaults for the package manager",
216				"description": "gets default items for the package manager in the current context",
217				"operationId": "getDefaultsUsingGET",
218				"parameters": [{
219					"name": "fields",
220					"in": "query",
221					"description": "Fields to be included in the response",
222					"required": false,
223					"type": "string"
224				}, {
225					"name": "customerId",
226					"in": "path",
227					"description": "Customer ID to retrieve the package manager for",
228					"required": true,
229					"type": "integer",
230					"format": "int64"
231				}, {
232					"name": "workspaceId",
233					"in": "path",
234					"description": "ID of the package manager",
235					"required": true,
236					"type": "integer",
237					"format": "int64"
238				}],
239				"responses": {
240					"200": {
241						"description": "OK",
242						"schema": {
243							"$ref": "#/definitions/PackageManagerDefaults"
244						}
245					},
246					"401": {
247						"description": "Unauthorized"
248					},
249					"403": {
250						"description": "Forbidden"
251					},
252					"404": {
253						"description": "Not Found"
254					}
255				}
256			}
257		},
258		"/v1/customers/{customerId}/packagemanager/{workspaceId}/docrec": {
259			"put": {
260				"tags": ["package-management-controller"],
261				"summary": "Run Doc Rec",
262				"description": "Runs doc rec for the given package manager ",
263				"operationId": "runDocRecUsingPUT",
264				"parameters": [{
265					"name": "fields",
266					"in": "query",
267					"description": "Fields to be included in the response",
268					"required": false,
269					"type": "string"
270				}, {
271					"name": "customerId",
272					"in": "path",
273					"description": "Customer ID to retrieve the package manager for",
274					"required": true,
275					"type": "integer",
276					"format": "int64"
277				}, {
278					"name": "workspaceId",
279					"in": "path",
280					"description": "ID of the package manager to empty",
281					"required": true,
282					"type": "integer",
283					"format": "int64"
284				}],
285				"responses": {
286					"200": {
287						"description": "OK"
288					},
289					"201": {
290						"description": "Created"
291					},
292					"401": {
293						"description": "Unauthorized"
294					},
295					"403": {
296						"description": "Forbidden"
297					},
298					"404": {
299						"description": "Not Found"
300					}
301				}
302			}
303		},
304		"/v1/customers/{customerId}/packagemanager/{workspaceId}/forms": {
305			"get": {
306				"tags": ["package-management-controller"],
307				"summary": "get form",
308				"description": "gets form metadata for forms",
309				"operationId": "getFormsUsingGET_1",
310				"parameters": [{
311					"name": "fields",
312					"in": "query",
313					"description": "Fields to be included in the response",
314					"required": false,
315					"type": "string"
316				}, {
317					"name": "customerId",
318					"in": "path",
319					"description": "Customer ID to retrieve the package manager for",
320					"required": true,
321					"type": "integer",
322					"format": "int64"
323				}, {
324					"name": "workspaceId",
325					"in": "path",
326					"description": "ID of the package manager",
327					"required": true,
328					"type": "integer",
329					"format": "int64"
330				}, {
331					"name": "docRecRunDate",
332					"in": "query",
333					"description": "Filters forms to forms that have been run through doc rec after the given date",
334					"required": false,
335					"type": "string"
336				}, {
337					"name": "docRecMatched",
338					"in": "query",
339					"description": "Match only documents with the given doc rec match state",
340					"required": false,
341					"type": "boolean"
342				}, {
343					"name": "limit",
344					"in": "query",
345					"description": "Limit number of forms returned",
346					"required": false,
347					"type": "integer",
348					"format": "int32"
349				}],
350				"responses": {
351					"200": {
352						"description": "OK",
353						"schema": {
354							"type": "array",
355							"items": {
356								"$ref": "#/definitions/FormContainer"
357							}
358						}
359					},
360					"401": {
361						"description": "Unauthorized"
362					},
363					"403": {
364						"description": "Forbidden"
365					},
366					"404": {
367						"description": "Not Found"
368					}
369				}
370			},
371			"post": {
372				"tags": ["package-management-controller"],
373				"summary": "add form",
374				"description": "adds a new form to the package sitting in package manager",
375				"operationId": "addFormUsingPOST",
376				"consumes": ["multipart/form-data"],
377				"parameters": [{
378					"name": "fields",
379					"in": "query",
380					"description": "Fields to be included in the response",
381					"required": false,
382					"type": "string"
383				}, {
384					"name": "customerId",
385					"in": "path",
386					"description": "Customer ID to retrieve the package manager for",
387					"required": true,
388					"type": "integer",
389					"format": "int64"
390				}, {
391					"name": "workspaceId",
392					"in": "path",
393					"description": "ID of the package manager",
394					"required": true,
395					"type": "integer",
396					"format": "int64"
397				}, {
398					"name": "file",
399					"in": "formData",
400					"description": "Pdf File to be uploaded to package",
401					"required": true,
402					"type": "file"
403				}, {
404					"name": "name",
405					"in": "query",
406					"description": "Name of the form that is being uploaded",
407					"required": false,
408					"type": "string"
409				}],
410				"responses": {
411					"200": {
412						"description": "OK",
413						"schema": {
414							"$ref": "#/definitions/ResponseEntity«FormContainer»"
415						}
416					},
417					"201": {
418						"description": "Created"
419					},
420					"401": {
421						"description": "Unauthorized"
422					},
423					"403": {
424						"description": "Forbidden"
425					},
426					"404": {
427						"description": "Not Found"
428					}
429				}
430			}
431		},
432		"/v1/customers/{customerId}/packagemanager/{workspaceId}/forms/{wsFormId}": {
433			"get": {
434				"tags": ["package-management-controller"],
435				"summary": "get form",
436				"description": "Returns the form metadata for a specific form in the package.",
437				"operationId": "getFormUsingGET",
438				"parameters": [{
439					"name": "fields",
440					"in": "query",
441					"description": "Fields to be included in the response",
442					"required": false,
443					"type": "string"
444				}, {
445					"name": "customerId",
446					"in": "path",
447					"description": "Customer ID to retrieve the package manager for",
448					"required": true,
449					"type": "integer",
450					"format": "int64"
451				}, {
452					"name": "workspaceId",
453					"in": "path",
454					"description": "ID of the package manager",
455					"required": true,
456					"type": "integer",
457					"format": "int64"
458				}, {
459					"name": "wsFormId",
460					"in": "path",
461					"description": "WsFileId of form to be retrieved",
462					"required": true,
463					"type": "string"
464				}],
465				"responses": {
466					"200": {
467						"description": "OK",
468						"schema": {
469							"$ref": "#/definitions/FormContainer"
470						}
471					},
472					"401": {
473						"description": "Unauthorized"
474					},
475					"403": {
476						"description": "Forbidden"
477					},
478					"404": {
479						"description": "Not Found"
480					}
481				}
482			},
483			"put": {
484				"tags": ["package-management-controller"],
485				"summary": "update form",
486				"description": "Update the form metadata for a specific form.",
487				"operationId": "updateFormUsingPUT",
488				"parameters": [{
489					"name": "fields",
490					"in": "query",
491					"description": "Fields to be included in the response",
492					"required": false,
493					"type": "string"
494				}, {
495					"name": "customerId",
496					"in": "path",
497					"description": "Customer ID to retrieve the package manager for",
498					"required": true,
499					"type": "integer",
500					"format": "int64"
501				}, {
502					"name": "workspaceId",
503					"in": "path",
504					"description": "ID of the package manager",
505					"required": true,
506					"type": "integer",
507					"format": "int64"
508				}, {
509					"name": "wsFormId",
510					"in": "path",
511					"description": "WsFileId of form to be retrieved",
512					"required": true,
513					"type": "string"
514				}, {
515					"in": "body",
516					"name": "newForm",
517					"description": "Delivery package to replace the current package with",
518					"required": true,
519					"schema": {
520						"$ref": "#/definitions/FormContainer"
521					}
522				}],
523				"responses": {
524					"200": {
525						"description": "OK",
526						"schema": {
527							"$ref": "#/definitions/FormContainer"
528						}
529					},
530					"201": {
531						"description": "Created"
532					},
533					"401": {
534						"description": "Unauthorized"
535					},
536					"403": {
537						"description": "Forbidden"
538					},
539					"404": {
540						"description": "Not Found"
541					}
542				}
543			},
544			"delete": {
545				"tags": ["package-management-controller"],
546				"summary": "delete form",
547				"description": "Remove a form from the package",
548				"operationId": "deleteFormUsingDELETE",
549				"parameters": [{
550					"name": "fields",
551					"in": "query",
552					"description": "Fields to be included in the response",
553					"required": false,
554					"type": "string"
555				}, {
556					"name": "customerId",
557					"in": "path",
558					"description": "Customer ID to retrieve the package manager for",
559					"required": true,
560					"type": "integer",
561					"format": "int64"
562				}, {
563					"name": "workspaceId",
564					"in": "path",
565					"description": "ID of the package manager",
566					"required": true,
567					"type": "integer",
568					"format": "int64"
569				}, {
570					"name": "wsFormId",
571					"in": "path",
572					"description": "WsFileId of form to be deleted",
573					"required": true,
574					"type": "string"
575				}],
576				"responses": {
577					"200": {
578						"description": "OK",
579						"schema": {
580							"$ref": "#/definitions/DeliveryPackageContainer"
581						}
582					},
583					"204": {
584						"description": "No Content"
585					},
586					"401": {
587						"description": "Unauthorized"
588					},
589					"403": {
590						"description": "Forbidden"
591					}
592				}
593			}
594		},
595		"/v1/customers/{customerId}/packagemanager/{workspaceId}/forms/{wsFormId}/imagingstatus": {
596			"get": {
597				"tags": ["package-management-controller"],
598				"summary": "get form imaging status",
599				"description": "returns if imaging has been completed on the form",
600				"operationId": "getFormImageStatusUsingGET",
601				"parameters": [{
602					"name": "fields",
603					"in": "query",
604					"description": "Fields to be included in the response",
605					"required": false,
606					"type": "string"
607				}, {
608					"name": "customerId",
609					"in": "path",
610					"description": "Customer ID to retrieve the package manager for",
611					"required": true,
612					"type": "integer",
613					"format": "int64"
614				}, {
615					"name": "workspaceId",
616					"in": "path",
617					"description": "ID of the package manager",
618					"required": true,
619					"type": "integer",
620					"format": "int64"
621				}, {
622					"name": "wsFormId",
623					"in": "path",
624					"description": "WsFileId of form to be retrieved",
625					"required": true,
626					"type": "string"
627				}],
628				"responses": {
629					"200": {
630						"description": "OK",
631						"schema": {
632							"$ref": "#/definitions/FormImagingStatus"
633						}
634					},
635					"401": {
636						"description": "Unauthorized"
637					},
638					"403": {
639						"description": "Forbidden"
640					},
641					"404": {
642						"description": "Not Found"
643					}
644				}
645			}
646		},
647		"/v1/customers/{customerId}/packagemanager/{workspaceId}/forms/{wsFormId}/map": {
648			"put": {
649				"tags": ["package-management-controller"],
650				"summary": "Maps the given form",
651				"description": "Pushes the form over to EMU to be mapped",
652				"operationId": "mapFormUsingPUT",
653				"parameters": [{
654					"name": "fields",
655					"in": "query",
656					"description": "Fields to be included in the response",
657					"required": false,
658					"type": "string"
659				}, {
660					"name": "customerId",
661					"in": "path",
662					"description": "Customer ID to retrieve the package manager for",
663					"required": true,
664					"type": "integer",
665					"format": "int64"
666				}, {
667					"name": "workspaceId",
668					"in": "path",
669					"description": "ID of the package manager",
670					"required": true,
671					"type": "integer",
672					"format": "int64"
673				}, {
674					"name": "wsFormId",
675					"in": "path",
676					"description": "WsFileId of form to be retrieved",
677					"required": true,
678					"type": "string"
679				}, {
680					"name": "redirect",
681					"in": "query",
682					"description": "Where to redirect to when emu is finished",
683					"required": false,
684					"type": "string"
685				}],
686				"responses": {
687					"200": {
688						"description": "OK",
689						"schema": {
690							"$ref": "#/definitions/BaseResult«string»"
691						}
692					},
693					"201": {
694						"description": "Created"
695					},
696					"401": {
697						"description": "Unauthorized"
698					},
699					"403": {
700						"description": "Forbidden"
701					},
702					"404": {
703						"description": "Not Found"
704					}
705				}
706			}
707		},
708		"/v1/customers/{customerId}/packagemanager/{workspaceId}/forms/{wsFormId}/pages/{pageNumber}": {
709			"get": {
710				"tags": ["package-management-controller"],
711				"summary": "get page",
712				"description": "gets page metadata for a specific page",
713				"operationId": "getPageUsingGET",
714				"parameters": [{
715					"name": "fields",
716					"in": "query",
717					"description": "Fields to be included in the response",
718					"required": false,
719					"type": "string"
720				}, {
721					"name": "customerId",
722					"in": "path",
723					"description": "Customer ID to retrieve the package manager for",
724					"required": true,
725					"type": "integer",
726					"format": "int64"
727				}, {
728					"name": "workspaceId",
729					"in": "path",
730					"description": "ID of the package manager",
731					"required": true,
732					"type": "integer",
733					"format": "int64"
734				}, {
735					"name": "wsFormId",
736					"in": "path",
737					"description": "WsFileId of form to be retrieved",
738					"required": true,
739					"type": "string"
740				}, {
741					"name": "pageNumber",
742					"in": "path",
743					"description": "Index of page in form (1 based)",
744					"required": true,
745					"type": "integer",
746					"format": "int32"
747				}],
748				"responses": {
749					"200": {
750						"description": "OK",
751						"schema": {
752							"$ref": "#/definitions/PageContainer"
753						}
754					},
755					"401": {
756						"description": "Unauthorized"
757					},
758					"403": {
759						"description": "Forbidden"
760					},
761					"404": {
762						"description": "Not Found"
763					}
764				}
765			}
766		},
767		"/v1/customers/{customerId}/packagemanager/{workspaceId}/forms/{wsFormId}/pages/{pageNumber}/image": {
768			"get": {
769				"tags": ["package-management-controller"],
770				"summary": "get page image",
771				"description": "gets page image for a specific page",
772				"operationId": "getPageImageUsingGET",
773				"produces": ["image/png"],
774				"parameters": [{
775					"name": "customerId",
776					"in": "path",
777					"description": "Customer ID to retrieve the package manager for",
778					"required": true,
779					"type": "integer",
780					"format": "int64"
781				}, {
782					"name": "workspaceId",
783					"in": "path",
784					"description": "ID of the package manager",
785					"required": true,
786					"type": "integer",
787					"format": "int64"
788				}, {
789					"name": "wsFormId",
790					"in": "path",
791					"description": "WsFileId of form to be retrieved",
792					"required": true,
793					"type": "string"
794				}, {
795					"name": "pageNumber",
796					"in": "path",
797					"description": "Index of page in form (1 based)",
798					"required": true,
799					"type": "integer",
800					"format": "int32"
801				}, {
802					"name": "editing_app_reference_id",
803					"in": "query",
804					"description": "Reference Id",
805					"required": false,
806					"type": "string"
807				}],
808				"responses": {
809					"200": {
810						"description": "OK"
811					},
812					"401": {
813						"description": "Unauthorized"
814					},
815					"403": {
816						"description": "Forbidden"
817					},
818					"404": {
819						"description": "Not Found"
820					}
821				}
822			}
823		},
824		"/v1/customers/{customerId}/packagemanager/{workspaceId}/forms/{wsFormId}/pdf": {
825			"get": {
826				"tags": ["package-management-controller"],
827				"summary": "get form pdf",
828				"description": "gets the pdf for a specific form",
829				"operationId": "getFormPdfUsingGET_1",
830				"produces": ["application/pdf"],
831				"parameters": [{
832					"name": "customerId",
833					"in": "path",
834					"description": "Customer ID to retrieve the package manager for",
835					"required": true,
836					"type": "integer",
837					"format": "int64"
838				}, {
839					"name": "workspaceId",
840					"in": "path",
841					"description": "ID of the package manager",
842					"required": true,
843					"type": "integer",
844					"format": "int64"
845				}, {
846					"name": "wsFormId",
847					"in": "path",
848					"description": "WsFileId of form to be retrieved",
849					"required": true,
850					"type": "string"
851				}],
852				"responses": {
853					"200": {
854						"description": "OK"
855					},
856					"401": {
857						"description": "Unauthorized"
858					},
859					"403": {
860						"description": "Forbidden"
861					},
862					"404": {
863						"description": "Not Found"
864					}
865				}
866			}
867		},
868		"/v1/customers/{customerId}/packagemanager/{workspaceId}/imagingstatus": {
869			"get": {
870				"tags": ["package-management-controller"],
871				"summary": "gets the imaging status",
872				"description": "return forms that have completed imaging and those that have not",
873				"operationId": "getImagingStatusUsingGET",
874				"parameters": [{
875					"name": "fields",
876					"in": "query",
877					"description": "Fields to be included in the response",
878					"required": false,
879					"type": "string"
880				}, {
881					"name": "customerId",
882					"in": "path",
883					"description": "Customer ID to retrieve the package manager for",
884					"required": true,
885					"type": "integer",
886					"format": "int64"
887				}, {
888					"name": "workspaceId",
889					"in": "path",
890					"description": "ID of the package manager",
891					"required": true,
892					"type": "integer",
893					"format": "int64"
894				}],
895				"responses": {
896					"200": {
897						"description": "OK",
898						"schema": {
899							"$ref": "#/definitions/ManagerImagingStatus"
900						}
901					},
902					"401": {
903						"description": "Unauthorized"
904					},
905					"403": {
906						"description": "Forbidden"
907					},
908					"404": {
909						"description": "Not Found"
910					}
911				}
912			}
913		},
914		"/v1/customers/{customerId}/packagemanager/{workspaceId}/recipientdetails": {
915			"get": {
916				"tags": ["package-management-controller"],
917				"summary": "get recipient details",
918				"description": "gets details of a recipient based on email Address to have the ability to add existing recipient accounts to package",
919				"operationId": "getRecipientDetailsUsingGET",
920				"parameters": [{
921					"name": "fields",
922					"in": "query",
923					"description": "Fields to be included in the response",
924					"required": false,
925					"type": "string"
926				}, {
927					"name": "customerId",
928					"in": "path",
929					"description": "Customer ID to retrieve the recpient details for/of",
930					"required": true,
931					"type": "integer",
932					"format": "int64"
933				}, {
934					"name": "workspaceId",
935					"in": "path",
936					"description": "ID of the package manager",
937					"required": true,
938					"type": "integer",
939					"format": "int64"
940				}, {
941					"name": "emailAddress",
942					"in": "query",
943					"description": "EmailAddress of the user",
944					"required": true,
945					"type": "string"
946				}, {
947					"name": "role",
948					"in": "query",
949					"description": "Role of the user (recipient/viewer)",
950					"required": false,
951					"type": "string"
952				}],
953				"responses": {
954					"200": {
955						"description": "OK",
956						"schema": {
957							"type": "array",
958							"items": {
959								"$ref": "#/definitions/RecipientDetails"
960							}
961						}
962					},
963					"401": {
964						"description": "Unauthorized"
965					},
966					"403": {
967						"description": "Forbidden"
968					},
969					"404": {
970						"description": "Not Found"
971					}
972				}
973			}
974		},
975		"/v1/packagemanagers/{workspaceId}": {
976			"get": {
977				"tags": ["package-management-controller"],
978				"summary": "get package manager list",
979				"description": "gets currently existing package managers",
980				"operationId": "getPackageManagersUsingGET",
981				"parameters": [{
982					"name": "fields",
983					"in": "query",
984					"description": "Fields to be included in the response",
985					"required": false,
986					"type": "string"
987				}, {
988					"name": "workspaceId",
989					"in": "path",
990					"description": "ID of the workspace to look for package manager list",
991					"required": true,
992					"type": "integer",
993					"format": "int64"
994				}],
995				"responses": {
996					"200": {
997						"description": "OK",
998						"schema": {
999							"type": "array",
1000							"items": {
1001								"$ref": "#/definitions/PackageManagerItem"
1002							}
1003						}
1004					},
1005					"401": {
1006						"description": "Unauthorized"
1007					},
1008					"403": {
1009						"description": "Forbidden"
1010					},
1011					"404": {
1012						"description": "Not Found"
1013					}
1014				}
1015			}
1016		},
1017		"/v1/packages/count": {
1018			"get": {
1019				"tags": ["package-controller"],
1020				"summary": "get all packages count",
1021				"description": "Gets the requested packages count by filtering the return list by given values.",
1022				"operationId": "getPackagesCountUsingGET",
1023				"parameters": [{
1024					"name": "memberName",
1025					"in": "query",
1026					"description": "Name of the user in the workspace to be retrieved",
1027					"required": false,
1028					"type": "string"
1029				}, {
1030					"name": "emailAddress",
1031					"in": "query",
1032					"description": "emailAddress of the user  in the workspace to be retrieved",
1033					"required": false,
1034					"type": "string"
1035				}, {
1036					"name": "packageName",
1037					"in": "query",
1038					"description": "Name of the package in the workspace to be retrieved",
1039					"required": false,
1040					"type": "string"
1041				}, {
1042					"name": "packageidentifier",
1043					"in": "query",
1044					"description": "identifier of the package in the workspace to be retrieved",
1045					"required": false,
1046					"type": "string"
1047				}, {
1048					"name": "organization",
1049					"in": "query",
1050					"description": "Filters returned packages in a workspace of only selected organization",
1051					"required": false,
1052					"type": "string"
1053				}, {
1054					"name": "startExpDate",
1055					"in": "query",
1056					"description": "Filters returned values to only return packages with an expiration date after this date",
1057					"required": false,
1058					"type": "string"
1059				}, {
1060					"name": "endExpDate",
1061					"in": "query",
1062					"description": "Filters returned values to only return packages with an expiration date before this date",
1063					"required": false,
1064					"type": "string"
1065				}, {
1066					"name": "packageRoleAccountId",
1067					"in": "query",
1068					"description": "AccountId of the particular user of a package in the workspace to be retrieved",
1069					"required": false,
1070					"type": "string"
1071				}, {
1072					"name": "packageRole",
1073					"in": "query",
1074					"description": "Role of the particular user of a package in the workspace to be retrieved",
1075					"required": false,
1076					"type": "string"
1077				}, {
1078					"name": "limit",
1079					"in": "query",
1080					"description": "limit- Number of records to be retrieved",
1081					"required": false,
1082					"type": "string"
1083				}, {
1084					"name": "inProgress",
1085					"in": "query",
1086					"description": "Only inprogress and delivered statuses packages in the workspace to be retrieved",
1087					"required": false,
1088					"type": "boolean"
1089				}, {
1090					"name": "fields",
1091					"in": "query",
1092					"description": "Fields to be included in the response",
1093					"required": false,
1094					"type": "string"
1095				}],
1096				"responses": {
1097					"200": {
1098						"description": "OK",
1099						"schema": {
1100							"type": "integer",
1101							"format": "int32"
1102						}
1103					},
1104					"401": {
1105						"description": "Unauthorized"
1106					},
1107					"403": {
1108						"description": "Forbidden"
1109					},
1110					"404": {
1111						"description": "Not Found"
1112					}
1113				}
1114			}
1115		},
1116		"/v1/packages/failed": {
1117			"get": {
1118				"tags": ["package-controller"],
1119				"summary": "get a summary of failed packages",
1120				"description": "Lists failed package counts for organizations the current logged in customer has access to.",
1121				"operationId": "getFailedPackagesUsingGET",
1122				"parameters": [{
1123					"name": "fields",
1124					"in": "query",
1125					"description": "Fields to be included in the response",
1126					"required": false,
1127					"type": "string"
1128				}, {
1129					"name": "offset",
1130					"in": "query",
1131					"description": "GMT hourly offset for calculating today, yesterday and last 7 days.  Defaults to current ET offset",
1132					"required": false,
1133					"type": "integer",
1134					"format": "int32"
1135				}],
1136				"responses": {
1137					"200": {
1138						"description": "OK",
1139						"schema": {
1140							"type": "array",
1141							"items": {
1142								"$ref": "#/definitions/FailedPackageSummary"
1143							}
1144						}
1145					},
1146					"401": {
1147						"description": "Unauthorized"
1148					},
1149					"403": {
1150						"description": "Forbidden"
1151					},
1152					"404": {
1153						"description": "Not Found"
1154					}
1155				}
1156			}
1157		},
1158		"/v1/packages/failed/files/{fileName}": {
1159			"get": {
1160				"tags": ["package-controller"],
1161				"summary": "get error details for a single failed package",
1162				"description": "Package filename should be returned from /v1/packages/failed/{timeframe} endpoint.",
1163				"operationId": "getFailedPackagesErrorDetailsUsingGET",
1164				"parameters": [{
1165					"name": "fields",
1166					"in": "query",
1167					"description": "Fields to be included in the response",
1168					"required": false,
1169					"type": "string"
1170				}, {
1171					"name": "fileName",
1172					"in": "path",
1173					"description": "Filename of the package to look up",
1174					"required": true,
1175					"type": "string"
1176				}],
1177				"responses": {
1178					"200": {
1179						"description": "OK",
1180						"schema": {
1181							"$ref": "#/definitions/FailedPackageError"
1182						}
1183					},
1184					"401": {
1185						"description": "Unauthorized"
1186					},
1187					"403": {
1188						"description": "Forbidden"
1189					},
1190					"404": {
1191						"description": "Not Found"
1192					}
1193				}
1194			},
1195			"put": {
1196				"tags": ["package-controller"],
1197				"summary": "update comments and handled status for a single failed package",
1198				"description": "Package filename should be returned from /v1/packages/failed/{timeframe} endpoint.",
1199				"operationId": "updateFailedPackageDetailsUsingPUT",
1200				"parameters": [{
1201					"name": "fields",
1202					"in": "query",
1203					"description": "Fields to be included in the response",
1204					"required": false,
1205					"type": "string"
1206				}, {
1207					"name": "fileName",
1208					"in": "path",
1209					"description": "Filename of the package to look up",
1210					"required": true,
1211					"type": "string"
1212				}, {
1213					"in": "body",
1214					"name": "updatedError",
1215					"description": "updatedError",
1216					"required": true,
1217					"schema": {
1218						"$ref": "#/definitions/FailedPackageError"
1219					}
1220				}],
1221				"responses": {
1222					"200": {
1223						"description": "OK",
1224						"schema": {
1225							"$ref": "#/definitions/FailedPackageError"
1226						}
1227					},
1228					"201": {
1229						"description": "Created"
1230					},
1231					"401": {
1232						"description": "Unauthorized"
1233					},
1234					"403": {
1235						"description": "Forbidden"
1236					},
1237					"404": {
1238						"description": "Not Found"
1239					}
1240				}
1241			}
1242		},
1243		"/v1/packages/failed/files/{fileName}/file": {
1244			"get": {
1245				"tags": ["package-controller"],
1246				"summary": "get the failed package",
1247				"description": "Downloads the failed package file for review.",
1248				"operationId": "getFailedPackageUsingGET",
1249				"parameters": [{
1250					"name": "fields",
1251					"in": "query",
1252					"description": "Fields to be included in the response",
1253					"required": false,
1254					"type": "string"
1255				}, {
1256					"name": "fileName",
1257					"in": "path",
1258					"description": "Filename of the package to look up",
1259					"required": true,
1260					"type": "string"
1261				}],
1262				"responses": {
1263					"200": {
1264						"description": "OK"
1265					},
1266					"401": {
1267						"description": "Unauthorized"
1268					},
1269					"403": {
1270						"description": "Forbidden"
1271					},
1272					"404": {
1273						"description": "Not Found"
1274					}
1275				}
1276			}
1277		},
1278		"/v1/packages/failed/{timeframe}": {
1279			"get": {
1280				"tags": ["package-controller"],
1281				"summary": "get a list of failed packages for a timeframe",
1282				"description": "Lists failed package  for organizations the current logged in customer has access to for given timeframe.",
1283				"operationId": "getFailedPackagesDetailsUsingGET",
1284				"parameters": [{
1285					"name": "fields",
1286					"in": "query",
1287					"description": "Fields to be included in the response",
1288					"required": false,
1289					"type": "string"
1290				}, {
1291					"name": "timeframe",
1292					"in": "path",
1293					"description": "Timeframe to return a list of failed packages",
1294					"required": true,
1295					"type": "string",
1296					"enum": ["LAST_1_HOUR", "TODAY", "YESTERDAY", "LAST_24_HOUR", "LAST_7_DAYS"]
1297				}, {
1298					"name": "offset",
1299					"in": "query",
1300					"description": "GMT hourly offset for calculating today, yesterday and last 7 days.  Defaults to current ET offset",
1301					"required": false,
1302					"type": "integer",
1303					"format": "int32"
1304				}],
1305				"responses": {
1306					"200": {
1307						"description": "OK",
1308						"schema": {
1309							"type": "array",
1310							"items": {
1311								"$ref": "#/definitions/FailedPackage"
1312							}
1313						}
1314					},
1315					"401": {
1316						"description": "Unauthorized"
1317					},
1318					"403": {
1319						"description": "Forbidden"
1320					},
1321					"404": {
1322						"description": "Not Found"
1323					}
1324				}
1325			}
1326		},
1327		"/v1/packages/{id}": {
1328			"get": {
1329				"tags": ["package-controller"],
1330				"summary": "get full delivery package",
1331				"description": "Gets the delivery package for the requested package.",
1332				"operationId": "getPackageByIdUsingGET",
1333				"parameters": [{
1334					"name": "id",
1335					"in": "path",
1336					"description": "ID of the package to be retrieved",
1337					"required": true,
1338					"type": "integer",
1339					"format": "int64"
1340				}, {
1341					"name": "fields",
1342					"in": "query",
1343					"description": "Fields to be included in the response",
1344					"required": false,
1345					"type": "string"
1346				}],
1347				"responses": {
1348					"200": {
1349						"description": "OK",
1350						"schema": {
1351							"$ref": "#/definitions/DeliveryPackageContainer"
1352						}
1353					},
1354					"401": {
1355						"description": "Unauthorized"
1356					},
1357					"403": {
1358						"description": "Forbidden"
1359					},
1360					"404": {
1361						"description": "Not Found"
1362					}
1363				}
1364			}
1365		},
1366		"/v1/packages/{id}/audit/{wsFileId}": {
1367			"get": {
1368				"tags": ["package-controller"],
1369				"summary": "Get audit file",
1370				"description": "Get an audit file from the package. This can include the audit report or the stacks.",
1371				"operationId": "getConcatenatedPdfUsingGET",
1372				"produces": ["application/pdf"],
1373				"parameters": [{
1374					"name": "id",
1375					"in": "path",
1376					"description": "ID of the package to retrieve",
1377					"required": true,
1378					"type": "integer",
1379					"format": "int64"
1380				}, {
1381					"name": "wsFileId",
1382					"in": "path",
1383					"description": "WSFileId of either the report or stack",
1384					"required": true,
1385					"type": "string"
1386				}],
1387				"responses": {
1388					"200": {
1389						"description": "OK"
1390					},
1391					"401": {
1392						"description": "Unauthorized"
1393					},
1394					"403": {
1395						"description": "Forbidden"
1396					},
1397					"404": {
1398						"description": "Not Found"
1399					}
1400				}
1401			}
1402		},
1403		"/v1/packages/{id}/auditlog": {
1404			"get": {
1405				"tags": ["package-controller"],
1406				"summary": "get the audit log",
1407				"description": "Get the audit log for the give package.  The audit logs is a pdf containing lists of actionsthat took place on the pckages ",
1408				"operationId": "getAuditLogUsingGET",
1409				"produces": ["application/pdf"],
1410				"parameters": [{
1411					"name": "id",
1412					"in": "path",
1413					"description": "ID of the package whose form is to be retrieved",
1414					"required": true,
1415					"type": "integer",
1416					"format": "int64"
1417				}],
1418				"responses": {
1419					"200": {
1420						"description": "OK"
1421					},
1422					"401": {
1423						"description": "Unauthorized"
1424					},
1425					"403": {
1426						"description": "Forbidden"
1427					},
1428					"404": {
1429						"description": "Not Found"
1430					}
1431				}
1432			}
1433		},
1434		"/v1/packages/{id}/forms": {
1435			"get": {
1436				"tags": ["package-controller"],
1437				"summary": "get all the forms for the given package",
1438				"description": "Gets all the forms  available in the requested package.",
1439				"operationId": "getFormsUsingGET",
1440				"parameters": [{
1441					"name": "id",
1442					"in": "path",
1443					"description": "ID of the package whose forms to be retrieved",
1444					"required": true,
1445					"type": "integer",
1446					"format": "int64"
1447				}, {
1448					"name": "fields",
1449					"in": "query",
1450					"description": "Fields to be included in the response",
1451					"required": false,
1452					"type": "string"
1453				}],
1454				"responses": {
1455					"200": {
1456						"description": "OK",
1457						"schema": {
1458							"type": "array",
1459							"items": {
1460								"$ref": "#/definitions/FormContainer"
1461							}
1462						}
1463					},
1464					"401": {
1465						"description": "Unauthorized"
1466					},
1467					"403": {
1468						"description": "Forbidden"
1469					},
1470					"404": {
1471						"description": "Not Found"
1472					}
1473				}
1474			}
1475		},
1476		"/v1/packages/{id}/forms/{formId}": {
1477			"get": {
1478				"tags": ["package-controller"],
1479				"summary": "lookup form by id",
1480				"description": "Get the form by ID for the given package ID.",
1481				"operationId": "getFormByIdUsingGET",
1482				"parameters": [{
1483					"name": "id",
1484					"in": "path",
1485					"description": "ID of the package whose forms to be retrieved",
1486					"required": true,
1487					"type": "integer",
1488					"format": "int64"
1489				}, {
1490					"name": "formId",
1491					"in": "path",
1492					"description": "ID of the form that has to be retrieved",
1493					"required": true,
1494					"type": "integer",
1495					"format": "int64"
1496				}, {
1497					"name": "fields",
1498					"in": "query",
1499					"description": "Fields to be included in the response",
1500					"required": false,
1501					"type": "string"
1502				}],
1503				"responses": {
1504					"200": {
1505						"description": "OK",
1506						"schema": {
1507							"$ref": "#/definitions/FormContainer"
1508						}
1509					},
1510					"401": {
1511						"description": "Unauthorized"
1512					},
1513					"403": {
1514						"description": "Forbidden"
1515					},
1516					"404": {
1517						"description": "Not Found"
1518					}
1519				}
1520			}
1521		},
1522		"/v1/packages/{id}/forms/{formId}/pages": {
1523			"get": {
1524				"tags": ["package-controller"],
1525				"summary": "get all the pages for the given form id",
1526				"description": "Get the pages available in the requested form.",
1527				"operationId": "getPagesUsingGET",
1528				"parameters": [{
1529					"name": "fields",
1530					"in": "query",
1531					"description": "Fields to be included in the response",
1532					"required": false,
1533					"type": "string"
1534				}, {
1535					"name": "id",
1536					"in": "path",
1537					"description": "ID of the package whose forms to be retrieved",
1538					"required": true,
1539					"type": "integer",
1540					"format": "int64"
1541				}, {
1542					"name": "formId",
1543					"in": "path",
1544					"description": "ID of the form that has to be retrieved",
1545					"required": true,
1546					"type": "integer",
1547					"format": "int64"
1548				}],
1549				"responses": {
1550					"200": {
1551						"description": "OK",
1552						"schema": {
1553							"type": "array",
1554							"items": {
1555								"$ref": "#/definitions/PageContainer"
1556							}
1557						}
1558					},
1559					"401": {
1560						"description": "Unauthorized"
1561					},
1562					"403": {
1563						"description": "Forbidden"
1564					},
1565					"404": {
1566						"description": "Not Found"
1567					}
1568				}
1569			}
1570		},
1571		"/v1/packages/{id}/forms/{formId}/pages/{pageId}": {
1572			"get": {
1573				"tags": ["package-controller"],
1574				"summary": "get the pages by id for the given form id",
1575				"description": "Get pages by id for the requested form.",
1576				"operationId": "getPageByIdUsingGET",
1577				"parameters": [{
1578					"name": "fields",
1579					"in": "query",
1580					"description": "Fields to be included in the response",
1581					"required": false,
1582					"type": "string"
1583				}, {
1584					"name": "id",
1585					"in": "path",
1586					"description": "ID of the package whose forms to be retrieved",
1587					"required": true,
1588					"type": "integer",
1589					"format": "int64"
1590				}, {
1591					"name": "formId",
1592					"in": "path",
1593					"description": "ID of the form that has to be retrieved",
1594					"required": true,
1595					"type": "integer",
1596					"format": "int64"
1597				}, {
1598					"name": "pageId",
1599					"in": "path",
1600					"description": "ID of the page that has to be retrieved",
1601					"required": true,
1602					"type": "integer",
1603					"format": "int64"
1604				}],
1605				"responses": {
1606					"200": {
1607						"description": "OK",
1608						"schema": {
1609							"$ref": "#/definitions/PageContainer"
1610						}
1611					},
1612					"401": {
1613						"description": "Unauthorized"
1614					},
1615					"403": {
1616						"description": "Forbidden"
1617					},
1618					"404": {
1619						"description": "Not Found"
1620					}
1621				}
1622			}
1623		},
1624		"/v1/packages/{id}/forms/{formId}/pages/{pageId}/fields": {
1625			"get": {
1626				"tags": ["package-controller"],
1627				"summary": "get fields",
1628				"description": "Gets all fields of the requested page.",
1629				"operationId": "getPageFieldsUsingGET",
1630				"parameters": [{
1631					"name": "id",
1632					"in": "path",
1633					"description": "ID of the package to be retrieved",
1634					"required": true,
1635					"type": "integer",
1636					"format": "int64"
1637				}, {
1638					"name": "formId",
1639					"in": "path",
1640					"description": "ID of the form to be retrieved",
1641					"required": true,
1642					"type": "integer",
1643					"format": "int64"
1644				}, {
1645					"name": "pageId",
1646					"in": "path",
1647					"description": "ID of the page to be retrieved",
1648					"required": true,
1649					"type": "integer",
1650					"format": "int64"
1651				}, {
1652					"name": "fields",
1653					"in": "query",
1654					"description": "Fields to be included in the response",
1655					"required": false,
1656					"type": "string"
1657				}],
1658				"responses": {
1659					"200": {
1660						"description": "OK",
1661						"schema": {
1662							"type": "array",
1663							"items": {
1664								"$ref": "#/definitions/FormFieldContainer"
1665							}
1666						}
1667					},
1668					"401": {
1669						"description": "Unauthorized"
1670					},
1671					"403": {
1672						"description": "Forbidden"
1673					},
1674					"404": {
1675						"description": "Not Found"
1676					}
1677				}
1678			}
1679		},
1680		"/v1/packages/{id}/forms/{formId}/pages/{pageId}/fields/{fieldId}": {
1681			"get": {
1682				"tags": ["package-controller"],
1683				"summary": "get field",
1684				"description": "Gets the field of the requested page.",
1685				"operationId": "getPageFieldByIdUsingGET",
1686				"parameters": [{
1687					"name": "id",
1688					"in": "path",
1689					"description": "ID of the package to be retrieved",
1690					"required": true,
1691					"type": "integer",
1692					"format": "int64"
1693				}, {
1694					"name": "formId",
1695					"in": "path",
1696					"description": "ID of the form to be retrieved",
1697					"required": true,
1698					"type": "integer",
1699					"format": "int64"
1700				}, {
1701					"name": "pageId",
1702					"in": "path",
1703					"description": "ID of the page to be retrieved",
1704					"required": true,
1705					"type": "integer",
1706					"format": "int64"
1707				}, {
1708					"name": "fieldId",
1709					"in": "path",
1710					"description": "ID of the field to be retrieved",
1711					"required": true,
1712					"type": "integer",
1713					"format": "int64"
1714				}, {
1715					"name": "fields",
1716					"in": "query",
1717					"description": "Fields to be included in the response",
1718					"required": false,
1719					"type": "string"
1720				}],
1721				"responses": {
1722					"200": {
1723						"description": "OK",
1724						"schema": {
1725							"$ref": "#/definitions/FormFieldContainer"
1726						}
1727					},
1728					"401": {
1729						"description": "Unauthorized"
1730					},
1731					"403": {
1732						"description": "Forbidden"
1733					},
1734					"404": {
1735						"description": "Not Found"
1736					}
1737				}
1738			},
1739			"put": {
1740				"tags": ["package-controller"],
1741				"summary": "update specific field",
1742				"description": "Updates the specific field of the requested page.",
1743				"operationId": "updatePageFieldByIdUsingPUT",
1744				"parameters": [{
1745					"name": "fields",
1746					"in": "query",
1747					"description": "Fields to be included in the response",
1748					"required": false,
1749					"type": "string"
1750				}, {
1751					"name": "id",
1752					"in": "path",
1753					"description": "ID of the package to be retrieved",
1754					"required": true,
1755					"type": "integer",
1756					"format": "int64"
1757				}, {
1758					"name": "formId",
1759					"in": "path",
1760					"description": "ID of the form to be retrieved",
1761					"required": true,
1762					"type": "integer",
1763					"format": "int64"
1764				}, {
1765					"name": "pageId",
1766					"in": "path",
1767					"description": "ID of the page to be retrieved",
1768					"required": true,
1769					"type": "integer",
1770					"format": "int64"
1771				}, {
1772					"name": "fieldId",
1773					"in": "path",
1774					"description": "ID of the field to be retrieved",
1775					"required": true,
1776					"type": "integer",
1777					"format": "int64"
1778				}, {
1779					"in": "body",
1780					"name": "formField",
1781					"description": "formField",
1782					"required": true,
1783					"schema": {
1784						"$ref": "#/definitions/FormFieldContainer"
1785					}
1786				}],
1787				"responses": {
1788					"200": {
1789						"description": "OK",
1790						"schema": {
1791							"$ref": "#/definitions/FormFieldResponse«FormFieldContainer»"
1792						}
1793					},
1794					"201": {
1795						"description": "Created"
1796					},
1797					"401": {
1798						"description": "Unauthorized"
1799					},
1800					"403": {
1801						"description": "Forbidden"
1802					},
1803					"404": {
1804						"description": "Not Found"
1805					}
1806				}
1807			}
1808		},
1809		"/v1/packages/{id}/forms/{formId}/pages/{pageId}/fields/{fieldId}/signature": {
1810			"get": {
1811				"tags": ["package-controller"],
1812				"summary": "get signature",
1813				"description": "Gets the signature image for this field if it is a signature and it has been signed",
1814				"operationId": "getSignatureUsingGET",
1815				"produces": ["image/png"],
1816				"parameters": [{
1817					"name": "id",
1818					"in": "path",
1819					"description": "ID of the package to be retrieved",
1820					"required": true,
1821					"type": "integer",
1822					"format": "int64"
1823				}, {
1824					"name": "formId",
1825					"in": "path",
1826					"description": "ID of the form to be retrieved",
1827					"required": true,
1828					"type": "integer",
1829					"format": "int64"
1830				}, {
1831					"name": "pageId",
1832					"in": "path",
1833					"description": "ID of the page to be retrieved",
1834					"required": true,
1835					"type": "integer",
1836					"format": "int64"
1837				}, {
1838					"name": "fieldId",
1839					"in": "path",
1840					"description": "ID of the field to be retrieved",
1841					"required": true,
1842					"type": "integer",
1843					"format": "int64"
1844				}],
1845				"responses": {
1846					"200": {
1847						"description": "OK"
1848					},
1849					"401": {
1850						"description": "Unauthorized"
1851					},
1852					"403": {
1853						"description": "Forbidden"
1854					},
1855					"404": {
1856						"description": "Not Found"
1857					}
1858				}
1859			}
1860		},
1861		"/v1/packages/{id}/forms/{formId}/pages/{pageId}/image": {
1862			"get": {
1863				"tags": ["package-controller"],
1864				"summary": "get page image",
1865				"description": "Gets the page thumbnail.  Only the first page of the document is imaged.",
1866				"operationId": "getImageUsingGET",
1867				"produces": ["image/png"],
1868				"parameters": [{
1869					"name": "id",
1870					"in": "path",
1871					"description": "ID of the package to be retrieved",
1872					"required": true,
1873					"type": "integer",
1874					"format": "int64"
1875				}, {
1876					"name": "formId",
1877					"in": "path",
1878					"description": "ID of the form to be retrieved",
1879					"required": true,
1880					"type": "integer",
1881					"format": "int64"
1882				}, {
1883					"name": "pageId",
1884					"in": "path",
1885					"description": "ID of the page to be retrieved",
1886					"required": true,
1887					"type": "integer",
1888					"format": "int64"
1889				}],
1890				"responses": {
1891					"200": {
1892						"description": "OK"
1893					},
1894					"401": {
1895						"description": "Unauthorized"
1896					},
1897					"403": {
1898						"description": "Forbidden"
1899					},
1900					"404": {
1901						"description": "Not Found"
1902					}
1903				}
1904			}
1905		},
1906		"/v1/packages/{id}/forms/{formId}/pdf": {
1907			"get": {
1908				"tags": ["package-controller"],
1909				"summary": "get the forms by id for the given package id",
1910				"description": "Get the form by id for the given package id.",
1911				"operationId": "getFormPdfUsingGET",
1912				"produces": ["application/json", "application/pdf"],
1913				"parameters": [{
1914					"name": "fields",
1915					"in": "query",
1916					"description": "Fields to be included in the response",
1917					"required": false,
1918					"type": "string"
1919				}, {
1920					"name": "id",
1921					"in": "path",
1922					"description": "ID of the package whose form is to be retrieved",
1923					"required": true,
1924					"type": "integer",
1925					"format": "int64"
1926				}, {
1927					"name": "formId",
1928					"in": "path",
1929					"description": "ID of the form that has to be retrieved",
1930					"required": true,
1931					"type": "integer",
1932					"format": "int64"
1933				}],
1934				"responses": {
1935					"200": {
1936						"description": "OK"
1937					},
1938					"401": {
1939						"description": "Unauthorized"
1940					},
1941					"403": {
1942						"description": "Forbidden"
1943					},
1944					"404": {
1945						"description": "Not Found"
1946					}
1947				}
1948			}
1949		},
1950		"/v1/packages/{id}/forms/{formId}/properties": {
1951			"get": {
1952				"tags": ["package-controller"],
1953				"summary": "get all the form properties for the given package id",
1954				"description": "Get the form properties for the given package id.",
1955				"operationId": "getFormPropertiesUsingGET",
1956				"parameters": [{
1957					"name": "fields",
1958					"in": "query",
1959					"description": "Fields to be included in the response",
1960					"required": false,
1961					"type": "string"
1962				}, {
1963					"name": "id",
1964					"in": "path",
1965					"description": "ID of the package whose forms to be retrieved",
1966					"required": true,
1967					"type": "integer",
1968					"format": "int64"
1969				}, {
1970					"name": "formId",
1971					"in": "path",
1972					"description": "ID of the form that has to be retrieved",
1973					"required": true,
1974					"type": "integer",
1975					"format": "int64"
1976				}],
1977				"responses": {
1978					"200": {
1979						"description": "OK",
1980						"schema": {
1981							"type": "array",
1982							"items": {
1983								"$ref": "#/definitions/PropertyContainer"
1984							}
1985						}
1986					},
1987					"401": {
1988						"description": "Unauthorized"
1989					},
1990					"403": {
1991						"description": "Forbidden"
1992					},
1993					"404": {
1994						"description": "Not Found"
1995					}
1996				}
1997			}
1998		},
1999		"/v1/packages/{id}/forms/{formId}/properties/{propertyId}": {
2000			"get": {
2001				"tags": ["package-controller"],
2002				"summary": "get the form properties by id for the given package id",
2003				"description": "Get the form properties by id for the given package id.",
2004				"operationId": "getFormPropertiesByIdUsingGET",
2005				"parameters": [{
2006					"name": "fields",
2007					"in": "query",
2008					"description": "Fields to be included in the response",
2009					"required": false,
2010					"type": "string"
2011				}, {
2012					"name": "id",
2013					"in": "path",
2014					"description": "ID of the package whose forms to be retrieved",
2015					"required": true,
2016					"type": "integer",
2017					"format": "int64"
2018				}, {
2019					"name": "formId",
2020					"in": "path",
2021					"description": "ID of the form that has to be retrieved",
2022					"required": true,
2023					"type": "integer",
2024					"format": "int64"
2025				}, {
2026					"name": "propertyId",
2027					"in": "path",
2028					"description": "ID of the form property that has to be retrieved",
2029					"required": true,
2030					"type": "integer",
2031					"format": "int64"
2032				}],
2033				"responses": {
2034					"200": {
2035						"description": "OK",
2036						"schema": {
2037							"$ref": "#/definitions/PropertyContainer"
2038						}
2039					},
2040					"401": {
2041						"description": "Unauthorized"
2042					},
2043					"403": {
2044						"description": "Forbidden"
2045					},
2046					"404": {
2047						"description": "Not Found"
2048					}
2049				}
2050			}
2051		},
2052		"/v1/packages/{id}/members": {
2053			"get": {
2054				"tags": ["package-controller"],
2055				"summary": "get viewers",
2056				"description": "Gets the viewers for the requested package.",
2057				"operationId": "getMembersUsingGET",
2058				"parameters": [{
2059					"name": "id",
2060					"in": "path",
2061					"description": "ID of the package to be retrieved",
2062					"required": true,
2063					"type": "integer",
2064					"format": "int64"
2065				}, {
2066					"name": "memberType",
2067					"in": "query",
2068					"description": "memberType",
2069					"required": true,
2070					"type": "string",
2071					"enum": ["APPROVER", "RECIPIENT", "SENDER", "VIEWER"]
2072				}, {
2073					"name": "fields",
2074					"in": "query",
2075					"description": "Fields to be included in the response",
2076					"required": false,
2077					"type": "string"
2078				}],
2079				"responses": {
2080					"200": {
2081						"description": "OK",
2082						"schema": {
2083							"type": "array",
2084							"items": {
2085								"$ref": "#/definitions/UserContainer"
2086							}
2087						}
2088					},
2089					"401": {
2090						"description": "Unauthorized"
2091					},
2092					"403": {
2093						"description": "Forbidden"
2094					},
2095					"404": {
2096						"description": "Not Found"
2097					}
2098				}
2099			}
2100		},
2101		"/v1/packages/{id}/members/{memberAccountId}": {
2102			"get": {
2103				"tags": ["package-controller"],
2104				"summary": "get viewer",
2105				"description": "Gets the viewer for the requested package.",
2106				"operationId": "getViewerUsingGET",
2107				"parameters": [{
2108					"name": "id",
2109					"in": "path",
2110					"description": "ID of the package to be retrieved",
2111					"required": true,
2112					"type": "integer",
2113					"format": "int64"
2114				}, {
2115					"name": "memberAccountId",
2116					"in": "path",
2117					"description": "Account Id of the member to be retrieved",
2118					"required": true,
2119					"type": "integer",
2120					"format": "int64"
2121				}, {
2122					"name": "fields",
2123					"in": "query",
2124					"description": "Fields to be included in the response",
2125					"required": false,
2126					"type": "string"
2127				}],
2128				"responses": {
2129					"200": {
2130						"description": "OK",
2131						"schema": {
2132							"$ref": "#/definitions/UserContainer"
2133						}
2134					},
2135					"401": {
2136						"description": "Unauthorized"
2137					},
2138					"403": {
2139						"description": "Forbidden"
2140					},
2141					"404": {
2142						"description": "Not Found"
2143					}
2144				}
2145			}
2146		},
2147		"/v1/packages/{id}/pdf": {
2148			"get": {
2149				"tags": ["package-controller"],
2150				"summary": "get a concantenated pdf of all files within the package",
2151				"description": "Concatenates all pdfs the user has access to in the package.",
2152				"operationId": "getConcatenatedPdfUsingGET_1",
2153				"produces": ["application/pdf"],
2154				"parameters": [{
2155					"name": "id",
2156					"in": "path",
2157					"description": "ID of the package to retrieve",
2158					"required": true,
2159					"type": "integer",
2160					"format": "int64"
2161				}, {
2162					"name": "downloadType",
2163					"in": "query",
2164					"description": "Which documents to include. Defaults to ALL",
2165					"required": false,
2166					"type": "string",
2167					"enum": ["ALL", "ELECTRONIC", "NOTARY", "PRINT_SIGN"]
2168				}],
2169				"responses": {
2170					"200": {
2171						"description": "OK"
2172					},
2173					"401": {
2174						"description": "Unauthorized"
2175					},
2176					"403": {
2177						"description": "Forbidden"
2178					},
2179					"404": {
2180						"description": "Not Found"
2181					}
2182				}
2183			}
2184		},
2185		"/v1/packages/{id}/properties": {
2186			"get": {
2187				"tags": ["package-controller"],
2188				"summary": "get delivery package properties",
2189				"description": "Fetches the delivery package properties for the requested package.",
2190				"operationId": "getPackagePropertiesUsingGET",
2191				"parameters": [{
2192					"name": "fields",
2193					"in": "query",
2194					"description": "Fields to be included in the response",
2195					"required": false,
2196					"type": "string"
2197				}, {
2198					"name": "id",
2199					"in": "path",
2200					"description": "ID of the package to be retrieved",
2201					"required": true,
2202					"type": "integer",
2203					"format": "int64"
2204				}],
2205				"responses": {
2206					"200": {
2207						"description": "OK",
2208						"schema": {
2209							"type": "array",
2210							"items": {
2211								"$ref": "#/definitions/PropertyContainer"
2212							}
2213						}
2214					},
2215					"401": {
2216						"description": "Unauthorized"
2217					},
2218					"403": {
2219						"description": "Forbidden"
2220					},
2221					"404": {
2222						"description": "Not Found"
2223					}
2224				}
2225			}
2226		},
2227		"/v1/packages/{id}/properties/{propertyId}": {
2228			"get": {
2229				"tags": ["package-controller"],
2230				"summary": "get delivery package properties by ID",
2231				"description": "Gets the delivery package properties by ID for the requested package.",
2232				"operationId": "getPackagePropertiesByIdUsingGET",
2233				"parameters": [{
2234					"name": "fields",
2235					"in": "query",
2236					"description": "Fields to be included in the response",
2237					"required": false,
2238					"type": "string"
2239				}, {
2240					"name": "id",
2241					"in": "path",
2242					"description": "ID of the package to be retrieved",
2243					"required": true,
2244					"type": "integer",
2245					"format": "int64"
2246				}, {
2247					"name": "propertyId",
2248					"in": "path",
2249					"description": "ID of the property to be retrieved",
2250					"required": true,
2251					"type": "integer",
2252					"format": "int64"
2253				}],
2254				"responses": {
2255					"200": {
2256						"description": "OK",
2257						"schema": {
2258							"$ref": "#/definitions/PropertyContainer"
2259						}
2260					},
2261					"401": {
2262						"description": "Unauthorized"
2263					},
2264					"403": {
2265						"description": "Forbidden"
2266					},
2267					"404": {
2268						"description": "Not Found"
2269					}
2270				}
2271			}
2272		},
2273		"/v1/packages/{id}/requestedItems": {
2274			"post": {
2275				"tags": ["package-controller"],
2276				"summary": "add document to the item requested",
2277				"description": "Adds a pdf document to the upload request.",
2278				"operationId": "addRequestedItemsUsingPOST",
2279				"consumes": ["multipart/form-data"],
2280				"parameters": [{
2281					"name": "fields",
2282					"in": "query",
2283					"description": "Fields to be included in the response",
2284					"required": false,
2285					"type": "string"
2286				}, {
2287					"name": "id",
2288					"in": "path",
2289					"description": "ID of the package to be retrieved",
2290					"required": true,
2291					"type": "integer",
2292					"format": "int64"
2293				}, {
2294					"name": "file",
2295					"in": "formData",
2296					"description": "Pdf File to be uploaded to package",
2297					"required": true,
2298					"type": "file"
2299				}, {
2300					"name": "fileName",
2301					"in": "query",
2302					"description": "Name of the file that is being uploaded",
2303					"required": false,
2304					"type": "string"
2305				}],
2306				"responses": {
2307					"200": {
2308						"description": "OK",
2309						"schema": {
2310							"$ref": "#/definitions/ResponseEntity«ReceivedDocumentContainer»"
2311						}
2312					},
2313					"201": {
2314						"description": "Created"
2315					},
2316					"401": {
2317						"description": "Unauthorized"
2318					},
2319					"403": {
2320						"description": "Forbidden"
2321					},
2322					"404": {
2323						"description": "Not Found"
2324					}
2325				}
2326			}
2327		},
2328		"/v1/packages/{id}/requestedItems/itemState/{transact_upload_recipients_ID}": {
2329			"put": {
2330				"tags": ["package-controller"],
2331				"summary": "Update the item state of an upload request item for a recipient",
2332				"description": "Maps the document to the Items",
2333				"operationId": "updateUploadRequestRecipientItemStateUsingPUT",
2334				"parameters": [{
2335					"name": "fields",
2336					"in": "query",
2337					"description": "Fields to be included in the response",
2338					"required": false,
2339					"type": "string"
2340				}, {
2341					"name": "id",
2342					"in": "path",
2343					"description": "ID of the package to be retrieved",
2344					"required": true,
2345					"type": "integer",
2346					"format": "int64"
2347				}, {
2348					"name": "transact_upload_recipients_ID",
2349					"in": "path",
2350					"description": "ID of the a request items recipient request",
2351					"required": true,
2352					"type": "integer",
2353					"format": "int64"
2354				}, {
2355					"name": "item_state",
2356					"in": "query",
2357					"description": "New value for the recipient request item state",
2358					"required": true,
2359					"type": "boolean"
2360				}],
2361				"responses": {
2362					"200": {
2363						"description": "OK",
2364						"schema": {
2365							"$ref": "#/definitions/ResponseEntity«string»"
2366						}
2367					},
2368					"201": {
2369						"description": "Created"
2370					},
2371					"401": {
2372						"description": "Unauthorized"
2373					},
2374					"403": {
2375						"description": "Forbidden"
2376					},
2377					"404": {
2378						"description": "Not Found"
2379					}
2380				}
2381			}
2382		},
2383		"/v1/packages/{id}/requestedItems/{wsFileId}": {
2384			"get": {
2385				"tags": ["package-controller"],
2386				"summary": "get the requested document",
2387				"description": "Gets the requested document of the package.",
2388				"operationId": "getRequestedDocumentUsingGET",
2389				"produces": ["application/msword", "application/pdf", "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "image/gif", "image/jpeg", "image/png", "text/plain"],
2390				"parameters": [{
2391					"name": "id",
2392					"in": "path",
2393					"description": "ID of the package to be retrieved",
2394					"required": true,
2395					"type": "integer",
2396					"format": "int64"
2397				}, {
2398					"name": "wsFileId",
2399					"in": "path",
2400					"description": "WsFileId of file to be retrieved",
2401					"required": true,
2402					"type": "string"
2403				}],
2404				"responses": {
2405					"200": {
2406						"description": "OK"
2407					},
2408					"401": {
2409						"description": "Unauthorized"
2410					},
2411					"403": {
2412						"description": "Forbidden"
2413					},
2414					"404": {
2415						"description": "Not Found"
2416					}
2417				}
2418			},
2419			"put": {
2420				"tags": ["package-controller"],
2421				"summary": "Update the package by mapping document to the Item",
2422				"description": "Maps the document to the Items",
2423				"operationId": "updateRequestedItemsUsingPUT",
2424				"parameters": [{
2425					"name": "fields",
2426					"in": "query",
2427					"description": "Fields to be included in the response",
2428					"required": false,
2429					"type": "string"
2430				}, {
2431					"name": "id",
2432					"in": "path",
2433					"description": "ID of the package to be retrieved",
2434					"required": true,
2435					"type": "integer",
2436					"format": "int64"
2437				}, {
2438					"name": "wsFileId",
2439					"in": "path",
2440					"description": "WsFileId of document to be retrieved",
2441					"required": true,
2442					"type": "string"
2443				}, {
2444					"in": "body",
2445					"name": "urc",
2446					"description": "urc",
2447					"required": true,
2448					"schema": {
2449						"$ref": "#/definitions/UploadRequestContainer"
2450					}
2451				}],
2452				"responses": {
2453					"200": {
2454						"description": "OK",
2455						"schema": {
2456							"$ref": "#/definitions/ResponseEntity«string»"
2457						}
2458					},
2459					"201": {
2460						"description": "Created"
2461					},
2462					"401": {
2463						"description": "Unauthorized"
2464					},
2465					"403": {
2466						"description": "Forbidden"
2467					},
2468					"404": {
2469						"description": "Not Found"
2470					}
2471				}
2472			},
2473			"delete": {
2474				"tags": ["package-controller"],
2475				"summary": "Delete the uploaded document of the requested Item ",
2476				"description": "Deletes the uploaded document of the requested item from the package",
2477				"operationId": "deleteRequestedItemUsingDELETE",
2478				"parameters": [{
2479					"name": "fields",
2480					"in": "query",
2481					"description": "Fields to be included in the response",
2482					"required": false,
2483					"type": "string"
2484				}, {
2485					"name": "id",
2486					"in": "path",
2487					"description": "ID of the package",
2488					"required": true,
2489					"type": "integer",
2490					"format": "int64"
2491				}, {
2492					"name": "wsFileId",
2493					"in": "path",
2494					"description": "WsFileId of the document uploaded to be deleted",
2495					"required": true,
2496					"type": "string"
2497				}],
2498				"responses": {
2499					"200": {
2500						"description": "OK",
2501						"schema": {
2502							"$ref": "#/definitions/ResponseEntity«string»"
2503						}
2504					},
2505					"204": {
2506						"description": "No Content"
2507					},
2508					"401": {
2509						"description": "Unauthorized"
2510					},
2511					"403": {
2512						"description": "Forbidden"
2513					}
2514				}
2515			}
2516		},
2517		"/v1/packages/{id}/status": {
2518			"put": {
2519				"tags": ["package-controller"],
2520				"summary": "updates the status for this user and the package",
2521				"description": "User can either decline, or complete the package.  Once completed they will no longer be able to update the package, and signature will be applied to the underlying pdf.  If declined, the user can no longer update the package.",
2522				"operationId": "updateStatusUsingPUT",
2523				"parameters": [{
2524					"name": "fields",
2525					"in": "query",
2526					"description": "Fields to be included in the response",
2527					"required": false,
2528					"type": "string"
2529				}, {
2530					"name": "id",
2531					"in": "path",
2532					"description": "ID of the package to be update",
2533					"required": true,
2534					"type": "integer",
2535					"format": "int64"
2536				}, {
2537					"name": "status",
2538					"in": "query",
2539					"description": "How the status should be updated for this user",
2540					"required": true,
2541					"type": "string",
2542					"enum": ["COMPLETE", "DECLINED", "RECALLED"]
2543				}, {
2544					"in": "body",
2545					"name": "packageDeclinedReasons",
2546					"description": "A list of declined reasons",
2547					"required": false,
2548					"schema": {
2549						"$ref": "#/definitions/PackageDeclinedReasons"
2550					}
2551				}],
2552				"responses": {
2553					"200": {
2554						"description": "OK",
2555						"schema": {
2556							"$ref": "#/definitions/UserStateContainer"
2557						}
2558					},
2559					"201": {
2560						"description": "Created"
2561					},
2562					"401": {
2563						"description": "Unauthorized"
2564					},
2565					"403": {
2566						"description": "Forbidden"
2567					},
2568					"404": {
2569						"description": "Not Found"
2570					}
2571				}
2572			}
2573		},
2574		"/v1/packages/{id}/zip": {
2575			"get": {
2576				"tags": ["package-controller"],
2577				"summary": "gets a zip of all files within the package",
2578				"description": "zips all pdfs the user has access to in the package.",
2579				"operationId": "getZipUsingGET",
2580				"produces": ["application/octet-stream"],
2581				"parameters": [{
2582					"name": "id",
2583					"in": "path",
2584					"description": "ID of the package to retrieve",
2585					"required": true,
2586					"type": "integer",
2587					"format": "int64"
2588				}],
2589				"responses": {
2590					"200": {
2591						"description": "OK"
2592					},
2593					"401": {
2594						"description": "Unauthorized"
2595					},
2596					"403": {
2597						"description": "Forbidden"
2598					},
2599					"404": {
2600						"description": "Not Found"
2601					}
2602				}
2603			}
2604		},
2605		"/v1/packages/{packageId}/audit/packages": {
2606			"put": {
2607				"tags": ["package-controller"],
2608				"summary": "Sets the packages to be included with this audit request",
2609				"description": "Identity of other completed packages within the workspace should be passed in, only UploadRequest with the AuditFlag set to true is supported",
2610				"operationId": "updateAuditPackageUsingPUT",
2611				"parameters": [{
2612					"name": "fields",
2613					"in": "query",
2614					"description": "Fields to be included in the response",
2615					"required": false,
2616					"type": "string"
2617				}, {
2618					"name": "packageId",
2619					"in": "path",
2620					"description": "ID of the package to be retrieved",
2621					"required": true,
2622					"type": "integer",
2623					"format": "int64"
2624				}, {
2625					"in": "body",
2626					"name": "auditPackages",
2627					"description": "List of AuditPackages to include",
2628					"required": true,
2629					"schema": {
2630						"type": "array",
2631						"items": {
2632							"$ref": "#/definitions/AuditPackageContainer"
2633						}
2634					}
2635				}],
2636				"responses": {
2637					"200": {
2638						"description": "OK"
2639					},
2640					"201": {
2641						"description": "Created"
2642					},
2643					"401": {
2644						"description": "Unauthorized"
2645					},
2646					"403": {
2647						"description": "Forbidden"
2648					},
2649					"404": {
2650						"description": "Not Found"
2651					}
2652				}
2653			}
2654		},
2655		"/v1/workspaces": {
2656			"get": {
2657				"tags": ["workspace-controller"],
2658				"summary": "get workspaces",
2659				"description": "Gets the workspaces by filtering the return list by the given values.",
2660				"operationId": "getWorkspacesUsingGET",
2661				"parameters": [{
2662					"name": "fromDate",
2663					"in": "query",
2664					"description": "Filters returned values to only return workspaces with creation date after this date",
2665					"required": false,
2666					"type": "string",
2667					"format": "date-time"
2668				}, {
2669					"name": "toDate",
2670					"in": "query",
2671					"description": "Filters returned values to only return workspaces with creation date before this date",
2672					"required": false,
2673					"type": "string",
2674					"format": "date-time"
2675				}, {
2676					"name": "memberName",
2677					"in": "query",
2678					"description": "name of the user in the workspace to be retrieved",
2679					"required": false,
2680					"type": "string"
2681				}, {
2682					"name": "packageName",
2683					"in": "query",
2684					"description": "name of the package in the workspace to be retrieved",
2685					"required": false,
2686					"type": "string"
2687				}, {
2688					"name": "packageidentifier",
2689					"in": "query",
2690					"description": "identifier of the package in the workspace to be retrieved",
2691					"required": false,
2692					"type": "string"
2693				}, {
2694					"name": "identifier",
2695					"in": "query",
2696					"description": "foreign Identity Value of the workspace to be retrieved",
2697					"required": false,
2698					"type": "string"
2699				}, {
2700					"name": "organization",
2701					"in": "query",
2702					"description": "Filters returned workspaces to only selected organization",
2703					"required": false,
2704					"type": "array",
2705					"items": {
2706						"type": "integer",
2707						"format": "int64"
2708					},
2709					"collectionFormat": "multi"
2710				}, {
2711					"name": "emailAddress",
2712					"in": "query",
2713					"description": "emailAddress of the user of a package in the workspace to be retrieved",
2714					"required": false,
2715					"type": "string"
2716				}, {
2717					"name": "limit",
2718					"in": "query",
2719					"description": "limit - for pagination support - This is the number of rows to be returned",
2720					"required": false,
2721					"type": "integer",
2722					"format": "int32"
2723				}, {
2724					"name": "offSet",
2725					"in": "query",
2726					"description": "offSet - for pagination support - This is the number of rows to be skipped before",
2727					"required": false,
2728					"type": "integer",
2729					"format": "int32"
2730				}, {
2731					"name": "startExpDate",
2732					"in": "query",
2733					"description": "Filters returned values to only return packages with an expiration date after this date",
2734					"required": false,
2735					"type": "string",
2736					"format": "date-time"
2737				}, {
2738					"name": "endExpDate",
2739					"in": "query",
2740					"description": "Filters returned values to only return packages with an expiration date before this date",
2741					"required": false,
2742					"type": "string",
2743					"format": "date-time"
2744				}, {
2745					"name": "packageRole",
2746					"in": "query",
2747					"description": "Role of the particular user of a package in the workspace to be retrieved",
2748					"required": false,
2749					"type": "string"
2750				}, {
2751					"name": "packageRoleAccountId",
2752					"in": "query",
2753					"description": "AccountId of the particular user of a package in the workspace to be retrieved",
2754					"required": false,
2755					"type": "integer",
2756					"format": "int64"
2757				}, {
2758					"name": "inProgress",
2759					"in": "query",
2760					"description": "Only inprogress and delivered statuses packages in the workspace to be retrieved",
2761					"required": false,
2762					"type": "boolean"
2763				}, {
2764					"name": "fields",
2765					"in": "query",
2766					"description": "Fields to be included in the response",
2767					"required": false,
2768					"type": "string"
2769				}],
2770				"responses": {
2771					"200": {
2772						"description": "OK",
2773						"schema": {
2774							"type": "array",
2775							"items": {
2776								"$ref": "#/definitions/WorkspaceContainer"
2777							}
2778						}
2779					},
2780					"401": {
2781						"description": "Unauthorized"
2782					},
2783					"403": {
2784						"description": "Forbidden"
2785					},
2786					"404": {
2787						"description": "Not Found"
2788					}
2789				}
2790			},
2791			"post": {
2792				"tags": ["workspace-controller"],
2793				"summary": "Create workspace",
2794				"description": "Creates the workspace.",
2795				"operationId": "createWorkspaceUsingPOST",
2796				"parameters": [{
2797					"name": "fields",
2798					"in": "query",
2799					"description": "Fields to be included in the response",
2800					"required": false,
2801					"type": "string"
2802				}, {
2803					"in": "body",
2804					"name": "workspace",
2805					"description": "workspace",
2806					"required": true,
2807					"schema": {
2808						"$ref": "#/definitions/WorkspaceContainer"
2809					}
2810				}],
2811				"responses": {
2812					"201": {
2813						"description": "Created",
2814						"schema": {
2815							"$ref": "#/definitions/WorkspaceContainer"
2816						}
2817					},
2818					"401": {
2819						"description": "Unauthorized"
2820					},
2821					"403": {
2822						"description": "Forbidden"
2823					},
2824					"404": {
2825						"description": "Not Found"
2826					}
2827				}
2828			}
2829		},
2830		"/v1/workspaces/{id}": {
2831			"get": {
2832				"tags": ["workspace-controller"],
2833				"summary": "get workspace",
2834				"description": "Gets the workspace.",
2835				"operationId": "getWorkspaceByIdUsingGET",
2836				"parameters": [{
2837					"name": "id",
2838					"in": "path",
2839					"description": "ID of the workspace to be retrieved",
2840					"required": true,
2841					"type": "integer",
2842					"format": "int64"
2843				}, {
2844					"name": "fields",
2845					"in": "query",
2846					"description": "Fields to be included in the response",
2847					"required": false,
2848					"type": "string"
2849				}],
2850				"responses": {
2851					"200": {
2852						"description": "OK",
2853						"schema": {
2854							"$ref": "#/definitions/WorkspaceContainer"
2855						}
2856					},
2857					"401": {
2858						"description": "Unauthorized"
2859					},
2860					"403": {
2861						"description": "Forbidden"
2862					},
2863					"404": {
2864						"description": "Not Found"
2865					}
2866				}
2867			}
2868		},
2869		"/v1/workspaces/{id}/auditlog": {
2870			"get": {
2871				"tags": ["workspace-controller"],
2872				"summary": "get the workspace audit log",
2873				"description": "Get the audit log for the given workspace.  The workspace audit log is a concatenated pdf of all the package audit logs.",
2874				"operationId": "getAuditLogUsingGET_1",
2875				"produces": ["application/pdf"],
2876				"parameters": [{
2877					"name": "id",
2878					"in": "path",
2879					"description": "ID of the workspaces whose log is to be retrieved",
2880					"required": true,
2881					"type": "integer",
2882					"format": "int64"
2883				}],
2884				"responses": {
2885					"200": {
2886						"description": "OK"
2887					},
2888					"401": {
2889						"description": "Unauthorized"
2890					},
2891					"403": {
2892						"description": "Forbidden"
2893					},
2894					"404": {
2895						"description": "Not Found"
2896					}
2897				}
2898			}
2899		},
2900		"/v1/workspaces/{id}/consent/{customerId}": {
2901			"get": {
2902				"tags": ["workspace-controller"],
2903				"summary": "get workspace consent",
2904				"description": "Gets the workspace consent.",
2905				"operationId": "getWorkspaceConsentUsingGET",
2906				"parameters": [{
2907					"name": "fields",
2908					"in": "query",
2909					"description": "Fields to be included in the response",
2910					"required": false,
2911					"type": "string"
2912				}, {
2913					"name": "id",
2914					"in": "path",
2915					"description": "ID of the workspace to be retrieved",
2916					"required": true,
2917					"type": "integer",
2918					"format": "int64"
2919				}, {
2920					"name": "customerId",
2921					"in": "path",
2922					"description": "ID of the customer to be retrieved",
2923					"required": true,
2924					"type": "integer",
2925					"format": "int64"
2926				}],
2927				"responses": {
2928					"200": {
2929						"description": "OK",
2930						"schema": {
2931							"$ref": "#/definitions/WorkspaceConsent"
2932						}
2933					},
2934					"401": {
2935						"description": "Unauthorized"
2936					},
2937					"403": {
2938						"description": "Forbidden"
2939					},
2940					"404": {
2941						"description": "Not Found"
2942					}
2943				}
2944			},
2945			"put": {
2946				"tags": ["workspace-controller"],
2947				"summary": "update workspace consent",
2948				"description": "Sets the logged in users consent status for the given workspace and customer.",
2949				"operationId": "updateWorkspaceConsentUsingPUT",
2950				"parameters": [{
2951					"name": "fields",
2952					"in": "query",
2953					"description": "Fields to be included in the response",
2954					"required": false,
2955					"type": "string"
2956				}, {
2957					"name": "id",
2958					"in": "path",
2959					"description": "ID of the workspace to be retrieved",
2960					"required": true,
2961					"type": "integer",
2962					"format": "int64"
2963				}, {
2964					"name": "customerId",
2965					"in": "path",
2966					"description": "ID of the customer to be retrieved",
2967					"required": true,
2968					"type": "integer",
2969					"format": "int64"
2970				}, {
2971					"in": "body",
2972					"name": "workspaceConsent",
2973					"description": "Workspace consent properties",
2974					"required": false,
2975					"schema": {
2976						"$ref": "#/definitions/WorkspaceConsent"
2977					}
2978				}],
2979				"responses": {
2980					"200": {
2981						"description": "OK",
2982						"schema": {
2983							"$ref": "#/definitions/WorkspaceConsent"
2984						}
2985					},
2986					"201": {
2987						"description": "Created"
2988					},
2989					"401": {
2990						"description": "Unauthorized"
2991					},
2992					"403": {
2993						"description": "Forbidden"
2994					},
2995					"404": {
2996						"description": "Not Found"
2997					}
2998				}
2999			}
3000		},
3001		"/v1/workspaces/{id}/foreignidentities": {
3002			"post": {
3003				"tags": ["workspace-controller"],
3004				"summary": "add foreign identifier",
3005				"description": "Adds a foreign identifier to the works",
3006				"operationId": "addFicUsingPOST",
3007				"parameters": [{
3008					"name": "fields",
3009					"in": "query",
3010					"description": "Fields to be included in the response",
3011					"required": false,
3012					"type": "string"
3013				}, {
3014					"name": "id",
3015					"in": "path",
3016					"description": "ID of the workspace to be retrieved",
3017					"required": true,
3018					"type": "integer",
3019					"format": "int64"
3020				}, {
3021					"in": "body",
3022					"name": "fic",
3023					"description": "Workspace consent properties",
3024					"required": false,
3025					"schema": {
3026						"$ref": "#/definitions/ForeignIdentityContainer"
3027					}
3028				}],
3029				"responses": {
3030					"200": {
3031						"description": "OK",
3032						"schema": {
3033							"$ref": "#/definitions/ForeignIdentityContainer"
3034						}
3035					},
3036					"201": {
3037						"description": "Created"
3038					},
3039					"401": {
3040						"description": "Unauthorized"
3041					},
3042					"403": {
3043						"description": "Forbidden"
3044					},
3045					"404": {
3046						"description": "Not Found"
3047					}
3048				}
3049			}
3050		},
3051		"/v1/workspaces/{id}/members": {
3052			"get": {
3053				"tags": ["workspace-controller"],
3054				"summary": "get workspace members",
3055				"description": "Gets the workspace members.",
3056				"operationId": "getWorkspaceMembersUsingGET",
3057				"parameters": [{
3058					"name": "id",
3059					"in": "path",
3060					"description": "ID of the workspace to be retrieved",
3061					"required": true,
3062					"type": "integer",
3063					"format": "int64"
3064				}, {
3065					"name": "fields",
3066					"in": "query",
3067					"description": "Fields to be included in the response",
3068					"required": false,
3069					"type": "string"
3070				}],
3071				"responses": {
3072					"200": {
3073						"description": "OK",
3074						"schema": {
3075							"$ref": "#/definitions/CollectionResponseEntity«UserContainer»"
3076						}
3077					},
3078					"401": {
3079						"description": "Unauthorized"
3080					},
3081					"403": {
3082						"description": "Forbidden"
3083					},
3084					"404": {
3085						"description": "Not Found"
3086					}
3087				}
3088			}
3089		},
3090		"/v1/workspaces/{id}/packages": {
3091			"get": {
3092				"tags": ["workspace-controller"],
3093				"summary": "get workspace packages",
3094				"description": "Gets the requested workspace packages by given id and filtering the return list by given values.",
3095				"operationId": "getWorkspacePackagesUsingGET",
3096				"parameters": [{
3097					"name": "id",
3098					"in": "path",
3099					"description": "ID of the workspace to be retrieved",
3100					"required": true,
3101					"type": "integer",
3102					"format": "int64"
3103				}, {
3104					"name": "memberName",
3105					"in": "query",
3106					"description": "Name of the user in the workspace to be retrieved",
3107					"required": false,
3108					"type": "string"
3109				}, {
3110					"name": "emailAddress",
3111					"in": "query",
3112					"description": "emailAddress of the user in the workspace to be retrieved",
3113					"required": false,
3114					"type": "string"
3115				}, {
3116					"name": "packageName",
3117					"in": "query",
3118					"description": "Name of the package in the workspace to be retrieved",
3119					"required": false,
3120					"type": "string"
3121				}, {
3122					"name": "packageidentifier",
3123					"in": "query",
3124					"description": "identifier of the package in the workspace to be retrieved",
3125					"required": false,
3126					"type": "string"
3127				}, {
3128					"name": "organization",
3129					"in": "query",
3130					"description": "Filters returned packages in a workspace of only selected organization",
3131					"required": false,
3132					"type": "string"
3133				}, {
3134					"name": "startExpDate",
3135					"in": "query",
3136					"description": "Filters returned values to only return packages with an expiration date after this date",
3137					"required": false,
3138					"type": "string"
3139				}, {
3140					"name": "endExpDate",
3141					"in": "query",
3142					"description": "Filters returned values to only return packages with an expiration date before this date",
3143					"required": false,
3144					"type": "string"
3145				}, {
3146					"name": "packageRoleAccountId",
3147					"in": "query",
3148					"description": "AccountId of the particular user of a package in the workspace to be retrieved",
3149					"required": false,
3150					"type": "string"
3151				}, {
3152					"name": "packageRole",
3153					"in": "query",
3154					"description": "Role of the particular user of a package in the workspace to be retrieved",
3155					"required": false,
3156					"type": "string"
3157				}, {
3158					"name": "limit",
3159					"in": "query",
3160					"description": "limit- Number of records to be retrieved",
3161					"required": false,
3162					"type": "string"
3163				}, {
3164					"name": "inProgress",
3165					"in": "query",
3166					"description": "Only inprogress and delivered statuses packages in the workspace to be retrieved",
3167					"required": false,
3168					"type": "boolean"
3169				}, {
3170					"name": "fields",
3171					"in": "query",
3172					"description": "Fields to be included in the response",
3173					"required": false,
3174					"type": "string"
3175				}],
3176				"responses": {
3177					"200": {
3178						"description": "OK",
3179						"schema": {
3180							"type": "array",
3181							"items": {
3182								"$ref": "#/definitions/WorkspaceListDP"
3183							}
3184						}
3185					},
3186					"401": {
3187						"description": "Unauthorized"
3188					},
3189					"403": {
3190						"description": "Forbidden"
3191					},
3192					"404": {
3193						"description": "Not Found"
3194					}
3195				}
3196			}
3197		},
3198		"/v1/workspaces/{id}/packages/{packageId}/{customerId}": {
3199			"post": {
3200				"tags": ["package-controller"],
3201				"summary": "resend notification",
3202				"description": "Resends the package email notification to the recipient.",
3203				"operationId": "resendNotificationUsingPOST",
3204				"parameters": [{
3205					"name": "fields",
3206					"in": "query",
3207					"description": "Fields to be included in the response",
3208					"required": false,
3209					"type": "string"
3210				}, {
3211					"name": "id",
3212					"in": "path",
3213					"description": "ID of the workspace to be retrieved",
3214					"required": true,
3215					"type": "integer",
3216					"format": "int64"
3217				}, {
3218					"name": "packageId",
3219					"in": "path",
3220					"description": "ID of the package to be retrieved",
3221					"required": true,
3222					"type": "integer",
3223					"format": "int64"
3224				}, {
3225					"name": "customerId",
3226					"in": "path",
3227					"description": "ID of the customer to be retrieved",
3228					"required": true,
3229					"type": "integer",
3230					"format": "int64"
3231				}],
3232				"responses": {
3233					"200": {
3234						"description": "OK"
3235					},
3236					"201": {
3237						"description": "Created"
3238					},
3239					"401": {
3240						"description": "Unauthorized"
3241					},
3242					"403": {
3243						"description": "Forbidden"
3244					},
3245					"404": {
3246						"description": "Not Found"
3247					}
3248				}
3249			}
3250		},
3251		"/v1/workspaces/{id}/properties": {
3252			"get": {
3253				"tags": ["workspace-controller"],
3254				"summary": "get workspace properties",
3255				"description": "Fetches the workspace properties for the requested workspace.",
3256				"operationId": "getWorkspacePropertiesUsingGET",
3257				"parameters": [{
3258					"name": "fields",
3259					"in": "query",
3260					"description": "Fields to be included in the response",
3261					"required": false,
3262					"type": "string"
3263				}, {
3264					"name": "id",
3265					"in": "path",
3266					"description": "ID of the workspace to be retrieved",
3267					"required": true,
3268					"type": "integer",
3269					"format": "int64"
3270				}],
3271				"responses": {
3272					"200": {
3273						"description": "OK",
3274						"schema": {
3275							"type": "array",
3276							"items": {
3277								"$ref": "#/definitions/PropertyContainer"
3278							}
3279						}
3280					},
3281					"401": {
3282						"description": "Unauthorized"
3283					},
3284					"403": {
3285						"description": "Forbidden"
3286					},
3287					"404": {
3288						"description": "Not Found"
3289					}
3290				}
3291			}
3292		},
3293		"/v1/workspaces/{id}/properties/{propertyId}": {
3294			"get": {
3295				"tags": ["workspace-controller"],
3296				"summary": "get workspace properties by ID",
3297				"description": "Gets the workspace properties by ID for the requested workspace.",
3298				"operationId": "getWorkspaceWorkspacePropertiesByIdUsingGET",
3299				"parameters": [{
3300					"name": "fields",
3301					"in": "query",
3302					"description": "Fields to be included in the response",
3303					"required": false,
3304					"type": "string"
3305				}, {
3306					"name": "id",
3307					"in": "path",
3308					"description": "ID of the workspace to be retrieved",
3309					"required": true,
3310					"type": "integer",
3311					"format": "int64"
3312				}, {
3313					"name": "propertyId",
3314					"in": "path",
3315					"description": "ID of the property to be retrieved",
3316					"required": true,
3317					"type": "integer",
3318					"format": "int64"
3319				}],
3320				"responses": {
3321					"200": {
3322						"description": "OK",
3323						"schema": {
3324							"$ref": "#/definitions/PropertyContainer"
3325						}
3326					},
3327					"401": {
3328						"description": "Unauthorized"
3329					},
3330					"403": {
3331						"description": "Forbidden"
3332					},
3333					"404": {
3334						"description": "Not Found"
3335					}
3336				}
3337			}
3338		}
3339	},
3340	"definitions": {
3341		"AccountLookupContainer": {
3342			"type": "object",
3343			"properties": {
3344				"EmailAddress": {
3345					"type": "string",
3346					"xml": {
3347						"name": "EmailAddress",
3348						"attribute": false,
3349						"wrapped": false
3350					},
3351					"description": "Primary email address for this user",
3352					"allowEmptyValue": false
3353				},
3354				"Name": {
3355					"xml": {
3356						"name": "Name",
3357						"attribute": false,
3358						"wrapped": false
3359					},
3360					"description": "Name on this user account",
3361					"allowEmptyValue": false,
3362					"$ref": "#/definitions/NameContainer"
3363				}
3364			},
3365			"title": "AccountLookup",
3366			"xml": {
3367				"name": "AccountLookup",
3368				"attribute": false,
3369				"wrapped": false
3370			}
3371		},
3372		"AddressContainer": {
3373			"type": "object",
3374			"properties": {
3375				"City": {
3376					"type": "string",
3377					"xml": {
3378						"name": "City",
3379						"attribute": false,
3380						"wrapped": false
3381					},
3382					"description": "City for this address, also known as locality.",
3383					"allowEmptyValue": false
3384				},
3385				"Country": {
3386					"type": "string",
3387					"xml": {
3388						"name": "Country",
3389						"attribute": false,
3390						"wrapped": false
3391					},
3392					"description": "3-character ISO designation for the country",
3393					"allowEmptyValue": false
3394				},
3395				"Line1": {
3396					"type": "string",
3397					"xml": {
3398						"name": "Line1",
3399						"attribute": false,
3400						"wrapped": false
3401					},
3402					"description": "First line of this address. For most areas, this is the street number and street name ",
3403					"allowEmptyValue": false
3404				},
3405				"Line2": {
3406					"type": "string",
3407					"xml": {
3408						"name": "Line2",
3409						"attribute": false,
3410						"wrapped": false
3411					},
3412					"description": "Second line of this address.",
3413					"allowEmptyValue": false
3414				},
3415				"PostalCode": {
3416					"type": "string",
3417					"xml": {
3418						"name": "PostalCode",
3419						"attribute": false,
3420						"wrapped": false
3421					},
3422					"description": "Postal Code for this address.  In the US, this is either a 5- or 9-digit number.",
3423					"allowEmptyValue": false
3424				},
3425				"State": {
3426					"type": "string",
3427					"xml": {
3428						"name": "State",
3429						"attribute": false,
3430						"wrapped": false
3431					},
3432					"description": "State or Province designation.  In the US, thiis is the 2-character state or APO/FPO/DPO designation.",
3433					"allowEmptyValue": false
3434				}
3435			},
3436			"title": "Address",
3437			"xml": {
3438				"name": "Address",
3439				"attribute": false,
3440				"wrapped": false
3441			}
3442		},
3443		"AffectedField": {
3444			"type": "object",
3445			"properties": {
3446				"Enabled": {
3447					"type": "boolean",
3448					"xml": {
3449						"name": "Enabled",
3450						"attribute": false,
3451						"wrapped": false
3452					}
3453				},
3454				"Identity": {
3455					"type": "integer",
3456					"format": "int64",
3457					"xml": {
3458						"name": "Identity",
3459						"attribute": false,
3460						"wrapped": false
3461					}
3462				},
3463				"Tag": {
3464					"type": "string",
3465					"xml": {
3466						"name": "Tag",
3467						"attribute": false,
3468						"wrapped": false
3469					}
3470				},
3471				"Type": {
3472					"type": "string",
3473					"xml": {
3474						"name": "Type",
3475						"attribute": false,
3476						"wrapped": false
3477					}
3478				},
3479				"Value": {
3480					"type": "string",
3481					"xml": {
3482						"name": "Value",
3483						"attribute": false,
3484						"wrapped": false
3485					}
3486				}
3487			},
3488			"title": "AffectedField"
3489		},
3490		"AggregatePackageStateContainer": {
3491			"type": "object",
3492			"properties": {
3493				"PackageCount": {
3494					"type": "integer",
3495					"format": "int64",
3496					"xml": {
3497						"name": "PackageCount",
3498						"attribute": false,
3499						"wrapped": false
3500					},
3501					"description": "Number of packages within this workspace that are in this package state",
3502					"allowEmptyValue": false
3503				},
3504				"PackageState": {
3505					"type": "string",
3506					"xml": {
3507						"name": "PackageState",
3508						"attribute": false,
3509						"wrapped": false
3510					},
3511					"description": "One of the enumerated states defined for packages",
3512					"allowEmptyValue": false
3513				}
3514			},
3515			"title": "AggregatePackageState",
3516			"xml": {
3517				"name": "AggregatePackageState",
3518				"attribute": false,
3519				"wrapped": false
3520			}
3521		},
3522		"AuditContainer": {
3523			"type": "object",
3524			"properties": {
3525				"AuditPackage": {
3526					"type": "array",
3527					"xml": {
3528						"name": "AuditPackages",
3529						"attribute": false,
3530						"wrapped": true
3531					},
3532					"description": "Additional system packages to be included in the audit request with this Audit package",
3533					"allowEmptyValue": false,
3534					"items": {
3535						"$ref": "#/definitions/AuditPackageContainer"
3536					}
3537				},
3538				"Complete": {
3539					"type": "boolean",
3540					"example": false,
3541					"xml": {
3542						"name": "Complete",
3543						"attribute": false,
3544						"wrapped": false
3545					},
3546					"description": "If the audit has been completed on this request",
3547					"allowEmptyValue": false
3548				},
3549				"Report": {
3550					"xml": {
3551						"name": "Report",
3552						"attribute": false,
3553						"wrapped": false
3554					},
3555					"description": "The completed eAudit report",
3556					"allowEmptyValue": false,
3557					"$ref": "#/definitions/AuditReportContainer"
3558				},
3559				"Stack": {
3560					"type": "array",
3561					"xml": {
3562						"name": "Stacks",
3563						"attribute": false,
3564						"wrapped": true
3565					},
3566					"description": "Document stacks generated by the eAudit process",
3567					"allowEmptyValue": false,
3568					"items": {
3569						"$ref": "#/definitions/AuditStackContainer"
3570					}
3571				}
3572			},
3573			"title": "Audit",
3574			"xml": {
3575				"name": "Audit",
3576				"attribute": false,
3577				"wrapped": false
3578			}
3579		},
3580		"AuditPackageContainer": {
3581			"type": "object",
3582			"properties": {
3583				"Identity": {
3584					"type": "integer",
3585					"format": "int64",
3586					"xml": {
3587						"name": "Identity",
3588						"attribute": false,
3589						"wrapped": false
3590					},
3591					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
3592					"allowEmptyValue": false
3593				}
3594			},
3595			"title": "AuditPackage",
3596			"xml": {
3597				"name": "AuditPackage",
3598				"attribute": false,
3599				"wrapped": false
3600			}
3601		},
3602		"AuditReportContainer": {
3603			"type": "object",
3604			"required": ["Name"],
3605			"properties": {
3606				"Name": {
3607					"type": "string",
3608					"xml": {
3609						"name": "Name",
3610						"attribute": false,
3611						"wrapped": false
3612					}
3613				},
3614				"WSFileId": {
3615					"type": "string",
3616					"xml": {
3617						"name": "WSFileId",
3618						"attribute": false,
3619						"wrapped": false
3620					},
3621					"description": "Identifier of the document file within the workspace",
3622					"allowEmptyValue": false
3623				}
3624			},
3625			"title": "Report",
3626			"xml": {
3627				"name": "Report",
3628				"attribute": false,
3629				"wrapped": false
3630			}
3631		},
3632		"AuditStackContainer": {
3633			"type": "object",
3634			"properties": {
3635				"Name": {
3636					"type": "string",
3637					"xml": {
3638						"name": "Name",
3639						"attribute": false,
3640						"wrapped": false
3641					},
3642					"description": "Name of the audit stack of documents",
3643					"allowEmptyValue": false
3644				},
3645				"WSFileId": {
3646					"type": "string",
3647					"xml": {
3648						"name": "WSFileId",
3649						"attribute": false,
3650						"wrapped": false
3651					},
3652					"description": "Identifier of the document file within the workspace",
3653					"allowEmptyValue": false
3654				}
3655			},
3656			"title": "Stack",
3657			"xml": {
3658				"name": "Stack",
3659				"attribute": false,
3660				"wrapped": false
3661			}
3662		},
3663		"AuthenticationContainer": {
3664			"type": "object",
3665			"properties": {
3666				"AuthenticationType": {
3667					"type": "string",
3668					"xml": {
3669						"name": "AuthenticationType",
3670						"attribute": false,
3671						"wrapped": false
3672					},
3673					"description": "Supplied by Package.  The desired authentication type requested for this user.",
3674					"allowEmptyValue": false,
3675					"enum": ["MFA", "SSO"]
3676				},
3677				"MFA": {
3678					"xml": {
3679						"name": "MFA",
3680						"attribute": false,
3681						"wrapped": false
3682					},
3683					"description": "Data to support Multi-Factor (cell phone) authentication",
3684					"allowEmptyValue": false,
3685					"$ref": "#/definitions/MFAContainer"
3686				}
3687			},
3688			"title": "Authentication",
3689			"xml": {
3690				"name": "Authentication",
3691				"attribute": false,
3692				"wrapped": false
3693			}
3694		},
3695		"BaseResult«string»": {
3696			"type": "object",
3697			"properties": {
3698				"code": {
3699					"type": "integer",
3700					"format": "int32"
3701				},
3702				"message": {
3703					"type": "string"
3704				},
3705				"payload": {
3706					"type": "string"
3707				},
3708				"success": {
3709					"type": "boolean"
3710				}
3711			},
3712			"title": "##default",
3713			"xml": {
3714				"name": "##default",
3715				"attribute": false,
3716				"wrapped": false
3717			}
3718		},
3719		"BillingAddressWaybillAddressContainer": {
3720			"type": "object",
3721			"properties": {
3722				"Address": {
3723					"xml": {
3724						"name": "Address",
3725						"attribute": false,
3726						"wrapped": false
3727					},
3728					"description": "Supplied by Package.  The postal address.",
3729					"allowEmptyValue": false,
3730					"$ref": "#/definitions/AddressContainer"
3731				},
3732				"CompanyName": {
3733					"type": "string",
3734					"xml": {
3735						"name": "CompanyName",
3736						"attribute": false,
3737						"wrapped": false
3738					},
3739					"description": "Supplied by Package.  Name of the contact company at the return address",
3740					"allowEmptyValue": false
3741				},
3742				"ContactName": {
3743					"type": "string",
3744					"xml": {
3745						"name": "ContactName",
3746						"attribute": false,
3747						"wrapped": false
3748					},
3749					"description": "Supplied by Package.  Name of the contact person at the return address",
3750					"allowEmptyValue": false
3751				},
3752				"ContactPhone": {
3753					"type": "string",
3754					"xml": {
3755						"name": "ContactPhone",
3756						"attribute": false,
3757						"wrapped": false
3758					},
3759					"description": "Supplied by Package.  Phone number of the contact person for this address.  Required for UPS and FedEx.",
3760					"allowEmptyValue": false
3761				}
3762			},
3763			"title": "BillingAddress",
3764			"xml": {
3765				"name": "BillingAddress",
3766				"attribute": false,
3767				"wrapped": false
3768			}
3769		},
3770		"BillingGroupContainer": {
3771			"type": "object",
3772			"properties": {
3773				"Identity": {
3774					"type": "integer",
3775					"format": "int64",
3776					"xml": {
3777						"name": "Identity",
3778						"attribute": false,
3779						"wrapped": false
3780					},
3781					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
3782					"allowEmptyValue": false
3783				},
3784				"Name": {
3785					"type": "string",
3786					"xml": {
3787						"name": "Name",
3788						"attribute": false,
3789						"wrapped": false
3790					},
3791					"description": "Supplied by Package.  Name of the billing group that this package is a member of",
3792					"allowEmptyValue": false
3793				}
3794			},
3795			"title": "BillingGroup",
3796			"xml": {
3797				"name": "BillingGroup",
3798				"attribute": false,
3799				"wrapped": false
3800			}
3801		},
3802		"ButtonContainer": {
3803			"type": "object",
3804			"properties": {
3805				"AccountId": {
3806					"type": "integer",
3807					"format": "int64",
3808					"xml": {
3809						"name": "AccountId",
3810						"attribute": false,
3811						"wrapped": false
3812					},
3813					"description": "Supplied by System.  Identity of the Account that is linked to this field.",
3814					"allowEmptyValue": false
3815				},
3816				"CoordinateType": {
3817					"type": "string",
3818					"xml": {
3819						"name": "CoordinateType",
3820						"attribute": false,
3821						"wrapped": false
3822					},
3823					"description": "If this is PDF or Screen coordinates.  Defaults to Screen coordinates",
3824					"allowEmptyValue": false,
3825					"enum": ["PDF", "SCREEN"]
3826				},
3827				"CustomFieldName": {
3828					"type": "string",
3829					"xml": {
3830						"name": "CustomFieldName",
3831						"attribute": false,
3832						"wrapped": false
3833					},
3834					"description": "Supplied by System Only.  Used to store a field name for template management when a predefined custom field is used.  This is only ephemeral data between the mapping application and package management.",
3835					"allowEmptyValue": false
3836				},
3837				"Enabled": {
3838					"type": "boolean",
3839					"example": false,
3840					"xml": {
3841						"name": "Enabled",
3842						"attribute": false,
3843						"wrapped": false
3844					},
3845					"description": "Supplied by system.  True if the field is currently enabled.  This is calculated based on linking logic.",
3846					"allowEmptyValue": false
3847				},
3848				"FieldName": {
3849					"type": "string",
3850					"xml": {
3851						"name": "FieldName",
3852						"attribute": false,
3853						"wrapped": false
3854					},
3855					"description": "Name of the field, if applicable",
3856					"allowEmptyValue": false
3857				},
3858				"Format": {
3859					"xml": {
3860						"name": "Format",
3861						"attribute": false,
3862						"wrapped": false
3863					},
3864					"description": "Formatting information for the field.  Allows field either to be masked (predefined format) or specify max length",
3865					"allowEmptyValue": false,
3866					"$ref": "#/definitions/Format"
3867				},
3868				"GroupTag": {
3869					"type": "string",
3870					"xml": {
3871						"name": "GroupTag",
3872						"attribute": false,
3873						"wrapped": false
3874					},
3875					"description": "Tag of the Group that this Button is a member of",
3876					"allowEmptyValue": false
3877				},
3878				"Height": {
3879					"type": "integer",
3880					"format": "int32",
3881					"xml": {
3882						"name": "Height",
3883						"attribute": false,
3884						"wrapped": false
3885					},
3886					"description": "Supplied by Package or Sigmapper.  Height of the field in Points.",
3887					"allowEmptyValue": false
3888				},
3889				"Identity": {
3890					"type": "integer",
3891					"format": "int64",
3892					"xml": {
3893						"name": "Identity",
3894						"attribute": false,
3895						"wrapped": false
3896					},
3897					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
3898					"allowEmptyValue": false
3899				},
3900				"Left": {
3901					"type": "integer",
3902					"format": "int32",
3903					"xml": {
3904						"name": "Left",
3905						"attribute": false,
3906						"wrapped": false
3907					},
3908					"description": "Supplied by Package or Sigmapper.  X-position of the top left of the field as measured from the left of the page.  Units are in Points. ",
3909					"allowEmptyValue": false
3910				},
3911				"Link": {
3912					"type": "array",
3913					"xml": {
3914						"name": "Links",
3915						"attribute": false,
3916						"wrapped": true
3917					},
3918					"description": "List of links to other fields.",
3919					"allowEmptyValue": false,
3920					"items": {
3921						"$ref": "#/definitions/Link"
3922					}
3923				},
3924				"RecipientTag": {
3925					"type": "string",
3926					"xml": {
3927						"name": "RecipientTag",
3928						"attribute": false,
3929						"wrapped": false
3930					},
3931					"description": "Supplied by Package or Sigmapper.  Tag of the Recipient that is signing this field.",
3932					"allowEmptyValue": false
3933				},
3934				"Required": {
3935					"type": "boolean",
3936					"example": false,
3937					"xml": {
3938						"name": "Required",
3939						"attribute": false,
3940						"wrapped": false
3941					},
3942					"description": "Supplied by Pacakge.  If 'true' indicates that the field must be signed/entered for package completion.",
3943					"allowEmptyValue": false
3944				},
3945				"Tag": {
3946					"type": "string",
3947					"xml": {
3948						"name": "Tag",
3949						"attribute": false,
3950						"wrapped": false
3951					},
3952					"description": "Supplied by Package or Sigmapper.  Reference identity tag for this entity used in the context of this DeliveryPackage",
3953					"allowEmptyValue": false
3954				},
3955				"Tooltip": {
3956					"type": "string",
3957					"xml": {
3958						"name": "Tooltip",
3959						"attribute": false,
3960						"wrapped": false
3961					},
3962					"description": "Tooltip to be displayed when recipient hovers over field.  Provides extra contextual information.",
3963					"allowEmptyValue": false
3964				},
3965				"Top": {
3966					"type": "integer",
3967					"format": "int32",
3968					"xml": {
3969						"name": "Top",
3970						"attribute": false,
3971						"wrapped": false
3972					},
3973					"description": "Supplied by Package or Sigmapper.  Y-position of the top left of the field as measured from the bottom of the page.  Units are in Points. ",
3974					"allowEmptyValue": false
3975				},
3976				"Type": {
3977					"type": "string",
3978					"xml": {
3979						"name": "Type",
3980						"attribute": false,
3981						"wrapped": false
3982					},
3983					"description": "Supplied by System.  Class of enterable field.",
3984					"allowEmptyValue": false,
3985					"enum": ["BUTTON", "TEXT", "TEXTAREA", "DATE", "SSN", "PHONE", "CURRENCY", "EMAIL", "NUMBER", "SELECT"]
3986				},
3987				"UpdateDate": {
3988					"type": "string",
3989					"format": "date-time",
3990					"xml": {
3991						"name": "UpdateDate",
3992						"attribute": false,
3993						"wrapped": false
3994					},
3995					"description": "Supplied by System.  Timestamp of the last time that this field data was entered.",
3996					"allowEmptyValue": false
3997				},
3998				"Value": {
3999					"type": "string",
4000					"xml": {
4001						"name": "Value",
4002						"attribute": false,
4003						"wrapped": false
4004					},
4005					"description": "Supplied by System Only.  Current value of this field as entered by the user.",
4006					"allowEmptyValue": false
4007				},
4008				"Width": {
4009					"type": "integer",
4010					"format": "int32",
4011					"xml": {
4012						"name": "Width",
4013						"attribute": false,
4014						"wrapped": false
4015					},
4016					"description": "Supplied by Package or Sigmapper.  Width of the field in Points.",
4017					"allowEmptyValue": false
4018				}
4019			},
4020			"title": "Button",
4021			"xml": {
4022				"name": "Button",
4023				"attribute": false,
4024				"wrapped": false
4025			}
4026		},
4027		"ButtonGroupContainer": {
4028			"type": "object",
4029			"properties": {
4030				"ButtonTag": {
4031					"type": "array",
4032					"xml": {
4033						"name": "ButtonTags",
4034						"attribute": false,
4035						"wrapped": true
4036					},
4037					"description": "List of Button Tags that are a member of this Button Group",
4038					"allowEmptyValue": false,
4039					"items": {
4040						"type": "string"
4041					}
4042				},
4043				"Identity": {
4044					"type": "integer",
4045					"format": "int64",
4046					"xml": {
4047						"name": "Identity",
4048						"attribute": false,
4049						"wrapped": false
4050					},
4051					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
4052					"allowEmptyValue": false
4053				},
4054				"Tag": {
4055					"type": "string",
4056					"xml": {
4057						"name": "Tag",
4058						"attribute": false,
4059						"wrapped": false
4060					},
4061					"description": "Supplied by Package.  Reference identity tag for this entity used in the context of this DeliveryPackage",
4062					"allowEmptyValue": false
4063				},
4064				"Type": {
4065					"type": "string",
4066					"xml": {
4067						"name": "Type",
4068						"attribute": false,
4069						"wrapped": false
4070					},
4071					"description": "Denotes the  type of button.",
4072					"allowEmptyValue": false,
4073					"enum": ["REQUIRED", "MUTEX", "BOTH"]
4074				}
4075			},
4076			"title": "Group",
4077			"xml": {
4078				"name": "Group",
4079				"attribute": false,
4080				"wrapped": false
4081			}
4082		},
4083		"ChangeOfCircumstanceContainer": {
4084			"type": "object",
4085			"properties": {
4086				"CoCDate": {
4087					"type": "string",
4088					"xml": {
4089						"name": "CoCDate",
4090						"attribute": false,
4091						"wrapped": false
4092					},
4093					"description": "Supplied by Package.  Date and time of the Change of Circumstance event.",
4094					"allowEmptyValue": false
4095				},
4096				"CoCDisposition": {
4097					"type": "string",
4098					"xml": {
4099						"name": "CoCDisposition",
4100						"attribute": false,
4101						"wrapped": false
4102					},
4103					"description": "Supplied by Package.  Type of CoC event; this helps determine the conditions of the redisclosure.",
4104					"allowEmptyValue": false
4105				},
4106				"CoCReason": {
4107					"type": "string",
4108					"xml": {
4109						"name": "CoCReason",
4110						"attribute": false,
4111						"wrapped": false
4112					},
4113					"description": "Supplied by Package.  Text description of the reason for the Change of Circumstance.",
4114					"allowEmptyValue": false
4115				},
4116				"InsertCoCLetter": {
4117					"type": "boolean",
4118					"example": false,
4119					"xml": {
4120						"name": "InsertCoCLetter",
4121						"attribute": false,
4122						"wrapped": false
4123					},
4124					"description": "Supplied by Package.  If 'false', indicates that the default CoC letter insertion should be suppressed for this posting.  Default value is 'true'.",
4125					"allowEmptyValue": false
4126				}
4127			},
4128			"title": "ChangeOfCircumstance",
4129			"xml": {
4130				"name": "ChangeOfCircumstance",
4131				"attribute": false,
4132				"wrapped": false
4133			}
4134		},
4135		"CollectionResponseEntity«UserContainer»": {
4136			"type": "object",
4137			"properties": {
4138				"content": {
4139					"type": "array",
4140					"items": {
4141						"$ref": "#/definitions/UserContainer"
4142					}
4143				},
4144				"notes": {
4145					"type": "string"
4146				},
4147				"status": {
4148					"type": "string",
4149					"enum": ["SUCCESS", "FAILURE"]
4150				}
4151			},
4152			"title": "CollectionResponseEntity«UserContainer»"
4153		},
4154		"CscBillingInfoContainer": {
4155			"type": "object",
4156			"properties": {
4157				"BillingAccountNumber": {
4158					"type": "string",
4159					"xml": {
4160						"name": "BillingAccountNumber",
4161						"attribute": false,
4162						"wrapped": false
4163					},
4164					"description": "Supplied by Package.  Carrier billing account to use for this shipment.  Only required if using a 3rd party billing account for this shipment.",
4165					"allowEmptyValue": false
4166				},
4167				"BillingAddress": {
4168					"xml": {
4169						"name": "BillingAddress",
4170						"attribute": false,
4171						"wrapped": false
4172					},
4173					"description": "Supplied by Package.  Billing address corresponding to the BillingAccountNumber.  Only required if using a 3rd party billing account for this shipment.",
4174					"allowEmptyValue": false,
4175					"$ref": "#/definitions/BillingAddressWaybillAddressContainer"
4176				},
4177				"CscLocationCode": {
4178					"type": "string",
4179					"xml": {
4180						"name": "CscLocationCode",
4181						"attribute": false,
4182						"wrapped": false
4183					},
4184					"description": "3-letter abbreviation for the print center location where this account info is valid.",
4185					"allowEmptyValue": false,
4186					"enum": ["CVG", "PDX"]
4187				}
4188			},
4189			"title": "CscBillingInfo",
4190			"xml": {
4191				"name": "CscBillingInfo",
4192				"attribute": false,
4193				"wrapped": false
4194			}
4195		},
4196		"DeliveryPackageContainer": {
4197			"type": "object",
4198			"properties": {
4199				"Href": {
4200					"type": "string",
4201					"description": "API endpoint to reference this object."
4202				},
4203				"Audit": {
4204					"xml": {
4205						"name": "Audit",
4206						"attribute": false,
4207						"wrapped": false
4208					},
4209					"description": "Information related to eAudit  if applicable.",
4210					"allowEmptyValue": false,
4211					"$ref": "#/definitions/AuditContainer"
4212				},
4213				"AuditFlag": {
4214					"type": "boolean",
4215					"example": false,
4216					"xml": {
4217						"name": "AuditFlag",
4218						"attribute": false,
4219						"wrapped": false
4220					},
4221					"description": "Supplied by Package.  When 'true', indicates that the completed package should be FW to the eAudit process",
4222					"allowEmptyValue": false
4223				},
4224				"BillingGroup": {
4225					"xml": {
4226						"name": "BillingGroup",
4227						"attribute": false,
4228						"wrapped": false
4229					},
4230					"description": "Information about the cusotmer billing group for this package",
4231					"allowEmptyValue": false,
4232					"$ref": "#/definitions/BillingGroupContainer"
4233				},
4234				"CurrentSigningPosition": {
4235					"type": "integer",
4236					"format": "int32",
4237					"xml": {
4238						"name": "CurrentSigningPosition",
4239						"attribute": false,
4240						"wrapped": false
4241					},
4242					"description": "Supplied by System.  Tracks current signing parties.",
4243					"allowEmptyValue": false
4244				},
4245				"Description": {
4246					"type": "string",
4247					"xml": {
4248						"name": "Description",
4249						"attribute": false,
4250						"wrapped": false
4251					},
4252					"description": "Supplied by Package.  Text description for the package",
4253					"allowEmptyValue": false
4254				},
4255				"EmailSubject": {
4256					"type": "string",
4257					"xml": {
4258						"name": "EmailSubject",
4259						"attribute": false,
4260						"wrapped": false
4261					},
4262					"description": "Supplied by Package.  Text for the recipient email notification subject line.",
4263					"allowEmptyValue": false
4264				},
4265				"Expiration": {
4266					"xml": {
4267						"name": "Expiration",
4268						"attribute": false,
4269						"wrapped": false
4270					},
4271					"description": "Parameters used to set the expiration date/time of the package",
4272					"allowEmptyValue": false,
4273					"$ref": "#/definitions/ExpirationContainer"
4274				},
4275				"ForeignIdentity": {
4276					"type": "array",
4277					"xml": {
4278						"name": "ForeignIdentities",
4279						"attribute": false,
4280						"wrapped": true
4281					},
4282					"description": "Identiy value(s) for this DeliveryPackage with respect to our trading partners",
4283					"allowEmptyValue": false,
4284					"items": {
4285						"$ref": "#/definitions/ForeignIdentityContainer"
4286					}
4287				},
4288				"Form": {
4289					"type": "array",
4290					"xml": {
4291						"name": "Forms",
4292						"attribute": false,
4293						"wrapped": true
4294					},
4295					"description": "Collection of documents in the package",
4296					"allowEmptyValue": false,
4297					"items": {
4298						"$ref": "#/definitions/FormContainer"
4299					}
4300				},
4301				"Identity": {
4302					"type": "integer",
4303					"format": "int64",
4304					"xml": {
4305						"name": "Identity",
4306						"attribute": false,
4307						"wrapped": false
4308					},
4309					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
4310					"allowEmptyValue": false
4311				},
4312				"MortgageData": {
4313					"xml": {
4314						"name": "MortgageData",
4315						"attribute": false,
4316						"wrapped": false
4317					},
4318					"description": "Data specific to mortgage transactions",
4319					"allowEmptyValue": false,
4320					"$ref": "#/definitions/MortgageDataContainer"
4321				},
4322				"NotifyWhenAllRecipientsHaveViewed": {
4323					"type": "boolean",
4324					"example": false,
4325					"xml": {
4326						"name": "NotifyWhenAllRecipientsHaveViewed",
4327						"attribute": false,
4328						"wrapped": false
4329					},
4330					"description": "When 'true', triggers the CI.FirstRecipientViewedPackage after all recipients have viewed the package.",
4331					"allowEmptyValue": false
4332				},
4333				"NotifyWhenFirstRecipientViews": {
4334					"type": "boolean",
4335					"example": false,
4336					"xml": {
4337						"name": "NotifyWhenFirstRecipientViews",
4338						"attribute": false,
4339						"wrapped": false
4340					},
4341					"description": "When 'true', triggers the CI.AllRecipientsViewedPackage when the first recipient views the package.",
4342					"allowEmptyValue": false
4343				},
4344				"PackageState": {
4345					"xml": {
4346						"name": "PackageState",
4347						"attribute": false,
4348						"wrapped": false
4349					},
4350					"description": "Supplied by System.  Data relating to the state of the package, for instance, is consent declined, has the package expired, etc.",
4351					"allowEmptyValue": false,
4352					"$ref": "#/definitions/PackageStateContainer"
4353				},
4354				"PersonalMessage": {
4355					"type": "string",
4356					"xml": {
4357						"name": "PersonalMessage",
4358						"attribute": false,
4359						"wrapped": false
4360					},
4361					"description": "Supplied by Package.  A simple text string message that is included in the recipient UI when this package is being signed.",
4362					"allowEmptyValue": false
4363				},
4364				"PostingControls": {
4365					"xml": {
4366						"name": "PostingControls",
4367						"attribute": false,
4368						"wrapped": false
4369					},
4370					"description": "Probably needs reorganizing with respect to both eCN and Inbox.  This will come out during detailed design.",
4371					"allowEmptyValue": false,
4372					"$ref": "#/definitions/PostingControlsContainer"
4373				},
4374				"Print": {
4375					"xml": {
4376						"name": "Print",
4377						"attribute": false,
4378						"wrapped": false
4379					},
4380					"description": "Data specific to print function",
4381					"allowEmptyValue": false,
4382					"$ref": "#/definitions/PrintContainer"
4383				},
4384				"ProcessingNote": {
4385					"type": "array",
4386					"xml": {
4387						"name": "ProcessingNotes",
4388						"attribute": false,
4389						"wrapped": true
4390					},
4391					"description": "Collection of messages concerning the processing of this Delivery Package, inserted by Package Processing.",
4392					"allowEmptyValue": false,
4393					"items": {
4394						"$ref": "#/definitions/ProcessingNoteContainer"
4395					}
4396				},
4397				"Property": {
4398					"type": "array",
4399					"xml": {
4400						"name": "Properties",
4401						"attribute": false,
4402						"wrapped": true
4403					},
4404					"description": "Package-level unstructured key-value pair data",
4405					"allowEmptyValue": false,
4406					"items": {
4407						"$ref": "#/definitions/PropertyContainer"
4408					}
4409				},
4410				"Recalled": {
4411					"type": "boolean",
4412					"example": false,
4413					"xml": {
4414						"name": "Recalled",
4415						"attribute": false,
4416						"wrapped": false
4417					},
4418					"description": "'true' indicates that this package has been recalled and is no longer available for viewing/signing by the recipients.",
4419					"allowEmptyValue": false
4420				},
4421				"Recipient": {
4422					"type": "array",
4423					"xml": {
4424						"name": "Recipients",
4425						"attribute": false,
4426						"wrapped": true
4427					},
4428					"description": "Collection of users that will receive the contents of this message",
4429					"allowEmptyValue": false,
4430					"items": {
4431						"$ref": "#/definitions/RecipientUserContainer"
4432					}
4433				},
4434				"RecipientReviewOnlyHoldTimer": {
4435					"xml": {
4436						"name": "RecipientReviewOnlyHoldTimer",
4437						"attribute": false,
4438						"wrapped": false
4439					},
4440					"description": "If this structure exists, designates that this eSignature or eClose package is view-only until the timer has expired.  After that the recipents will be allowed to sign.",
4441					"allowEmptyValue": false,
4442					"$ref": "#/definitions/RecipientReviewOnlyHoldTimerExpirationContainer"
4443				},
4444				"ReferenceDoc": {
4445					"type": "array",
4446					"xml": {
4447						"name": "ReferenceDocs",
4448						"attribute": false,
4449						"wrapped": true
4450					},
4451					"description": "Supplied by Package.  Defines Reference documents for inclusion in hte package.",
4452					"allowEmptyValue": false,
4453					"items": {
4454						"$ref": "#/definitions/ReferenceDocContainer"
4455					}
4456				},
4457				"Sender": {
4458					"xml": {
4459						"name": "Sender",
4460						"attribute": false,
4461						"wrapped": false
4462					},
4463					"description": "Data bout the user who requests that this message gets processed.",
4464					"allowEmptyValue": false,
4465					"$ref": "#/definitions/SenderUserContainer"
4466				},
4467				"SendingOrganizationApproval": {
4468					"type": "boolean",
4469					"example": false,
4470					"xml": {
4471						"name": "SendingOrganizationApproval",
4472						"attribute": false,
4473						"wrapped": false
4474					},
4475					"description": "When 'true', indicates that the designated user from the Sending Organization has approved the package to be released to the recipients.  The Approver is the user contained in the 'Recipients' list where Recipient/AccessRoles/AccessRole = 'Approver'",
4476					"allowEmptyValue": false
4477				},
4478				"SendingOrganizationIdentity": {
4479					"type": "integer",
4480					"format": "int64",
4481					"xml": {
4482						"name": "SendingOrganizationIdentity",
4483						"attribute": false,
4484						"wrapped": false
4485					},
4486					"description": "Supplied by System. Customer ID of the organization that sent this package.  ",
4487					"allowEmptyValue": false
4488				},
4489				"SendingOrganizationName": {
4490					"type": "string",
4491					"xml": {
4492						"name": "SendingOrganizationName",
4493						"attribute": false,
4494						"wrapped": false
4495					},
4496					"description": "Supplied by System. Customer Name of the organization that sent this package.  ",
4497					"allowEmptyValue": false
4498				},
4499				"SentDate": {
4500					"type": "string",
4501					"format": "date-time",
4502					"xml": {
4503						"name": "SentDate",
4504						"attribute": false,
4505						"wrapped": false
4506					},
4507					"description": "Supplied by System.  Timestamp when this delivery package was sent out.",
4508					"allowEmptyValue": false
4509				},
4510				"ShelfDoc": {
4511					"type": "array",
4512					"xml": {
4513						"name": "ShelfDocs",
4514						"attribute": false,
4515						"wrapped": true
4516					},
4517					"description": "(Make this the form strucxture + key + insertpostion, both shelf and jasper)  Supplied by Package.  Defines Shelf Documents for inclusion in the package.",
4518					"allowEmptyValue": false,
4519					"items": {
4520						"$ref": "#/definitions/ShelfDocContainer"
4521					}
4522				},
4523				"Size": {
4524					"type": "integer",
4525					"format": "int64",
4526					"xml": {
4527						"name": "Size",
4528						"attribute": false,
4529						"wrapped": false
4530					},
4531					"description": "Supplied by System.  Size of the package.",
4532					"allowEmptyValue": false
4533				},
4534				"UndeliverablePackageId": {
4535					"type": "string",
4536					"xml": {
4537						"name": "UndeliverablePackageId",
4538						"attribute": false,
4539						"wrapped": false
4540					},
4541					"description": "unknown",
4542					"allowEmptyValue": false
4543				},
4544				"UploadRequest": {
4545					"xml": {
4546						"name": "UploadRequest",
4547						"attribute": false,
4548						"wrapped": false
4549					},
4550					"description": "Upload Request definition for this delivery package",
4551					"allowEmptyValue": false,
4552					"$ref": "#/definitions/UploadRequestContainer"
4553				},
4554				"ViewUIProvider": {
4555					"type": "string",
4556					"xml": {
4557						"name": "ViewUIProvider",
4558						"attribute": false,
4559						"wrapped": false
4560					},
4561					"description": "Specifies who is providing the view/sign UI.  'Default' indicates a standard package handled by Expedite.",
4562					"allowEmptyValue": false,
4563					"enum": ["DEFAULT", "DOCUTECH"]
4564				},
4565				"WorkspaceIdentity": {
4566					"type": "integer",
4567					"format": "int64",
4568					"xml": {
4569						"name": "WorkspaceIdentity",
4570						"attribute": false,
4571						"wrapped": false
4572					},
4573					"description": "Supplied by System.  The internal identity of the Expedite Workspace that this package is a member of.",
4574					"allowEmptyValue": false
4575				}
4576			},
4577			"title": "DeliveryPackage",
4578			"xml": {
4579				"name": "DeliveryPackage",
4580				"attribute": false,
4581				"wrapped": false
4582			}
4583		},
4584		"DocumentRecognitionContainer": {
4585			"type": "object",
4586			"properties": {
4587				"DocumentFrequencyOverride": {
4588					"type": "string",
4589					"xml": {
4590						"name": "DocumentFrequencyOverride",
4591						"attribute": false,
4592						"wrapped": false
4593					},
4594					"description": "Supplied by Package.  When included, Doc Rec will force all forms identified in this Document to be the Document Frequency contained in this element.",
4595					"allowEmptyValue": false,
4596					"enum": ["NORMAL", "PER_RECIPIENT"]
4597				},
4598				"Matched": {
4599					"type": "boolean",
4600					"example": false,
4601					"xml": {
4602						"name": "Matched",
4603						"attribute": false,
4604						"wrapped": false
4605					},
4606					"description": "Supplied by System.  'True' indicates that this document was processed by Document Recognition and successfully matched.",
4607					"allowEmptyValue": false
4608				},
4609				"PassUnrecognizedPages": {
4610					"type": "boolean",
4611					"example": false,
4612					"xml": {
4613						"name": "PassUnrecognizedPages",
4614						"attribute": false,
4615						"wrapped": false
4616					},
4617					"description": "When 'true', unrecognized pages are expected.  Handling/assembly of unrecgnized pages is TBD but the package will post through to the recipient(s) lights-out if the package 'Hold' flag is not set.  When 'false', unrecognized pages will cause the package to be held in the Package Manager for manual dispostion.  Handling of the unrecognized pages is TBD. ",
4618					"allowEmptyValue": false
4619				},
4620				"RunDate": {
4621					"type": "string",
4622					"format": "date-time",
4623					"xml": {
4624						"name": "RunDate",
4625						"attribute": false,
4626						"wrapped": false
4627					},
4628					"description": "Supplied by System.  The date and time that this document was run by Document Recognition",
4629					"allowEmptyValue": false
4630				},
4631				"UseRecognition": {
4632					"type": "boolean",
4633					"example": false,
4634					"xml": {
4635						"name": "UseRecognition",
4636						"attribute": false,
4637						"wrapped": false
4638					},
4639					"description": "When 'true', the document is run through doc recognition to split the concatenated PDF into multiple docs.  ",
4640					"allowEmptyValue": false
4641				}
4642			},
4643			"title": "DocumentRecognition",
4644			"xml": {
4645				"name": "DocumentRecognition",
4646				"attribute": false,
4647				"wrapped": false
4648			}
4649		},
4650		"EnterableFieldContainer": {
4651			"type": "object",
4652			"properties": {
4653				"AccountId": {
4654					"type": "integer",
4655					"format": "int64",
4656					"xml": {
4657						"name": "AccountId",
4658						"attribute": false,
4659						"wrapped": false
4660					},
4661					"description": "Supplied by System.  Identity of the Account that is linked to this field.",
4662					"allowEmptyValue": false
4663				},
4664				"CoordinateType": {
4665					"type": "string",
4666					"xml": {
4667						"name": "CoordinateType",
4668						"attribute": false,
4669						"wrapped": false
4670					},
4671					"description": "If this is PDF or Screen coordinates.  Defaults to Screen coordinates",
4672					"allowEmptyValue": false,
4673					"enum": ["PDF", "SCREEN"]
4674				},
4675				"CustomFieldName": {
4676					"type": "string",
4677					"xml": {
4678						"name": "CustomFieldName",
4679						"attribute": false,
4680						"wrapped": false
4681					},
4682					"description": "Supplied by System Only.  Used to store a field name for template management when a predefined custom field is used.  This is only ephemeral data between the mapping application and package management.",
4683					"allowEmptyValue": false
4684				},
4685				"Enabled": {
4686					"type": "boolean",
4687					"example": false,
4688					"xml": {
4689						"name": "Enabled",
4690						"attribute": false,
4691						"wrapped": false
4692					},
4693					"description": "Supplied by system.  True if the field is currently enabled.  This is calculated based on linking logic.",
4694					"allowEmptyValue": false
4695				},
4696				"FieldName": {
4697					"type": "string",
4698					"xml": {
4699						"name": "FieldName",
4700						"attribute": false,
4701						"wrapped": false
4702					},
4703					"description": "Name of the field, if applicable",
4704					"allowEmptyValue": false
4705				},
4706				"Format": {
4707					"xml": {
4708						"name": "Format",
4709						"attribute": false,
4710						"wrapped": false
4711					},
4712					"description": "Formatting information for the field.  Allows field either to be masked (predefined format) or specify max length",
4713					"allowEmptyValue": false,
4714					"$ref": "#/definitions/Format"
4715				},
4716				"Height": {
4717					"type": "integer",
4718					"format": "int32",
4719					"xml": {
4720						"name": "Height",
4721						"attribute": false,
4722						"wrapped": false
4723					},
4724					"description": "Supplied by Package or Sigmapper.  Height of the field in Points.",
4725					"allowEmptyValue": false
4726				},
4727				"Identity": {
4728					"type": "integer",
4729					"format": "int64",
4730					"xml": {
4731						"name": "Identity",
4732						"attribute": false,
4733						"wrapped": false
4734					},
4735					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
4736					"allowEmptyValue": false
4737				},
4738				"Left": {
4739					"type": "integer",
4740					"format": "int32",
4741					"xml": {
4742						"name": "Left",
4743						"attribute": false,
4744						"wrapped": false
4745					},
4746					"description": "Supplied by Package or Sigmapper.  X-position of the top left of the field as measured from the left of the page.  Units are in Points. ",
4747					"allowEmptyValue": false
4748				},
4749				"Link": {
4750					"type": "array",
4751					"xml": {
4752						"name": "Links",
4753						"attribute": false,
4754						"wrapped": true
4755					},
4756					"description": "List of links to other fields.",
4757					"allowEmptyValue": false,
4758					"items": {
4759						"$ref": "#/definitions/Link"
4760					}
4761				},
4762				"RecipientTag": {
4763					"type": "string",
4764					"xml": {
4765						"name": "RecipientTag",
4766						"attribute": false,
4767						"wrapped": false
4768					},
4769					"description": "Supplied by Package or Sigmapper.  Tag of the Recipient that is signing this field.",
4770					"allowEmptyValue": false
4771				},
4772				"Required": {
4773					"type": "boolean",
4774					"example": false,
4775					"xml": {
4776						"name": "Required",
4777						"attribute": false,
4778						"wrapped": false
4779					},
4780					"description": "Supplied by Pacakge.  If 'true' indicates that the field must be signed/entered for package completion.",
4781					"allowEmptyValue": false
4782				},
4783				"Tag": {
4784					"type": "string",
4785					"xml": {
4786						"name": "Tag",
4787						"attribute": false,
4788						"wrapped": false
4789					},
4790					"description": "Supplied by Package or Sigmapper.  Reference identity tag for this entity used in the context of this DeliveryPackage",
4791					"allowEmptyValue": false
4792				},
4793				"Tooltip": {
4794					"type": "string",
4795					"xml": {
4796						"name": "Tooltip",
4797						"attribute": false,
4798						"wrapped": false
4799					},
4800					"description": "Tooltip to be displayed when recipient hovers over field.  Provides extra contextual information.",
4801					"allowEmptyValue": false
4802				},
4803				"Top": {
4804					"type": "integer",
4805					"format": "int32",
4806					"xml": {
4807						"name": "Top",
4808						"attribute": false,
4809						"wrapped": false
4810					},
4811					"description": "Supplied by Package or Sigmapper.  Y-position of the top left of the field as measured from the bottom of the page.  Units are in Points. ",
4812					"allowEmptyValue": false
4813				},
4814				"Type": {
4815					"type": "string",
4816					"xml": {
4817						"name": "Type",
4818						"attribute": false,
4819						"wrapped": false
4820					},
4821					"description": "Supplied by System.  Class of enterable field.",
4822					"allowEmptyValue": false,
4823					"enum": ["BUTTON", "TEXT", "TEXTAREA", "DATE", "SSN", "PHONE", "CURRENCY", "EMAIL", "NUMBER", "SELECT"]
4824				},
4825				"UpdateDate": {
4826					"type": "string",
4827					"format": "date-time",
4828					"xml": {
4829						"name": "UpdateDate",
4830						"attribute": false,
4831						"wrapped": false
4832					},
4833					"description": "Supplied by System.  Timestamp of the last time that this field data was entered.",
4834					"allowEmptyValue": false
4835				},
4836				"Value": {
4837					"type": "string",
4838					"xml": {
4839						"name": "Value",
4840						"attribute": false,
4841						"wrapped": false
4842					},
4843					"description": "Supplied by System Only.  Current value of this field as entered by the user.",
4844					"allowEmptyValue": false
4845				},
4846				"Width": {
4847					"type": "integer",
4848					"format": "int32",
4849					"xml": {
4850						"name": "Width",
4851						"attribute": false,
4852						"wrapped": false
4853					},
4854					"description": "Supplied by Package or Sigmapper.  Width of the field in Points.",
4855					"allowEmptyValue": false
4856				}
4857			},
4858			"title": "Field",
4859			"xml": {
4860				"name": "Field",
4861				"attribute": false,
4862				"wrapped": false
4863			}
4864		},
4865		"Enum": {
4866			"type": "object",
4867			"properties": {
4868				"EnumName": {
4869					"type": "string",
4870					"xml": {
4871						"name": "EnumName",
4872						"attribute": false,
4873						"wrapped": false
4874					}
4875				},
4876				"IsDefault": {
4877					"type": "boolean",
4878					"xml": {
4879						"name": "IsDefault",
4880						"attribute": false,
4881						"wrapped": false
4882					}
4883				}
4884			},
4885			"title": "Enum",
4886			"xml": {
4887				"name": "Enum",
4888				"attribute": false,
4889				"wrapped": false
4890			}
4891		},
4892		"EpaperStateContainer": {
4893			"type": "object",
4894			"properties": {
4895				"CreationDate": {
4896					"type": "string",
4897					"format": "date-time",
4898					"xml": {
4899						"name": "CreationDate",
4900						"attribute": false,
4901						"wrapped": false
4902					},
4903					"description": "Timestamp of when this package was queued for the ePaper delivery process",
4904					"allowEmptyValue": false
4905				},
4906				"DeliveryState": {
4907					"type": "string",
4908					"xml": {
4909						"name": "DeliveryState",
4910						"attribute": false,
4911						"wrapped": false
4912					},
4913					"description": "State of this package in the ePaper delivery process",
4914					"allowEmptyValue": false,
4915					"enum": ["POSTED", "PRINTED", "READY_FOR_PICKUP", "RETURNED_UNDELIVERABLE", "FAILED_BY_CSA"]
4916				},
4917				"EpaperQueueId": {
4918					"type": "integer",
4919					"format": "int32",
4920					"xml": {
4921						"name": "EpaperQueueId",
4922						"attribute": false,
4923						"wrapped": false
4924					},
4925					"description": "Index of the EpaperQueue record that corresponds to this data",
4926					"allowEmptyValue": false
4927				},
4928				"NumberOfPages": {
4929					"type": "integer",
4930					"format": "int32",
4931					"xml": {
4932						"name": "NumberOfPages",
4933						"attribute": false,
4934						"wrapped": false
4935					},
4936					"description": "Number of pages contained in this particular ePaper delivery",
4937					"allowEmptyValue": false
4938				}
4939			},
4940			"title": "EpaperState",
4941			"xml": {
4942				"name": "EpaperState",
4943				"attribute": false,
4944				"wrapped": false
4945			}
4946		},
4947		"EsignXrefContainer": {
4948			"type": "object",
4949			"properties": {
4950				"Applicant": {
4951					"type": "integer",
4952					"format": "int32",
4953					"xml": {
4954						"name": "Applicant",
4955						"attribute": false,
4956						"wrapped": false
4957					},
4958					"description": "Supplied by Package.  Designates which Applicant order this recipient when using Applicant/Borrower logic to assign this user to premapped signature blocks in the documents.",
4959					"allowEmptyValue": false
4960				},
4961				"Borrower": {
4962					"type": "integer",
4963					"format": "int32",
4964					"xml": {
4965						"name": "Borrower",
4966						"attribute": false,
4967						"wrapped": false
4968					},
4969					"description": "Supplied by Package.  Designates the Borrower order for this recipient when using Applicant/Borrower logic to assign this user to premapped signature blocks in the documents.",
4970					"allowEmptyValue": false
4971				}
4972			},
4973			"title": "EsignXref",
4974			"xml": {
4975				"name": "EsignXref",
4976				"attribute": false,
4977				"wrapped": false
4978			}
4979		},
4980		"ExpirationContainer": {
4981			"type": "object",
4982			"properties": {
4983				"Date": {
4984					"type": "string",
4985					"format": "date-time",
4986					"xml": {
4987						"name": "Date",
4988						"attribute": false,
4989						"wrapped": false
4990					},
4991					"description": "Supplied by Package.  The absolute date/time that package expiration is to occur.  This overrides any values contained in 'IntervalCalculation'",
4992					"allowEmptyValue": false
4993				},
4994				"IntervalCalculation": {
4995					"xml": {
4996						"name": "IntervalCalculation",
4997						"attribute": false,
4998						"wrapped": false
4999					},
5000					"description": "Parameters concerning expiration timing for the package",
5001					"allowEmptyValue": false,
5002					"$ref": "#/definitions/IntervalContainer"
5003				}
5004			},
5005			"title": "Expiration",
5006			"xml": {
5007				"name": "Expiration",
5008				"attribute": false,
5009				"wrapped": false
5010			}
5011		},
5012		"FailedPackage": {
5013			"type": "object",
5014			"properties": {
5015				"Href": {
5016					"type": "string",
5017					"description": "API endpoint to reference this object."
5018				},
5019				"comments": {
5020					"type": "string",
5021					"description": "User entered comments.",
5022					"allowEmptyValue": false
5023				},
5024				"fileName": {
5025					"type": "string",
5026					"description": "Filename of the failed package.",
5027					"allowEmptyValue": false
5028				},
5029				"postedDate": {
5030					"type": "string",
5031					"format": "date-time",
5032					"description": "Date the package was posted.",
5033					"allowEmptyValue": false
5034				},
5035				"processedBy": {
5036					"type": "string",
5037					"description": "User that handled the failed package.",
5038					"allowEmptyValue": false
5039				},
5040				"statusNotes": {
5041					"type": "string",
5042					"description": "Additional information about the why the package is in its current state.",
5043					"allowEmptyValue": false
5044				}
5045			},
5046			"title": "FailedPackage"
5047		},
5048		"FailedPackageError": {
5049			"type": "object",
5050			"properties": {
5051				"comments": {
5052					"type": "string",
5053					"description": "User entered comments about the failure.",
5054					"allowEmptyValue": false
5055				},
5056				"errorInfo": {
5057					"type": "string",
5058					"description": "Information on the error that caused the package to fail.",
5059					"allowEmptyValue": false
5060				},
5061				"handled": {
5062					"type": "boolean",
5063					"example": false,
5064					"description": "If the package has been handled.",
5065					"allowEmptyValue": false
5066				},
5067				"processedBy": {
5068					"type": "string",
5069					"description": "User that handled the package.",
5070					"allowEmptyValue": false
5071				}
5072			},
5073			"title": "FailedPackageError"
5074		},
5075		"FailedPackageSummary": {
5076			"type": "object",
5077			"properties": {
5078				"Href": {
5079					"type": "string",
5080					"description": "API endpoint to reference this object."
5081				},
5082				"averageTime": {
5083					"type": "number",
5084					"format": "double",
5085					"description": "Average time it took to process the package.",
5086					"allowEmptyValue": false
5087				},
5088				"failed": {
5089					"type": "integer",
5090					"format": "int32",
5091					"description": "Number of packages that failed.",
5092					"allowEmptyValue": false
5093				},
5094				"failedNotHandled": {
5095					"type": "integer",
5096					"format": "int32",
5097					"description": "Number of packages that failed that a user has not marked as handled.",
5098					"allowEmptyValue": false
5099				},
5100				"packages": {
5101					"type": "integer",
5102					"format": "int32",
5103					"description": "Total number of packages posted.",
5104					"allowEmptyValue": false
5105				},
5106				"processing": {
5107					"type": "integer",
5108					"format": "int32",
5109					"description": "Number of packages that are currently being processed.",
5110					"allowEmptyValue": false
5111				},
5112				"timeframe": {
5113					"type": "string",
5114					"description": "Timeframe this object represents.",
5115					"allowEmptyValue": false,
5116					"enum": ["LAST_1_HOUR", "TODAY", "YESTERDAY", "LAST_24_HOUR", "LAST_7_DAYS"]
5117				}
5118			},
5119			"title": "FailedPackageSummary"
5120		},
5121		"FallToPrintTimerExpirationContainer": {
5122			"type": "object",
5123			"properties": {
5124				"Date": {
5125					"type": "string",
5126					"format": "date-time",
5127					"xml": {
5128						"name": "Date",
5129						"attribute": false,
5130						"wrapped": false
5131					},
5132					"description": "Supplied by Package.  The absolute date/time that package expiration is to occur.  This overrides any values contained in 'IntervalCalculation'",
5133					"allowEmptyValue": false
5134				},
5135				"IntervalCalculation": {
5136					"xml": {
5137						"name": "IntervalCalculation",
5138						"attribute": false,
5139						"wrapped": false
5140					},
5141					"description": "Parameters concerning expiration timing for the package",
5142					"allowEmptyValue": false,
5143					"$ref": "#/definitions/IntervalContainer"
5144				}
5145			},
5146			"title": "FallToPrintTimer",
5147			"xml": {
5148				"name": "FallToPrintTimer",
5149				"attribute": false,
5150				"wrapped": false
5151			}
5152		},
5153		"ForeignIdentityContainer": {
5154			"type": "object",
5155			"properties": {
5156				"CreationMessageIdentifier": {
5157					"type": "string",
5158					"xml": {
5159						"name": "CreationMessageIdentifier",
5160						"attribute": false,
5161						"wrapped": false
5162					},
5163					"description": "Supplied by System.  The Identifier of the message that created the parent object.",
5164					"allowEmptyValue": false
5165				},
5166				"DisplayLabel": {
5167					"type": "string",
5168					"xml": {
5169						"name": "DisplayLabel",
5170						"attribute": false,
5171						"wrapped": false
5172					},
5173					"description": "Label for the type of value that the identity is, for instance, 'Loan Number' or 'File Number\\\"",
5174					"allowEmptyValue": false
5175				},
5176				"ForeignIdentityValue": {
5177					"type": "string",
5178					"xml": {
5179						"name": "ForeignIdentityValue",
5180						"attribute": false,
5181						"wrapped": false
5182					},
5183					"description": "Index vialue for this entity as provided by our partner/customer",
5184					"allowEmptyValue": false
5185				},
5186				"LatestMessageIdentifier": {
5187					"type": "string",
5188					"xml": {
5189						"name": "LatestMessageIdentifier",
5190						"attribute": false,
5191						"wrapped": false
5192					},
5193					"description": "Supplied by System.  The Identifier of the message that last modified the parent object.",
5194					"allowEmptyValue": false
5195				},
5196				"Owner": {
5197					"xml": {
5198						"name": "Owner",
5199						"attribute": false,
5200						"wrapped": false
5201					},
5202					"description": "Contans the reference to the customer, parnter, or user that owns this identifier",
5203					"allowEmptyValue": false,
5204					"$ref": "#/definitions/OwnerContainer"
5205				}
5206			},
5207			"title": "ForeignIdentity",
5208			"xml": {
5209				"name": "ForeignIdentity",
5210				"attribute": false,
5211				"wrapped": false
5212			}
5213		},
5214		"FormContainer": {
5215			"type": "object",
5216			"properties": {
5217				"Href": {
5218					"type": "string",
5219					"description": "API endpoint to reference this object."
5220				},
5221				"DirtyTemplate": {
5222					"type": "boolean",
5223					"example": false,
5224					"xml": {
5225						"name": "DirtyTemplate",
5226						"attribute": false,
5227						"wrapped": false
5228					},
5229					"description": "When 'true', indicates that that the signature template has been changed but not saved.",
5230					"allowEmptyValue": false
5231				},
5232				"DontPrint": {
5233					"type": "boolean",
5234					"example": false,
5235					"xml": {
5236						"name": "DontPrint",
5237						"attribute": false,
5238						"wrapped": false
5239					},
5240					"description": "Defaults to 'false'. If set to true, the shelf doc will not be printed if package falls to print.",
5241					"allowEmptyValue": false
5242				},
5243				"EncodedImage": {
5244					"type": "string",
5245					"xml": {
5246						"name": "EncodedImage",
5247						"attribute": false,
5248						"wrapped": false
5249					},
5250					"description": "The base-64 encoded image of the complete form in PDF format",
5251					"allowEmptyValue": false
5252				},
5253				"Filename": {
5254					"type": "string",
5255					"xml": {
5256						"name": "Filename",
5257						"attribute": false,
5258						"wrapped": false
5259					},
5260					"description": "The filename of the document used to save it to disk.  Must confirm to Windows and Linux filename rules.",
5261					"allowEmptyValue": false
5262				},
5263				"ForeignIdentity": {
5264					"type": "array",
5265					"xml": {
5266						"name": "ForeignIdentities",
5267						"attribute": false,
5268						"wrapped": true
5269					},
5270					"description": "Supplied by Package.  Information on how this form is identified in other systems.",
5271					"allowEmptyValue": false,
5272					"items": {
5273						"$ref": "#/definitions/ForeignIdentityContainer"
5274					}
5275				},
5276				"FormPostingControl": {
5277					"xml": {
5278						"name": "FormPostingControl",
5279						"attribute": false,
5280						"wrapped": false
5281					},
5282					"description": "Provided by Package.  Information on how this form should be processed during posting.",
5283					"allowEmptyValue": false,
5284					"$ref": "#/definitions/FormPostingControlContainer"
5285				},
5286				"FormRecipient": {
5287					"type": "array",
5288					"xml": {
5289						"name": "FormRecipients",
5290						"attribute": false,
5291						"wrapped": true
5292					},
5293					"description": "List of viewers and signers for this document",
5294					"allowEmptyValue": false,
5295					"items": {
5296						"$ref": "#/definitions/FormRecipientContainer"
5297					}
5298				},
5299				"Identity": {
5300					"type": "integer",
5301					"format": "int64",
5302					"xml": {
5303						"name": "Identity",
5304						"attribute": false,
5305						"wrapped": false
5306					},
5307					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
5308					"allowEmptyValue": false
5309				},
5310				"IsShelfDoc": {
5311					"type": "boolean",
5312					"example": false,
5313					"xml": {
5314						"name": "IsShelfDoc",
5315						"attribute": false,
5316						"wrapped": false
5317					},
5318					"description": "If this document is a shelf doc, set to true",
5319					"allowEmptyValue": false
5320				},
5321				"MismoSmartDoc": {
5322					"xml": {
5323						"name": "MismoSmartDoc",
5324						"attribute": false,
5325						"wrapped": false
5326					},
5327					"description": "Placehodler for future MISMO SMARTDoc structure for this form",
5328					"allowEmptyValue": false,
5329					"$ref": "#/definitions/MismoSmartDoc"
5330				},
5331				"Name": {
5332					"type": "string",
5333					"xml": {
5334						"name": "Name",
5335						"attribute": false,
5336						"wrapped": false
5337					},
5338					"description": "Name of the document used for display in the UI",
5339					"allowEmptyValue": false
5340				},
5341				"NotaryRequired": {
5342					"type": "boolean",
5343					"example": false,
5344					"xml": {
5345						"name": "NotaryRequired",
5346						"attribute": false,
5347						"wrapped": false
5348					},
5349					"description": "When 'true', indicates that this document requires notarization.",
5350					"allowEmptyValue": false
5351				},
5352				"Page": {
5353					"type": "array",
5354					"xml": {
5355						"name": "Pages",
5356						"attribute": false,
5357						"wrapped": true
5358					},
5359					"description": "Data about the individual pages in the document",
5360					"allowEmptyValue": false,
5361					"items": {
5362						"$ref": "#/definitions/PageContainer"
5363					}
5364				},
5365				"PersonalMessage": {
5366					"type": "string",
5367					"xml": {
5368						"name": "PersonalMessage",
5369						"attribute": false,
5370						"wrapped": false
5371					},
5372					"description": "Supplied by Package.  A simple text string message that is included in the recipient UI when this package is being signed.",
5373					"allowEmptyValue": false
5374				},
5375				"PrintAndSign": {
5376					"type": "boolean",
5377					"example": false,
5378					"xml": {
5379						"name": "PrintAndSign",
5380						"attribute": false,
5381						"wrapped": false
5382					},
5383					"description": "When 'true', indicates that this is a document  that must be printed and wet signed.",
5384					"allowEmptyValue": false
5385				},
5386				"Property": {
5387					"type": "array",
5388					"xml": {
5389						"name": "Properties",
5390						"attribute": false,
5391						"wrapped": true
5392					},
5393					"description": "Key/Value data pairs to hold custom data required by the customer/partner",
5394					"allowEmptyValue": false,
5395					"items": {
5396						"$ref": "#/definitions/PropertyContainer"
5397					}
5398				},
5399				"ReviewRequired": {
5400					"type": "boolean",
5401					"example": false,
5402					"xml": {
5403						"name": "ReviewRequired",
5404						"attribute": false,
5405						"wrapped": false
5406					},
5407					"description": "If 'true', indicates that this document must be viewed or signed.",
5408					"allowEmptyValue": false
5409				},
5410				"ShelfDocKey": {
5411					"type": "string",
5412					"xml": {
5413						"name": "ShelfDocKey",
5414						"attribute": false,
5415						"wrapped": false
5416					},
5417					"description": "Key used to generate the shelf doc.  System generated",
5418					"allowEmptyValue": false
5419				},
5420				"Signable": {
5421					"type": "boolean",
5422					"example": false,
5423					"xml": {
5424						"name": "Signable",
5425						"attribute": false,
5426						"wrapped": false
5427					},
5428					"description": "If 'true', indicates that this document can be signed.",
5429					"allowEmptyValue": false
5430				},
5431				"Size": {
5432					"type": "integer",
5433					"format": "int64",
5434					"xml": {
5435						"name": "Size",
5436						"attribute": false,
5437						"wrapped": false
5438					},
5439					"description": "Size of the document disk file",
5440					"allowEmptyValue": false
5441				},
5442				"SortOrder": {
5443					"type": "integer",
5444					"format": "int32",
5445					"xml": {
5446						"name": "SortOrder",
5447						"attribute": false,
5448						"wrapped": false
5449					},
5450					"description": "The order that the documents must be presented to the recipient",
5451					"allowEmptyValue": false
5452				},
5453				"Tag": {
5454					"type": "string",
5455					"xml": {
5456						"name": "Tag",
5457						"attribute": false,
5458						"wrapped": false
5459					},
5460					"description": "Supplied by Package.  Reference identity tag for this entity used in the context of this DeliveryPackage",
5461					"allowEmptyValue": false
5462				},
5463				"TemplateName": {
5464					"type": "string",
5465					"xml": {
5466						"name": "TemplateName",
5467						"attribute": false,
5468						"wrapped": false
5469					},
5470					"description": "Name of the signature template for this document",
5471					"allowEmptyValue": false
5472				},
5473				"UploadDate": {
5474					"type": "string",
5475					"format": "date-time",
5476					"xml": {
5477						"name": "UploadDate",
5478						"attribute": false,
5479						"wrapped": false
5480					},
5481					"description": "Timestamp when the doucment was uploaded",
5482					"allowEmptyValue": false
5483				},
5484				"WSFileId": {
5485					"type": "string",
5486					"xml": {
5487						"name": "WSFileId",
5488						"attribute": false,
5489						"wrapped": false
5490					},
5491					"description": "Identifier of the document file within the workspace",
5492					"allowEmptyValue": false
5493				}
5494			},
5495			"title": "Form",
5496			"xml": {
5497				"name": "Form",
5498				"attribute": false,
5499				"wrapped": false
5500			}
5501		},
5502		"FormFieldContainer": {
5503			"type": "object",
5504			"properties": {
5505				"Href": {
5506					"type": "string",
5507					"description": "API endpoint to reference this object."
5508				},
5509				"AccountId": {
5510					"type": "integer",
5511					"format": "int64",
5512					"xml": {
5513						"name": "AccountId",
5514						"attribute": false,
5515						"wrapped": false
5516					},
5517					"description": "Supplied by System.  Identity of the Account that is linked to this field.",
5518					"allowEmptyValue": false
5519				},
5520				"CoordinateType": {
5521					"type": "string",
5522					"xml": {
5523						"name": "CoordinateType",
5524						"attribute": false,
5525						"wrapped": false
5526					},
5527					"description": "If this is PDF or Screen coordinates.  Defaults to Screen coordinates",
5528					"allowEmptyValue": false,
5529					"enum": ["PDF", "SCREEN"]
5530				},
5531				"CustomFieldName": {
5532					"type": "string",
5533					"xml": {
5534						"name": "CustomFieldName",
5535						"attribute": false,
5536						"wrapped": false
5537					},
5538					"description": "Supplied by System Only.  Used to store a field name for template management when a predefined custom field is used.  This is only ephemeral data between the mapping application and package management.",
5539					"allowEmptyValue": false
5540				},
5541				"Enabled": {
5542					"type": "boolean",
5543					"example": false,
5544					"xml": {
5545						"name": "Enabled",
5546						"attribute": false,
5547						"wrapped": false
5548					},
5549					"description": "Supplied by system.  True if the field is currently enabled.  This is calculated based on linking logic.",
5550					"allowEmptyValue": false
5551				},
5552				"FieldName": {
5553					"type": "string",
5554					"xml": {
5555						"name": "FieldName",
5556						"attribute": false,
5557						"wrapped": false
5558					},
5559					"description": "Name of the field, if applicable",
5560					"allowEmptyValue": false
5561				},
5562				"Format": {
5563					"xml": {
5564						"name": "Format",
5565						"attribute": false,
5566						"wrapped": false
5567					},
5568					"description": "Formatting information for the field.  Allows field either to be masked (predefined format) or specify max length",
5569					"allowEmptyValue": false,
5570					"$ref": "#/definitions/Format"
5571				},
5572				"Height": {
5573					"type": "integer",
5574					"format": "int32",
5575					"xml": {
5576						"name": "Height",
5577						"attribute": false,
5578						"wrapped": false
5579					},
5580					"description": "Supplied by Package or Sigmapper.  Height of the field in Points.",
5581					"allowEmptyValue": false
5582				},
5583				"Identity": {
5584					"type": "integer",
5585					"format": "int64",
5586					"xml": {
5587						"name": "Identity",
5588						"attribute": false,
5589						"wrapped": false
5590					},
5591					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
5592					"allowEmptyValue": false
5593				},
5594				"Left": {
5595					"type": "integer",
5596					"format": "int32",
5597					"xml": {
5598						"name": "Left",
5599						"attribute": false,
5600						"wrapped": false
5601					},
5602					"description": "Supplied by Package or Sigmapper.  X-position of the top left of the field as measured from the left of the page.  Units are in Points. ",
5603					"allowEmptyValue": false
5604				},
5605				"Link": {
5606					"type": "array",
5607					"xml": {
5608						"name": "Links",
5609						"attribute": false,
5610						"wrapped": true
5611					},
5612					"description": "List of links to other fields.",
5613					"allowEmptyValue": false,
5614					"items": {
5615						"$ref": "#/definitions/Link"
5616					}
5617				},
5618				"RecipientTag": {
5619					"type": "string",
5620					"xml": {
5621						"name": "RecipientTag",
5622						"attribute": false,
5623						"wrapped": false
5624					},
5625					"description": "Supplied by Package or Sigmapper.  Tag of the Recipient that is signing this field.",
5626					"allowEmptyValue": false
5627				},
5628				"Required": {
5629					"type": "boolean",
5630					"example": false,
5631					"xml": {
5632						"name": "Required",
5633						"attribute": false,
5634						"wrapped": false
5635					},
5636					"description": "Supplied by Pacakge.  If 'true' indicates that the field must be signed/entered for package completion.",
5637					"allowEmptyValue": false
5638				},
5639				"Tag": {
5640					"type": "string",
5641					"xml": {
5642						"name": "Tag",
5643						"attribute": false,
5644						"wrapped": false
5645					},
5646					"description": "Supplied by Package or Sigmapper.  Reference identity tag for this entity used in the context of this DeliveryPackage",
5647					"allowEmptyValue": false
5648				},
5649				"Tooltip": {
5650					"type": "string",
5651					"xml": {
5652						"name": "Tooltip",
5653						"attribute": false,
5654						"wrapped": false
5655					},
5656					"description": "Tooltip to be displayed when recipient hovers over field.  Provides extra contextual information.",
5657					"allowEmptyValue": false
5658				},
5659				"Top": {
5660					"type": "integer",
5661					"format": "int32",
5662					"xml": {
5663						"name": "Top",
5664						"attribute": false,
5665						"wrapped": false
5666					},
5667					"description": "Supplied by Package or Sigmapper.  Y-position of the top left of the field as measured from the bottom of the page.  Units are in Points. ",
5668					"allowEmptyValue": false
5669				},
5670				"UpdateDate": {
5671					"type": "string",
5672					"format": "date-time",
5673					"xml": {
5674						"name": "UpdateDate",
5675						"attribute": false,
5676						"wrapped": false
5677					},
5678					"description": "Supplied by System.  Timestamp of the last time that this field data was entered.",
5679					"allowEmptyValue": false
5680				},
5681				"Value": {
5682					"type": "string",
5683					"xml": {
5684						"name": "Value",
5685						"attribute": false,
5686						"wrapped": false
5687					},
5688					"description": "Supplied by System Only.  Current value of this field as entered by the user.",
5689					"allowEmptyValue": false
5690				},
5691				"Width": {
5692					"type": "integer",
5693					"format": "int32",
5694					"xml": {
5695						"name": "Width",
5696						"attribute": false,
5697						"wrapped": false
5698					},
5699					"description": "Supplied by Package or Sigmapper.  Width of the field in Points.",
5700					"allowEmptyValue": false
5701				}
5702			},
5703			"title": "FormFieldContainer",
5704			"xml": {
5705				"name": "FormFieldContainer",
5706				"attribute": false,
5707				"wrapped": false
5708			}
5709		},
5710		"FormFieldResponse«FormFieldContainer»": {
5711			"type": "object",
5712			"properties": {
5713				"affectedFields": {
5714					"type": "array",
5715					"items": {
5716						"$ref": "#/definitions/AffectedField"
5717					}
5718				},
5719				"content": {
5720					"$ref": "#/definitions/FormFieldContainer"
5721				},
5722				"formCompleted": {
5723					"type": "boolean"
5724				},
5725				"notes": {
5726					"type": "string"
5727				},
5728				"status": {
5729					"type": "string",
5730					"enum": ["SUCCESS", "FAILURE"]
5731				}
5732			},
5733			"title": "FormFieldResponse«FormFieldContainer»"
5734		},
5735		"FormImagingStatus": {
5736			"type": "object",
5737			"properties": {
5738				"complete": {
5739					"type": "boolean",
5740					"example": false,
5741					"description": "If the form has completed imaging, this is set to true",
5742					"allowEmptyValue": false
5743				},
5744				"form": {
5745					"description": "Metadata about this form.",
5746					"allowEmptyValue": false,
5747					"$ref": "#/definitions/FormContainer"
5748				}
5749			},
5750			"title": "FormImagingStatus"
5751		},
5752		"FormPostingControlContainer": {
5753			"type": "object",
5754			"properties": {
5755				"DocumentRecognition": {
5756					"xml": {
5757						"name": "DocumentRecognition",
5758						"attribute": false,
5759						"wrapped": false
5760					},
5761					"description": "Requests a pass through DocRec for this document.  After this step, resulting individual documents will be included as individual 'Form's in this package, in the same position and order as they were contained in the single unsplit file.",
5762					"allowEmptyValue": false,
5763					"$ref": "#/definitions/DocumentRecognitionContainer"
5764				},
5765				"TemplateMapping": {
5766					"xml": {
5767						"name": "TemplateMapping",
5768						"attribute": false,
5769						"wrapped": false
5770					},
5771					"description": "Requests application of mapped signature tempalte to this document",
5772					"allowEmptyValue": false,
5773					"$ref": "#/definitions/TemplateMappingContainer"
5774				}
5775			},
5776			"title": "FormPostingControl",
5777			"xml": {
5778				"name": "FormPostingControl",
5779				"attribute": false,
5780				"wrapped": false
5781			}
5782		},
5783		"FormRecipientContainer": {
5784			"type": "object",
5785			"properties": {
5786				"AccountIdentity": {
5787					"type": "integer",
5788					"format": "int64",
5789					"xml": {
5790						"name": "AccountIdentity",
5791						"attribute": false,
5792						"wrapped": false
5793					},
5794					"description": "Identity value of the recipient user account",
5795					"allowEmptyValue": false
5796				},
5797				"FormState": {
5798					"xml": {
5799						"name": "FormState",
5800						"attribute": false,
5801						"wrapped": false
5802					},
5803					"description": "State indicators for this recipient with respect to this form",
5804					"allowEmptyValue": false,
5805					"$ref": "#/definitions/FormStateContainer"
5806				},
5807				"RecipientTag": {
5808					"type": "string",
5809					"xml": {
5810						"name": "RecipientTag",
5811						"attribute": false,
5812						"wrapped": false
5813					},
5814					"description": "Tag value of the recipient of this form",
5815					"allowEmptyValue": false
5816				}
5817			},
5818			"title": "FormRecipient",
5819			"xml": {
5820				"name": "FormRecipient",
5821				"attribute": false,
5822				"wrapped": false
5823			}
5824		},
5825		"FormReferenceContainer": {
5826			"type": "object",
5827			"properties": {
5828				"FormIdentity": {
5829					"type": "string",
5830					"xml": {
5831						"name": "FormIdentity",
5832						"attribute": false,
5833						"wrapped": false
5834					},
5835					"description": "The internal Expedite index or identity value for this record.",
5836					"allowEmptyValue": false
5837				},
5838				"FormTag": {
5839					"type": "string",
5840					"xml": {
5841						"name": "FormTag",
5842						"attribute": false,
5843						"wrapped": false
5844					},
5845					"description": "Reference identity tag for this entity used in the context of this DeliveryPackage",
5846					"allowEmptyValue": false
5847				}
5848			},
5849			"title": "FormReference",
5850			"xml": {
5851				"name": "FormReference",
5852				"attribute": false,
5853				"wrapped": false
5854			}
5855		},
5856		"FormStateContainer": {
5857			"type": "object",
5858			"properties": {
5859				"Complete": {
5860					"type": "boolean",
5861					"example": false,
5862					"xml": {
5863						"name": "Complete",
5864						"attribute": false,
5865						"wrapped": false
5866					},
5867					"description": "Supplied by System.  If 'true', indicates the document has completed review and signing",
5868					"allowEmptyValue": false
5869				},
5870				"Downloaded": {
5871					"type": "boolean",
5872					"example": false,
5873					"xml": {
5874						"name": "Downloaded",
5875						"attribute": false,
5876						"wrapped": false
5877					},
5878					"description": "Supplied by System.  'True' if user has downloaded at least one PDF copy of a document in this package.",
5879					"allowEmptyValue": false
5880				},
5881				"Viewed": {
5882					"type": "boolean",
5883					"example": false,
5884					"xml": {
5885						"name": "Viewed",
5886						"attribute": false,
5887						"wrapped": false
5888					},
5889					"description": "Supplied by System.  'True' if user has viewed at least one imaged version of doucment in this package",
5890					"allowEmptyValue": false
5891				}
5892			},
5893			"title": "FormState",
5894			"xml": {
5895				"name": "FormState",
5896				"attribute": false,
5897				"wrapped": false
5898			}
5899		},
5900		"Format": {
5901			"type": "object",
5902			"properties": {
5903				"Mask": {
5904					"type": "string",
5905					"xml": {
5906						"name": "Mask",
5907						"attribute": false,
5908						"wrapped": false
5909					},
5910					"description": "Mask format to be presented to recipient when they are filling out the data",
5911					"allowEmptyValue": false
5912				},
5913				"MaxLength": {
5914					"type": "integer",
5915					"format": "int32",
5916					"xml": {
5917						"name": "MaxLength",
5918						"attribute": false,
5919						"wrapped": false
5920					},
5921					"description": "Maxmimumn length of the text field",
5922					"allowEmptyValue": false
5923				},
5924				"Option": {
5925					"type": "array",
5926					"xml": {
5927						"name": "Options",
5928						"attribute": false,
5929						"wrapped": true
5930					},
5931					"description": "List of options for a select field",
5932					"allowEmptyValue": false,
5933					"items": {
5934						"type": "string"
5935					}
5936				}
5937			},
5938			"title": "Format",
5939			"xml": {
5940				"name": "Format",
5941				"attribute": false,
5942				"wrapped": false
5943			}
5944		},
5945		"IntervalContainer": {
5946			"type": "object",
5947			"properties": {
5948				"ExcludeSaturdays": {
5949					"type": "boolean",
5950					"example": false,
5951					"xml": {
5952						"name": "ExcludeSaturdays",
5953						"attribute": false,
5954						"wrapped": false
5955					},
5956					"description": "Supplied by Package.  Instructs the interval calculation to exlcude Saturdays from its total.",
5957					"allowEmptyValue": false
5958				},
5959				"Interval": {
5960					"type": "string",
5961					"xml": {
5962						"name": "Interval",
5963						"attribute": false,
5964						"wrapped": false
5965					},
5966					"description": "Supplied by Package.  Time interval specified in 'nnn.IntervalUnit', where IntervalUnit is SECONDS, MINUTES, DAYS, HOURS, WEEKS,  MONTHS, or YEARS.",
5967					"allowEmptyValue": false
5968				},
5969				"StartDate": {
5970					"type": "string",
5971					"format": "date-time",
5972					"xml": {
5973						"name": "StartDate",
5974						"attribute": false,
5975						"wrapped": false
5976					},
5977					"description": "Supplied by Package.  The start date and time for the interval calculation.",
5978					"allowEmptyValue": false
5979				},
5980				"Timezone": {
5981					"type": "string",
5982					"xml": {
5983						"name": "Timezone",
5984						"attribute": false,
5985						"wrapped": false
5986					},
5987					"description": "Timezone that applies to the TriggerTime entry.  This determines both the offset and Daylight Savings Time behavior of the interval calculation.",
5988					"allowEmptyValue": false,
5989					"enum": ["AMERICA_PUERTO_RICO", "AMERICA_NEW_YORK", "AMERICA_CHICAGO", "AMERICA_DENVER", "AMERICA_LOS_ANGELES", "AMERICA_PHOENIX", "AMERICA_JUNEAU", "AMERICA_ADAK", "PACIFIC_HONOLULU", "PACIFIC_GUAM", "PACIFIC_PAGO_PAGO", "PACIFIC_WAKE"]
5990				},
5991				"TriggerTime": {
5992					"xml": {
5993						"name": "TriggerTime",
5994						"attribute": false,
5995						"wrapped": false
5996					},
5997					"description": "The time of day that the expiration should actually occur on the day that the interval expires.  This value must be expressed without a timezone offset; the Timezone element ",
5998					"allowEmptyValue": false,
5999					"$ref": "#/definitions/LocalTime"
6000				},
6001				"UseBusinessDays": {
6002					"type": "boolean",
6003					"example": false,
6004					"xml": {
6005						"name": "UseBusinessDays",
6006						"attribute": false,
6007						"wrapped": false
6008					},
6009					"description": "Supplied by package.  Whether or not to use business days (excluding Sunday and federal holidays) or not.  Defaults to true",
6010					"allowEmptyValue": false
6011				}
6012			},
6013			"title": "IntervalCalculation",
6014			"xml": {
6015				"name": "IntervalCalculation",
6016				"attribute": false,
6017				"wrapped": false
6018			}
6019		},
6020		"ItemStateContainer": {
6021			"type": "object",
6022			"properties": {
6023				"Complete": {
6024					"type": "boolean",
6025					"example": false,
6026					"xml": {
6027						"name": "Complete",
6028						"attribute": false,
6029						"wrapped": false
6030					},
6031					"description": "'True' indicates that the Upload Request Item has been successfully delivered by the recipient",
6032					"allowEmptyValue": false
6033				}
6034			},
6035			"title": "ItemState",
6036			"xml": {
6037				"name": "ItemState",
6038				"attribute": false,
6039				"wrapped": false
6040			}
6041		},
6042		"Link": {
6043			"type": "object",
6044			"properties": {
6045				"LinkType": {
6046					"type": "string",
6047					"xml": {
6048						"name": "LinkType",
6049						"attribute": false,
6050						"wrapped": false
6051					},
6052					"description": "Type of link this is.  Autofill is used to signify date objects that autopopulate with current date when they are trigger, while Enable just enables/disables based on the field",
6053					"allowEmptyValue": false
6054				},
6055				"Target": {
6056					"type": "string",
6057					"xml": {
6058						"name": "Target",
6059						"attribute": false,
6060						"wrapped": false
6061					},
6062					"description": "Tagname of the field to be autofilled or enabled when this field is filled out",
6063					"allowEmptyValue": false
6064				},
6065				"TargetIdentity": {
6066					"type": "integer",
6067					"format": "int64",
6068					"xml": {
6069						"name": "TargetIdentity",
6070						"attribute": false,
6071						"wrapped": false
6072					},
6073					"description": "Internal identity for target field",
6074					"allowEmptyValue": false
6075				}
6076			},
6077			"title": "Link",
6078			"xml": {
6079				"name": "Link",
6080				"attribute": false,
6081				"wrapped": false
6082			}
6083		},
6084		"LocalTime": {
6085			"type": "object",
6086			"properties": {
6087				"hour": {
6088					"type": "integer",
6089					"format": "int32"
6090				},
6091				"minute": {
6092					"type": "integer",
6093					"format": "int32"
6094				},
6095				"nano": {
6096					"type": "integer",
6097					"format": "int32"
6098				},
6099				"second": {
6100					"type": "integer",
6101					"format": "int32"
6102				}
6103			},
6104			"title": "LocalTime"
6105		},
6106		"MFAContainer": {
6107			"type": "object",
6108			"properties": {
6109				"LineType": {
6110					"type": "string",
6111					"xml": {
6112						"name": "LineType",
6113						"attribute": false,
6114						"wrapped": false
6115					},
6116					"description": "Supplied by Package.  Designates whther this is a Voice or Text line.",
6117					"allowEmptyValue": false,
6118					"enum": ["TEXT", "VOICE"]
6119				},
6120				"Number": {
6121					"type": "string",
6122					"xml": {
6123						"name": "Number",
6124						"attribute": false,
6125						"wrapped": false
6126					},
6127					"description": "Supplied by Package.  10-digit US telephone number.",
6128					"allowEmptyValue": false
6129				}
6130			},
6131			"title": "MFA",
6132			"xml": {
6133				"name": "MFA",
6134				"attribute": false,
6135				"wrapped": false
6136			}
6137		},
6138		"ManagerImagingStatus": {
6139			"type": "object",
6140			"properties": {
6141				"complete": {
6142					"type": "boolean",
6143					"example": false,
6144					"description": "If all forms within the manager are completed, this is set to true.",
6145					"allowEmptyValue": false
6146				},
6147				"notFinished": {
6148					"type": "array",
6149					"description": "List of forms that are still being imaged.",
6150					"allowEmptyValue": false,
6151					"items": {
6152						"$ref": "#/definitions/FormContainer"
6153					}
6154				},
6155				"numberNotFinished": {
6156					"type": "integer",
6157					"format": "int32",
6158					"description": "Numer of forms that have not completed imaging.",
6159					"allowEmptyValue": false
6160				},
6161				"totalForms": {
6162					"type": "integer",
6163					"format": "int32",
6164					"description": "Total number of forms withing the manager.",
6165					"allowEmptyValue": false
6166				}
6167			},
6168			"title": "ManagerImagingStatus"
6169		},
6170		"MessageIdentifiersContainer": {
6171			"type": "object",
6172			"title": "MessageIdentifiers",
6173			"xml": {
6174				"name": "MessageIdentifiers",
6175				"attribute": false,
6176				"wrapped": false
6177			}
6178		},
6179		"MismoSmartDoc": {
6180			"type": "object",
6181			"properties": {
6182				"any": {
6183					"type": "object"
6184				}
6185			},
6186			"title": "MismoSmartDoc",
6187			"xml": {
6188				"name": "MismoSmartDoc",
6189				"attribute": false,
6190				"wrapped": false
6191			}
6192		},
6193		"MortgageDataContainer": {
6194			"type": "object",
6195			"properties": {
6196				"ChangeOfCircumstance": {
6197					"xml": {
6198						"name": "ChangeOfCircumstance",
6199						"attribute": false,
6200						"wrapped": false
6201					},
6202					"description": "Contains Change of Circumstance data elements",
6203					"allowEmptyValue": false,
6204					"$ref": "#/definitions/ChangeOfCircumstanceContainer"
6205				},
6206				"CollectIntentToProceed": {
6207					"type": "boolean",
6208					"example": false,
6209					"xml": {
6210						"name": "CollectIntentToProceed",
6211						"attribute": false,
6212						"wrapped": false
6213					},
6214					"description": "Supplied by Package.  'true' if the system needs to collect Intent to Proced from the recipient.",
6215					"allowEmptyValue": false
6216				},
6217				"IntegratedDisclosureType": {
6218					"type": "string",
6219					"xml": {
6220						"name": "IntegratedDisclosureType",
6221						"attribute": false,
6222						"wrapped": false
6223					},
6224					"description": "Supplied by Package.  Denotes if this is a Loan Estimate or Closing Disclosure package.",
6225					"allowEmptyValue": false,
6226					"enum": ["CLOSING_DISCLOSURE", "LOAN_ESTIMATE"]
6227				}
6228			},
6229			"title": "MortgageData",
6230			"xml": {
6231				"name": "MortgageData",
6232				"attribute": false,
6233				"wrapped": false
6234			}
6235		},
6236		"NameContainer": {
6237			"type": "object",
6238			"required": ["First", "Last"],
6239			"properties": {
6240				"First": {
6241					"type": "string",
6242					"xml": {
6243						"name": "First",
6244						"attribute": false,
6245						"wrapped": false
6246					}
6247				},
6248				"Last": {
6249					"type": "string",
6250					"xml": {
6251						"name": "Last",
6252						"attribute": false,
6253						"wrapped": false
6254					}
6255				},
6256				"Middle": {
6257					"type": "string",
6258					"xml": {
6259						"name": "Middle",
6260						"attribute": false,
6261						"wrapped": false
6262					}
6263				},
6264				"Prefix": {
6265					"type": "string",
6266					"xml": {
6267						"name": "Prefix",
6268						"attribute": false,
6269						"wrapped": false
6270					}
6271				},
6272				"Suffix": {
6273					"type": "string",
6274					"xml": {
6275						"name": "Suffix",
6276						"attribute": false,
6277						"wrapped": false
6278					}
6279				}
6280			},
6281			"title": "Name",
6282			"xml": {
6283				"name": "Name",
6284				"attribute": false,
6285				"wrapped": false
6286			}
6287		},
6288		"OwnerContainer": {
6289			"type": "object",
6290			"properties": {
6291				"AccountLookup": {
6292					"xml": {
6293						"name": "AccountLookup",
6294						"attribute": false,
6295						"wrapped": false
6296					},
6297					"description": "Parameters to use to lookup this owner in the Account table",
6298					"allowEmptyValue": false,
6299					"$ref": "#/definitions/AccountLookupContainer"
6300				},
6301				"Identity": {
6302					"type": "integer",
6303					"format": "int64",
6304					"xml": {
6305						"name": "Identity",
6306						"attribute": false,
6307						"wrapped": false
6308					},
6309					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
6310					"allowEmptyValue": false
6311				},
6312				"OrganizationName": {
6313					"type": "string",
6314					"xml": {
6315						"name": "OrganizationName",
6316						"attribute": false,
6317						"wrapped": false
6318					}
6319				},
6320				"OwnerClass": {
6321					"type": "string",
6322					"xml": {
6323						"name": "OwnerClass",
6324						"attribute": false,
6325						"wrapped": false
6326					},
6327					"description": "Specifies the class of the owner of this entity, either Account or Customer",
6328					"allowEmptyValue": false,
6329					"enum": ["ACCOUNT", "ORGANIZATION"]
6330				}
6331			},
6332			"title": "Owner",
6333			"xml": {
6334				"name": "Owner",
6335				"attribute": false,
6336				"wrapped": false
6337			}
6338		},
6339		"PackageDeclinedReasons": {
6340			"type": "object",
6341			"properties": {
6342				"DeclinedReasons": {
6343					"type": "array",
6344					"xml": {
6345						"name": "DeclinedReasons",
6346						"attribute": false,
6347						"wrapped": false
6348					},
6349					"items": {
6350						"type": "string"
6351					}
6352				},
6353				"Identity": {
6354					"type": "string",
6355					"xml": {
6356						"name": "Identity",
6357						"attribute": false,
6358						"wrapped": false
6359					}
6360				}
6361			},
6362			"title": "PackageDeclinedReasons",
6363			"xml": {
6364				"name": "PackageDeclinedReasons",
6365				"attribute": false,
6366				"wrapped": false
6367			}
6368		},
6369		"PackageDimensionsContainer": {
6370			"type": "object",
6371			"properties": {
6372				"A": {
6373					"type": "number",
6374					"xml": {
6375						"name": "A",
6376						"attribute": false,
6377						"wrapped": false
6378					},
6379					"description": "Supplied by Package.  Package dimension in inches",
6380					"allowEmptyValue": false
6381				},
6382				"B": {
6383					"type": "number",
6384					"xml": {
6385						"name": "B",
6386						"attribute": false,
6387						"wrapped": false
6388					},
6389					"description": "Supplied by Package.  Package dimension in inches",
6390					"allowEmptyValue": false
6391				},
6392				"C": {
6393					"type": "number",
6394					"xml": {
6395						"name": "C",
6396						"attribute": false,
6397						"wrapped": false
6398					},
6399					"description": "Supplied by Package.  Package dimension in inches",
6400					"allowEmptyValue": false
6401				}
6402			},
6403			"title": "PackageDimensions",
6404			"xml": {
6405				"name": "PackageDimensions",
6406				"attribute": false,
6407				"wrapped": false
6408			}
6409		},
6410		"PackageManagerDefaults": {
6411			"type": "object",
6412			"properties": {
6413				"allowFallToPrint": {
6414					"type": "boolean",
6415					"example": false,
6416					"xml": {
6417						"name": "allowFallToPrint",
6418						"attribute": false,
6419						"wrapped": false
6420					},
6421					"description": "Determines if this package is allowed to fall to print.",
6422					"allowEmptyValue": false
6423				},
6424				"allowablePostingTypes": {
6425					"type": "array",
6426					"xml": {
6427						"name": "allowablePostingTypes",
6428						"attribute": false,
6429						"wrapped": false
6430					},
6431					"description": "Posting types that are allowed for this package.",
6432					"allowEmptyValue": false,
6433					"items": {
6434						"$ref": "#/definitions/Enum"
6435					}
6436				},
6437				"carriers": {
6438					"type": "array",
6439					"xml": {
6440						"name": "carriers",
6441						"attribute": false,
6442						"wrapped": false
6443					},
6444					"description": "List of mail carriers available if this package falls to print.",
6445					"allowEmptyValue": false,
6446					"items": {
6447						"$ref": "#/definitions/WaybillShippingDetailWaybillRequestDetailContainer"
6448					}
6449				},
6450				"eConsentExpiration": {
6451					"type": "string",
6452					"format": "date-time",
6453					"xml": {
6454						"name": "eConsentExpiration",
6455						"attribute": false,
6456						"wrapped": false
6457					},
6458					"description": "Default date this package will expire if an eConsent.",
6459					"allowEmptyValue": false
6460				},
6461				"eSignatureExpiration": {
6462					"type": "string",
6463					"format": "date-time",
6464					"xml": {
6465						"name": "eSignatureExpiration",
6466						"attribute": false,
6467						"wrapped": false
6468					},
6469					"description": "Default date this package will expire if an eSignature.",
6470					"allowEmptyValue": false
6471				}
6472			},
6473			"title": "PackageManagerDefaults"
6474		},
6475		"PackageManagerItem": {
6476			"type": "object",
6477			"properties": {
6478				"creationDate": {
6479					"type": "string",
6480					"format": "date-time"
6481				},
6482				"dp": {
6483					"$ref": "#/definitions/DeliveryPackageContainer"
6484				},
6485				"organizationId": {
6486					"type": "integer",
6487					"format": "int64"
6488				},
6489				"organizationName": {
6490					"type": "string"
6491				},
6492				"updateDate": {
6493					"type": "string",
6494					"format": "date-time"
6495				}
6496			},
6497			"title": "PackageManagerItem"
6498		},
6499		"PackageStateContainer": {
6500			"type": "object",
6501			"properties": {
6502				"Complete": {
6503					"type": "boolean",
6504					"example": false,
6505					"xml": {
6506						"name": "Complete",
6507						"attribute": false,
6508						"wrapped": false
6509					},
6510					"description": "Supplied by System.  'true' if the current package is complete for all users",
6511					"allowEmptyValue": false
6512				},
6513				"Declined": {
6514					"type": "boolean",
6515					"example": false,
6516					"xml": {
6517						"name": "Declined",
6518						"attribute": false,
6519						"wrapped": false
6520					},
6521					"description": "Supplied by System.  'True' if this user has declined consent.",
6522					"allowEmptyValue": false
6523				},
6524				"Expired": {
6525					"type": "boolean",
6526					"example": false,
6527					"xml": {
6528						"name": "Expired",
6529						"attribute": false,
6530						"wrapped": false
6531					},
6532					"description": "Supplied by System.  'true' if the package is expired.",
6533					"allowEmptyValue": false
6534				}
6535			},
6536			"title": "PackageState",
6537			"xml": {
6538				"name": "PackageState",
6539				"attribute": false,
6540				"wrapped": false
6541			}
6542		},
6543		"PackageWaybillInfoContainer": {
6544			"type": "object",
6545			"properties": {
6546				"WaybillReplyAddress": {
6547					"xml": {
6548						"name": "WaybillReplyAddress",
6549						"attribute": false,
6550						"wrapped": false
6551					},
6552					"description": "The address where signed packages should be shipped back to.",
6553					"allowEmptyValue": false,
6554					"$ref": "#/definitions/WaybillReplyAddressWaybillAddressContainer"
6555				},
6556				"WaybillReplyDetail": {
6557					"xml": {
6558						"name": "WaybillReplyDetail",
6559						"attribute": false,
6560						"wrapped": false
6561					},
6562					"description": "Per-delivery-package business reply (BRM) shipping detail information",
6563					"allowEmptyValue": false,
6564					"$ref": "#/definitions/WaybillReplyDetailWaybillRequestDetailContainer"
6565				},
6566				"WaybillReturnAddress": {
6567					"xml": {
6568						"name": "WaybillReturnAddress",
6569						"attribute": false,
6570						"wrapped": false
6571					},
6572					"description": "The address where the postal carrier should return undeliverable packages to, or the address at the top-left of the address label.",
6573					"allowEmptyValue": false,
6574					"$ref": "#/definitions/WaybillReturnAddressWaybillAddressContainer"
6575				},
6576				"WaybillShippingDetail": {
6577					"xml": {
6578						"name": "WaybillShippingDetail",
6579						"attribute": false,
6580						"wrapped": false
6581					},
6582					"description": "Per-delivery-pacakage shipping detail information",
6583					"allowEmptyValue": false,
6584					"$ref": "#/definitions/WaybillShippingDetailWaybillRequestDetailContainer"
6585				}
6586			},
6587			"title": "PackageWaybillInfo",
6588			"xml": {
6589				"name": "PackageWaybillInfo",
6590				"attribute": false,
6591				"wrapped": false
6592			}
6593		},
6594		"PageContainer": {
6595			"type": "object",
6596			"properties": {
6597				"Href": {
6598					"type": "string",
6599					"description": "API endpoint to reference this object."
6600				},
6601				"Button": {
6602					"type": "array",
6603					"xml": {
6604						"name": "Buttons",
6605						"attribute": false,
6606						"wrapped": true
6607					},
6608					"description": "Metadata about checkbox type controls within the page.",
6609					"allowEmptyValue": false,
6610					"items": {
6611						"$ref": "#/definitions/ButtonContainer"
6612					}
6613				},
6614				"Field": {
6615					"type": "array",
6616					"xml": {
6617						"name": "Fields",
6618						"attribute": false,
6619						"wrapped": true
6620					},
6621					"description": "Metadata about text entry type controls within the page.",
6622					"allowEmptyValue": false,
6623					"items": {
6624						"$ref": "#/definitions/EnterableFieldContainer"
6625					}
6626				},
6627				"Group": {
6628					"type": "array",
6629					"xml": {
6630						"name": "Groups",
6631						"attribute": false,
6632						"wrapped": true
6633					},
6634					"description": "Metadata about groups of buttons.  Used to control grouped behaviour (i.e. one required, only one allowed, etc.)",
6635					"allowEmptyValue": false,
6636					"items": {
6637						"$ref": "#/definitions/ButtonGroupContainer"
6638					}
6639				},
6640				"Height": {
6641					"type": "integer",
6642					"format": "int32",
6643					"xml": {
6644						"name": "Height",
6645						"attribute": false,
6646						"wrapped": false
6647					},
6648					"description": "Supplied by System.  Page height in Points",
6649					"allowEmptyValue": false
6650				},
6651				"Identity": {
6652					"type": "integer",
6653					"format": "int64",
6654					"xml": {
6655						"name": "Identity",
6656						"attribute": false,
6657						"wrapped": false
6658					},
6659					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
6660					"allowEmptyValue": false
6661				},
6662				"ImageId": {
6663					"type": "string",
6664					"xml": {
6665						"name": "ImageId",
6666						"attribute": false,
6667						"wrapped": false
6668					},
6669					"description": "Supplied by System.  Identifier of the rendered page image",
6670					"allowEmptyValue": false
6671				},
6672				"Number": {
6673					"type": "integer",
6674					"format": "int32",
6675					"xml": {
6676						"name": "Number",
6677						"attribute": false,
6678						"wrapped": false
6679					},
6680					"description": "Supplied by Package.  Sequential number of the page in the form.",
6681					"allowEmptyValue": false
6682				},
6683				"Signature": {
6684					"type": "array",
6685					"xml": {
6686						"name": "Signatures",
6687						"attribute": false,
6688						"wrapped": true
6689					},
6690					"description": "Metadata about signature type controls within the page.",
6691					"allowEmptyValue": false,
6692					"items": {
6693						"$ref": "#/definitions/SignatureContainer"
6694					}
6695				},
6696				"Size": {
6697					"type": "integer",
6698					"format": "int64",
6699					"xml": {
6700						"name": "Size",
6701						"attribute": false,
6702						"wrapped": false
6703					},
6704					"description": "Supplied by System.  File size of the page image file.",
6705					"allowEmptyValue": false
6706				},
6707				"Width": {
6708					"type": "integer",
6709					"format": "int32",
6710					"xml": {
6711						"name": "Width",
6712						"attribute": false,
6713						"wrapped": false
6714					},
6715					"description": "Supplied by System.  Page width in Points",
6716					"allowEmptyValue": false
6717				}
6718			},
6719			"title": "Page",
6720			"xml": {
6721				"name": "Page",
6722				"attribute": false,
6723				"wrapped": false
6724			}
6725		},
6726		"PhoneNumberContainer": {
6727			"type": "object",
6728			"properties": {
6729				"Country": {
6730					"type": "string",
6731					"xml": {
6732						"name": "Country",
6733						"attribute": false,
6734						"wrapped": false
6735					},
6736					"description": "Supplied by Package.  Country dialing prefix, '1' in the US",
6737					"allowEmptyValue": false
6738				},
6739				"Extension": {
6740					"type": "string",
6741					"xml": {
6742						"name": "Extension",
6743						"attribute": false,
6744						"wrapped": false
6745					},
6746					"description": "Supplied by Package.  Post-dial extension number for this phone",
6747					"allowEmptyValue": false
6748				},
6749				"IsPrimary": {
6750					"type": "boolean",
6751					"example": false,
6752					"xml": {
6753						"name": "IsPrimary",
6754						"attribute": false,
6755						"wrapped": false
6756					},
6757					"description": "Supplied by Package.  'True' indicates that this phone number is the primary voice contact number for thsi account",
6758					"allowEmptyValue": false
6759				},
6760				"Number": {
6761					"type": "string",
6762					"xml": {
6763						"name": "Number",
6764						"attribute": false,
6765						"wrapped": false
6766					},
6767					"description": "Supplied by Package.  10 to 15-digit telephone number, numeric only",
6768					"allowEmptyValue": false
6769				},
6770				"PhoneNumberType": {
6771					"type": "string",
6772					"xml": {
6773						"name": "PhoneNumberType",
6774						"attribute": false,
6775						"wrapped": false
6776					},
6777					"description": "Type designation of the phone number for use in the UI, as in Home, Work, Mobile, etc.",
6778					"allowEmptyValue": false,
6779					"enum": ["CELL", "FAX", "HOME", "PAGER", "WORK"]
6780				}
6781			},
6782			"title": "PhoneNumber",
6783			"xml": {
6784				"name": "PhoneNumber",
6785				"attribute": false,
6786				"wrapped": false
6787			}
6788		},
6789		"PostingControlsContainer": {
6790			"type": "object",
6791			"properties": {
6792				"HoldDelivery": {
6793					"type": "boolean",
6794					"example": false,
6795					"xml": {
6796						"name": "HoldDelivery",
6797						"attribute": false,
6798						"wrapped": false
6799					},
6800					"description": "When 'true', indicates that this package should be held in Package Center for further manual processing instead of being immediately delivered to the specified recipient(s).  Default is 'false'.",
6801					"allowEmptyValue": false
6802				},
6803				"PostingType": {
6804					"type": "string",
6805					"xml": {
6806						"name": "PostingType",
6807						"attribute": false,
6808						"wrapped": false
6809					},
6810					"description": "Supplied by Package.  The type of DeliveryPackate to create with this posting. (eConsent, eDelivery, eSignature, eClosing)",
6811					"allowEmptyValue": false,
6812					"enum": ["E_CONSENT", "E_DELIVERY", "E_SIGNATURE", "E_CLOSING", "UPLOAD_REQUEST"]
6813				}
6814			},
6815			"title": "PostingControls",
6816			"xml": {
6817				"name": "PostingControls",
6818				"attribute": false,
6819				"wrapped": false
6820			}
6821		},
6822		"PrintContainer": {
6823			"type": "object",
6824			"properties": {
6825				"AllowFallToPrint": {
6826					"type": "boolean",
6827					"example": false,
6828					"xml": {
6829						"name": "AllowFallToPrint",
6830						"attribute": false,
6831						"wrapped": false
6832					},
6833					"description": "Supplied by Package.  When 'true', indicates that the package is enabled for the normal fall-to-print process.",
6834					"allowEmptyValue": false
6835				},
6836				"AllowPrintOnError": {
6837					"type": "boolean",
6838					"example": false,
6839					"xml": {
6840						"name": "AllowPrintOnError",
6841						"attribute": false,
6842						"wrapped": false
6843					},
6844					"description": "Supplied by Package.  When 'true' indicates that the package may automatically fall to print if a posting error occurs.",
6845					"allowEmptyValue": false
6846				},
6847				"CscBillingInfo": {
6848					"type": "array",
6849					"xml": {
6850						"name": "CscBillingInfos",
6851						"attribute": false,
6852						"wrapped": true
6853					},
6854					"description": "Collection of carrier 3rd party billing info for all print locations for this package",
6855					"allowEmptyValue": false,
6856					"items": {
6857						"$ref": "#/definitions/CscBillingInfoContainer"
6858					}
6859				},
6860				"DirectToPrint": {
6861					"type": "boolean",
6862					"example": false,
6863					"xml": {
6864						"name": "DirectToPrint",
6865						"attribute": false,
6866						"wrapped": false
6867					},
6868					"description": "Supplied by Package.  When 'true' indicates that the package should be routed directly to the print queue.",
6869					"allowEmptyValue": false
6870				},
6871				"FallToPrintTimer": {
6872					"xml": {
6873						"name": "FallToPrintTimer",
6874						"attribute": false,
6875						"wrapped": false
6876					},
6877					"$ref": "#/definitions/FallToPrintTimerExpirationContainer"
6878				},
6879				"OnlyPrintOnePackage": {
6880					"type": "boolean",
6881					"example": false,
6882					"xml": {
6883						"name": "OnlyPrintOnePackage",
6884						"attribute": false,
6885						"wrapped": false
6886					},
6887					"description": "Supplied by Package.  If 'true', indicates that the package should only be mailed to the primary borrower.",
6888					"allowEmptyValue": false
6889				},
6890				"PackageWaybillInfo": {
6891					"xml": {
6892						"name": "PackageWaybillInfo",
6893						"attribute": false,
6894						"wrapped": false
6895					},
6896					"description": "Package level CSC waybill information",
6897					"allowEmptyValue": false,
6898					"$ref": "#/definitions/PackageWaybillInfoContainer"
6899				},
6900				"RequestColorPrint": {
6901					"type": "boolean",
6902					"example": false,
6903					"xml": {
6904						"name": "RequestColorPrint",
6905						"attribute": false,
6906						"wrapped": false
6907					},
6908					"description": "Supplied by Package.  If 'true', routes printing of this package to a color printer.",
6909					"allowEmptyValue": false
6910				},
6911				"RequestReplyLabel": {
6912					"type": "boolean",
6913					"example": false,
6914					"xml": {
6915						"name": "RequestReplyLabel",
6916						"attribute": false,
6917						"wrapped": false
6918					},
6919					"description": "Supplied by Package.  If 'true', requests a reply shipping label to be printed.",
6920					"allowEmptyValue": false
6921				}
6922			},
6923			"title": "Print",
6924			"xml": {
6925				"name": "Print",
6926				"attribute": false,
6927				"wrapped": false
6928			}
6929		},
6930		"ProcessingNoteContainer": {
6931			"type": "object",
6932			"properties": {
6933				"FormReference": {
6934					"type": "array",
6935					"xml": {
6936						"name": "FormReferences",
6937						"attribute": false,
6938						"wrapped": true
6939					},
6940					"description": "References to Forms that are in context of this Note",
6941					"allowEmptyValue": false,
6942					"items": {
6943						"$ref": "#/definitions/FormReferenceContainer"
6944					}
6945				},
6946				"NoteText": {
6947					"type": "string",
6948					"xml": {
6949						"name": "NoteText",
6950						"attribute": false,
6951						"wrapped": false
6952					},
6953					"description": "Text containing a message about some issue or event that occurred during package processing.  This can describe fatal events, warnings, or general information.",
6954					"allowEmptyValue": false
6955				},
6956				"NoteTimestamp": {
6957					"type": "string",
6958					"format": "date-time",
6959					"xml": {
6960						"name": "NoteTimestamp",
6961						"attribute": false,
6962						"wrapped": false
6963					},
6964					"description": "Timestamp of when this message was attached to the Delivery Package",
6965					"allowEmptyValue": false
6966				},
6967				"UserReference": {
6968					"type": "array",
6969					"xml": {
6970						"name": "UserReferences",
6971						"attribute": false,
6972						"wrapped": true
6973					},
6974					"description": "References to Users (Sender or Recipient) that are in context of this Note",
6975					"allowEmptyValue": false,
6976					"items": {
6977						"$ref": "#/definitions/UserReferenceContainer"
6978					}
6979				}
6980			},
6981			"title": "ProcessingNote",
6982			"xml": {
6983				"name": "ProcessingNote",
6984				"attribute": false,
6985				"wrapped": false
6986			}
6987		},
6988		"PropertyContainer": {
6989			"type": "object",
6990			"properties": {
6991				"Href": {
6992					"type": "string",
6993					"description": "API endpoint to reference this object."
6994				},
6995				"Identity": {
6996					"type": "string",
6997					"xml": {
6998						"name": "Identity",
6999						"attribute": false,
7000						"wrapped": false
7001					},
7002					"description": "Internal ID for this property",
7003					"allowEmptyValue": false
7004				},
7005				"Key": {
7006					"type": "string",
7007					"xml": {
7008						"name": "Key",
7009						"attribute": false,
7010						"wrapped": false
7011					},
7012					"description": "Parameter name for this property",
7013					"allowEmptyValue": false
7014				},
7015				"Owner": {
7016					"xml": {
7017						"name": "Owner",
7018						"attribute": false,
7019						"wrapped": false
7020					},
7021					"description": "System assigned.  The organizatgion that owns this property.",
7022					"allowEmptyValue": false,
7023					"$ref": "#/definitions/OwnerContainer"
7024				},
7025				"Value": {
7026					"type": "string",
7027					"xml": {
7028						"name": "Value",
7029						"attribute": false,
7030						"wrapped": false
7031					},
7032					"description": "Value of this property",
7033					"allowEmptyValue": false
7034				},
7035				"ViewAll": {
7036					"type": "boolean",
7037					"example": false,
7038					"xml": {
7039						"name": "ViewAll",
7040						"attribute": false,
7041						"wrapped": false
7042					},
7043					"description": "When 'true', allows users that have view permission of the parent entity to view this Property.",
7044					"allowEmptyValue": false
7045				},
7046				"Viewer": {
7047					"type": "array",
7048					"xml": {
7049						"name": "Viewers",
7050						"attribute": false,
7051						"wrapped": true
7052					},
7053					"description": "Accounts or organizations permitted to view this property",
7054					"allowEmptyValue": false,
7055					"items": {
7056						"$ref": "#/definitions/ViewerOwnerContainer"
7057					}
7058				}
7059			},
7060			"title": "Property",
7061			"xml": {
7062				"name": "Property",
7063				"attribute": false,
7064				"wrapped": false
7065			}
7066		},
7067		"ReceivedDocumentContainer": {
7068			"type": "object",
7069			"properties": {
7070				"FileName": {
7071					"type": "string",
7072					"xml": {
7073						"name": "FileName",
7074						"attribute": false,
7075						"wrapped": false
7076					},
7077					"description": "File system filename of the uploaded file",
7078					"allowEmptyValue": false
7079				},
7080				"Identity": {
7081					"type": "integer",
7082					"format": "int64",
7083					"xml": {
7084						"name": "Identity",
7085						"attribute": false,
7086						"wrapped": false
7087					},
7088					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
7089					"allowEmptyValue": false
7090				},
7091				"WSFileId": {
7092					"type": "string",
7093					"xml": {
7094						"name": "WSFileId",
7095						"attribute": false,
7096						"wrapped": false
7097					},
7098					"description": "Identifier of the document file within the workspace",
7099					"allowEmptyValue": false
7100				}
7101			},
7102			"title": "ReceivedDocument",
7103			"xml": {
7104				"name": "ReceivedDocument",
7105				"attribute": false,
7106				"wrapped": false
7107			}
7108		},
7109		"RecipientDetails": {
7110			"type": "object",
7111			"properties": {
7112				"addressLine1": {
7113					"type": "string"
7114				},
7115				"addressLine2": {
7116					"type": "string"
7117				},
7118				"city": {
7119					"type": "string"
7120				},
7121				"firstName": {
7122					"type": "string"
7123				},
7124				"fullName": {
7125					"type": "string"
7126				},
7127				"lastName": {
7128					"type": "string"
7129				},
7130				"middleName": {
7131					"type": "string"
7132				},
7133				"primaryPhone": {
7134					"type": "integer",
7135					"format": "int64"
7136				},
7137				"state": {
7138					"type": "string"
7139				},
7140				"suffix": {
7141					"type": "string"
7142				},
7143				"zip": {
7144					"type": "string"
7145				}
7146			},
7147			"title": "RecipientDetails"
7148		},
7149		"RecipientReviewOnlyHoldTimerExpirationContainer": {
7150			"type": "object",
7151			"properties": {
7152				"Date": {
7153					"type": "string",
7154					"format": "date-time",
7155					"xml": {
7156						"name": "Date",
7157						"attribute": false,
7158						"wrapped": false
7159					},
7160					"description": "Supplied by Package.  The absolute date/time that package expiration is to occur.  This overrides any values contained in 'IntervalCalculation'",
7161					"allowEmptyValue": false
7162				},
7163				"IntervalCalculation": {
7164					"xml": {
7165						"name": "IntervalCalculation",
7166						"attribute": false,
7167						"wrapped": false
7168					},
7169					"description": "Parameters concerning expiration timing for the package",
7170					"allowEmptyValue": false,
7171					"$ref": "#/definitions/IntervalContainer"
7172				}
7173			},
7174			"title": "RecipientReviewOnlyHoldTimer",
7175			"xml": {
7176				"name": "RecipientReviewOnlyHoldTimer",
7177				"attribute": false,
7178				"wrapped": false
7179			}
7180		},
7181		"RecipientUserContainer": {
7182			"type": "object",
7183			"properties": {
7184				"AccessRole": {
7185					"type": "array",
7186					"xml": {
7187						"name": "AccessRoles",
7188						"attribute": false,
7189						"wrapped": true
7190					},
7191					"description": "List of roles that determine the access of the user in this package.",
7192					"allowEmptyValue": false,
7193					"items": {
7194						"type": "string",
7195						"enum": ["APPROVER", "RECIPIENT", "SENDER", "VIEWER"]
7196					}
7197				},
7198				"Authentication": {
7199					"xml": {
7200						"name": "Authentication",
7201						"attribute": false,
7202						"wrapped": false
7203					},
7204					"description": "Data related to recipient authentication",
7205					"allowEmptyValue": false,
7206					"$ref": "#/definitions/AuthenticationContainer"
7207				},
7208				"EmailAddress": {
7209					"type": "string",
7210					"xml": {
7211						"name": "EmailAddress",
7212						"attribute": false,
7213						"wrapped": false
7214					},
7215					"description": "Primary email address for this user",
7216					"allowEmptyValue": false
7217				},
7218				"EsignXref": {
7219					"xml": {
7220						"name": "EsignXref",
7221						"attribute": false,
7222						"wrapped": false
7223					},
7224					"description": "Information needed map this recipient to document signatures on pre-mapped documents",
7225					"allowEmptyValue": false,
7226					"$ref": "#/definitions/EsignXrefContainer"
7227				},
7228				"ForeignIdentity": {
7229					"type": "array",
7230					"xml": {
7231						"name": "ForeignIdentities",
7232						"attribute": false,
7233						"wrapped": true
7234					},
7235					"description": "Supplied by Package.  Information on how this object is identified in other systems.",
7236					"allowEmptyValue": false,
7237					"items": {
7238						"$ref": "#/definitions/ForeignIdentityContainer"
7239					}
7240				},
7241				"Identity": {
7242					"type": "integer",
7243					"format": "int64",
7244					"xml": {
7245						"name": "Identity",
7246						"attribute": false,
7247						"wrapped": false
7248					},
7249					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
7250					"allowEmptyValue": false
7251				},
7252				"Name": {
7253					"xml": {
7254						"name": "Name",
7255						"attribute": false,
7256						"wrapped": false
7257					},
7258					"description": "Name of the user",
7259					"allowEmptyValue": false,
7260					"$ref": "#/definitions/NameContainer"
7261				},
7262				"PackageRole": {
7263					"type": "string",
7264					"xml": {
7265						"name": "PackageRole",
7266						"attribute": false,
7267						"wrapped": false
7268					},
7269					"description": "The role that this user is fulfilling in this specific package",
7270					"allowEmptyValue": false,
7271					"enum": ["ATTORNEY", "BORROWER", "CLOSING_AGENT", "LOAN_OFFICER", "TITLE_AGENT"]
7272				},
7273				"PartnerViewUri": {
7274					"type": "string",
7275					"xml": {
7276						"name": "PartnerViewUri",
7277						"attribute": false,
7278						"wrapped": false
7279					},
7280					"description": "Supplied by Package.  Contains the URL that opens the third-party application that views and signs the documents.",
7281					"allowEmptyValue": false
7282				},
7283				"PersonalMessage": {
7284					"type": "string",
7285					"xml": {
7286						"name": "PersonalMessage",
7287						"attribute": false,
7288						"wrapped": false
7289					},
7290					"description": "Supplied by Package.  A simple text string message that is included in the recipient UI when this package is being signed.",
7291					"allowEmptyValue": false
7292				},
7293				"PhoneNumber": {
7294					"type": "array",
7295					"xml": {
7296						"name": "PhoneNumbers",
7297						"attribute": false,
7298						"wrapped": true
7299					},
7300					"description": "List of contact phone numbers",
7301					"allowEmptyValue": false,
7302					"items": {
7303						"$ref": "#/definitions/PhoneNumberContainer"
7304					}
7305				},
7306				"Property": {
7307					"type": "array",
7308					"xml": {
7309						"name": "Properties",
7310						"attribute": false,
7311						"wrapped": true
7312					},
7313					"description": "Collection of Key/Value unstructured properties for this user",
7314					"allowEmptyValue": false,
7315					"items": {
7316						"$ref": "#/definitions/UserPropertyContainer"
7317					}
7318				},
7319				"Role": {
7320					"type": "string",
7321					"xml": {
7322						"name": "Role",
7323						"attribute": false,
7324						"wrapped": false
7325					},
7326					"description": "(Talk to Chip about what these are)  ",
7327					"allowEmptyValue": false
7328				},
7329				"SigningOrder": {
7330					"type": "integer",
7331					"format": "int32",
7332					"xml": {
7333						"name": "SigningOrder",
7334						"attribute": false,
7335						"wrapped": false
7336					},
7337					"description": "Supplied by Package.  The order in which this user is to sign the package.",
7338					"allowEmptyValue": false
7339				},
7340				"Tag": {
7341					"type": "string",
7342					"xml": {
7343						"name": "Tag",
7344						"attribute": false,
7345						"wrapped": false
7346					},
7347					"description": "Supplied by Package.  Reference identity tag for this entity used in the context of this DeliveryPackage",
7348					"allowEmptyValue": false
7349				},
7350				"UserState": {
7351					"xml": {
7352						"name": "UserState",
7353						"attribute": false,
7354						"wrapped": false
7355					},
7356					"description": "User-specific state information for this package",
7357					"allowEmptyValue": false,
7358					"$ref": "#/definitions/UserStateContainer"
7359				},
7360				"UserWaybillInfo": {
7361					"xml": {
7362						"name": "UserWaybillInfo",
7363						"attribute": false,
7364						"wrapped": false
7365					},
7366					"description": "Packaging and shipping information needed for print-and-ship processing",
7367					"allowEmptyValue": false,
7368					"$ref": "#/definitions/UserWaybillInfoContainer"
7369				},
7370				"saData": {
7371					"type": "array",
7372					"description": "Placeholder for Settlement Agent data",
7373					"allowEmptyValue": false,
7374					"items": {
7375						"type": "object"
7376					}
7377				}
7378			},
7379			"title": "Recipient",
7380			"xml": {
7381				"name": "Recipient",
7382				"attribute": false,
7383				"wrapped": false
7384			}
7385		},
7386		"ReferenceDocContainer": {
7387			"type": "object",
7388			"required": ["Name", "Url"],
7389			"properties": {
7390				"Name": {
7391					"type": "string",
7392					"xml": {
7393						"name": "Name",
7394						"attribute": false,
7395						"wrapped": false
7396					}
7397				},
7398				"Url": {
7399					"type": "string",
7400					"xml": {
7401						"name": "Url",
7402						"attribute": false,
7403						"wrapped": false
7404					}
7405				}
7406			},
7407			"title": "ReferenceDoc",
7408			"xml": {
7409				"name": "ReferenceDoc",
7410				"attribute": false,
7411				"wrapped": false
7412			}
7413		},
7414		"RejectReason": {
7415			"type": "object",
7416			"properties": {
7417				"Description": {
7418					"type": "string",
7419					"xml": {
7420						"name": "Description",
7421						"attribute": false,
7422						"wrapped": false
7423					},
7424					"description": "Description in case if reject reason selected is Other",
7425					"allowEmptyValue": false
7426				},
7427				"Value": {
7428					"type": "string",
7429					"xml": {
7430						"name": "Value",
7431						"attribute": false,
7432						"wrapped": false
7433					},
7434					"description": "Reject reason for declining workspace consent",
7435					"allowEmptyValue": false
7436				}
7437			},
7438			"title": "RejectReason",
7439			"xml": {
7440				"name": "RejectReason",
7441				"attribute": false,
7442				"wrapped": false
7443			}
7444		},
7445		"ResponseEntity«FormContainer»": {
7446			"type": "object",
7447			"properties": {
7448				"content": {
7449					"$ref": "#/definitions/FormContainer"
7450				},
7451				"notes": {
7452					"type": "string"
7453				},
7454				"status": {
7455					"type": "string",
7456					"enum": ["SUCCESS", "FAILURE"]
7457				}
7458			},
7459			"title": "ResponseEntity«FormContainer»"
7460		},
7461		"ResponseEntity«PropertyContainer»": {
7462			"type": "object",
7463			"properties": {
7464				"content": {
7465					"$ref": "#/definitions/PropertyContainer"
7466				},
7467				"notes": {
7468					"type": "string"
7469				},
7470				"status": {
7471					"type": "string",
7472					"enum": ["SUCCESS", "FAILURE"]
7473				}
7474			},
7475			"title": "ResponseEntity«PropertyContainer»"
7476		},
7477		"ResponseEntity«ReceivedDocumentContainer»": {
7478			"type": "object",
7479			"properties": {
7480				"content": {
7481					"$ref": "#/definitions/ReceivedDocumentContainer"
7482				},
7483				"notes": {
7484					"type": "string"
7485				},
7486				"status": {
7487					"type": "string",
7488					"enum": ["SUCCESS", "FAILURE"]
7489				}
7490			},
7491			"title": "ResponseEntity«ReceivedDocumentContainer»"
7492		},
7493		"ResponseEntity«RecipientUserContainer»": {
7494			"type": "object",
7495			"properties": {
7496				"content": {
7497					"$ref": "#/definitions/RecipientUserContainer"
7498				},
7499				"notes": {
7500					"type": "string"
7501				},
7502				"status": {
7503					"type": "string",
7504					"enum": ["SUCCESS", "FAILURE"]
7505				}
7506			},
7507			"title": "ResponseEntity«RecipientUserContainer»"
7508		},
7509		"ResponseEntity«ViewerOwnerContainer»": {
7510			"type": "object",
7511			"properties": {
7512				"content": {
7513					"$ref": "#/definitions/ViewerOwnerContainer"
7514				},
7515				"notes": {
7516					"type": "string"
7517				},
7518				"status": {
7519					"type": "string",
7520					"enum": ["SUCCESS", "FAILURE"]
7521				}
7522			},
7523			"title": "ResponseEntity«ViewerOwnerContainer»"
7524		},
7525		"ResponseEntity«string»": {
7526			"type": "object",
7527			"properties": {
7528				"content": {
7529					"type": "string",
7530					"enum": ["100", "101", "102", "103", "200", "201", "202", "203", "204", "205", "206", "207", "208", "226", "300", "301", "302", "303", "304", "305", "307", "308", "400", "401", "402", "403", "404", "405", "406", "407", "408", "409", "410", "411", "412", "413", "414", "415", "416", "417", "418", "419", "420", "421", "422", "423", "424", "426", "428", "429", "431", "451", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511"]
7531				},
7532				"notes": {
7533					"type": "string"
7534				},
7535				"status": {
7536					"type": "string",
7537					"enum": ["SUCCESS", "FAILURE"]
7538				}
7539			},
7540			"title": "ResponseEntity«string»"
7541		},
7542		"SenderUserContainer": {
7543			"type": "object",
7544			"properties": {
7545				"AccessRole": {
7546					"type": "array",
7547					"xml": {
7548						"name": "AccessRoles",
7549						"attribute": false,
7550						"wrapped": true
7551					},
7552					"description": "List of roles that determine the access of the user in this package.",
7553					"allowEmptyValue": false,
7554					"items": {
7555						"type": "string",
7556						"enum": ["APPROVER", "RECIPIENT", "SENDER", "VIEWER"]
7557					}
7558				},
7559				"Authentication": {
7560					"xml": {
7561						"name": "Authentication",
7562						"attribute": false,
7563						"wrapped": false
7564					},
7565					"description": "Data related to recipient authentication",
7566					"allowEmptyValue": false,
7567					"$ref": "#/definitions/AuthenticationContainer"
7568				},
7569				"EmailAddress": {
7570					"type": "string",
7571					"xml": {
7572						"name": "EmailAddress",
7573						"attribute": false,
7574						"wrapped": false
7575					},
7576					"description": "Primary email address for this user",
7577					"allowEmptyValue": false
7578				},
7579				"EsignXref": {
7580					"xml": {
7581						"name": "EsignXref",
7582						"attribute": false,
7583						"wrapped": false
7584					},
7585					"description": "Information needed map this recipient to document signatures on pre-mapped documents",
7586					"allowEmptyValue": false,
7587					"$ref": "#/definitions/EsignXrefContainer"
7588				},
7589				"ForeignIdentity": {
7590					"type": "array",
7591					"xml": {
7592						"name": "ForeignIdentities",
7593						"attribute": false,
7594						"wrapped": true
7595					},
7596					"description": "Supplied by Package.  Information on how this object is identified in other systems.",
7597					"allowEmptyValue": false,
7598					"items": {
7599						"$ref": "#/definitions/ForeignIdentityContainer"
7600					}
7601				},
7602				"Identity": {
7603					"type": "integer",
7604					"format": "int64",
7605					"xml": {
7606						"name": "Identity",
7607						"attribute": false,
7608						"wrapped": false
7609					},
7610					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
7611					"allowEmptyValue": false
7612				},
7613				"Name": {
7614					"xml": {
7615						"name": "Name",
7616						"attribute": false,
7617						"wrapped": false
7618					},
7619					"description": "Name of the user",
7620					"allowEmptyValue": false,
7621					"$ref": "#/definitions/NameContainer"
7622				},
7623				"PackageRole": {
7624					"type": "string",
7625					"xml": {
7626						"name": "PackageRole",
7627						"attribute": false,
7628						"wrapped": false
7629					},
7630					"description": "The role that this user is fulfilling in this specific package",
7631					"allowEmptyValue": false,
7632					"enum": ["ATTORNEY", "BORROWER", "CLOSING_AGENT", "LOAN_OFFICER", "TITLE_AGENT"]
7633				},
7634				"PartnerViewUri": {
7635					"type": "string",
7636					"xml": {
7637						"name": "PartnerViewUri",
7638						"attribute": false,
7639						"wrapped": false
7640					},
7641					"description": "Supplied by Package.  Contains the URL that opens the third-party application that views and signs the documents.",
7642					"allowEmptyValue": false
7643				},
7644				"PersonalMessage": {
7645					"type": "string",
7646					"xml": {
7647						"name": "PersonalMessage",
7648						"attribute": false,
7649						"wrapped": false
7650					},
7651					"description": "Supplied by Package.  A simple text string message that is included in the recipient UI when this package is being signed.",
7652					"allowEmptyValue": false
7653				},
7654				"PhoneNumber": {
7655					"type": "array",
7656					"xml": {
7657						"name": "PhoneNumbers",
7658						"attribute": false,
7659						"wrapped": true
7660					},
7661					"description": "List of contact phone numbers",
7662					"allowEmptyValue": false,
7663					"items": {
7664						"$ref": "#/definitions/PhoneNumberContainer"
7665					}
7666				},
7667				"Property": {
7668					"type": "array",
7669					"xml": {
7670						"name": "Properties",
7671						"attribute": false,
7672						"wrapped": true
7673					},
7674					"description": "Collection of Key/Value unstructured properties for this user",
7675					"allowEmptyValue": false,
7676					"items": {
7677						"$ref": "#/definitions/UserPropertyContainer"
7678					}
7679				},
7680				"Role": {
7681					"type": "string",
7682					"xml": {
7683						"name": "Role",
7684						"attribute": false,
7685						"wrapped": false
7686					},
7687					"description": "(Talk to Chip about what these are)  ",
7688					"allowEmptyValue": false
7689				},
7690				"SigningOrder": {
7691					"type": "integer",
7692					"format": "int32",
7693					"xml": {
7694						"name": "SigningOrder",
7695						"attribute": false,
7696						"wrapped": false
7697					},
7698					"description": "Supplied by Package.  The order in which this user is to sign the package.",
7699					"allowEmptyValue": false
7700				},
7701				"Tag": {
7702					"type": "string",
7703					"xml": {
7704						"name": "Tag",
7705						"attribute": false,
7706						"wrapped": false
7707					},
7708					"description": "Supplied by Package.  Reference identity tag for this entity used in the context of this DeliveryPackage",
7709					"allowEmptyValue": false
7710				},
7711				"UserState": {
7712					"xml": {
7713						"name": "UserState",
7714						"attribute": false,
7715						"wrapped": false
7716					},
7717					"description": "User-specific state information for this package",
7718					"allowEmptyValue": false,
7719					"$ref": "#/definitions/UserStateContainer"
7720				},
7721				"UserWaybillInfo": {
7722					"xml": {
7723						"name": "UserWaybillInfo",
7724						"attribute": false,
7725						"wrapped": false
7726					},
7727					"description": "Packaging and shipping information needed for print-and-ship processing",
7728					"allowEmptyValue": false,
7729					"$ref": "#/definitions/UserWaybillInfoContainer"
7730				},
7731				"saData": {
7732					"type": "array",
7733					"description": "Placeholder for Settlement Agent data",
7734					"allowEmptyValue": false,
7735					"items": {
7736						"type": "object"
7737					}
7738				}
7739			},
7740			"title": "Sender",
7741			"xml": {
7742				"name": "Sender",
7743				"attribute": false,
7744				"wrapped": false
7745			}
7746		},
7747		"ShelfDocContainer": {
7748			"type": "object",
7749			"properties": {
7750				"DirtyTemplate": {
7751					"type": "boolean",
7752					"example": false,
7753					"xml": {
7754						"name": "DirtyTemplate",
7755						"attribute": false,
7756						"wrapped": false
7757					},
7758					"description": "When 'true', indicates that that the signature template has been changed but not saved.",
7759					"allowEmptyValue": false
7760				},
7761				"DontPrint": {
7762					"type": "boolean",
7763					"example": false,
7764					"xml": {
7765						"name": "DontPrint",
7766						"attribute": false,
7767						"wrapped": false
7768					},
7769					"description": "Defaults to 'false'. If set to true, the shelf doc will not be printed if package falls to print.",
7770					"allowEmptyValue": false
7771				},
7772				"EncodedImage": {
7773					"type": "string",
7774					"xml": {
7775						"name": "EncodedImage",
7776						"attribute": false,
7777						"wrapped": false
7778					},
7779					"description": "The base-64 encoded image of the complete form in PDF format",
7780					"allowEmptyValue": false
7781				},
7782				"Filename": {
7783					"type": "string",
7784					"xml": {
7785						"name": "Filename",
7786						"attribute": false,
7787						"wrapped": false
7788					},
7789					"description": "The filename of the document used to save it to disk.  Must confirm to Windows and Linux filename rules.",
7790					"allowEmptyValue": false
7791				},
7792				"ForeignIdentity": {
7793					"type": "array",
7794					"xml": {
7795						"name": "ForeignIdentities",
7796						"attribute": false,
7797						"wrapped": true
7798					},
7799					"description": "Supplied by Package.  Information on how this form is identified in other systems.",
7800					"allowEmptyValue": false,
7801					"items": {
7802						"$ref": "#/definitions/ForeignIdentityContainer"
7803					}
7804				},
7805				"FormPostingControl": {
7806					"xml": {
7807						"name": "FormPostingControl",
7808						"attribute": false,
7809						"wrapped": false
7810					},
7811					"description": "Provided by Package.  Information on how this form should be processed during posting.",
7812					"allowEmptyValue": false,
7813					"$ref": "#/definitions/FormPostingControlContainer"
7814				},
7815				"FormRecipient": {
7816					"type": "array",
7817					"xml": {
7818						"name": "FormRecipients",
7819						"attribute": false,
7820						"wrapped": true
7821					},
7822					"description": "List of viewers and signers for this document",
7823					"allowEmptyValue": false,
7824					"items": {
7825						"$ref": "#/definitions/FormRecipientContainer"
7826					}
7827				},
7828				"Identity": {
7829					"type": "integer",
7830					"format": "int64",
7831					"xml": {
7832						"name": "Identity",
7833						"attribute": false,
7834						"wrapped": false
7835					},
7836					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
7837					"allowEmptyValue": false
7838				},
7839				"InsertPosition": {
7840					"type": "string",
7841					"xml": {
7842						"name": "InsertPosition",
7843						"attribute": false,
7844						"wrapped": false
7845					},
7846					"description": "Defaults to \\\"append\\\". Can also be the index of the document (1, 2, 3, etc.)",
7847					"allowEmptyValue": false
7848				},
7849				"IsShelfDoc": {
7850					"type": "boolean",
7851					"example": false,
7852					"xml": {
7853						"name": "IsShelfDoc",
7854						"attribute": false,
7855						"wrapped": false
7856					},
7857					"description": "If this document is a shelf doc, set to true",
7858					"allowEmptyValue": false
7859				},
7860				"Key": {
7861					"type": "string",
7862					"xml": {
7863						"name": "Key",
7864						"attribute": false,
7865						"wrapped": false
7866					},
7867					"description": "Config Key that holds the zip for the shelf doc",
7868					"allowEmptyValue": false
7869				},
7870				"MismoSmartDoc": {
7871					"xml": {
7872						"name": "MismoSmartDoc",
7873						"attribute": false,
7874						"wrapped": false
7875					},
7876					"description": "Placehodler for future MISMO SMARTDoc structure for this form",
7877					"allowEmptyValue": false,
7878					"$ref": "#/definitions/MismoSmartDoc"
7879				},
7880				"Name": {
7881					"type": "string",
7882					"xml": {
7883						"name": "Name",
7884						"attribute": false,
7885						"wrapped": false
7886					},
7887					"description": "Name of the document used for display in the UI",
7888					"allowEmptyValue": false
7889				},
7890				"NotaryRequired": {
7891					"type": "boolean",
7892					"example": false,
7893					"xml": {
7894						"name": "NotaryRequired",
7895						"attribute": false,
7896						"wrapped": false
7897					},
7898					"description": "When 'true', indicates that this document requires notarization.",
7899					"allowEmptyValue": false
7900				},
7901				"Page": {
7902					"type": "array",
7903					"xml": {
7904						"name": "Pages",
7905						"attribute": false,
7906						"wrapped": true
7907					},
7908					"description": "Data about the individual pages in the document",
7909					"allowEmptyValue": false,
7910					"items": {
7911						"$ref": "#/definitions/PageContainer"
7912					}
7913				},
7914				"PersonalMessage": {
7915					"type": "string",
7916					"xml": {
7917						"name": "PersonalMessage",
7918						"attribute": false,
7919						"wrapped": false
7920					},
7921					"description": "Supplied by Package.  A simple text string message that is included in the recipient UI when this package is being signed.",
7922					"allowEmptyValue": false
7923				},
7924				"PrintAndSign": {
7925					"type": "boolean",
7926					"example": false,
7927					"xml": {
7928						"name": "PrintAndSign",
7929						"attribute": false,
7930						"wrapped": false
7931					},
7932					"description": "When 'true', indicates that this is a document  that must be printed and wet signed.",
7933					"allowEmptyValue": false
7934				},
7935				"Property": {
7936					"type": "array",
7937					"xml": {
7938						"name": "Properties",
7939						"attribute": false,
7940						"wrapped": true
7941					},
7942					"description": "Key/Value data pairs to hold custom data required by the customer/partner",
7943					"allowEmptyValue": false,
7944					"items": {
7945						"$ref": "#/definitions/PropertyContainer"
7946					}
7947				},
7948				"ReviewRequired": {
7949					"type": "boolean",
7950					"example": false,
7951					"xml": {
7952						"name": "ReviewRequired",
7953						"attribute": false,
7954						"wrapped": false
7955					},
7956					"description": "If 'true', indicates that this document must be viewed or signed.",
7957					"allowEmptyValue": false
7958				},
7959				"ShelfDocKey": {
7960					"type": "string",
7961					"xml": {
7962						"name": "ShelfDocKey",
7963						"attribute": false,
7964						"wrapped": false
7965					},
7966					"description": "Key used to generate the shelf doc.  System generated",
7967					"allowEmptyValue": false
7968				},
7969				"Signable": {
7970					"type": "boolean",
7971					"example": false,
7972					"xml": {
7973						"name": "Signable",
7974						"attribute": false,
7975						"wrapped": false
7976					},
7977					"description": "If 'true', indicates that this document can be signed.",
7978					"allowEmptyValue": false
7979				},
7980				"Size": {
7981					"type": "integer",
7982					"format": "int64",
7983					"xml": {
7984						"name": "Size",
7985						"attribute": false,
7986						"wrapped": false
7987					},
7988					"description": "Size of the document disk file",
7989					"allowEmptyValue": false
7990				},
7991				"SortOrder": {
7992					"type": "integer",
7993					"format": "int32",
7994					"xml": {
7995						"name": "SortOrder",
7996						"attribute": false,
7997						"wrapped": false
7998					},
7999					"description": "The order that the documents must be presented to the recipient",
8000					"allowEmptyValue": false
8001				},
8002				"Tag": {
8003					"type": "string",
8004					"xml": {
8005						"name": "Tag",
8006						"attribute": false,
8007						"wrapped": false
8008					},
8009					"description": "Supplied by Package.  Reference identity tag for this entity used in the context of this DeliveryPackage",
8010					"allowEmptyValue": false
8011				},
8012				"TemplateName": {
8013					"type": "string",
8014					"xml": {
8015						"name": "TemplateName",
8016						"attribute": false,
8017						"wrapped": false
8018					},
8019					"description": "Name of the signature template for this document",
8020					"allowEmptyValue": false
8021				},
8022				"UploadDate": {
8023					"type": "string",
8024					"format": "date-time",
8025					"xml": {
8026						"name": "UploadDate",
8027						"attribute": false,
8028						"wrapped": false
8029					},
8030					"description": "Timestamp when the doucment was uploaded",
8031					"allowEmptyValue": false
8032				},
8033				"WSFileId": {
8034					"type": "string",
8035					"xml": {
8036						"name": "WSFileId",
8037						"attribute": false,
8038						"wrapped": false
8039					},
8040					"description": "Identifier of the document file within the workspace",
8041					"allowEmptyValue": false
8042				}
8043			},
8044			"title": "ShelfDoc",
8045			"xml": {
8046				"name": "ShelfDoc",
8047				"attribute": false,
8048				"wrapped": false
8049			}
8050		},
8051		"SignatureContainer": {
8052			"type": "object",
8053			"properties": {
8054				"AccountId": {
8055					"type": "integer",
8056					"format": "int64",
8057					"xml": {
8058						"name": "AccountId",
8059						"attribute": false,
8060						"wrapped": false
8061					},
8062					"description": "Supplied by System.  Identity of the Account that is linked to this field.",
8063					"allowEmptyValue": false
8064				},
8065				"Conditional": {
8066					"type": "string",
8067					"xml": {
8068						"name": "Conditional",
8069						"attribute": false,
8070						"wrapped": false
8071					},
8072					"description": "Supplied by Package.  String used to determine if the signature is enabled or not.  (format needs documenting)",
8073					"allowEmptyValue": false
8074				},
8075				"CoordinateType": {
8076					"type": "string",
8077					"xml": {
8078						"name": "CoordinateType",
8079						"attribute": false,
8080						"wrapped": false
8081					},
8082					"description": "If this is PDF or Screen coordinates.  Defaults to Screen coordinates",
8083					"allowEmptyValue": false,
8084					"enum": ["PDF", "SCREEN"]
8085				},
8086				"CustomFieldName": {
8087					"type": "string",
8088					"xml": {
8089						"name": "CustomFieldName",
8090						"attribute": false,
8091						"wrapped": false
8092					},
8093					"description": "Supplied by System Only.  Used to store a field name for template management when a predefined custom field is used.  This is only ephemeral data between the mapping application and package management.",
8094					"allowEmptyValue": false
8095				},
8096				"Enabled": {
8097					"type": "boolean",
8098					"example": false,
8099					"xml": {
8100						"name": "Enabled",
8101						"attribute": false,
8102						"wrapped": false
8103					},
8104					"description": "Supplied by system.  True if the field is currently enabled.  This is calculated based on linking logic.",
8105					"allowEmptyValue": false
8106				},
8107				"FieldName": {
8108					"type": "string",
8109					"xml": {
8110						"name": "FieldName",
8111						"attribute": false,
8112						"wrapped": false
8113					},
8114					"description": "Name of the field, if applicable",
8115					"allowEmptyValue": false
8116				},
8117				"Format": {
8118					"xml": {
8119						"name": "Format",
8120						"attribute": false,
8121						"wrapped": false
8122					},
8123					"description": "Formatting information for the field.  Allows field either to be masked (predefined format) or specify max length",
8124					"allowEmptyValue": false,
8125					"$ref": "#/definitions/Format"
8126				},
8127				"Height": {
8128					"type": "integer",
8129					"format": "int32",
8130					"xml": {
8131						"name": "Height",
8132						"attribute": false,
8133						"wrapped": false
8134					},
8135					"description": "Supplied by Package or Sigmapper.  Height of the field in Points.",
8136					"allowEmptyValue": false
8137				},
8138				"Identity": {
8139					"type": "integer",
8140					"format": "int64",
8141					"xml": {
8142						"name": "Identity",
8143						"attribute": false,
8144						"wrapped": false
8145					},
8146					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
8147					"allowEmptyValue": false
8148				},
8149				"Left": {
8150					"type": "integer",
8151					"format": "int32",
8152					"xml": {
8153						"name": "Left",
8154						"attribute": false,
8155						"wrapped": false
8156					},
8157					"description": "Supplied by Package or Sigmapper.  X-position of the top left of the field as measured from the left of the page.  Units are in Points. ",
8158					"allowEmptyValue": false
8159				},
8160				"Link": {
8161					"type": "array",
8162					"xml": {
8163						"name": "Links",
8164						"attribute": false,
8165						"wrapped": true
8166					},
8167					"description": "List of links to other fields.",
8168					"allowEmptyValue": false,
8169					"items": {
8170						"$ref": "#/definitions/Link"
8171					}
8172				},
8173				"RecipientTag": {
8174					"type": "string",
8175					"xml": {
8176						"name": "RecipientTag",
8177						"attribute": false,
8178						"wrapped": false
8179					},
8180					"description": "Supplied by Package or Sigmapper.  Tag of the Recipient that is signing this field.",
8181					"allowEmptyValue": false
8182				},
8183				"Required": {
8184					"type": "boolean",
8185					"example": false,
8186					"xml": {
8187						"name": "Required",
8188						"attribute": false,
8189						"wrapped": false
8190					},
8191					"description": "Supplied by Pacakge.  If 'true' indicates that the field must be signed/entered for package completion.",
8192					"allowEmptyValue": false
8193				},
8194				"Tag": {
8195					"type": "string",
8196					"xml": {
8197						"name": "Tag",
8198						"attribute": false,
8199						"wrapped": false
8200					},
8201					"description": "Supplied by Package or Sigmapper.  Reference identity tag for this entity used in the context of this DeliveryPackage",
8202					"allowEmptyValue": false
8203				},
8204				"Tooltip": {
8205					"type": "string",
8206					"xml": {
8207						"name": "Tooltip",
8208						"attribute": false,
8209						"wrapped": false
8210					},
8211					"description": "Tooltip to be displayed when recipient hovers over field.  Provides extra contextual information.",
8212					"allowEmptyValue": false
8213				},
8214				"Top": {
8215					"type": "integer",
8216					"format": "int32",
8217					"xml": {
8218						"name": "Top",
8219						"attribute": false,
8220						"wrapped": false
8221					},
8222					"description": "Supplied by Package or Sigmapper.  Y-position of the top left of the field as measured from the bottom of the page.  Units are in Points. ",
8223					"allowEmptyValue": false
8224				},
8225				"Type": {
8226					"type": "string",
8227					"xml": {
8228						"name": "Type",
8229						"attribute": false,
8230						"wrapped": false
8231					},
8232					"description": "The type of signature required for this field, either 'initial' or 'signature'",
8233					"allowEmptyValue": false,
8234					"enum": ["SIGNATURE", "INITIAL"]
8235				},
8236				"UpdateDate": {
8237					"type": "string",
8238					"format": "date-time",
8239					"xml": {
8240						"name": "UpdateDate",
8241						"attribute": false,
8242						"wrapped": false
8243					},
8244					"description": "Supplied by System.  Timestamp of the last time that this field data was entered.",
8245					"allowEmptyValue": false
8246				},
8247				"Value": {
8248					"type": "string",
8249					"xml": {
8250						"name": "Value",
8251						"attribute": false,
8252						"wrapped": false
8253					},
8254					"description": "Supplied by System Only.  Current value of this field as entered by the user.",
8255					"allowEmptyValue": false
8256				},
8257				"Width": {
8258					"type": "integer",
8259					"format": "int32",
8260					"xml": {
8261						"name": "Width",
8262						"attribute": false,
8263						"wrapped": false
8264					},
8265					"description": "Supplied by Package or Sigmapper.  Width of the field in Points.",
8266					"allowEmptyValue": false
8267				}
8268			},
8269			"title": "Signature",
8270			"xml": {
8271				"name": "Signature",
8272				"attribute": false,
8273				"wrapped": false
8274			}
8275		},
8276		"TemplateMappingContainer": {
8277			"type": "object",
8278			"properties": {
8279				"ApplyMapping": {
8280					"type": "boolean",
8281					"example": false,
8282					"xml": {
8283						"name": "ApplyMapping",
8284						"attribute": false,
8285						"wrapped": false
8286					},
8287					"description": "When 'true', and posting type is eSignature, attempt to find a template to match the document and apply the field mappings.  This is used when the sender cannot provide signature/field mappings on their own.  ",
8288					"allowEmptyValue": false
8289				},
8290				"PassUnmatchedDocument": {
8291					"type": "boolean",
8292					"example": false,
8293					"xml": {
8294						"name": "PassUnmatchedDocument",
8295						"attribute": false,
8296						"wrapped": false
8297					},
8298					"description": "When 'true', a miss on the signature template lookup is expected.  The unrecognized document will be marked as a non-signable document going to all recipient(s).  Package will post lights-out to recipients unless the pacakge 'Hold' flag is set.   When 'false', a signature template lookup miss will cause the package to be held in the Package Manager for manual disposition.",
8299					"allowEmptyValue": false
8300				}
8301			},
8302			"title": "TemplateMapping",
8303			"xml": {
8304				"name": "TemplateMapping",
8305				"attribute": false,
8306				"wrapped": false
8307			}
8308		},
8309		"UploadRequestContainer": {
8310			"type": "object",
8311			"properties": {
8312				"Item": {
8313					"type": "array",
8314					"xml": {
8315						"name": "Items",
8316						"attribute": false,
8317						"wrapped": true
8318					},
8319					"description": "Collection of documentation requested by this Upload Reqeust",
8320					"allowEmptyValue": false,
8321					"items": {
8322						"$ref": "#/definitions/UploadRequestItemContainer"
8323					}
8324				},
8325				"UploadRequestAutoComplete": {
8326					"type": "boolean",
8327					"example": false,
8328					"xml": {
8329						"name": "UploadRequestAutoComplete",
8330						"attribute": false,
8331						"wrapped": false
8332					},
8333					"description": "When 'true', indicates that this upload request contains the requested document(s), and should be automatically completed when it is created.",
8334					"allowEmptyValue": false
8335				},
8336				"UploadRequestReturn": {
8337					"xml": {
8338						"name": "UploadRequestReturn",
8339						"attribute": false,
8340						"wrapped": false
8341					},
8342					"description": "Data required to process the return shipping of Upload Requests",
8343					"allowEmptyValue": false,
8344					"$ref": "#/definitions/UploadRequestReturnContainer"
8345				}
8346			},
8347			"title": "UploadRequest",
8348			"xml": {
8349				"name": "UploadRequest",
8350				"attribute": false,
8351				"wrapped": false
8352			}
8353		},
8354		"UploadRequestItemContainer": {
8355			"type": "object",
8356			"properties": {
8357				"EncodedImage": {
8358					"type": "string",
8359					"xml": {
8360						"name": "EncodedImage",
8361						"attribute": false,
8362						"wrapped": false
8363					},
8364					"description": "The base-64 encoded image of the document that completes this upload request.  (This allows simultaneous creation and satisfaction of an upload request)",
8365					"allowEmptyValue": false
8366				},
8367				"Filename": {
8368					"type": "string",
8369					"xml": {
8370						"name": "Filename",
8371						"attribute": false,
8372						"wrapped": false
8373					},
8374					"description": "The filename of the document used to save it to disk.  Must confirm to Windows and Linux filename rules.",
8375					"allowEmptyValue": false
8376				},
8377				"ForeignIdentity": {
8378					"type": "array",
8379					"xml": {
8380						"name": "ForeignIdentities",
8381						"attribute": false,
8382						"wrapped": true
8383					},
8384					"description": "Supplied by Package.  Information on how this object is identified in other systems.",
8385					"allowEmptyValue": false,
8386					"items": {
8387						"$ref": "#/definitions/ForeignIdentityContainer"
8388					}
8389				},
8390				"Identity": {
8391					"type": "integer",
8392					"format": "int64",
8393					"xml": {
8394						"name": "Identity",
8395						"attribute": false,
8396						"wrapped": false
8397					},
8398					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
8399					"allowEmptyValue": false
8400				},
8401				"Name": {
8402					"type": "string",
8403					"xml": {
8404						"name": "Name",
8405						"attribute": false,
8406						"wrapped": false
8407					},
8408					"description": "Name for this upload request item for use in the UI",
8409					"allowEmptyValue": false
8410				},
8411				"PersonalMessage": {
8412					"type": "string",
8413					"xml": {
8414						"name": "PersonalMessage",
8415						"attribute": false,
8416						"wrapped": false
8417					},
8418					"description": "Supplied by Package.  A simple text string message that is included in the recipient UI for this upload request item.",
8419					"allowEmptyValue": false
8420				},
8421				"Tag": {
8422					"type": "string",
8423					"xml": {
8424						"name": "Tag",
8425						"attribute": false,
8426						"wrapped": false
8427					},
8428					"description": "Supplied by Package.  Reference identity tag for this entity used in the context of this DeliveryPackage",
8429					"allowEmptyValue": false
8430				},
8431				"UploadRequestRecipient": {
8432					"type": "array",
8433					"xml": {
8434						"name": "UploadRequestRecipients",
8435						"attribute": false,
8436						"wrapped": true
8437					},
8438					"items": {
8439						"$ref": "#/definitions/UploadRequestRecipientContainer"
8440					}
8441				}
8442			},
8443			"title": "Item",
8444			"xml": {
8445				"name": "Item",
8446				"attribute": false,
8447				"wrapped": false
8448			}
8449		},
8450		"UploadRequestRecipientContainer": {
8451			"type": "object",
8452			"properties": {
8453				"AccountIdentity": {
8454					"type": "integer",
8455					"format": "int64",
8456					"xml": {
8457						"name": "AccountIdentity",
8458						"attribute": false,
8459						"wrapped": false
8460					},
8461					"description": "Identity value of the recipient user account",
8462					"allowEmptyValue": false
8463				},
8464				"ItemState": {
8465					"xml": {
8466						"name": "ItemState",
8467						"attribute": false,
8468						"wrapped": false
8469					},
8470					"description": "State indicators for this recipient with respect to this upload request item",
8471					"allowEmptyValue": false,
8472					"$ref": "#/definitions/ItemStateContainer"
8473				},
8474				"ReceivedDocument": {
8475					"type": "array",
8476					"xml": {
8477						"name": "ReceivedDocuments",
8478						"attribute": false,
8479						"wrapped": true
8480					},
8481					"description": "Collection of documents uploaded from this recipient",
8482					"allowEmptyValue": false,
8483					"items": {
8484						"$ref": "#/definitions/ReceivedDocumentContainer"
8485					}
8486				},
8487				"RecipientTag": {
8488					"type": "string",
8489					"xml": {
8490						"name": "RecipientTag",
8491						"attribute": false,
8492						"wrapped": false
8493					},
8494					"description": "Tag value of the recipient of this form",
8495					"allowEmptyValue": false
8496				}
8497			},
8498			"title": "UploadRequestRecipient",
8499			"xml": {
8500				"name": "UploadRequestRecipient",
8501				"attribute": false,
8502				"wrapped": false
8503			}
8504		},
8505		"UploadRequestReturnContainer": {
8506			"type": "object",
8507			"properties": {
8508				"Address": {
8509					"xml": {
8510						"name": "Address",
8511						"attribute": false,
8512						"wrapped": false
8513					},
8514					"description": "Supplied by Package.  Mailing address for upload requests.",
8515					"allowEmptyValue": false,
8516					"$ref": "#/definitions/AddressContainer"
8517				},
8518				"AllowWaybill": {
8519					"type": "boolean",
8520					"example": false,
8521					"xml": {
8522						"name": "AllowWaybill",
8523						"attribute": false,
8524						"wrapped": false
8525					},
8526					"description": "Supplied by Package.  When 'true' indicates that the pacakge recipents are allowed to print a waybill to return documents requested via Upload Request.",
8527					"allowEmptyValue": false
8528				},
8529				"Carrier": {
8530					"type": "string",
8531					"xml": {
8532						"name": "Carrier",
8533						"attribute": false,
8534						"wrapped": false
8535					},
8536					"description": "Supplied by Package.  The carrier to use for this package.",
8537					"allowEmptyValue": false,
8538					"enum": ["FED_EX", "UPS", "USPS"]
8539				},
8540				"ServiceClass": {
8541					"type": "string",
8542					"xml": {
8543						"name": "ServiceClass",
8544						"attribute": false,
8545						"wrapped": false
8546					},
8547					"description": "Supplied by Package.  The class of delivery service requested for this package.  (Ex. 3Day, Overnight)",
8548					"allowEmptyValue": false
8549				}
8550			},
8551			"title": "UploadRequestReturn",
8552			"xml": {
8553				"name": "UploadRequestReturn",
8554				"attribute": false,
8555				"wrapped": false
8556			}
8557		},
8558		"UserContainer": {
8559			"type": "object",
8560			"properties": {
8561				"Href": {
8562					"type": "string",
8563					"description": "API endpoint to reference this object."
8564				},
8565				"AccessRole": {
8566					"type": "array",
8567					"xml": {
8568						"name": "AccessRoles",
8569						"attribute": false,
8570						"wrapped": true
8571					},
8572					"description": "List of roles that determine the access of the user in this package.",
8573					"allowEmptyValue": false,
8574					"items": {
8575						"type": "string",
8576						"enum": ["APPROVER", "RECIPIENT", "SENDER", "VIEWER"]
8577					}
8578				},
8579				"Authentication": {
8580					"xml": {
8581						"name": "Authentication",
8582						"attribute": false,
8583						"wrapped": false
8584					},
8585					"description": "Data related to recipient authentication",
8586					"allowEmptyValue": false,
8587					"$ref": "#/definitions/AuthenticationContainer"
8588				},
8589				"EmailAddress": {
8590					"type": "string",
8591					"xml": {
8592						"name": "EmailAddress",
8593						"attribute": false,
8594						"wrapped": false
8595					},
8596					"description": "Primary email address for this user",
8597					"allowEmptyValue": false
8598				},
8599				"EsignXref": {
8600					"xml": {
8601						"name": "EsignXref",
8602						"attribute": false,
8603						"wrapped": false
8604					},
8605					"description": "Information needed map this recipient to document signatures on pre-mapped documents",
8606					"allowEmptyValue": false,
8607					"$ref": "#/definitions/EsignXrefContainer"
8608				},
8609				"ForeignIdentity": {
8610					"type": "array",
8611					"xml": {
8612						"name": "ForeignIdentities",
8613						"attribute": false,
8614						"wrapped": true
8615					},
8616					"description": "Supplied by Package.  Information on how this object is identified in other systems.",
8617					"allowEmptyValue": false,
8618					"items": {
8619						"$ref": "#/definitions/ForeignIdentityContainer"
8620					}
8621				},
8622				"Identity": {
8623					"type": "integer",
8624					"format": "int64",
8625					"xml": {
8626						"name": "Identity",
8627						"attribute": false,
8628						"wrapped": false
8629					},
8630					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
8631					"allowEmptyValue": false
8632				},
8633				"Name": {
8634					"xml": {
8635						"name": "Name",
8636						"attribute": false,
8637						"wrapped": false
8638					},
8639					"description": "Name of the user",
8640					"allowEmptyValue": false,
8641					"$ref": "#/definitions/NameContainer"
8642				},
8643				"PackageRole": {
8644					"type": "string",
8645					"xml": {
8646						"name": "PackageRole",
8647						"attribute": false,
8648						"wrapped": false
8649					},
8650					"description": "The role that this user is fulfilling in this specific package",
8651					"allowEmptyValue": false,
8652					"enum": ["ATTORNEY", "BORROWER", "CLOSING_AGENT", "LOAN_OFFICER", "TITLE_AGENT"]
8653				},
8654				"PartnerViewUri": {
8655					"type": "string",
8656					"xml": {
8657						"name": "PartnerViewUri",
8658						"attribute": false,
8659						"wrapped": false
8660					},
8661					"description": "Supplied by Package.  Contains the URL that opens the third-party application that views and signs the documents.",
8662					"allowEmptyValue": false
8663				},
8664				"PersonalMessage": {
8665					"type": "string",
8666					"xml": {
8667						"name": "PersonalMessage",
8668						"attribute": false,
8669						"wrapped": false
8670					},
8671					"description": "Supplied by Package.  A simple text string message that is included in the recipient UI when this package is being signed.",
8672					"allowEmptyValue": false
8673				},
8674				"PhoneNumber": {
8675					"type": "array",
8676					"xml": {
8677						"name": "PhoneNumbers",
8678						"attribute": false,
8679						"wrapped": true
8680					},
8681					"description": "List of contact phone numbers",
8682					"allowEmptyValue": false,
8683					"items": {
8684						"$ref": "#/definitions/PhoneNumberContainer"
8685					}
8686				},
8687				"Property": {
8688					"type": "array",
8689					"xml": {
8690						"name": "Properties",
8691						"attribute": false,
8692						"wrapped": true
8693					},
8694					"description": "Collection of Key/Value unstructured properties for this user",
8695					"allowEmptyValue": false,
8696					"items": {
8697						"$ref": "#/definitions/UserPropertyContainer"
8698					}
8699				},
8700				"Role": {
8701					"type": "string",
8702					"xml": {
8703						"name": "Role",
8704						"attribute": false,
8705						"wrapped": false
8706					},
8707					"description": "(Talk to Chip about what these are)  ",
8708					"allowEmptyValue": false
8709				},
8710				"SigningOrder": {
8711					"type": "integer",
8712					"format": "int32",
8713					"xml": {
8714						"name": "SigningOrder",
8715						"attribute": false,
8716						"wrapped": false
8717					},
8718					"description": "Supplied by Package.  The order in which this user is to sign the package.",
8719					"allowEmptyValue": false
8720				},
8721				"Tag": {
8722					"type": "string",
8723					"xml": {
8724						"name": "Tag",
8725						"attribute": false,
8726						"wrapped": false
8727					},
8728					"description": "Supplied by Package.  Reference identity tag for this entity used in the context of this DeliveryPackage",
8729					"allowEmptyValue": false
8730				},
8731				"UserState": {
8732					"xml": {
8733						"name": "UserState",
8734						"attribute": false,
8735						"wrapped": false
8736					},
8737					"description": "User-specific state information for this package",
8738					"allowEmptyValue": false,
8739					"$ref": "#/definitions/UserStateContainer"
8740				},
8741				"UserWaybillInfo": {
8742					"xml": {
8743						"name": "UserWaybillInfo",
8744						"attribute": false,
8745						"wrapped": false
8746					},
8747					"description": "Packaging and shipping information needed for print-and-ship processing",
8748					"allowEmptyValue": false,
8749					"$ref": "#/definitions/UserWaybillInfoContainer"
8750				},
8751				"saData": {
8752					"type": "array",
8753					"description": "Placeholder for Settlement Agent data",
8754					"allowEmptyValue": false,
8755					"items": {
8756						"type": "object"
8757					}
8758				}
8759			},
8760			"title": "UserContainer",
8761			"xml": {
8762				"name": "UserContainer",
8763				"attribute": false,
8764				"wrapped": false
8765			}
8766		},
8767		"UserPropertyContainer": {
8768			"type": "object",
8769			"properties": {
8770				"Identity": {
8771					"type": "string",
8772					"xml": {
8773						"name": "Identity",
8774						"attribute": false,
8775						"wrapped": false
8776					},
8777					"description": "Internal ID for this property",
8778					"allowEmptyValue": false
8779				},
8780				"Key": {
8781					"type": "string",
8782					"xml": {
8783						"name": "Key",
8784						"attribute": false,
8785						"wrapped": false
8786					},
8787					"description": "Parameter name for this property",
8788					"allowEmptyValue": false
8789				},
8790				"Owner": {
8791					"xml": {
8792						"name": "Owner",
8793						"attribute": false,
8794						"wrapped": false
8795					},
8796					"description": "System assigned.  The organizatgion that owns this property.",
8797					"allowEmptyValue": false,
8798					"$ref": "#/definitions/OwnerContainer"
8799				},
8800				"PropertyRelationshipType": {
8801					"type": "string",
8802					"xml": {
8803						"name": "PropertyRelationshipType",
8804						"attribute": false,
8805						"wrapped": false
8806					},
8807					"description": "Specifies whether this Property is globally attached to the user (value = User), attached to the user in the context of this package (value = Package), or attached to the user in the context of this workspace (value = Workspace).  Default is User.",
8808					"allowEmptyValue": false,
8809					"enum": ["USER", "PACKAGE", "WORKSPACE"]
8810				},
8811				"Value": {
8812					"type": "string",
8813					"xml": {
8814						"name": "Value",
8815						"attribute": false,
8816						"wrapped": false
8817					},
8818					"description": "Value of this property",
8819					"allowEmptyValue": false
8820				},
8821				"ViewAll": {
8822					"type": "boolean",
8823					"example": false,
8824					"xml": {
8825						"name": "ViewAll",
8826						"attribute": false,
8827						"wrapped": false
8828					},
8829					"description": "When 'true', allows users that have view permission of the parent entity to view this Property.",
8830					"allowEmptyValue": false
8831				},
8832				"Viewer": {
8833					"type": "array",
8834					"xml": {
8835						"name": "Viewers",
8836						"attribute": false,
8837						"wrapped": true
8838					},
8839					"description": "Accounts or organizations permitted to view this property",
8840					"allowEmptyValue": false,
8841					"items": {
8842						"$ref": "#/definitions/ViewerOwnerContainer"
8843					}
8844				}
8845			},
8846			"title": "Property",
8847			"xml": {
8848				"name": "Property",
8849				"attribute": false,
8850				"wrapped": false
8851			}
8852		},
8853		"UserReferenceContainer": {
8854			"type": "object",
8855			"properties": {
8856				"UserIdentity": {
8857					"type": "string",
8858					"xml": {
8859						"name": "UserIdentity",
8860						"attribute": false,
8861						"wrapped": false
8862					},
8863					"description": "The internal Expedite index or identity value for this record.",
8864					"allowEmptyValue": false
8865				},
8866				"UserTag": {
8867					"type": "string",
8868					"xml": {
8869						"name": "UserTag",
8870						"attribute": false,
8871						"wrapped": false
8872					},
8873					"description": "Reference identity tag for this entity used in the context of this DeliveryPackage",
8874					"allowEmptyValue": false
8875				}
8876			},
8877			"title": "UserReference",
8878			"xml": {
8879				"name": "UserReference",
8880				"attribute": false,
8881				"wrapped": false
8882			}
8883		},
8884		"UserStateContainer": {
8885			"type": "object",
8886			"properties": {
8887				"Complete": {
8888					"type": "boolean",
8889					"example": false,
8890					"xml": {
8891						"name": "Complete",
8892						"attribute": false,
8893						"wrapped": false
8894					},
8895					"description": "Supplied by System.  'true' if the current package is complete for this user",
8896					"allowEmptyValue": false
8897				},
8898				"Declined": {
8899					"type": "boolean",
8900					"example": false,
8901					"xml": {
8902						"name": "Declined",
8903						"attribute": false,
8904						"wrapped": false
8905					},
8906					"description": "Supplied by System.  'True' if this user has declined consent.",
8907					"allowEmptyValue": false
8908				},
8909				"DeclinedReason": {
8910					"type": "array",
8911					"xml": {
8912						"name": "DeclinedReasons",
8913						"attribute": false,
8914						"wrapped": true
8915					},
8916					"description": "Collection of reasons that the user declined to execute the package electronically.",
8917					"allowEmptyValue": false,
8918					"items": {
8919						"type": "string"
8920					}
8921				},
8922				"Downloaded": {
8923					"type": "boolean",
8924					"example": false,
8925					"xml": {
8926						"name": "Downloaded",
8927						"attribute": false,
8928						"wrapped": false
8929					},
8930					"description": "Supplied by System.  'True' if user has downloaded at least one PDF copy of a document in this package.",
8931					"allowEmptyValue": false
8932				},
8933				"Viewed": {
8934					"type": "boolean",
8935					"example": false,
8936					"xml": {
8937						"name": "Viewed",
8938						"attribute": false,
8939						"wrapped": false
8940					},
8941					"description": "Supplied by System.  'True' if user has viewed at least one imaged version of doucment in this package",
8942					"allowEmptyValue": false
8943				}
8944			},
8945			"title": "UserState",
8946			"xml": {
8947				"name": "UserState",
8948				"attribute": false,
8949				"wrapped": false
8950			}
8951		},
8952		"UserWaybillInfoContainer": {
8953			"type": "object",
8954			"properties": {
8955				"CreatedWaybill": {
8956					"type": "array",
8957					"xml": {
8958						"name": "CreatedWaybills",
8959						"attribute": false,
8960						"wrapped": true
8961					},
8962					"description": "Information about waybills that have been created for this package",
8963					"allowEmptyValue": false,
8964					"items": {
8965						"$ref": "#/definitions/WaybillCreatedDetailContainer"
8966					}
8967				},
8968				"EpaperState": {
8969					"xml": {
8970						"name": "EpaperState",
8971						"attribute": false,
8972						"wrapped": false
8973					},
8974					"$ref": "#/definitions/EpaperStateContainer"
8975				},
8976				"WaybillShippingAddress": {
8977					"xml": {
8978						"name": "WaybillShippingAddress",
8979						"attribute": false,
8980						"wrapped": false
8981					},
8982					"description": "Address the package is to be shipped to",
8983					"allowEmptyValue": false,
8984					"$ref": "#/definitions/WaybillShippingAddressWaybillAddressContainer"
8985				}
8986			},
8987			"title": "UserWaybillInfo",
8988			"xml": {
8989				"name": "UserWaybillInfo",
8990				"attribute": false,
8991				"wrapped": false
8992			}
8993		},
8994		"ViewerOwnerContainer": {
8995			"type": "object",
8996			"properties": {
8997				"AccountLookup": {
8998					"xml": {
8999						"name": "AccountLookup",
9000						"attribute": false,
9001						"wrapped": false
9002					},
9003					"description": "Parameters to use to lookup this owner in the Account table",
9004					"allowEmptyValue": false,
9005					"$ref": "#/definitions/AccountLookupContainer"
9006				},
9007				"Identity": {
9008					"type": "integer",
9009					"format": "int64",
9010					"xml": {
9011						"name": "Identity",
9012						"attribute": false,
9013						"wrapped": false
9014					},
9015					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
9016					"allowEmptyValue": false
9017				},
9018				"OrganizationName": {
9019					"type": "string",
9020					"xml": {
9021						"name": "OrganizationName",
9022						"attribute": false,
9023						"wrapped": false
9024					}
9025				},
9026				"OwnerClass": {
9027					"type": "string",
9028					"xml": {
9029						"name": "OwnerClass",
9030						"attribute": false,
9031						"wrapped": false
9032					},
9033					"description": "Specifies the class of the owner of this entity, either Account or Customer",
9034					"allowEmptyValue": false,
9035					"enum": ["ACCOUNT", "ORGANIZATION"]
9036				}
9037			},
9038			"title": "Viewer",
9039			"xml": {
9040				"name": "Viewer",
9041				"attribute": false,
9042				"wrapped": false
9043			}
9044		},
9045		"WaybillCreatedDetailContainer": {
9046			"type": "object",
9047			"properties": {
9048				"Carrier": {
9049					"type": "string",
9050					"xml": {
9051						"name": "Carrier",
9052						"attribute": false,
9053						"wrapped": false
9054					},
9055					"description": "Supplied by Package.  The carrier to use for this package.",
9056					"allowEmptyValue": false,
9057					"enum": ["FED_EX", "UPS", "USPS"]
9058				},
9059				"DeliveryPackaging": {
9060					"type": "string",
9061					"xml": {
9062						"name": "DeliveryPackaging",
9063						"attribute": false,
9064						"wrapped": false
9065					},
9066					"description": "Packaging type for the shipment",
9067					"allowEmptyValue": false,
9068					"enum": ["CUSTOM", "LETTER", "LGLENVELOPE", "PAK"]
9069				},
9070				"ServiceClass": {
9071					"type": "string",
9072					"xml": {
9073						"name": "ServiceClass",
9074						"attribute": false,
9075						"wrapped": false
9076					},
9077					"description": "Supplied by Package.  The class of delivery service requested for this package.  (Ex. 3Day, Overnight)",
9078					"allowEmptyValue": false
9079				},
9080				"TrackingNumberValue": {
9081					"type": "string",
9082					"xml": {
9083						"name": "TrackingNumberValue",
9084						"attribute": false,
9085						"wrapped": false
9086					},
9087					"description": "Carrier tracking number for this package",
9088					"allowEmptyValue": false
9089				},
9090				"WaybillType": {
9091					"type": "string",
9092					"xml": {
9093						"name": "WaybillType",
9094						"attribute": false,
9095						"wrapped": false
9096					},
9097					"description": "Type of waybill, can be either 'Shipping' for outbound, or 'Reply' for the business reply label",
9098					"allowEmptyValue": false,
9099					"enum": ["REPLY", "SHIPPING"]
9100				},
9101				"Weight": {
9102					"type": "number",
9103					"xml": {
9104						"name": "Weight",
9105						"attribute": false,
9106						"wrapped": false
9107					},
9108					"description": "Actual weight of the shipped package in lbs",
9109					"allowEmptyValue": false
9110				}
9111			},
9112			"title": "CreatedWaybill",
9113			"xml": {
9114				"name": "CreatedWaybill",
9115				"attribute": false,
9116				"wrapped": false
9117			}
9118		},
9119		"WaybillReplyAddressWaybillAddressContainer": {
9120			"type": "object",
9121			"properties": {
9122				"Address": {
9123					"xml": {
9124						"name": "Address",
9125						"attribute": false,
9126						"wrapped": false
9127					},
9128					"description": "Supplied by Package.  The postal address.",
9129					"allowEmptyValue": false,
9130					"$ref": "#/definitions/AddressContainer"
9131				},
9132				"CompanyName": {
9133					"type": "string",
9134					"xml": {
9135						"name": "CompanyName",
9136						"attribute": false,
9137						"wrapped": false
9138					},
9139					"description": "Supplied by Package.  Name of the contact company at the return address",
9140					"allowEmptyValue": false
9141				},
9142				"ContactName": {
9143					"type": "string",
9144					"xml": {
9145						"name": "ContactName",
9146						"attribute": false,
9147						"wrapped": false
9148					},
9149					"description": "Supplied by Package.  Name of the contact person at the return address",
9150					"allowEmptyValue": false
9151				},
9152				"ContactPhone": {
9153					"type": "string",
9154					"xml": {
9155						"name": "ContactPhone",
9156						"attribute": false,
9157						"wrapped": false
9158					},
9159					"description": "Supplied by Package.  Phone number of the contact person for this address.  Required for UPS and FedEx.",
9160					"allowEmptyValue": false
9161				}
9162			},
9163			"title": "WaybillReplyAddress",
9164			"xml": {
9165				"name": "WaybillReplyAddress",
9166				"attribute": false,
9167				"wrapped": false
9168			}
9169		},
9170		"WaybillReplyDetailWaybillRequestDetailContainer": {
9171			"type": "object",
9172			"properties": {
9173				"Carrier": {
9174					"type": "string",
9175					"xml": {
9176						"name": "Carrier",
9177						"attribute": false,
9178						"wrapped": false
9179					},
9180					"description": "Supplied by Package.  The carrier to use for this package.",
9181					"allowEmptyValue": false,
9182					"enum": ["FED_EX", "UPS", "USPS"]
9183				},
9184				"DeliveryPackaging": {
9185					"type": "string",
9186					"xml": {
9187						"name": "DeliveryPackaging",
9188						"attribute": false,
9189						"wrapped": false
9190					},
9191					"description": "Packaging type for the shipment",
9192					"allowEmptyValue": false,
9193					"enum": ["CUSTOM", "LETTER", "LGLENVELOPE", "PAK"]
9194				},
9195				"PackageDimensions": {
9196					"xml": {
9197						"name": "PackageDimensions",
9198						"attribute": false,
9199						"wrapped": false
9200					},
9201					"description": "Supplied by Package.  Dimensions of the package used for shipping.  Required if DeliveryPackaging = CUSTOM",
9202					"allowEmptyValue": false,
9203					"$ref": "#/definitions/PackageDimensionsContainer"
9204				},
9205				"RequestResidentialDelivery": {
9206					"type": "boolean",
9207					"example": false,
9208					"xml": {
9209						"name": "RequestResidentialDelivery",
9210						"attribute": false,
9211						"wrapped": false
9212					},
9213					"description": "Supplied by Package.  If 'true' sets Residential Delivery flag for this shipment.  Defaults to 'true' for ShippingInfo, and 'false' for ReplyInfo.",
9214					"allowEmptyValue": false
9215				},
9216				"RequestSaturdayDelivery": {
9217					"type": "boolean",
9218					"example": false,
9219					"xml": {
9220						"name": "RequestSaturdayDelivery",
9221						"attribute": false,
9222						"wrapped": false
9223					},
9224					"description": "Supplied by Package.  If 'true' sets Saturday Delivery flag for this shipment.  Defaults to 'false'.",
9225					"allowEmptyValue": false
9226				},
9227				"RequestSignatureConfirmation": {
9228					"type": "boolean",
9229					"example": false,
9230					"xml": {
9231						"name": "RequestSignatureConfirmation",
9232						"attribute": false,
9233						"wrapped": false
9234					},
9235					"description": "Supplied by Package.  If 'true' sets Signature Confirmation flag for this shipment.  Defaults to 'false'.",
9236					"allowEmptyValue": false
9237				},
9238				"ServiceClass": {
9239					"type": "string",
9240					"xml": {
9241						"name": "ServiceClass",
9242						"attribute": false,
9243						"wrapped": false
9244					},
9245					"description": "Supplied by Package.  The class of delivery service requested for this package.  (Ex. 3Day, Overnight)",
9246					"allowEmptyValue": false
9247				}
9248			},
9249			"title": "WaybillReplyDetail",
9250			"xml": {
9251				"name": "WaybillReplyDetail",
9252				"attribute": false,
9253				"wrapped": false
9254			}
9255		},
9256		"WaybillReturnAddressWaybillAddressContainer": {
9257			"type": "object",
9258			"properties": {
9259				"Address": {
9260					"xml": {
9261						"name": "Address",
9262						"attribute": false,
9263						"wrapped": false
9264					},
9265					"description": "Supplied by Package.  The postal address.",
9266					"allowEmptyValue": false,
9267					"$ref": "#/definitions/AddressContainer"
9268				},
9269				"CompanyName": {
9270					"type": "string",
9271					"xml": {
9272						"name": "CompanyName",
9273						"attribute": false,
9274						"wrapped": false
9275					},
9276					"description": "Supplied by Package.  Name of the contact company at the return address",
9277					"allowEmptyValue": false
9278				},
9279				"ContactName": {
9280					"type": "string",
9281					"xml": {
9282						"name": "ContactName",
9283						"attribute": false,
9284						"wrapped": false
9285					},
9286					"description": "Supplied by Package.  Name of the contact person at the return address",
9287					"allowEmptyValue": false
9288				},
9289				"ContactPhone": {
9290					"type": "string",
9291					"xml": {
9292						"name": "ContactPhone",
9293						"attribute": false,
9294						"wrapped": false
9295					},
9296					"description": "Supplied by Package.  Phone number of the contact person for this address.  Required for UPS and FedEx.",
9297					"allowEmptyValue": false
9298				}
9299			},
9300			"title": "WaybillReturnAddress",
9301			"xml": {
9302				"name": "WaybillReturnAddress",
9303				"attribute": false,
9304				"wrapped": false
9305			}
9306		},
9307		"WaybillShippingAddressWaybillAddressContainer": {
9308			"type": "object",
9309			"properties": {
9310				"Address": {
9311					"xml": {
9312						"name": "Address",
9313						"attribute": false,
9314						"wrapped": false
9315					},
9316					"description": "Supplied by Package.  The postal address.",
9317					"allowEmptyValue": false,
9318					"$ref": "#/definitions/AddressContainer"
9319				},
9320				"CompanyName": {
9321					"type": "string",
9322					"xml": {
9323						"name": "CompanyName",
9324						"attribute": false,
9325						"wrapped": false
9326					},
9327					"description": "Supplied by Package.  Name of the contact company at the return address",
9328					"allowEmptyValue": false
9329				},
9330				"ContactName": {
9331					"type": "string",
9332					"xml": {
9333						"name": "ContactName",
9334						"attribute": false,
9335						"wrapped": false
9336					},
9337					"description": "Supplied by Package.  Name of the contact person at the return address",
9338					"allowEmptyValue": false
9339				},
9340				"ContactPhone": {
9341					"type": "string",
9342					"xml": {
9343						"name": "ContactPhone",
9344						"attribute": false,
9345						"wrapped": false
9346					},
9347					"description": "Supplied by Package.  Phone number of the contact person for this address.  Required for UPS and FedEx.",
9348					"allowEmptyValue": false
9349				}
9350			},
9351			"title": "WaybillShippingAddress",
9352			"xml": {
9353				"name": "WaybillShippingAddress",
9354				"attribute": false,
9355				"wrapped": false
9356			}
9357		},
9358		"WaybillShippingDetailWaybillRequestDetailContainer": {
9359			"type": "object",
9360			"properties": {
9361				"Carrier": {
9362					"type": "string",
9363					"xml": {
9364						"name": "Carrier",
9365						"attribute": false,
9366						"wrapped": false
9367					},
9368					"description": "Supplied by Package.  The carrier to use for this package.",
9369					"allowEmptyValue": false,
9370					"enum": ["FED_EX", "UPS", "USPS"]
9371				},
9372				"DeliveryPackaging": {
9373					"type": "string",
9374					"xml": {
9375						"name": "DeliveryPackaging",
9376						"attribute": false,
9377						"wrapped": false
9378					},
9379					"description": "Packaging type for the shipment",
9380					"allowEmptyValue": false,
9381					"enum": ["CUSTOM", "LETTER", "LGLENVELOPE", "PAK"]
9382				},
9383				"PackageDimensions": {
9384					"xml": {
9385						"name": "PackageDimensions",
9386						"attribute": false,
9387						"wrapped": false
9388					},
9389					"description": "Supplied by Package.  Dimensions of the package used for shipping.  Required if DeliveryPackaging = CUSTOM",
9390					"allowEmptyValue": false,
9391					"$ref": "#/definitions/PackageDimensionsContainer"
9392				},
9393				"RequestResidentialDelivery": {
9394					"type": "boolean",
9395					"example": false,
9396					"xml": {
9397						"name": "RequestResidentialDelivery",
9398						"attribute": false,
9399						"wrapped": false
9400					},
9401					"description": "Supplied by Package.  If 'true' sets Residential Delivery flag for this shipment.  Defaults to 'true' for ShippingInfo, and 'false' for ReplyInfo.",
9402					"allowEmptyValue": false
9403				},
9404				"RequestSaturdayDelivery": {
9405					"type": "boolean",
9406					"example": false,
9407					"xml": {
9408						"name": "RequestSaturdayDelivery",
9409						"attribute": false,
9410						"wrapped": false
9411					},
9412					"description": "Supplied by Package.  If 'true' sets Saturday Delivery flag for this shipment.  Defaults to 'false'.",
9413					"allowEmptyValue": false
9414				},
9415				"RequestSignatureConfirmation": {
9416					"type": "boolean",
9417					"example": false,
9418					"xml": {
9419						"name": "RequestSignatureConfirmation",
9420						"attribute": false,
9421						"wrapped": false
9422					},
9423					"description": "Supplied by Package.  If 'true' sets Signature Confirmation flag for this shipment.  Defaults to 'false'.",
9424					"allowEmptyValue": false
9425				},
9426				"ServiceClass": {
9427					"type": "string",
9428					"xml": {
9429						"name": "ServiceClass",
9430						"attribute": false,
9431						"wrapped": false
9432					},
9433					"description": "Supplied by Package.  The class of delivery service requested for this package.  (Ex. 3Day, Overnight)",
9434					"allowEmptyValue": false
9435				}
9436			},
9437			"title": "WaybillShippingDetail",
9438			"xml": {
9439				"name": "WaybillShippingDetail",
9440				"attribute": false,
9441				"wrapped": false
9442			}
9443		},
9444		"WorkspaceConsent": {
9445			"type": "object",
9446			"properties": {
9447				"RejectReason": {
9448					"type": "array",
9449					"xml": {
9450						"name": "RejectReasons",
9451						"attribute": false,
9452						"wrapped": true
9453					},
9454					"items": {
9455						"$ref": "#/definitions/RejectReason"
9456					}
9457				},
9458				"Verbiage": {
9459					"type": "string",
9460					"xml": {
9461						"name": "Verbiage",
9462						"attribute": false,
9463						"wrapped": false
9464					}
9465				},
9466				"createdOn": {
9467					"type": "string",
9468					"format": "date-time",
9469					"xml": {
9470						"name": "createdOn",
9471						"attribute": false,
9472						"wrapped": false
9473					}
9474				},
9475				"isProofAvailable": {
9476					"type": "boolean",
9477					"xml": {
9478						"name": "isProofAvailable",
9479						"attribute": false,
9480						"wrapped": false
9481					}
9482				},
9483				"organizationId": {
9484					"type": "integer",
9485					"format": "int64",
9486					"xml": {
9487						"name": "organizationId",
9488						"attribute": false,
9489						"wrapped": false
9490					}
9491				},
9492				"status": {
9493					"type": "string",
9494					"xml": {
9495						"name": "status",
9496						"attribute": false,
9497						"wrapped": false
9498					},
9499					"enum": ["ACCEPTED", "DECLINED"]
9500				},
9501				"updatedOn": {
9502					"type": "string",
9503					"format": "date-time",
9504					"xml": {
9505						"name": "updatedOn",
9506						"attribute": false,
9507						"wrapped": false
9508					}
9509				},
9510				"workspaceConsentId": {
9511					"type": "integer",
9512					"format": "int64",
9513					"xml": {
9514						"name": "workspaceConsentId",
9515						"attribute": false,
9516						"wrapped": false
9517					}
9518				}
9519			},
9520			"title": "WorkspaceConsent",
9521			"xml": {
9522				"name": "WorkspaceConsent",
9523				"attribute": false,
9524				"wrapped": false
9525			}
9526		},
9527		"WorkspaceContactContainer": {
9528			"type": "object",
9529			"properties": {
9530				"EmailAddress": {
9531					"type": "string",
9532					"xml": {
9533						"name": "EmailAddress",
9534						"attribute": false,
9535						"wrapped": false
9536					},
9537					"description": "Email address the recipient can use to contact a sender.  This is displayed in the signer UI.",
9538					"allowEmptyValue": false
9539				},
9540				"Extension": {
9541					"type": "string",
9542					"xml": {
9543						"name": "Extension",
9544						"attribute": false,
9545						"wrapped": false
9546					},
9547					"description": "Phone number extension the recipient can use to contact a sender.  This is displayed in the signer UI.",
9548					"allowEmptyValue": false
9549				},
9550				"FullName": {
9551					"type": "string",
9552					"xml": {
9553						"name": "FullName",
9554						"attribute": false,
9555						"wrapped": false
9556					},
9557					"description": "Full name of a sender contact for the recipient.  This is displayed in the signer UI.",
9558					"allowEmptyValue": false
9559				},
9560				"Owner": {
9561					"xml": {
9562						"name": "Owner",
9563						"attribute": false,
9564						"wrapped": false
9565					},
9566					"description": "The organization this contact belongs to.",
9567					"allowEmptyValue": false,
9568					"$ref": "#/definitions/OwnerContainer"
9569				},
9570				"Phone": {
9571					"type": "string",
9572					"xml": {
9573						"name": "Phone",
9574						"attribute": false,
9575						"wrapped": false
9576					},
9577					"description": "Phone number the recipient can use to contact a sender.  This is displayed in the signer UI.",
9578					"allowEmptyValue": false
9579				}
9580			},
9581			"title": "WorkspaceContact",
9582			"xml": {
9583				"name": "WorkspaceContact",
9584				"attribute": false,
9585				"wrapped": false
9586			}
9587		},
9588		"WorkspaceContainer": {
9589			"type": "object",
9590			"properties": {
9591				"Href": {
9592					"type": "string",
9593					"description": "API endpoint to reference this object."
9594				},
9595				"AggregatePackageState": {
9596					"type": "array",
9597					"xml": {
9598						"name": "AggregatePackageStates",
9599						"attribute": false,
9600						"wrapped": true
9601					},
9602					"description": "Breakdown of the number of packages in each state within this workspace ",
9603					"allowEmptyValue": false,
9604					"items": {
9605						"$ref": "#/definitions/AggregatePackageStateContainer"
9606					}
9607				},
9608				"CreationDate": {
9609					"type": "string",
9610					"format": "date-time",
9611					"xml": {
9612						"name": "CreationDate",
9613						"attribute": false,
9614						"wrapped": false
9615					},
9616					"description": "Supplied by System.  Timestamp when this workspace was created.",
9617					"allowEmptyValue": false
9618				},
9619				"ForeignIdentity": {
9620					"type": "array",
9621					"xml": {
9622						"name": "ForeignIdentities",
9623						"attribute": false,
9624						"wrapped": true
9625					},
9626					"description": "Supplied by Package.  Information on how this object is identified in other systems.",
9627					"allowEmptyValue": false,
9628					"items": {
9629						"$ref": "#/definitions/ForeignIdentityContainer"
9630					}
9631				},
9632				"Identity": {
9633					"type": "integer",
9634					"format": "int64",
9635					"xml": {
9636						"name": "Identity",
9637						"attribute": false,
9638						"wrapped": false
9639					},
9640					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
9641					"allowEmptyValue": false
9642				},
9643				"MessageIdentifiers": {
9644					"xml": {
9645						"name": "MessageIdentifiers",
9646						"attribute": false,
9647						"wrapped": false
9648					},
9649					"description": "Collection of identifiers of the message(s) that created or modified this object.",
9650					"allowEmptyValue": false,
9651					"$ref": "#/definitions/MessageIdentifiersContainer"
9652				},
9653				"MortgageData": {
9654					"xml": {
9655						"name": "MortgageData",
9656						"attribute": false,
9657						"wrapped": false
9658					},
9659					"description": "Data specific to mortgage transactions",
9660					"allowEmptyValue": false,
9661					"$ref": "#/definitions/WorkspaceMortgageDataContainer"
9662				},
9663				"Property": {
9664					"type": "array",
9665					"xml": {
9666						"name": "Properties",
9667						"attribute": false,
9668						"wrapped": true
9669					},
9670					"description": "Workspace-level unstructured key-value pair data",
9671					"allowEmptyValue": false,
9672					"items": {
9673						"$ref": "#/definitions/PropertyContainer"
9674					}
9675				},
9676				"WorkspaceContact": {
9677					"type": "array",
9678					"xml": {
9679						"name": "WorkspaceContacts",
9680						"attribute": false,
9681						"wrapped": true
9682					},
9683					"description": "Collection of Workspace Contacts.  Workspace Contact information is someone the signer can contact to ask questions about the doucment(s) or content.  This information is displayed in the signer UI",
9684					"allowEmptyValue": false,
9685					"items": {
9686						"$ref": "#/definitions/WorkspaceContactContainer"
9687					}
9688				},
9689				"WorkspaceType": {
9690					"xml": {
9691						"name": "WorkspaceType",
9692						"attribute": false,
9693						"wrapped": false
9694					},
9695					"description": "General transaction type, eg \\\"Mortgage', 'Auto Loan'",
9696					"allowEmptyValue": false,
9697					"$ref": "#/definitions/WorkspaceTypeContainer"
9698				}
9699			},
9700			"title": "Workspace",
9701			"xml": {
9702				"name": "Workspace",
9703				"attribute": false,
9704				"wrapped": false
9705			}
9706		},
9707		"WorkspaceListDP": {
9708			"type": "object",
9709			"properties": {
9710				"Audit": {
9711					"xml": {
9712						"name": "Audit",
9713						"attribute": false,
9714						"wrapped": false
9715					},
9716					"description": "Information related to eAudit  if applicable.",
9717					"allowEmptyValue": false,
9718					"$ref": "#/definitions/AuditContainer"
9719				},
9720				"AuditFlag": {
9721					"type": "boolean",
9722					"example": false,
9723					"xml": {
9724						"name": "AuditFlag",
9725						"attribute": false,
9726						"wrapped": false
9727					},
9728					"description": "Supplied by Package.  When 'true', indicates that the completed package should be FW to the eAudit process",
9729					"allowEmptyValue": false
9730				},
9731				"BillingGroup": {
9732					"xml": {
9733						"name": "BillingGroup",
9734						"attribute": false,
9735						"wrapped": false
9736					},
9737					"description": "Information about the cusotmer billing group for this package",
9738					"allowEmptyValue": false,
9739					"$ref": "#/definitions/BillingGroupContainer"
9740				},
9741				"CurrentSigningPosition": {
9742					"type": "integer",
9743					"format": "int32",
9744					"xml": {
9745						"name": "CurrentSigningPosition",
9746						"attribute": false,
9747						"wrapped": false
9748					},
9749					"description": "Supplied by System.  Tracks current signing parties.",
9750					"allowEmptyValue": false
9751				},
9752				"Description": {
9753					"type": "string",
9754					"xml": {
9755						"name": "Description",
9756						"attribute": false,
9757						"wrapped": false
9758					},
9759					"description": "Supplied by Package.  Text description for the package",
9760					"allowEmptyValue": false
9761				},
9762				"EmailSubject": {
9763					"type": "string",
9764					"xml": {
9765						"name": "EmailSubject",
9766						"attribute": false,
9767						"wrapped": false
9768					},
9769					"description": "Supplied by Package.  Text for the recipient email notification subject line.",
9770					"allowEmptyValue": false
9771				},
9772				"Expiration": {
9773					"xml": {
9774						"name": "Expiration",
9775						"attribute": false,
9776						"wrapped": false
9777					},
9778					"description": "Parameters used to set the expiration date/time of the package",
9779					"allowEmptyValue": false,
9780					"$ref": "#/definitions/ExpirationContainer"
9781				},
9782				"ForeignIdentity": {
9783					"type": "array",
9784					"xml": {
9785						"name": "ForeignIdentities",
9786						"attribute": false,
9787						"wrapped": true
9788					},
9789					"description": "Identiy value(s) for this DeliveryPackage with respect to our trading partners",
9790					"allowEmptyValue": false,
9791					"items": {
9792						"$ref": "#/definitions/ForeignIdentityContainer"
9793					}
9794				},
9795				"Form": {
9796					"type": "array",
9797					"xml": {
9798						"name": "Forms",
9799						"attribute": false,
9800						"wrapped": true
9801					},
9802					"description": "Collection of documents in the package",
9803					"allowEmptyValue": false,
9804					"items": {
9805						"$ref": "#/definitions/FormContainer"
9806					}
9807				},
9808				"Identity": {
9809					"type": "integer",
9810					"format": "int64",
9811					"xml": {
9812						"name": "Identity",
9813						"attribute": false,
9814						"wrapped": false
9815					},
9816					"description": "Supplied by System.  The internal Expedite index or identity value for this record.",
9817					"allowEmptyValue": false
9818				},
9819				"MortgageData": {
9820					"xml": {
9821						"name": "MortgageData",
9822						"attribute": false,
9823						"wrapped": false
9824					},
9825					"description": "Data specific to mortgage transactions",
9826					"allowEmptyValue": false,
9827					"$ref": "#/definitions/MortgageDataContainer"
9828				},
9829				"NotifyWhenAllRecipientsHaveViewed": {
9830					"type": "boolean",
9831					"example": false,
9832					"xml": {
9833						"name": "NotifyWhenAllRecipientsHaveViewed",
9834						"attribute": false,
9835						"wrapped": false
9836					},
9837					"description": "When 'true', triggers the CI.FirstRecipientViewedPackage after all recipients have viewed the package.",
9838					"allowEmptyValue": false
9839				},
9840				"NotifyWhenFirstRecipientViews": {
9841					"type": "boolean",
9842					"example": false,
9843					"xml": {
9844						"name": "NotifyWhenFirstRecipientViews",
9845						"attribute": false,
9846						"wrapped": false
9847					},
9848					"description": "When 'true', triggers the CI.AllRecipientsViewedPackage when the first recipient views the package.",
9849					"allowEmptyValue": false
9850				},
9851				"PackageState": {
9852					"xml": {
9853						"name": "PackageState",
9854						"attribute": false,
9855						"wrapped": false
9856					},
9857					"description": "Supplied by System.  Data relating to the state of the package, for instance, is consent declined, has the package expired, etc.",
9858					"allowEmptyValue": false,
9859					"$ref": "#/definitions/PackageStateContainer"
9860				},
9861				"PageCount": {
9862					"type": "integer",
9863					"format": "int32",
9864					"xml": {
9865						"name": "PageCount",
9866						"attribute": false,
9867						"wrapped": false
9868					},
9869					"description": "Number of pages in the package the current user can access",
9870					"allowEmptyValue": false
9871				},
9872				"PersonalMessage": {
9873					"type": "string",
9874					"xml": {
9875						"name": "PersonalMessage",
9876						"attribute": false,
9877						"wrapped": false
9878					},
9879					"description": "Supplied by Package.  A simple text string message that is included in the recipient UI when this package is being signed.",
9880					"allowEmptyValue": false
9881				},
9882				"PostingControls": {
9883					"xml": {
9884						"name": "PostingControls",
9885						"attribute": false,
9886						"wrapped": false
9887					},
9888					"description": "Probably needs reorganizing with respect to both eCN and Inbox.  This will come out during detailed design.",
9889					"allowEmptyValue": false,
9890					"$ref": "#/definitions/PostingControlsContainer"
9891				},
9892				"Print": {
9893					"xml": {
9894						"name": "Print",
9895						"attribute": false,
9896						"wrapped": false
9897					},
9898					"description": "Data specific to print function",
9899					"allowEmptyValue": false,
9900					"$ref": "#/definitions/PrintContainer"
9901				},
9902				"ProcessingNote": {
9903					"type": "array",
9904					"xml": {
9905						"name": "ProcessingNotes",
9906						"attribute": false,
9907						"wrapped": true
9908					},
9909					"description": "Collection of messages concerning the processing of this Delivery Package, inserted by Package Processing.",
9910					"allowEmptyValue": false,
9911					"items": {
9912						"$ref": "#/definitions/ProcessingNoteContainer"
9913					}
9914				},
9915				"Property": {
9916					"type": "array",
9917					"xml": {
9918						"name": "Properties",
9919						"attribute": false,
9920						"wrapped": true
9921					},
9922					"description": "Package-level unstructured key-value pair data",
9923					"allowEmptyValue": false,
9924					"items": {
9925						"$ref": "#/definitions/PropertyContainer"
9926					}
9927				},
9928				"Recalled": {
9929					"type": "boolean",
9930					"example": false,
9931					"xml": {
9932						"name": "Recalled",
9933						"attribute": false,
9934						"wrapped": false
9935					},
9936					"description": "'true' indicates that this package has been recalled and is no longer available for viewing/signing by the recipients.",
9937					"allowEmptyValue": false
9938				},
9939				"Recipient": {
9940					"type": "array",
9941					"xml": {
9942						"name": "Recipients",
9943						"attribute": false,
9944						"wrapped": true
9945					},
9946					"description": "Collection of users that will receive the contents of this message",
9947					"allowEmptyValue": false,
9948					"items": {
9949						"$ref": "#/definitions/RecipientUserContainer"
9950					}
9951				},
9952				"RecipientReviewOnlyHoldTimer": {
9953					"xml": {
9954						"name": "RecipientReviewOnlyHoldTimer",
9955						"attribute": false,
9956						"wrapped": false
9957					},
9958					"description": "If this structure exists, designates that this eSignature or eClose package is view-only until the timer has expired.  After that the recipents will be allowed to sign.",
9959					"allowEmptyValue": false,
9960					"$ref": "#/definitions/RecipientReviewOnlyHoldTimerExpirationContainer"
9961				},
9962				"ReferenceDoc": {
9963					"type": "array",
9964					"xml": {
9965						"name": "ReferenceDocs",
9966						"attribute": false,
9967						"wrapped": true
9968					},
9969					"description": "Supplied by Package.  Defines Reference documents for inclusion in hte package.",
9970					"allowEmptyValue": false,
9971					"items": {
9972						"$ref": "#/definitions/ReferenceDocContainer"
9973					}
9974				},
9975				"Sender": {
9976					"xml": {
9977						"name": "Sender",
9978						"attribute": false,
9979						"wrapped": false
9980					},
9981					"description": "Data bout the user who requests that this message gets processed.",
9982					"allowEmptyValue": false,
9983					"$ref": "#/definitions/SenderUserContainer"
9984				},
9985				"SendingOrganizationApproval": {
9986					"type": "boolean",
9987					"example": false,
9988					"xml": {
9989						"name": "SendingOrganizationApproval",
9990						"attribute": false,
9991						"wrapped": false
9992					},
9993					"description": "When 'true', indicates that the designated user from the Sending Organization has approved the package to be released to the recipients.  The Approver is the user contained in the 'Recipients' list where Recipient/AccessRoles/AccessRole = 'Approver'",
9994					"allowEmptyValue": false
9995				},
9996				"SendingOrganizationIdentity": {
9997					"type": "integer",
9998					"format": "int64",
9999					"xml": {
10000						"name": "SendingOrganizationIdentity",
10001						"attribute": false,
10002						"wrapped": false
10003					},
10004					"description": "Supplied by System. Customer ID of the organization that sent this package.  ",
10005					"allowEmptyValue": false
10006				},
10007				"SendingOrganizationName": {
10008					"type": "string",
10009					"xml": {
10010						"name": "SendingOrganizationName",
10011						"attribute": false,
10012						"wrapped": false
10013					},
10014					"description": "Supplied by System. Customer Name of the organization that sent this package.  ",
10015					"allowEmptyValue": false
10016				},
10017				"SentDate": {
10018					"type": "string",
10019					"format": "date-time",
10020					"xml": {
10021						"name": "SentDate",
10022						"attribute": false,
10023						"wrapped": false
10024					},
10025					"description": "Supplied by System.  Timestamp when this delivery package was sent out.",
10026					"allowEmptyValue": false
10027				},
10028				"ShelfDoc": {
10029					"type": "array",
10030					"xml": {
10031						"name": "ShelfDocs",
10032						"attribute": false,
10033						"wrapped": true
10034					},
10035					"description": "(Make this the form strucxture + key + insertpostion, both shelf and jasper)  Supplied by Package.  Defines Shelf Documents for inclusion in the package.",
10036					"allowEmptyValue": false,
10037					"items": {
10038						"$ref": "#/definitions/ShelfDocContainer"
10039					}
10040				},
10041				"Size": {
10042					"type": "integer",
10043					"format": "int64",
10044					"xml": {
10045						"name": "Size",
10046						"attribute": false,
10047						"wrapped": false
10048					},
10049					"description": "Supplied by System.  Size of the package.",
10050					"allowEmptyValue": false
10051				},
10052				"UndeliverablePackageId": {
10053					"type": "string",
10054					"xml": {
10055						"name": "UndeliverablePackageId",
10056						"attribute": false,
10057						"wrapped": false
10058					},
10059					"description": "unknown",
10060					"allowEmptyValue": false
10061				},
10062				"UploadRequest": {
10063					"xml": {
10064						"name": "UploadRequest",
10065						"attribute": false,
10066						"wrapped": false
10067					},
10068					"description": "Upload Request definition for this delivery package",
10069					"allowEmptyValue": false,
10070					"$ref": "#/definitions/UploadRequestContainer"
10071				},
10072				"ViewUIProvider": {
10073					"type": "string",
10074					"xml": {
10075						"name": "ViewUIProvider",
10076						"attribute": false,
10077						"wrapped": false
10078					},
10079					"description": "Specifies who is providing the view/sign UI.  'Default' indicates a standard package handled by Expedite.",
10080					"allowEmptyValue": false,
10081					"enum": ["DEFAULT", "DOCUTECH"]
10082				},
10083				"WorkspaceIdentity": {
10084					"type": "integer",
10085					"format": "int64",
10086					"xml": {
10087						"name": "WorkspaceIdentity",
10088						"attribute": false,
10089						"wrapped": false
10090					},
10091					"description": "Supplied by System.  The internal identity of the Expedite Workspace that this package is a member of.",
10092					"allowEmptyValue": false
10093				}
10094			},
10095			"title": "WorkspaceListDP",
10096			"xml": {
10097				"name": "DeliveryPackage",
10098				"attribute": false,
10099				"wrapped": false
10100			}
10101		},
10102		"WorkspaceMortgageDataContainer": {
10103			"type": "object",
10104			"properties": {
10105				"ApplicationDate": {
10106					"type": "string",
10107					"xml": {
10108						"name": "ApplicationDate",
10109						"attribute": false,
10110						"wrapped": false
10111					},
10112					"description": "Supplied by Package.  The date that the loan application was submitted.",
10113					"allowEmptyValue": false
10114				},
10115				"ClosingDate": {
10116					"type": "string",
10117					"xml": {
10118						"name": "ClosingDate",
10119						"attribute": false,
10120						"wrapped": false
10121					},
10122					"description": "Supplied by Package.  The date that the closing ceremony occurred.",
10123					"allowEmptyValue": false
10124				},
10125				"ConsummationDate": {
10126					"type": "string",
10127					"xml": {
10128						"name": "ConsummationDate",
10129						"attribute": false,
10130						"wrapped": false
10131					},
10132					"description": "Supplied by Package.  The date that the borrower(s) become financially responsible for the note.",
10133					"allowEmptyValue": false
10134				}
10135			},
10136			"title": "MortgageData",
10137			"xml": {
10138				"name": "MortgageData",
10139				"attribute": false,
10140				"wrapped": false
10141			}
10142		},
10143		"WorkspaceTypeContainer": {
10144			"type": "object",
10145			"properties": {
10146				"Label": {
10147					"type": "string",
10148					"xml": {
10149						"name": "Label",
10150						"attribute": false,
10151						"wrapped": false
10152					},
10153					"description": "Human readable workspace type for display use in the UI",
10154					"allowEmptyValue": false
10155				},
10156				"Type": {
10157					"type": "string",
10158					"xml": {
10159						"name": "Type",
10160						"attribute": false,
10161						"wrapped": false
10162					},
10163					"description": "Type descriptor used to trigger work process",
10164					"allowEmptyValue": false,
10165					"enum": ["DEFAULT", "MORTGAGE"]
10166				}
10167			},
10168			"title": "WorkspaceType",
10169			"xml": {
10170				"name": "WorkspaceType",
10171				"attribute": false,
10172				"wrapped": false
10173			}
10174		}
10175	}
10176}