Generate-Result
Overview
The GetGenerateResults operation is used to request status information about a previously submitted request and to retrieve generated documents (using a RequestID) for a Generate or Generate-Synchronous call.
The operation returns document packets along with status and detailed information about the packets associated with the RequestID.
| Method | URL | Description |
|---|---|---|
| GET | https://ct-expere.wolterskluwerfs.com/DocumentService/api/v1/Document/account/{{accountId}}/transaction/{transactionIdentifier}/generate-result | The GET method submits eview status and results for a specific transaction using a Transaction ID. |
| Name | Type | Constraints | Description |
|---|---|---|---|
| accountId | integer | required | The account used to associate to the request. |
| transactionIdentifier | integer | required | An identifier assigned by the Expere Document Services solution for the document request event. This ID is used for request tracking purposes |
| deliveryGroupId | integer | optional | Used to filter results by delivery group ID |
| documentId | integer | optional | Used to filter results by document ID Note: Is returned
as docID in response. |
Sample Request
"transactionIdentifier": "448868"Sample Response
{
"generateResultsResponse": {
"getGenerateResultsResult": {
"passthroughIdentifier": "string",
"transactionIdentifier": "string",
"status": "Incomplete",
"statusDescription": "string",
"documents": {
"docSetTxnIDRef": "string",
"docSetPackageIDRef": "string",
"packageDocs": [
{
"packageDocID": "string",
"docDescriptor": {
"docID": "string",
"docType": "Dynamic",
"docDisplayName": "string",
"docRootEntityName": "string",
"docCustomDataItems": [
{
"dataItemName": "string",
"value": "string"
}
],
"documentClass": "string",
"documentTypeDescription": "string",
"negotiableInstrumentFlag": true,
"recordableFlag": true,
"formNumber": "string",
"eSignatureDocument": true
},
"docWorkOrder": {
"docPrepare": true,
"docAutoselected": true,
"docSuggested": true,
"docFormat": "PDF",
"docStyle": "string",
"ancillaryOutputOptions": [
{
"outputType": "Barcode",
"watermark": {
"imageURL": "string",
"text": "string",
"rotate": true,
"location": "Top"
},
"setEncryption": {
"strength128Bits": true,
"passwords": {
"user": "string",
"owner": "string"
},
"permissions": {
"allowPrinting": true,
"allowModifyContents": true,
"allowCopy": true,
"allowModifyAnnotations": true,
"allowScreenReaders": true,
"allowFillIn": true,
"allowAssembly": true,
"allowDegradedPrinting": true
}
},
"barcode": {
"type": "Barcode128",
"pattern": "string",
"useCoverPage": true,
"firstPageOnly": true,
"horizontalAlignment": "Left"
},
"eSignatureAndFieldSupport": {
"eSignatureCoordinatesOnly": true,
"eSignatureDateSupport": true,
"eSignatureTooltip": "string",
"eSignatureInitialsTooltip": "string",
"nonSignatureFieldCoordinatesOnly": true,
"eSignatureWKES": true
},
"logo": {
"image": "string",
"heightInInches": 0,
"widthInInches": 0,
"placement": "AllPages",
"justification": "Left",
"alternateText": "string"
}
}
]
}
}
],
"packet": [
{
"packetName": "string",
"packetFileName": "string",
"packetType": "string",
"docInstances": [
{
"docData": {
"base64": "string",
"text": "string",
"xml": "string"
},
"instanceDisplayName": "string",
"instanceFileName": "string",
"instanceFormattingMetadata": {
"instanceSigningInstructions": "NoSignatures"
},
"instancePacketType": "string",
"instancePacketName": "string",
"instanceDocumentRef": "string",
"instanceSequence": 0,
"instanceBarcodeValue": "string",
"instancePageCount": 0,
"docFormat": "PDF",
"copy": "string",
"ancillaryOutputOption": [
{
"outputType": "Barcode",
"watermark": {
"imageURL": "string",
"text": "string",
"rotate": true,
"location": "Top"
},
"setEncryption": {
"strength128Bits": true,
"passwords": {
"user": "string",
"owner": "string"
},
"permissions": {
"allowPrinting": true,
"allowModifyContents": true,
"allowCopy": true,
"allowModifyAnnotations": true,
"allowScreenReaders": true,
"allowFillIn": true,
"allowAssembly": true,
"allowDegradedPrinting": true
}
},
"barcode": {
"type": "Barcode128",
"pattern": "string",
"useCoverPage": true,
"firstPageOnly": true,
"horizontalAlignment": "Left"
},
"eSignatureAndFieldSupport": {
"eSignatureCoordinatesOnly": true,
"eSignatureDateSupport": true,
"eSignatureTooltip": "string",
"eSignatureInitialsTooltip": "string",
"nonSignatureFieldCoordinatesOnly": true,
"eSignatureWKES": true
},
"logo": {
"image": "string",
"heightInInches": 0,
"widthInInches": 0,
"placement": "AllPages",
"justification": "Left",
"alternateText": "string"
}
}
],
"signaturePointSet": {
"signer": [
{
"id": "string",
"description": "string",
"signaturePoints": {
"signaturePoint": [
{
"includeDate": true,
"pageNumber": 0,
"pageOrder": "string",
"height": 0,
"width": 0,
"signatureText": "string",
"xCoordinate": 0,
"yCoordinate": 0,
"type": "string",
"fieldName": "string",
"sequencing": 0,
"signatureRequired": true,
"signatureUniqueIdentifier": "string"
}
]
},
"signerEmail": "string"
}
]
},
"fillableFieldSet": {
"fillableText": [
{
"xCoordinate": 0,
"yCoordinate": 0,
"fieldName": "string",
"toolTip": "string",
"pageNumber": 0,
"sequencing": 0,
"id": "string",
"emailAddress": "string",
"mandatory": "No"
}
],
"fillableCheckbox": [
{
"xCoordinate": 0,
"yCoordinate": 0,
"fieldName": "string",
"toolTip": "string",
"pageNumber": 0,
"sequencing": 0,
"id": "string",
"emailAddress": "string",
"mandatory": "No"
}
]
},
"discretePartyIDs": {
"discretePartyID": [
"string"
]
},
"instancePageSize": "string",
"docIDRef": "string",
"instanceProperties": {
"colorPaperRequired": "No",
"colorPaperColor": "White",
"printingOption": "NotSpecified",
"registrationRequired": "No",
"registrationInstructions": "string",
"recordingRequired": "No",
"recordingInstructions": "string",
"customerPrintingRequired": "No",
"customerPrintingInstructions": "string",
"attachmentRequired": "No",
"attachmentInstructions": "string",
"insertRequired": "No",
"insertInstructions": "string"
},
"discreteParties": {
"discreteParty": [
{
"id": "string",
"name": "string",
"businessName": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"countryCode": "string",
"mailingMethod": "string",
"accountNumber": "string",
"emailAddress": "string"
}
]
},
"instanceRecordableFlag": true,
"deliveryGroups": [
"string"
]
}
],
"outputDestination": "string",
"docFormat": "PDF",
"ancillaryOutputOptions": [
{
"outputType": "Barcode",
"watermark": {
"imageURL": "string",
"text": "string",
"rotate": true,
"location": "Top"
},
"setEncryption": {
"strength128Bits": true,
"passwords": {
"user": "string",
"owner": "string"
},
"permissions": {
"allowPrinting": true,
"allowModifyContents": true,
"allowCopy": true,
"allowModifyAnnotations": true,
"allowScreenReaders": true,
"allowFillIn": true,
"allowAssembly": true,
"allowDegradedPrinting": true
}
},
"barcode": {
"type": "Barcode128",
"pattern": "string",
"useCoverPage": true,
"firstPageOnly": true,
"horizontalAlignment": "Left"
},
"eSignatureAndFieldSupport": {
"eSignatureCoordinatesOnly": true,
"eSignatureDateSupport": true,
"eSignatureTooltip": "string",
"eSignatureInitialsTooltip": "string",
"nonSignatureFieldCoordinatesOnly": true,
"eSignatureWKES": true
},
"logo": {
"image": "string",
"heightInInches": 0,
"widthInInches": 0,
"placement": "AllPages",
"justification": "Left",
"alternateText": "string"
}
}
],
"recipient": "string",
"docData": {
"base64": "string",
"text": "string",
"xml": "string"
},
"packetCustomDataItems": {
"packetCustomDataItem": [
{
"dataItemName": "string",
"dataItemValue": "string"
}
]
},
"signaturePointSet": {
"signer": [
{
"id": "string",
"description": "string",
"signaturePoints": {
"signaturePoint": [
{
"includeDate": true,
"pageNumber": 0,
"pageOrder": "string",
"height": 0,
"width": 0,
"signatureText": "string",
"xCoordinate": 0,
"yCoordinate": 0,
"type": "string",
"fieldName": "string",
"sequencing": 0,
"signatureRequired": true,
"signatureUniqueIdentifier": "string"
}
]
},
"signerEmail": "string"
}
]
},
"fillableFieldSet": {
"fillableText": [
{
"xCoordinate": 0,
"yCoordinate": 0,
"fieldName": "string",
"toolTip": "string",
"pageNumber": 0,
"sequencing": 0,
"id": "string",
"emailAddress": "string",
"mandatory": "No"
}
],
"fillableCheckbox": [
{
"xCoordinate": 0,
"yCoordinate": 0,
"fieldName": "string",
"toolTip": "string",
"pageNumber": 0,
"sequencing": 0,
"id": "string",
"emailAddress": "string",
"mandatory": "No"
}
]
}
}
],
"mismoDataSet": "string",
"eOriginal": {
"transactionID": "string",
"documentProfileID": "string"
}
},
"delivery": {
"deliveryMode": "ImageOnly",
"deliveryGroups": [
{
"name": "string",
"addressLine1": "string",
"addressLine2": "string",
"city": "string",
"state": "string",
"zip": "string",
"countryCode": "string",
"mailingMethod": "USPSFirstClass",
"emailAddresses": [
"string"
],
"discretePartyId": "string",
"wkesId": "string",
"groupId": "string",
"documents": [
{
"docID": "string",
"instanceDisplayName": "string"
}
]
}
]
}
}
}
}