GET api/Document/BatchPrint/{auth}

Retrieve a list of batch print items

Request Information

URI Parameters

NameDescriptionTypeAdditional information
auth

Authorization token

string

Required

Body Parameters

None.

Response Information

Resource Description

BatchPrintDocumentResp
NameDescriptionTypeAdditional 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.

Items

List of batch print items

Collection of BatchPrintDocumentItem

None.

Response Formats

application/json, text/json

Sample:
{
  "ErrorMessage": "sample string 2",
  "IsSuccessful": true,
  "Items": [
    {
      "BatchPrintDocGUID": "sample string 1",
      "DelAirportID": "sample string 2",
      "DeliverTo": "sample string 3",
      "OrderNumber": "sample string 4",
      "OriginalFileName": "sample string 5",
      "PuAirportID": "sample string 6",
      "Reference": "sample string 7",
      "ServiceCode": "sample string 8",
      "ShipmentDocumentID": 9,
      "ShipmentGUID": "sample string 10"
    },
    {
      "BatchPrintDocGUID": "sample string 1",
      "DelAirportID": "sample string 2",
      "DeliverTo": "sample string 3",
      "OrderNumber": "sample string 4",
      "OriginalFileName": "sample string 5",
      "PuAirportID": "sample string 6",
      "Reference": "sample string 7",
      "ServiceCode": "sample string 8",
      "ShipmentDocumentID": 9,
      "ShipmentGUID": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:
<BatchPrintDocumentResp 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>
  <Items>
    <BatchPrintDocumentItem>
      <BatchPrintDocGUID>sample string 1</BatchPrintDocGUID>
      <DelAirportID>sample string 2</DelAirportID>
      <DeliverTo>sample string 3</DeliverTo>
      <OrderNumber>sample string 4</OrderNumber>
      <OriginalFileName>sample string 5</OriginalFileName>
      <PuAirportID>sample string 6</PuAirportID>
      <Reference>sample string 7</Reference>
      <ServiceCode>sample string 8</ServiceCode>
      <ShipmentDocumentID>9</ShipmentDocumentID>
      <ShipmentGUID>sample string 10</ShipmentGUID>
    </BatchPrintDocumentItem>
    <BatchPrintDocumentItem>
      <BatchPrintDocGUID>sample string 1</BatchPrintDocGUID>
      <DelAirportID>sample string 2</DelAirportID>
      <DeliverTo>sample string 3</DeliverTo>
      <OrderNumber>sample string 4</OrderNumber>
      <OriginalFileName>sample string 5</OriginalFileName>
      <PuAirportID>sample string 6</PuAirportID>
      <Reference>sample string 7</Reference>
      <ServiceCode>sample string 8</ServiceCode>
      <ShipmentDocumentID>9</ShipmentDocumentID>
      <ShipmentGUID>sample string 10</ShipmentGUID>
    </BatchPrintDocumentItem>
  </Items>
</BatchPrintDocumentResp>