getCountOfPackagesInFolderEx

This method is used to retrieve the number of packages in a folder.

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
folderType xsd:int mandatory – cannot be null or empty An integer representing the required folder type. The possible values are:
  • 0 – inbox
  • 1 – sent items
  • 2 – archived items
  • 3 – deleted items
filterString xsd:string mandatory – cannot be null or empty A filter string to allow calling process to find all opened, viewed etc.
The current list of filters is included below but this list is subject to change over time. Filters are NOT removed, however.
  • RECEIVED - Packages created but not viewed by recipient
  • WAITING - Packages created but not viewed by recipient
  • PURGED - Packages that has been purged
  • RECALLED - Packages that has been recalled
  • PAPERREQUESTED - Packages where a paper version has been requested by the recipient or by the system
  • PAPERCOMPLETED - Packages completed by paper out process
  • SIGNED - Packages signed by recipient
  • REJECTED - Packages rejected by recipient
  • CONSENTED - Packages consented by recipient
  • PAPERDIRECT - Packages sent direct to paper
  • PAPERNOTE - Packages with a paper note date set
  • ALL - Packages received including those purged and recalled
  • OPEN - Packages received excluding those purged and recalled
  • VIEWED - Packages viewed by recipient
  • EDISCLOSURES - Packages signed, rejected, consented, paper requested, sent direct to paper, or paper completed
  • DISCLOSURECOMPLETE - Packages consented or paper completed by recipient

The getPackageStatusTypes call will return all active filter types available.

Response

  • Type: xsd:string

    Possible return values: A string containing the number of packages in the folder

    An error in format

  • “ERROR” - an error occurred. This will be followed by a description of the error (e.g. ERROR : Invalid folderType)
WKFS