getPackageTrackingIds

This method is used to retrieve a list of package tracking ids for a specific sender. It is typically used by a calling system that wants to refresh its own view of all sent messages.

Request Parameters

Parameter Type Requirement Description
username xsd:string mandatory – cannot be null or empty The username of the registered user who sent the package
password xsd:string mandatory – cannot be null or empty The password of the registered user who sent the package
encodedPassword xsd:boolean optional – can be null (indicates false) Indicates whether the password parameter is MD5 encoded
trackingFilter xsd:string mandatory – cannot be null or empty The tracking filters to be applied. Please see getPackageStatusTypes for information on values that can be sent

Response

Possible return values:
  • Type: xsd:string
    <trackingids>
     <packageid>
     <id></id>
     <status></status>
     <date></date>
     </packageid>
    </trackingids>
    with a <packageid> entry for each of the package that meets the filtering requirement. There are many possible contents for the <status> elements depending on the type of packages being requested. For details, refer to getPackageStatusTypes.
  • “ERROR” - an error occurred. This will be followed by a description of the error (e.g. ERROR : Package not found)