6DZ79ZWt

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