Email Document Images Web Service

URL Format Representational State Transfer (REST) Web Service

Version

V2X1 (Major Version 2, Minor Version 1)

Description

This Web Service is a batch service for emailing shipping documents for multiple shipments. Documents can be sent to five different email addresses. The email contains all documents as a single PDF attachment and provides the retrieval status of documents not found.

Useful links

Test Page

URL format (REST/URLweb service)

https://my.yrcregional.com/XMLServices/REST/v2/x1/doImageEmail?accessKey=&searchBy=&n1=&BOL=true&email1=&output=

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
n1...n20 String (optional) Numbers identifying the shipments; up to 20
email1...email5 String (optional)

Email addresses to send the email; maximum of 5
BOL Boolean

Set to true if Bill of Lading needs to be emailed.
DR Boolean Set to true if Delivery Receipt needs to be emailed.
CBOL Boolean

Set to true if Corrected BOL needs to be emailed.
WRR Boolean Set to true if Weight and Research Report needs to be emailed.
INV Boolean

Set to true if Invoice needs to be emailed.
debtorCode String (optional) Debtor code; should be used only by collection agencies.
output String (optional) Format of the output response. Valid values are:
xml: XML (default)
xsd: XML with XSD (schemas)
html: HTML
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: Success
1: Error
STATUS:ERROR_TYPE String Error type returned if applicable. Valid values are:
AUTHENTICATION_ERROR: Invalid yrcregional.com credentials were supplied
INPUT_ERROR: Error in input parameters
PROCESSING_ERROR: Internal processing error. Please retry or contact YRC Regional 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
BATCH_NUMBER Number Batch number of the submitted request.