URL Format Representational State Transfer (REST) Web Service
Version
V3X3 (Major Version 3, Minor Version 3)
Description
This image Web Service retrieves document images related to a shipment identified by given PRO, PO or BOL number.
URL format (REST/URLweb service)
Request structure
Parameter | Value | Description |
accessKey | String (required) | Access Key identifying the user invoking the service. |
searchBy | String (required) | Search by; could be PRO, PO or BOL |
number | String (required) | Number identifying the shipment |
BOL | String (optional) | BOL image format Valid values are: TIF Set if Bill of Lading needs to be retrieved. |
DR | String (optional) | DR image format Valid values are: TIF Set if Delivery Receipt needs to be retrieved. |
CBOL | String (optional) | CBOL image format Valid values are: TIF Set if Corrected BOL needs to be retrieved. |
WRR | String (optional) | WRR image format Valid values are: TIF Set if WRR needs to be retrieved. |
INV | String (optional) | Invoice format; Valid values are: TIF Set if Invoice needs to be generated. |
serviceCompany | String (required) | Reddaway |
debtorCode | String (optional) | A debtor code (or account ID) is required for invoice documents. |
output | String (optional) | Format of the output response. Valid values are: raw: Native format of the document, available only for Get Image service. |
Response structure
Parameter | Value | Description |
STATUS:CODE | Integer | Status code of the response. Valid values are: 0: Success1: Error |
STATUS:ERROR_TYPE | String | Error type returned if applicable. Valid values are: AUTHENTICATION_ERROR: Invalid reddawayregional.com credentials were supplied INPUT_ERROR: Error in input parameters PROCESSING_ERROR: Internal processing error. Please retry or contact reddawayregional.com Support NOT_FOUND_ERROR: Requested information not found NOT_ALL_FOUND_ERROR: Some requested information not found |
STATUS:VIEW | String | Response View. Valid values are: PUBLIC: Unsecured view. Returned when service is invoked with no credentials or when business rules prevent access to secured information. SECURED: Secured View. Complete information including secured data. ERROR: Error View. |
STATUS:MESSAGE | String | Error message (if applicable) |
STATUS:VERSION:CURRENT | String | Version of service. Format is V[Major version number]X[Minor version number] |
STATUS:VERSION:CURRENT_RELEASE_DATE | Date | Release date of service. Format is MM/DD/YYYY |
STATUS:VERSION:LATEST | String | Latest available version of this service. Format is V[Major version number]X[Minor version number] |
STATUS:VERSION:LATEST_RELEASE_DATE | Date | Release date of latest available service. Format is MM/DD/YYYY |
ReturnedImage | Multiple | Image information structure, containing result of the request |
ReturnedImage:imageType | String | Document identifier. Valid values are: BOL: Bill of lading DR: Delivery receipt CBOL: Corrected Bill of lading WRR: Weight and Research Report INV: Invoice |
ReturnedImage:imageFormat | String | Image format Valid values are: TIF TXT |
ReturnedImage:url | String | URL of the returned image |
ReturnedImage:isFound | Boolean | Set to true if found, otherwise false |