GET api/Document/ForShipment/{UserGUID}/{ShipmentDocumentID}

Use this method retrieve the a document attached to a shipment

Request Information

URI Parameters

Name	Description	Type	Additional information
UserGUID	System assign unique user identifier	string	Required
ShipmentDocumentID	System assign unique shipment document identifier	integer	Required

Body Parameters

None.

Response Information

Resource Description

DocumentItem

Name	Description	Type	Additional information
IsSuccessful	Document was succesfully returned (true)	boolean	None.
ErrorMessage	Set if error occured by retrieving document	string	None.
DocumentID	System assigned document ID (ShipmentDocumentID, CustomerDocumentID, etc)	string	None.
DocumentEntity	Entity type that document is attached to (SH=shipment, CU=customer, etc)	string	None.
OriginalFileName	The original file name of the document when uploaded	string	None.
SystemFileName	The system generated unique file name	string	None.
DocumentData	Base64 encoded string representing the document	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "DocumentID": "sample string 3",
  "DocumentEntity": "sample string 4",
  "OriginalFileName": "sample string 5",
  "SystemFileName": "sample string 6",
  "DocumentData": "sample string 7"
}

application/xml, text/xml

Sample:

<DocumentItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models">
  <DocumentData>sample string 7</DocumentData>
  <DocumentEntity>sample string 4</DocumentEntity>
  <DocumentID>sample string 3</DocumentID>
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
  <OriginalFileName>sample string 5</OriginalFileName>
  <SystemFileName>sample string 6</SystemFileName>
</DocumentItem>