setPackageError

This method is used to set the errors on received messages, i.e. it is only valid for received messages. The error 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
sErrors xsd:string mandatory – cannot be null or empty A “;” delimited list of tracking ids and note in the format 11042-R=Paper Error;11045-R=Paper did not print;11046-R=User was wrong

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