7.4 Retrieve Package or Document Correlation Audit Proofs Xml
7.4.1 Description
Correlation ids are used to track packages or documents across several passes through the eSignatures application. On a document it states the “external identity” of that document so that it can be established what happened to it, whereas for a package it depends on how you interpret the data.
Either way, retrieving the audit proofs for such an identifier will combine all available audit proofs into one big XML. Items will be grouped into packages and documents to indicate how they were uploaded several times of the lifespan of the set.
Important: combined audit proofs xmls should only be retrieved when all packages containing the package correlation id or all documents with the given correlation id are fully signed, or otherwise in a final state.
7.4.2 URL
https://[servername]:[port]/webportalapi/v3/packagecorrelations/{correlationId}/auditproof/download
https://[servername]:[port]/webportalapi/v3/documentcorrelations/{correlationId}/auditproof/download
7.4.3 HTTP Method
GET
7.4.4 MIME Type
application/xml
7.4.5 Response parameters
The API will return a signed xml containing the Audit proofs (if the status of all items in the set is right). See section 7.5 for the format.
7.4.6 Response codes
Response status code | Description |
---|---|
200 OK | The Audit proofs xml is returned. |
404 Not Found | The document/package id could not be found. |
409 Conflict | The package is not fully signed. |
7.4.7 Error codes
HTTP Code | Code |
---|---|
TBD |