RPC-Encoded Web Services
For applications:
LinkIT
Describes the RPC-Encoded LeasePak web services that include LPClient, LPApplication, LPAsset, LPNotebook, and MsiAppOriginator.
Introduction
The web services consist of a first generation, first implemented in 5.1a, that includes LPClient, LPApplication, LPAsset, and LPNotebook, and a second generation, first implemented in 5.2a, that includes MsiAppOriginator. These services are synchronous, RPC (Remote Procedure Call) style web services. They use simple types, with all types being treated as String data (although field values are converted to their proper data types when inserted in the LeasePak database.
The following is an example of how a LeasePak API web service is created and used in Java:
// these are the required import statements to use the Apache Axis API
import org.apache.axis.client.Call;
import org.apache.axis.client.Service;
import org.apache.axis.encoding.XMLType;
// these imports are used to print out SOAP messages
import org.apache.axis.MessageContext;
import org.apache.axis.Message;
import org.apache.axis.AxisFault;
// more required imports
import javax.xml.namespace.QName;
import javax.xml.rpc.ParameterMode;
public class LPWebServiceTemplate {
// this is a method that allows you to print out the SOAP request and SOAP response
// useful for debugging
public static void printCallRequestResponse(Call lpcall) throws AxisFault {
MessageContext ctx = lpcall.getMessageContext();
Message requestMsg = ctx.getRequestMessage();
Message responseMsg = ctx.getResponseMessage();
System.out.println("SOAP REQUEST : " + requestMsg.getSOAPPartAsString());
System.out.println();
System.out.println("SOAP RESPONSE : " + responseMsg.getSOAPPartAsString());
System.out.println();
}
public static void main(String [] args) {
try {
String lpendpoint = "http://hostname:port/deployed_location/services/service_name";
// where hostname is the name of your host machine, port is your port number,
// deployed_location is the root directory where mPower is deployed, and
// service_name is the name of the web service (LPClient, LPApplication, MsiAppOriginator, etc.)
Service lpservice = new Service();
Call lpcall = (Call)lpservice.createCall();
lpcall.setTargetEndpointAddress(new java.net.URL(lpendpoint) );
// for the LeasePak API web services, the caller must maintain state (session)
lpcall.setProperty(call.SESSION_MAINTAIN_PROPERTY,new Boolean(true));
// call to log in
lpcall.setOperationName(new QName("urn:LPWebService", "lpMethod") );
// where LPWebService is LPCLient, LPApplication, MsiAppOriginator, etc., and
// lpMethod is the method you are executing (for first generation services, you must execute dsConnect first;
// for MsiAppOriginator, you can execute createApplication, getMessages, etc.)
Type result = lpcall.invoke(new Object[]{optional_arguments});
// where Type is the return data type (boolean, java.lang.String, void, etc.)
printCallRequestResponse(lpcall);
} catch (Exception e) {
System.out.println(e.toString());
}
}
}
The web services use Web Service Definition Language (WSDL) to generate client proxy classes that allow the user to treat a web service (such as LPClient) as a local object. The documentation includes an example (Java RMI/Apache Axis , presented as an HTML document) of LPClient, lpclient_wsdl.java.
The session data is stored in a Java Map. Each object (LPClient, LPApplication, LPAsset, LPNotebook, MsiAppOriginator) has its own
connection to LeasePak and each object maintains a connection to the LeasePak XML driver until dsDisconnect() is called
(MsiAppOriginator calls dsConnect() and dsDisconnect() internally, transparent to the user). Most
errors (or SOAP exceptions) are caught and re-thrown so the program can close the connection. If an unexpected error occurs, connections
and XML drivers could remain open and running. NetSol recommends checking for open connections and running drivers after receiving an error
or exception, and reporting any occurrences of open connections or running drivers to MSI.
First Generation
LPClient, LPApplication, LPAsset, 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 Web Services API: Supported Fields lists fields for the various first-generation web services as sections of the comprehensive, second-generation service 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.
dsConnectreturns 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,
getAddress1andsetAddress1) to modify specific field contents, then useupdateLesseeto 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
getmethods 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
getAddress1to assign a value to the first address line of the appropriate LeasePak Client (Broker, Customer, Guarantor, Lessee, or Vendor).All
setmethods 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>
Second Generation
MsiAppOriginator
The web service MsiAppOriginator allows you to load XML-format Client, Application, Asset, Insurance, and User Defined Fields information into the LeasePak database. It also enables you to delete pending assets. Unlike the first generation web services, MsiAppOriginator makes calls to dsConnect and dsDisconnect automatically as needed.
Supported Fields
The document Web Services API: Supported Fields lists fields supported by MsiAppOriginator.
The documentation also includes a sample file, used in the createApplication SOAP request/response example,
create_app_sample.htm.
Methods
- boolean createApplication(java.lang.String xmlDocument, boolean addOnly)
- Where xmlDocument is the entire contents (as a String) of the XML document containing the records
you wish to add to LeasePak, and addOnly is either true to not make updates to any existing LeasePak data
or false if your XML data contains updates to existing records.
The available XML child elements within MSI_APP_ORIG are:
CUSTOMER_RECORD (none required, only 1 allowed) LESSEE_RECORD (at least one required, many allowed) GUARANTOR_RECORD (none required, many allowed) VENDOR_RECORD (none required, many allowed) BROKER_RECORD (none required, many allowed) APPLICATION_RECORD (none required, only 1 allowed) ASSET_DELETE (none required, only 1 allowed) ASSET_RECORD (none required, many allowed) INSURANCE_RECORD (none required, only 1 allowed) NOTEBOOK_RECORD (none required, only 1 allowed) UDF_FIELDS_RECORD (none required, many allowed)
Child elements are processed in the order specified above: all Customer elements first, then all Lessee elements, etc. If processing a child element results in an error or exception, no adds or updates are made for that element, and no further processing of child elements within the parent MSI_APP_ORIG element occurs.
ASSET_DELETE
Use this child element instead of the deprecated
deleteAssetsmethod to delete all pending assets from an application:<ASSET_DELETE> <appNumber>application_number</appNumber> </ASSET_DELETE>
where application_number is the application for which you wish to delete all pending assets.
XML Data Requirements
Data within the xmlDocument string must meet the following requirements:
- No empty elements. For example,
<appNumber></appNumber>in the XML string will throw an error; - No carriage returns, new line characters, or spaces between the closing tag of one element and the opening tag of the next.
Below is an example (in Java) of how to strip CR/NL and between-element spaces from your XML text:
String xml = new String(); // where xml is the XML document (as a String) containing the records you wish to add to LeasePak StringBuffer data = new StringBuffer(); BufferedReader reader = new BufferedReader(new StringReader(xml)); String res = reader.readLine(); while ( res != null ) { data.append(res.trim()); res = reader.readLine(); }
MsiAppOriginator Method Information
The Java RMI and Apache Axis syntax for the method is:
lpcall.setOperationName( new QName("urn:MsiAppOriginator", "createApplication") );The parameters are:
Name Direction Type Description xmlDocument / in0 Input xsd:string The XML document (as a String) containing the records you wish to add to LeasePak addOnly / in1 Input xsd:boolean true to not make updates to any existing LeasePak data or false if your XML data contains updates to existing records Sample SOAP request:
The following was generated using the XML data from create_app_sample.htm. Note that line breaks have been added to improve readability--the actual SOAP request does not contain any line breaks or spaces between XML elements.
<?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:createApplication soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:mpower-v52a"> <ns1:arg0 xsi:type="xsd:string"> <?xml version="1.0" encoding="iso-8859-1"?> <!-- application_full.xml, from msi_app_orig.dtd "//McCue Systems Incorporated//DTD MSI_APP_ORIG 1.0//EN " --><!-- APPLICATION_RECORD using established clients from complete_ok_01.xml --> <MSI_APP_ORIG><APPLICATION_RECORD><portfolio>2</portfolio> <company>1</company><region>1</region> <office>1</office><vendor>262</vendor> <broker>263</broker><investor>264</investor> <lessee>259</lessee><leaseDate>071604</leaseDate> <commencementDate>071604</commencementDate><disbursementDate>071604</disbursementDate> <documentSentDate>070104</documentSentDate><documentCompleteDate>071604</documentCompleteDate> <dueDate>16</dueDate><lessorAccrualMethod>RAPR</lessorAccrualMethod> <vendorAccrualMethod>RAPR</vendorAccrualMethod><investorAccrualMethod>RAPR</investorAccrualMethod> <leaseSource>BROK</leaseSource><formCode>PCFL</formCode> <advancePaymentBegins>0</advancePaymentBegins><advancePaymentEnds>0</advancePaymentEnds> <delinquencyWatchCode>0</delinquencyWatchCode><brokerPaymentCode>PRIN</brokerPaymentCode> <lateChargeAsmt>GFL6</lateChargeAsmt><leaseTypeCode>FIN</leaseTypeCode> <purOptionBillingMethod>NONE</purOptionBillingMethod><purchaseOption>PAY</purchaseOption> <purOptionOwner>LSSR</purOptionOwner><marketCode>SUB</marketCode> <accountCode>PRFR</accountCode><applicationType>NEW</applicationType> <ratePlan>RAT1</ratePlan><upfrontSalesTaxCode>PAID</upfrontSalesTaxCode> <documentTypeCode>DOC1</documentTypeCode><primeRateBankNumber>1</primeRateBankNumber> <lateChargeIndex>1</lateChargeIndex><productTypeCode>LSE</productTypeCode> <businessPersonal>B</businessPersonal><openCloseLeaseType>O</openCloseLeaseType> <assumedPayment>N</assumedPayment><refundable>N</refundable> <preauthSwitch>Y</preauthSwitch><billingLevel>L</billingLevel> <statementCode>I</statementCode><normalMstrSub>N</normalMstrSub> <automaticChargeOff>N</automaticChargeOff><generalDescription>Placid Inventory System 3000</generalDescription> <tradeinDescription>Not Applicable</tradeinDescription><vendContactName>George Brunelli</vendContactName> <vendPhoneNum>518-555-0999</vendPhoneNum><brkrContactName>Celia Modo</brkrContactName> <brkrPhoneNum>303-555-9999</brkrPhoneNum><securityDeposit>500.00</securityDeposit> <downPayment>500.00</downPayment><residual>500.00</residual> <fundingInterestOwedOrEarned>150.00</fundingInterestOwedOrEarned><leaseAddressName>Marcelli & Marcelli</leaseAddressName> <leaseAddress1>19050 Anza Ave.</leaseAddress1><leaseAddress2>Apt. 9E</leaseAddress2> <leaseCity>Torrance</leaseCity><leaseState>CA</leaseState> <leaseZipCode>90503</leaseZipCode><billingName>Marcelli & Marcelli</billingName> <billingAddress1>PO Box 23054</billingAddress1><billingAddress2>Attn: Ruth & Freddie</billingAddress2> <billingCity>Torrance</billingCity><billingState>CA</billingState> <billingZipCode>905233054</billingZipCode><groupNumber>1</groupNumber> <term>36</term><gracePeriodInDays>3</gracePeriodInDays> <npvDiscountRate>5</npvDiscountRate><documentationFee>50.00</documentationFee> <interimRent>150.00</interimRent><brokerFees>250.00</brokerFees> <guaranteedPortionOfResidual>250.00</guaranteedPortionOfResidual><upfrontTitlingTaxPaid>250.00</upfrontTitlingTaxPaid> <upfrontSalesTaxOnCost>412.50</upfrontSalesTaxOnCost><advancedMoneyReceived>500.00</advancedMoneyReceived> <acquisitionCost>5000.00</acquisitionCost><paymentFreq>MON</paymentFreq> <paymentAmount>200.00</paymentAmount><notaryFeePayable>263</notaryFeePayable> <insurancePremiumPayTo>263</insurancePremiumPayTo><dealerRecourse>LMTD</dealerRecourse> <creditQuality>A</creditQuality><optionalInsurance>NONE</optionalInsurance> <accountType>L</accountType><revolvingCreditLimit>20000.00</revolvingCreditLimit> <sumOfPayments>7200.00</sumOfPayments><invoiceFormatCode>GENR</invoiceFormatCode> <payment_Freq_0>9</payment_Freq_0><payment_Amount_0>200.00</payment_Amount_0> <payment_Code_0>MON</payment_Code_0><payment_Freq_1>9</payment_Freq_1> <payment_Amount_1>200.00</payment_Amount_1><payment_Code_1>MON</payment_Code_1> <payment_Freq_2>9</payment_Freq_2><payment_Amount_2>200.00</payment_Amount_2> <payment_Code_2>MON</payment_Code_2><payment_Freq_3>9</payment_Freq_3> <payment_Amount_3>200.00</payment_Amount_3><payment_Code_3>MON</payment_Code_3> <recurringChargeStartDate_0>081604</recurringChargeStartDate_0><recurringChargeMaturityDate_0>071607</recurringChargeMaturityDate_0> <recurringChargeAmount_0>10.00</recurringChargeAmount_0><bndlRecurrChgOnInvo_0>Y</bndlRecurrChgOnInvo_0> <recurringChargeStartDate_1>081604</recurringChargeStartDate_1><recurringChargeMaturityDate_1>071607</recurringChargeMaturityDate_1> <recurringChargeDealerPayable_1>262</recurringChargeDealerPayable_1><recurringChargeAmount_1>20.00</recurringChargeAmount_1> <bndlRecurrChgOnInvo_1>N</bndlRecurrChgOnInvo_1><recurringChargeStartDate_2>081604</recurringChargeStartDate_2> <recurringChargeMaturityDate_2>071607</recurringChargeMaturityDate_2><recurringChargeAmount_2>30.00</recurringChargeAmount_2> <bndlRecurrChgOnInvo_2>Y</bndlRecurrChgOnInvo_2><recurringChargeStartDate_3>081604</recurringChargeStartDate_3> <recurringChargeMaturityDate_3>071607</recurringChargeMaturityDate_3><recurringChargeBrkrPayable_3>263</recurringChargeBrkrPayable_3> <recurringChargeAmount_3>40.00</recurringChargeAmount_3><bndlRecurrChgOnInvo_3>N</bndlRecurrChgOnInvo_3> <salesPersonNumber_0>JOE</salesPersonNumber_0><salesPersonDollarPrct_0>60</salesPersonDollarPrct_0> <salesPersonVolumePrct_0>55</salesPersonVolumePrct_0><salesPersonNumber_1>EDIE</salesPersonNumber_1> <salesPersonDollarPrct_1>40</salesPersonDollarPrct_1><salesPersonVolumePrct_1>45</salesPersonVolumePrct_1> <clientRelationshipType_0>LES</clientRelationshipType_0><client_Number_0>260</client_Number_0> <clientRelationshipType_1>GRT</clientRelationshipType_1><client_Number_1>261</client_Number_1> </APPLICATION_RECORD></MSI_APP_ORIG> </ns1:arg0> <ns1:arg1 xsi:type="xsd:boolean">true</ns1:arg1> </ns1:createApplication> </soapenv:Body> </soapenv:Envelope>
Sample SOAP response:
The following was generated using the XML data from create_app_sample.htm
<?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:createApplicationResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:mpower-v52a"> <createApplicationReturn xsi:type="xsd:boolean">true</createApplicationReturn> </ns1:createApplicationResponse> </soapenv:Body> </soapenv:Envelope>
- No empty elements. For example,
- boolean createApplicationAsUser(java.lang.String username,
java.lang.String pwd,
java.lang.String xmlDocument,
boolean addOnly) - Where username is the name of the user you wish to log on as, pwd is that user's LeasePak client string
password, xmlDocument is the entire contents (as a String) of the XML document containing the records
you wish to add to LeasePak, and addOnly is either true to not make updates to any existing LeasePak data
or false if your XML data contains updates to existing records.
This method is identical to
createApplicationexcept that you supply a logon user name and password instead of using the default API user name and password.The Java RMI and Apache Axis syntax for the method is:
lpcall.setOperationName( new QName("urn:MsiAppOriginator", "createApplicationAsUser") );The parameters are:
Name Direction Type Description username / in0 Input xsd:string User name you wish to log on as pwd / in1 Input xsd:string Password (LeasePak client string) for the user xmlDocument / in2 Input xsd:string The XML document (as a String) containing the records you wish to add to LeasePak addOnly / in3 Input xsd:boolean true to not make updates to any existing LeasePak data or false if your XML data contains updates to existing records - boolean deleteAssets(java.lang.String applicationNumber)
- Deprecated: do not use this method. Use the XML ASSET_DELETE element instead.
- java.lang.String getMessages()
- Call this method after using any of the other methods to retrieve record keys (if applicable) and messages.
The Java RMI and Apache Axis syntax for the method is:
lpcall.setOperationName( new QName("urn:MsiAppOriginator", "getMessages") );There are no parameters.
Sample SOAP request:
The following was generated using the XML data from create_app_sample.htm
<?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:getMessages soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:mpower-v52a"/> </soapenv:Body> </soapenv:Envelope>
Sample SOAP response:
The following was generated using the XML data from create_app_sample.htm. Note that line breaks have been added to improve readability--the actual SOAP request does not contain any line breaks or spaces between elements.
<?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:getMessagesResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:mpower-v52a"> <getMessagesReturn xsi:type="xsd:string"> <?xml version="1.0"?><MSI_APP_ORIG_MSGS><INFO>Processing started.</INFO> <INFO>CUSTOMER: No record to process.</INFO><INFO>LESSEE: No records to process.</INFO> <INFO>GUARANTOR: No records to process.</INFO><INFO>BROKER: No records to process.</INFO> <INFO>VENDOR: No records to process.</INFO><INFO>APPLICATION: Processing started.</INFO> <INFO>APPLICATION: (): New Application Created: 180</INFO> <INFO>APPLICATION: Processing completed.</INFO><INFO>ASSET: No records to process.</INFO> <INFO>INSURANCE: No records to process.</INFO><INFO>USER DEFINED FIELDS: No records to process.</INFO> <INFO>Processing completed.</INFO></MSI_APP_ORIG_MSGS> </getMessagesReturn> </ns1:getMessagesResponse> </soapenv:Body> </soapenv:Envelope>
Additional Information
These are links to other documents providing additional information on the web services:
- Java Call Reference
- Java call reference including all methods used by LeasePak web services, presented as a self-contained set of HTML documents using frames.
- lpclient_wsdl_rpc.java
- A WSDL example (Java RMI/Apache Axis , presented as an HTML document) of the web service LPClient.
- MsiAppOriginator Document Type Definition (DTD)
- The DTD for the MSI_APP_ORIG parent element and all children, preformatted within an HTML document. A plain text version is also available.
- Web Services API: Supported Fields
- API fields and their corresponding LeasePak database columns supported by the MsiAppOriginator web service for LinkIT.
- XML Sample: MSI_APP_ORIG/APPLICATION_RECORD
- A sample of the XML document used to create an application through the Web Services API, preformatted within an HTML document. A plain text version is also available.
LeasePak Documentation Suite
© by NetSol Technologies Inc. All rights reserved.
The information contained in this document is the property of NetSol Technologies Inc. Use of the information contained herein is restricted. Conditions of use are subject to change without notice. NetSol Technologies Inc. assumes no liability for any inaccuracy that may appear in this document; the contents of this document do not constitute a promise or warranty. The software described in this document is furnished under license and may be used or copied only in accordance with the terms of said license. Unauthorized use, alteration, or reproduction of this document without the written consent of NetSol Technologies Inc. is prohibited.