GET api/Report/Shipment/{auth}/{ShipmentGUID}/{Type}

Use this method to retrieve a predefined shipment based forms

Request Information

URI Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	Required
ShipmentGUID	Unique shipment identifier	string	Required
Type	SD=Shippers Document (airbill),CI=Commerical Invoice,SL=Shipping Label (label),DG=Dangerous Goods	string	Required

Body Parameters

None.

Response Information

Resource Description

ReportResp

Name	Description	Type	Additional information
IsSuccessful	Used to determine if method call was successful (true) or failure (false)	boolean	None.
ErrorMessage	The error message if method call was not successful	string	None.
FileName	Suggested file name to use for the report	string	None.
FileData	Base64 encoded string of the raw report file data	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorMessage": "sample string 2",
  "FileData": "sample string 4",
  "FileName": "sample string 3",
  "IsSuccessful": true
}

application/xml, text/xml

Sample:

<ReportResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <ErrorMessage>sample string 2</ErrorMessage>
  <FileData>sample string 4</FileData>
  <FileName>sample string 3</FileName>
  <IsSuccessful>true</IsSuccessful>
</ReportResp>