setPackagesPapered

This method is used to set the “PaperCompleted” status on a collection of messages. 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 IDs of the packages on which the papered out status should be set. These are “;” delimited and must be in the same form as that returned by the <Id> element in the Response togetFolderContent.

“11042-R;11045-R;11046-R”

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