getExtendedPackageStatus

This method is used to retrieve an extended status message for a sent package. This call is usually used where there is a need to provide a status file for a calling system. The resulting XML can be streamed to a file.

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 for the sent package (see sendPackage response)

Response

Type: xsd:string
Possible return values:
- If succesful the response will be an XML format string detailing the entire package and its attachments. The exact format is dependant on how the subject fields are configured on the SDX server. These are set in the SubjectMetaData server config item.
  For example, if the server is configured to expect the fields BorrowerName1, LoanNumber and PropertyAddress the XML will look something like the example below. You will see that below the <Subject> entry there is an entry for each subject field that the SDX server expected ie. <BorrowerName1> <LoanNumber> and <PropertyAddress>
```
<?xml version="1.0" encoding="UTF-8" ?>
<Package>
	<PackageDetail>
		<Id>103003</Id>
		<Sender>loanofficer@lender.com</Sender>
		<SubmittedBy>onsite@wkfs.com</SubmittedBy>
		<ReplyTo></ReplyTo>
		<Subject>LOAN NUMBER=12345678:RECIPIENT NAME=John Smith:BRANCH NUMBER=12:PROPERTY ADDRESS=2 Somewhere, sometown, somestate:BORROWER NAME1=Alan Borrower</Subject>
		<BorrowerName1>Alan Borrower</BorrowerName1>
		<LoanNumber>12345678</LoanNumber>
		<PropertyAddress>2 Somewhere, sometown, somestate</PropertyAddress>
		<Comment></Comment>
		<NumberOfAttachments>1</NumberOfAttachments>
		<Attachments>
			<Attachment>
				<Name>loandocs.pcl</Name>
			</Attachment>
		</Attachments>
	</PackageDetail>
	<PackageStatuses>
		<PackageStatus>
			<Recipient>closer@somehwere.com</Recipient>
			<Received>2006-04-06 05:08:50</Received>
			<Viewed></Viewed>
			<Purged></Purged>
			<Recalled></Recalled>
		</PackageStatus>
	</PackageStatuses>
</Package>
```
  There will be an <Attachment> entry for each attachment and a <PackageStatus> for each recipient.
  
  The <SubmittedBy> entry will contain the username used when sendPackage was called. If the ReplyTo address supplied in the sendPackage call referred to a registered SDX user then the Sender will be set to that ReplyTo address. If the ReplyTo was not a registered user then the <ReplyTo> entry will contain that address.
- ERROR - an error occurred. This will be followed by a description of the error (e.g. ERROR : Package not found)