PostalWS Web Service

PostalWS

Click here for a complete list of operations.

GetDetails

The GetDetails() method is a way to get detailed mailer reports.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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/GetDetails"

<?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>
    <GetDetails xmlns="PostalMethods">
      <Username>string</Username>
      <Password>string</Password>
      <ID>string</ID>
    </GetDetails>
  </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>
    <GetDetailsResponse xmlns="PostalMethods">
      <GetDetailsResult>
        <ResultCode>int</ResultCode>
        <Details>
          <Details>
            <ID>int</ID>
            <Price>decimal</Price>
            <NumOfSheets>int</NumOfSheets>
            <SubmitTime>dateTime</SubmitTime>
            <CompletionTime>dateTime</CompletionTime>
            <Status>int</Status>
            <StatusDescription>string</StatusDescription>
            <IsBatch>boolean</IsBatch>
            <MyDescription>string</MyDescription>
            <MailerType>Letter or Postcard</MailerType>
            <WorkMode>Production or Development</WorkMode>
          </Details>
          <Details>
            <ID>int</ID>
            <Price>decimal</Price>
            <NumOfSheets>int</NumOfSheets>
            <SubmitTime>dateTime</SubmitTime>
            <CompletionTime>dateTime</CompletionTime>
            <Status>int</Status>
            <StatusDescription>string</StatusDescription>
            <IsBatch>boolean</IsBatch>
            <MyDescription>string</MyDescription>
            <MailerType>Letter or Postcard</MailerType>
            <WorkMode>Production or Development</WorkMode>
          </Details>
        </Details>
      </GetDetailsResult>
    </GetDetailsResponse>
  </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>
    <GetDetails xmlns="PostalMethods">
      <Username>string</Username>
      <Password>string</Password>
      <ID>string</ID>
    </GetDetails>
  </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>
    <GetDetailsResponse xmlns="PostalMethods">
      <GetDetailsResult>
        <ResultCode>int</ResultCode>
        <Details>
          <Details>
            <ID>int</ID>
            <Price>decimal</Price>
            <NumOfSheets>int</NumOfSheets>
            <SubmitTime>dateTime</SubmitTime>
            <CompletionTime>dateTime</CompletionTime>
            <Status>int</Status>
            <StatusDescription>string</StatusDescription>
            <IsBatch>boolean</IsBatch>
            <MyDescription>string</MyDescription>
            <MailerType>Letter or Postcard</MailerType>
            <WorkMode>Production or Development</WorkMode>
          </Details>
          <Details>
            <ID>int</ID>
            <Price>decimal</Price>
            <NumOfSheets>int</NumOfSheets>
            <SubmitTime>dateTime</SubmitTime>
            <CompletionTime>dateTime</CompletionTime>
            <Status>int</Status>
            <StatusDescription>string</StatusDescription>
            <IsBatch>boolean</IsBatch>
            <MyDescription>string</MyDescription>
            <MailerType>Letter or Postcard</MailerType>
            <WorkMode>Production or Development</WorkMode>
          </Details>
        </Details>
      </GetDetailsResult>
    </GetDetailsResponse>
  </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/GetDetails?Username=string&Password=string&ID=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"?>
<GetDetailsResult xmlns="PostalMethods">
  <ResultCode>int</ResultCode>
  <Details>
    <Details>
      <ID>int</ID>
      <Price>decimal</Price>
      <NumOfSheets>int</NumOfSheets>
      <SubmitTime>dateTime</SubmitTime>
      <CompletionTime>dateTime</CompletionTime>
      <Status>int</Status>
      <StatusDescription>string</StatusDescription>
      <IsBatch>boolean</IsBatch>
      <MyDescription>string</MyDescription>
      <MailerType>Letter or Postcard</MailerType>
      <WorkMode>Production or Development</WorkMode>
    </Details>
    <Details>
      <ID>int</ID>
      <Price>decimal</Price>
      <NumOfSheets>int</NumOfSheets>
      <SubmitTime>dateTime</SubmitTime>
      <CompletionTime>dateTime</CompletionTime>
      <Status>int</Status>
      <StatusDescription>string</StatusDescription>
      <IsBatch>boolean</IsBatch>
      <MyDescription>string</MyDescription>
      <MailerType>Letter or Postcard</MailerType>
      <WorkMode>Production or Development</WorkMode>
    </Details>
  </Details>
</GetDetailsResult>

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/GetDetails HTTP/1.1
Host: api.postalmethods.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

Username=string&Password=string&ID=string

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

<?xml version="1.0" encoding="utf-8"?>
<GetDetailsResult xmlns="PostalMethods">
  <ResultCode>int</ResultCode>
  <Details>
    <Details>
      <ID>int</ID>
      <Price>decimal</Price>
      <NumOfSheets>int</NumOfSheets>
      <SubmitTime>dateTime</SubmitTime>
      <CompletionTime>dateTime</CompletionTime>
      <Status>int</Status>
      <StatusDescription>string</StatusDescription>
      <IsBatch>boolean</IsBatch>
      <MyDescription>string</MyDescription>
      <MailerType>Letter or Postcard</MailerType>
      <WorkMode>Production or Development</WorkMode>
    </Details>
    <Details>
      <ID>int</ID>
      <Price>decimal</Price>
      <NumOfSheets>int</NumOfSheets>
      <SubmitTime>dateTime</SubmitTime>
      <CompletionTime>dateTime</CompletionTime>
      <Status>int</Status>
      <StatusDescription>string</StatusDescription>
      <IsBatch>boolean</IsBatch>
      <MyDescription>string</MyDescription>
      <MailerType>Letter or Postcard</MailerType>
      <WorkMode>Production or Development</WorkMode>
    </Details>
  </Details>
</GetDetailsResult>

Parameter	Value
Username:
Password:
ID: