getWebFormPackages

This method is used to return completed (eSigned or rejected or eSigned and rejected) Web Forms

Additional 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
status xsd:int mandatory – cannot be null or empty An integer representing the required status type. The possible values are:
  • 0 (Signed) – returns all signed Web Forms
  • 1 (Rejected)– returns all rejected Web Forms
  • 2 (Completed) – returns all completed Web Forms (Signed or Rejected).
from xsd:date time mandatory – cannot be null The start of the UTC date time range
to xsd:date time mandatory – cannot be null The end of the UTC date time range

Response

  • Type: xsd:string
    Possible return values: An xml string – will take the form of
    <Folder>
     <Package>
     <PackageDetail>
     <Id>3282705-S</Id>
     <Sender>1242000_gleech@isentry.com</Sender>
     <Recipient>1242000_gleech@isentry.com</Recipient> 
     <Subject>Loan Number=1234567890:Comment=Comment:challengeanswer1=Test:challengeanswer2=Test::LoanNumber:Comment</Subject> 
     <LoanNumber>1234567890</LoanNumber>
     <Comment>Comment</Comment>
     <NumberOfAttachments>1</NumberOfAttachments>
     <TrackingNumber>1242002-3282705</TrackingNumber>
     <Created>2014-10-20 12:03:39</Created>
     <Viewed>2014-10-20 12:03:51</Viewed>
     <Authen>true</Authen>
     <Sign>true</Sign>
     </PackageDetail>
     </Package>
    </Folder>
    

    The contents of the <Id> element will take the form digits-R if the package is a received package or digits-S if the package is a sent package.

    The metadatafield items will be all those defined within your skin but with whitespace removed, for example
    <accountname></accountname>
    <transactionid></transactionid>
    <paperout></paperout>
    The <subject></subject> entry may not always exist as this can be suppressed by skin settings.

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

    If the user is not a Compliance Officer, the response is as follows:

    ERROR: Only a Compliance Officer can call this webservice.