Paperless Document Push Image Example Request
POST {{base_url}}/api/paperlessdocuments/:version/image
This HTTP POST request allows the user to push a group of DocumentIDs to a common formsHistoryDocumentID that will returned in the response.
Note: Your UPS Shipper Account Number must be enabled to upload forms created offline.
Request Body
{"PushToImageRepositoryRequest"=>{"Request"=>{"TransactionReference"=>{"CustomerContext"=>"Your Customer Context"}}, "FormsHistoryDocumentID"=>{"DocumentID"=>["2016-01-18-11.01.07.589501"]}, "ShipmentIdentifier"=>"Your Package Shipment Identifier", "ShipmentDateAndTime"=>"2016-01-18-11.01.07", "ShipmentType"=>"1", "TrackingNumber"=>"Your Package Tracking Number"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
transId | null | An identifier unique to the request. Length 32 | |
transactionSrc | string | An identifier of the client/source application that is making the request.Length 512 | |
ShipperNumber | string | An identifier of the client/source application that is making the request.Length 512 | |
Content-Type | string |
RESPONSES
status: OK
{"PushToImageRepositoryResponse":{"FormsGroupID":"2016-01-18-11.09.01.244847","Response":{"ResponseStatus":{"Code":"1","Description":"Success"},"TransactionReference":{"CustomerContext":"Your Customer Context"}}}}