POST api/Shipper/AttachDocument

Use this method to attach a document to a shipment

Request Information

URI Parameters

None.

Body Parameters

AttachDocumentParm
NameDescriptionTypeAdditional information
auth

string

None.

ShipmentGUID

string

None.

FileName

string

None.

FileData

string

None.

DocumentTypeID

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "auth": "sample string 1",
  "ShipmentGUID": "sample string 2",
  "FileName": "sample string 3",
  "FileData": "sample string 4",
  "DocumentTypeID": 1
}

application/xml, text/xml

Sample:
<AttachDocumentParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Shipper">
  <DocumentTypeID>1</DocumentTypeID>
  <FileData>sample string 4</FileData>
  <FileName>sample string 3</FileName>
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <auth>sample string 1</auth>
</AttachDocumentParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase
NameDescriptionTypeAdditional information
IsSuccessful

Set to true if method was successful

boolean

None.

ErrorMessage

The error message if method call was not successful

string

None.

Response Formats

application/json, text/json

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

application/xml, text/xml

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