Document-Literal Web Services

LPBookLease

LPBookLease allows you to perform a variety of functions on a booked lease, including getting the revolving credit limit of a master application or a booked lease using revolving credit, updating the revolving credit limit of a booked lease, and extracting various items of information from a booked lease.

 

API Reference

If you need additional information, Sun Microsystems maintains a Java developers' site at http://java.sun.com that includes API specifications, sample code and applications, and technical articles and tips.

Methods

LPBookLease contains several methods, including getCreditLimit, updateRevCreditLimit, and extractBookLease. For more information, refer to the Java Call Reference. For the most current list of methods available, refer to host:port/service_name/services, where host:port/service_name is the location where you've deployed your web service(s).

 

XML Inputs and Returns

getCreditLimit

This method requires a master application number or booked lease (with revolving credit) number. On failure it returns (example)

<?xml version="1.0"?><CREDLIT_LIMIT><ERROR>error message</ERROR></CREDLIT_LIMIT>

On success, it returns (example)

<?xml version="1.0"?><CREDLIT_LIMIT><INFO>1000.00</INFO></CREDLIT_LIMIT>

updateRevCreditLimit

In order to use this method, you will first need to obtain the 26-character checksum for the lease using extractBookLease

This method uses an XML input file with the following DTD:

<!ELEMENT UPDATE_RLS_RCL (leaseNumber | revolvingCreditLimit | revolvCredEffDate | dlscksum | revolvingLineFee? )>
<!ELEMENT leaseNumber (#PCDATA)>
<!ELEMENT revolvingCreditLimit (#PCDATA)>
<!ELEMENT revolvCredEffDate (#PCDATA)>
<!ELEMENT dlscksum (#PCDATA)>
<!ELEMENT revolvingLineFee (#PCDATA)>

Here is an example based on the above DTD:

<?xml version="1.0"?><UPDATE_RLS_RCL><leaseNumber>50</leaseNumber>
<revolvingCreditLimit>10000000.00</revolvingCreditLimit>
<revolvCredLimEffDate>112306</revolvCredLimEffDate>
<dlscksum>75e17e5acb22908ff51c2bd971c87fb4</dlscksum>
<revolvingLineFee>.0005</revolvingLineFee>
</UPDATE_RLS_RCL>

where the date is in MMDDYY format and the dlscksum is the 26-character checksum obtained from extractBookLease.

On success this returns

<?xml version="1.0"?><UPDATE_RLS_RCL>
<INFO>Lease updated.</INFO></UPDATE_RLS_RCL>

On failure this returns

<?xml version="1.0"?><UPDATE_RLS_RCL>
<ERROR>error message</ERROR></UPDATE_RLS_RCL>

extractBookLease

This method takes a booked lease number as input. On success it returns (example)

<?xml version="1.0"?><BOOKLEASE_RECORD><leaseNumber>50</leaseNumber>
<accruedPrincipalBalance>10000000.00</accruedPrincipalBalance >
<portfolio>2</portfolio>
<dlscksum>75e17e5acb22908ff51c2bd971c87fb4</dlscksum>
<company>1</company><region>1</region>
<office>1</office>
</BOOKLEASE_RECORD>

On failure it returns (example)

<?xml version="1.0"?><BOOKLEASE_RECORD>
<ERROR>error message</ERROR></BOOKLEASE_RECORD>

 

disburseCheck

 public String disburseCheck(String xmlDocument)   

This new method takes XML input file, validate the values of the elements of XML, and then process the check disbursal.

 throws RemoteException;   

This method uses an XML input file with the following DTD:

<!ELEMENT CHECK_UPDATE (CHECK_RECORD+)>
<!ELEMENT CHECK_RECORD (disbursementType, asset, checkAmount, disbursementDate, reference?, bankCode, payeeNumber?, payeeName?, payeeAddress?, payeeCity?, payeeState?, payeeZip?)>
<!ELEMENT disbursementType (#PCDATA)>>
<!ELEMENT asset (#PCDATA)>> 
<!ELEMENT checkAmount (#PCDATA)> 
<!ELEMENT disbursementDate (#PCDATA)> 
<!ELEMENT reference (#PCDATA)>
<!ELEMENT bankCode (#PCDATA)> 
<!ELEMENT payeeNumber (#PCDATA)> 
<!ELEMENT payeeName (#PCDATA)> 
<!ELEMENT payeeAddress (#PCDATA)> 
<!ELEMENT payeeCity (#PCDATA)> 
<!ELEMENT payeeState (#PCDATA)> 
<!ELEMENT payeeZip (#PCDATA)>  

Here is an example based on the above DTD:

<CHECK_UPDATE>
  <CHECK_RECORD> 
     <disbursementType>NEWD</disbursementType> 
	    <asset>79</asset>
	    <checkAmount>1234.56</checkAmount> 
	 	<disbursementDate>891031</disbursementDate>
	 	<reference>Reference text</reference> 
	 	<bankCode>126</bankCode> 
	 	<payeeNumber>1</payeeNumber> 
	 	<payeeName>COPIERWORLD, INC.</payeeName> 
	 	<payeeAddress>616 MARKET STREET</payeeAddress> 
	 	<payeeCity>SAN FRANCISCO</payeeCity> 
	 	<payeeState>CA</payeeState> 
	 	<payeeZip>94111</payeeZip>
  </CHECK_RECORD>
</CHECK_UPDATE>

On success it returns

<CHECK_UPDATE>
<INFO> API Processing Started.</INFO> 
<INFO>ASSET:(###) disbursed successfully.</INFO> 
<INFO> API Processing Stopped.</INFO>  
</CHECK_UPDATE> 

On failure it returns (example)

<CHECK_UPDATE> 
<INFO> API Processing Started.</INFO> 
<ERROR>ASSET:(###) Error Message Description.</ERROR>  
<ERROR> API Processing Stopped due to error.</ERROR>  
</CHECK_UPDATE> 

Method Output

This method will output an audit report named lpu0101d.rpt to the user�s home directory, the same as if the checks were disbursed using U0101 Disburse Check. If multiple calls are made to this new method, the audit report will be overwritten each time, so make sure to plan for making a copy of the report with a unique name if you wish to save it.