RPC-Encoded Web Services: First Generation Web Services

RPC-Encoded Web Services

First Generation Web Services

Includes LPClient, LPApplication, LPAsset, and LPNotebook

These web services allow you to add or change LeasePak Clients (Broker, Customer, Guarantor, Lessee and Co-Lessee, Vendor), Applications, Pending Assets (tied to Applications), and Application Notebook records. They provide access to individual fields. When using these web services, you must call dsConnect() to start the driver before calling the web service, then call dsDisconnect() to disconnect the driver.

Supported Fields

The document Supported Fields lists fields for the various first-generation web services as sections of the comprehensive, second-generation service MsiAppOriginator:

First-Generation Web Services and Corresponding Sections of MsiAppOriginator
Web Service	Corresponding Section
LPClient	Broker, Customer, Guarantor, Lessee, Vendor
LPApplication	Application
LPAsset	Asset
LPNotebook	Notebook

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

Most methods are self explanatory in nature. For example, to set an address use setAddress1 method call; to get an address use the corresponding get method.

Only a very small number of the available methods are listed here. For a complete list of methods, refer to the Java Call Reference.

boolean dsConnect()

This method logs in and establishes a session within the mPower WSDL interface. If successful, it spawns a new XML driver. The XML driver then listens for further calls. The program stores a connection object in memory containing the socket connected to the XML driver. dsConnect() returns true on success and false on failure.

The Java RMI and Apache Axis syntax is:

lpcall.setOperationName( new QName("urn:LPWebService", "dsConnect") );

where LPWebService is LPCLient, LPApplication, LPAsset, or LPNotebook.

There are no parameters.

Sample SOAP request:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:dsConnect soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient"/>
</soapenv:Body>
</soapenv:Envelope>

Sample SOAP response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:dsConnectResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient">
<dsConnectReturn xsi:type="xsd:boolean">true</dsConnectReturn>
</ns1:dsConnectResponse>
</soapenv:Body>
</soapenv:Envelope>

java.lang.String editLessee(java.lang.String >clientNumber>)

Where clientNumber is the LeasePak Client Number of the Lessee you wish to update. This method loads the Lessee into memory for editing. Use additional methods (for example, getAddress1 and setAddress1) to modify specific field contents, then use updateLessee to save changes.

The Java RMI and Apache Axis syntax is:

lpcall.setOperationName( new QName("urn:LPClient", "editLessee") );

The parameters are:

Name	Direction	Type	Description
clientNumber / in0	Input	xsd:string	The LeasePak Client Number of the Lessee you wish to edit

Sample SOAP request:

<?xml version="1.0" encoding="UTF-8"?> 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:editLessee soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient">
<ns1:arg0 xsi:type="xsd:string">38</ns1:arg0>
</ns1:editLessee>
</soapenv:Body>
</soapenv:Envelope>

Sample SOAP response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:editLesseeResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient">
<editLesseeReturn xsi:type="xsd:string">ITEMLIST</editLesseeReturn>
</ns1:editLesseeResponse>
</soapenv:Body>
</soapenv:Envelope>

java.lang.String getAddress1()

Use this method to get the first address line of the appropriate LeasePak Client (Broker, Customer, Guarantor, Lessee, or Vendor).

All get methods use the following syntax shown below, and all return Strings.

The Java RMI and Apache Axis syntax is:

lpcall.setOperationName( new QName("urn:LPClient", "getAddress1") );

There are no parameters.

Sample SOAP request:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:getAddress1 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient"/>
</soapenv:Body>
</soapenv:Envelope>

Sample SOAP response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:getAddress1Response soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient">
<getAddress1Return xsi:type="xsd:string">235 Germantown Bend Cove #1</getAddress1Return>
</ns1:getAddress1Response> </soapenv:Body>
</soapenv:Envelope>

void setAddress1(java.lang.String in)

Where in is the string corresponding to the first address line. Use this method after getAddress1 to assign a value to the first address line of the appropriate LeasePak Client (Broker, Customer, Guarantor, Lessee, or Vendor).

All set methods use the following syntax shown below.

The Java RMI and Apache Axis syntax is:

lpcall.setOperationName( new QName("urn:LPClient", "setAddress1") );

The parameters are:

Name	Direction	Type	Description
in / in0	Input	xsd:string	The new value for the first address line of the LeasePak Client

Sample SOAP request:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:setAddress1 soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient">
<ns1:arg0 xsi:type="xsd:string">111 Anza Blvd</ns1:arg0>
</ns1:setAddress1>
</soapenv:Body>
</soapenv:Envelope>

Sample SOAP response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:setAddress1Response soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient"/>
</soapenv:Body>
</soapenv:Envelope>

void dsDisconnect()

This method logs off the server and closes the socket within the mPower WSDL interface.

The Java RMI and Apache Axis syntax is:

lpcall.setOperationName( new QName("urn:LPWebService", "dsDisonnect") );

where LPWebService is LPCLient, LPApplication, LPAsset, or LPNotebook.

There are no parameters.

Sample SOAP request:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:dsDisconnect soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient"/>
</soapenv:Body>
</soapenv:Envelope>

Sample SOAP response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
<ns1:dsDisconnectResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:LPClient"/>
</soapenv:Body>
</soapenv:Envelope>