Errors
objectAn error occurred, and the request could not be completed.
errorsarray[object]
Details of an error or issue.
Show Child Parameters
Example
PdfFile
objectPDF File.
ScanStatus
The status of the virus scan on the document.
Allowed values:SCAN_NOT_SUPPORTEDNOT_SCANNEDSUCCESSFAILED
Example
UploadUrlCollection
objectDetails of the upload URL response.
documentsarray[object]
Details of the upload URL response.
Show Child Parameters
Example
UploadUrlRequest
objectDetails of the upload URL request.
fileNamestring
The actual file name of the document including the file extension.
Example:example.txt
parentIdstring(uuid)
The parent resource of the document if not only the dispatch ID or listing ID. If the document pertains to a vehicle (bill, inspection document, etc.) it will be the vehicle ID.
Example:dad00000-e89b-12d3-a456-426614174000
displayNamestring
The display name of the document. If not provided, fileName will be used.
Example:Example document
Example