PostalWS


Click here for a complete list of operations.

GetBatchDetails

The GetBatchDetails() method is the way to get batch details mailer reports.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
Username:
Password:
ID:
ItemID:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /2009-02-26/PostalWS.asmx HTTP/1.1
Host: api.postalmethods.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "PostalMethods/GetBatchDetails"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetBatchDetails xmlns="PostalMethods">
      <Username>string</Username>
      <Password>string</Password>
      <ID>int</ID>
      <ItemID>string</ItemID>
    </GetBatchDetails>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetBatchDetailsResponse xmlns="PostalMethods">
      <GetBatchDetailsResult>
        <ResultCode>int</ResultCode>
        <ID>int</ID>
        <Price>decimal</Price>
        <SubmitTime>dateTime</SubmitTime>
        <CompletionTime>dateTime</CompletionTime>
        <MyDescription>string</MyDescription>
        <MailerType>Letter or Postcard</MailerType>
        <WorkMode>Production or Development</WorkMode>
        <Orientation>string</Orientation>
        <Envelope>string</Envelope>
        <Paper>string</Paper>
        <PrintColor>string</PrintColor>
        <PrintSides>string</PrintSides>
        <Postcard>string</Postcard>
        <NationalMailing>string</NationalMailing>
        <InternationalMailing>string</InternationalMailing>
        <Items>
          <ItemsStatusAndDescExtended>
            <ItemID>int</ItemID>
            <Status>int</Status>
            <Description>string</Description>
            <Price>decimal</Price>
            <NumOfSheets>int</NumOfSheets>
            <LastUpdateTime>dateTime</LastUpdateTime>
          </ItemsStatusAndDescExtended>
          <ItemsStatusAndDescExtended>
            <ItemID>int</ItemID>
            <Status>int</Status>
            <Description>string</Description>
            <Price>decimal</Price>
            <NumOfSheets>int</NumOfSheets>
            <LastUpdateTime>dateTime</LastUpdateTime>
          </ItemsStatusAndDescExtended>
        </Items>
      </GetBatchDetailsResult>
    </GetBatchDetailsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /2009-02-26/PostalWS.asmx HTTP/1.1
Host: api.postalmethods.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetBatchDetails xmlns="PostalMethods">
      <Username>string</Username>
      <Password>string</Password>
      <ID>int</ID>
      <ItemID>string</ItemID>
    </GetBatchDetails>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetBatchDetailsResponse xmlns="PostalMethods">
      <GetBatchDetailsResult>
        <ResultCode>int</ResultCode>
        <ID>int</ID>
        <Price>decimal</Price>
        <SubmitTime>dateTime</SubmitTime>
        <CompletionTime>dateTime</CompletionTime>
        <MyDescription>string</MyDescription>
        <MailerType>Letter or Postcard</MailerType>
        <WorkMode>Production or Development</WorkMode>
        <Orientation>string</Orientation>
        <Envelope>string</Envelope>
        <Paper>string</Paper>
        <PrintColor>string</PrintColor>
        <PrintSides>string</PrintSides>
        <Postcard>string</Postcard>
        <NationalMailing>string</NationalMailing>
        <InternationalMailing>string</InternationalMailing>
        <Items>
          <ItemsStatusAndDescExtended>
            <ItemID>int</ItemID>
            <Status>int</Status>
            <Description>string</Description>
            <Price>decimal</Price>
            <NumOfSheets>int</NumOfSheets>
            <LastUpdateTime>dateTime</LastUpdateTime>
          </ItemsStatusAndDescExtended>
          <ItemsStatusAndDescExtended>
            <ItemID>int</ItemID>
            <Status>int</Status>
            <Description>string</Description>
            <Price>decimal</Price>
            <NumOfSheets>int</NumOfSheets>
            <LastUpdateTime>dateTime</LastUpdateTime>
          </ItemsStatusAndDescExtended>
        </Items>
      </GetBatchDetailsResult>
    </GetBatchDetailsResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /2009-02-26/PostalWS.asmx/GetBatchDetails?Username=string&Password=string&ID=string&ItemID=string HTTP/1.1
Host: api.postalmethods.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetBatchDetailsResult xmlns="PostalMethods">
  <ResultCode>int</ResultCode>
  <ID>int</ID>
  <Price>decimal</Price>
  <SubmitTime>dateTime</SubmitTime>
  <CompletionTime>dateTime</CompletionTime>
  <MyDescription>string</MyDescription>
  <MailerType>Letter or Postcard</MailerType>
  <WorkMode>Production or Development</WorkMode>
  <Orientation>string</Orientation>
  <Envelope>string</Envelope>
  <Paper>string</Paper>
  <PrintColor>string</PrintColor>
  <PrintSides>string</PrintSides>
  <Postcard>string</Postcard>
  <NationalMailing>string</NationalMailing>
  <InternationalMailing>string</InternationalMailing>
  <Items>
    <ItemsStatusAndDescExtended>
      <ItemID>int</ItemID>
      <Status>int</Status>
      <Description>string</Description>
      <Price>decimal</Price>
      <NumOfSheets>int</NumOfSheets>
      <LastUpdateTime>dateTime</LastUpdateTime>
    </ItemsStatusAndDescExtended>
    <ItemsStatusAndDescExtended>
      <ItemID>int</ItemID>
      <Status>int</Status>
      <Description>string</Description>
      <Price>decimal</Price>
      <NumOfSheets>int</NumOfSheets>
      <LastUpdateTime>dateTime</LastUpdateTime>
    </ItemsStatusAndDescExtended>
  </Items>
</GetBatchDetailsResult>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /2009-02-26/PostalWS.asmx/GetBatchDetails HTTP/1.1
Host: api.postalmethods.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&ID=string&ItemID=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<GetBatchDetailsResult xmlns="PostalMethods">
  <ResultCode>int</ResultCode>
  <ID>int</ID>
  <Price>decimal</Price>
  <SubmitTime>dateTime</SubmitTime>
  <CompletionTime>dateTime</CompletionTime>
  <MyDescription>string</MyDescription>
  <MailerType>Letter or Postcard</MailerType>
  <WorkMode>Production or Development</WorkMode>
  <Orientation>string</Orientation>
  <Envelope>string</Envelope>
  <Paper>string</Paper>
  <PrintColor>string</PrintColor>
  <PrintSides>string</PrintSides>
  <Postcard>string</Postcard>
  <NationalMailing>string</NationalMailing>
  <InternationalMailing>string</InternationalMailing>
  <Items>
    <ItemsStatusAndDescExtended>
      <ItemID>int</ItemID>
      <Status>int</Status>
      <Description>string</Description>
      <Price>decimal</Price>
      <NumOfSheets>int</NumOfSheets>
      <LastUpdateTime>dateTime</LastUpdateTime>
    </ItemsStatusAndDescExtended>
    <ItemsStatusAndDescExtended>
      <ItemID>int</ItemID>
      <Status>int</Status>
      <Description>string</Description>
      <Price>decimal</Price>
      <NumOfSheets>int</NumOfSheets>
      <LastUpdateTime>dateTime</LastUpdateTime>
    </ItemsStatusAndDescExtended>
  </Items>
</GetBatchDetailsResult>