GetStatus

Description

The GetStatus() method is the simplest way to get a status report of a single, multiple or range of letters or postcards sent through the PostalMethods service.

Formal Definition

https://api.postalmethods.com/2009-02-26/PostalWS.asmx?op=GetStatus

Input

Property Type Comments
Username String As provided during registration
Password String As provided during registration
ID String Single Item: Matches the ID provided as the response for the original Web Service request.
Multiple Items: ID1,ID2,ID3. Response is provided for up to 1000 letters per query. Additional items are ignored. Items not assigned to the account or which the user has no permission to access are returned with a "No Permissions" status code.
Range Of Items: LowerID-HigherID. Response is provided for up to 1000 letters per query. Additional items are ignored. Items not assigned to the account or which the user has no permission to access will not be returned.

Output: GetStatusResponse

Structure: GetStatusResult

Element Type Comments
ResultCode int Result code for this Web Service request. Possible result codes appear in the Web Service Result Codes list.
Statuses Array Array of LetterStatusAndDesc structures

 

Structure: LetterStatusAndDesc

Element Type Comments
ID int Corresponds to one of the IDs sent in the request
Status int The current status code of the letter or postcard.
Letter Sending Status Codes
Description string The text description for the status code of the letter or postcard.
Letter Sending Status Codes
LastUpdateTime DateTime The time stamp of the last update made to the letter or postcard's status.

Change Log

  • Cancel methods: "GetLetterStatusV2", "GetLetterStatusV2_Multiple" and "GetLetterStatusV2_Range".
  • Provide status results for letters AND postcards.
  • Change "ID" type to string.
  • Results are provided as an array.