setPackagesNotes

This method is used to set the notes on received messages, i.e. it is only valid for received messages. If the message is a paper-out request then note will be accessible to the original sender of the message via the getExtendedPackageStatusEx method.

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
sNotes xsd:string mandatory – cannot be null or empty A “;” delimited list of tracking ids and note in the format 
11042-R=Paper note;11045-R=Paper note 2;11046-R=Paper note 3

The tracking ID of the package to retrieve which must be in the same form as that returned by the <Id> element in the Response togetFolderContent. The note element is the note to set on each tracking id.

Response

  • Type: xsd:string
  • Possible return values:
    • A “;” delimited list of status returns in the format
      OK:11042-R=OK;11045-R=OK;11046-R=OK;11047-R=OK;11048-R=OK
    • Messages that could not have a note set will include an error code, i.e
      OK:11042-R=OK;11045-R=OK;11046-R=OK;11047-R=OK;11048-R=ERROR: Invalid ID
WKFS