setPackageNote

This method is used to set the note on a received message, 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
trackingNumber xsd:string mandatory – cannot be null or empty 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.
sNote xsd:string mandatory – cannot be null or empty The note to set on this message.

Response

Type: xsd:string

Possible return values:
  • “OK” - The note was set.
  • “ERROR” - an error occurred. This is followed by a description of the error (e.g. ERROR : Wrong format for trackingNumber)
WKFS