Document-Literal Web Services: MsiAppExtractor

Document-Literal Web Services

MsiAppExtractor

MsiAppExtractor allows you to pass a Client (Broker, Customer, Guarantor, Lessee, or Vendor), application, or asset number and returns an XML document containing the Supported Fields that pertain to the type of record you are requesting.

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

MsiAppExtractor contains several methods, including extractApplication, extractAsset, extractLessee, and extractVendor. 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). Below is an example of one of the methods.

public extractLessee(java.lang.String, lesseeNumber)

Where lesseeNumber is the Client number of the Lessee whose record you wish to extract. This method logs in as the api user, spawns an XML driver, and does all the necessary checks to extract a Lessee record from the database. It will return either all the supported fields in the LESSEE_RECORD or a SOAP fault. It will close the connection to the XML driver automatically. 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.

Throws java.lang.Exception.

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:extractLessee soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="urn:mpower-v53a"><ns2:lesseeNumber xmlns:ns2="http://client.web.msi">25</ns2:lesseeNumber></ns1:extractLessee></soapenv:Body></soapenv:Envelope>

Sample SOAP response if Lessee exists:

<?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><extractLesseeResponse xmlns="urn:mpower-v53a"><extractLesseeReturn><?xml version="1.0"?><MSI_APP_ORIG><LESSEE_RECORD><zipCode>90141 </zipCode><shortname>DEFAULT </shortname><useTaxExemptCode>NONE</useTaxExemptCode><company> 1</company><ssnBusinessID> </ssnBusinessID><region> 1</region><name>default </name><address1>111 Anza Blvd </address1><lastPhoneUsed> </lastPhoneUsed><clientNumber> 25</clientNumber><age>0</age><portfolio> 2</portfolio><noDependents>0</noDependents><city>San Francisco </city><office> 1</office>< ;remittanceAddress>1 </remittanceAddress><state>CA</state><prenoteSent>Y</prenoteSent></LESSEE_RECORD></MSI_APP_ORIG></extractLesseeReturn></extractLesseeResponse></soapenv:Body></soapenv:Envelope>

Sample SOAP response if Lessee does not exist:

XML document, returned as a string:

<?xml version="1.0"?><MSI_APP_ORIG><LESSEE_RECORD><age>0</age><portfolio>2</portfolio><company>1 </company><name>Yogurt's-R-Us Yogurt Shop </name><address1>984 Pleasant Street </address1><city>Burlingame </city><lastPhoneUsed></lastPhoneUsed><clientNumber> 79</clientNumber><office> 1</office><zipCode>94010 </zipCode><shortname>YOGURT'S-R-US </shortname><ssnBusinessID> </ssnBusinessID><region> 1</region><noDependents>0</noDependents><prenoteSent>N </prenoteSent><state>CA</state></LESSEE_RECORD></MSI_APP_ORIG>