setPackagePapered

This method is used to set the “PaperCompleted” status on the message. This is only valid for received messages that are the result of a paper request.

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.

Response

  • Type: xsd:string
  • Possible return values:
    • “OK” - The paper completed date was set.
    • “ERROR” - an error occurred. This will be followed by a description of the error (e.g. ERROR : Wrong format for trackingNumber)