POST api/Document/BatchPrint/FileData
Retrieve the combined batch print file
Request Information
URI Parameters
None.
Body Parameters
BatchPrintDocumentFileDataParm| Name | Description | Type | Additional information |
|---|---|---|---|
| auth |
Authentication token |
string |
None. |
| ShipmentDocumentID |
List of shipment document identifiers |
Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"ShipmentDocumentID": [
1,
2
],
"auth": "sample string 1"
}
application/xml, text/xml
Sample:
<BatchPrintDocumentFileDataParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Shipper.Models">
<ShipmentDocumentID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</ShipmentDocumentID>
<auth>sample string 1</auth>
</BatchPrintDocumentFileDataParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BatchPrintDocumentFileDataResp| 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 |
File name |
string |
None. |
| FileData |
Base64 raw 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:
<BatchPrintDocumentFileDataResp 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> </BatchPrintDocumentFileDataResp>