GET api/Shipper/GetDocuments/{auth}/{ShipmentGUID}

Used to retrieve the list of customer visible documents for a shipment

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

Unique authorization identifier

 string

Required
ShipmentGUID

Unique shipment identifier

 string

Required

Body Parameters

None.

Response Information

Resource Description

GetDocumentsResp
NameDescriptionTypeAdditional information
IsSuccessful

Set to true if method was successful

 boolean

None.
ErrorMessage

The error message if method call was not successful

 string

None.
Documents

List of document visible to the customer

 Collection of DocumentItem

None.

Response Formats

application/json, text/json

Sample: 
{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Documents": null
}

application/xml, text/xml

Sample: 
<GetDocumentsResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Shipper">
  <Documents i:nil="true" />
  <ErrorMessage>sample string 2</ErrorMessage>
  <IsSuccessful>true</IsSuccessful>
</GetDocumentsResp>