POST api/Document/Shipment/Create

Use this method to attach a document to a shipment

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
auth	Authorization token	string	None.
ShipmentGUID	Shipment that document is attached to	string	None.
Name	Name of the document	string	None.
Description	Description of the document	string	None.
DocumentTypeID	The document type	integer	None.
OriginalFileName	The original file name of the document (file name only, no path)	string	None.
FileData	Base64 encoded string containing the file data	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Description": "sample string 4",
  "DocumentTypeID": 1,
  "FileData": "sample string 6",
  "Name": "sample string 3",
  "OriginalFileName": "sample string 5",
  "ShipmentGUID": "sample string 2",
  "auth": "sample string 1"
}

application/xml, text/xml

Sample:

<CreateShipmentDocumentParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
  <Description>sample string 4</Description>
  <DocumentTypeID>1</DocumentTypeID>
  <FileData>sample string 6</FileData>
  <Name>sample string 3</Name>
  <OriginalFileName>sample string 5</OriginalFileName>
  <ShipmentGUID>sample string 2</ShipmentGUID>
  <auth>sample string 1</auth>
</CreateShipmentDocumentParm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseBase

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.

Response Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

<ResponseBase 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>
  <IsSuccessful>true</IsSuccessful>
</ResponseBase>