GetAdapterDetails Method

The GetAdapterDetails method returns a list of SiAdapters available to SmartOffice users. Details for each adapter—such as the adapter ID, type and URL—are included in the response. This method is used in conjunction with the GetAdapterTransfDetails method to launch any of those adapters.

The GetAdapterDetails method is invoked using the MethodOperation.

Parameters

Name Type Description
ContextName String Required. Specifies the context that the adapters returned in the response must support. For example, to retrieve all adapters that can be run from a contact record, specify a ContextName of Contact. Valid contexts are: None, Contact, Policy, Pending Case, Investment, Opportunity, Commission, Agent, Household, ProposalTracking, Carrier, Requirement, Skip, LicenseList, ContractList, AppointmentList, License-Only, Wholesaler.

Examples

The following request retrieves a list of adapters that the user can access from SmartOffice contact records. The response shows that the user has access to two adapters.

Request XML
<request version='1.0'>
    <header>
        <office> myoffice</office>
        <user>jdoe</user>
        <password>password<password/>
    </header>
    <method>
        <GetAdapterDetails>
            <ContextName>Contact</ContextName>
        </GetAdapterDetails>
    </method>
</request>

Response XML
<?xml version="1.0" encoding="UTF-8" ?> 
<response version="1.0">
    <header>
        <sessionClosed /> 
    </header>
    <method>
        <GetAdapterDetails>
            <SIAdapterList>
                <SIAdapter>
                    <AdapterID>418</AdapterID>
                    <AdapterName>Labels - SmartLink</AdapterName>
                    <ButtonName>smartlabel</ButtonName>
                    <FileName>solabel.elb6</FileName>
                    <AdapterType>Local Application</AdapterType>
                    <WebSiteURL>http://www.google.com</WebSiteURL>
                </SIAdapter>
                <SIAdapter>
                    <AdapterID>458</AdapterID>
                    <AdapterName>Life Quote</AdapterName>
                    <ButtonName>vitalterm</ButtonName>
                    <ButtonToolTipName>Life Quote-REL</ButtonToolTipName>
                    <AdapterType>Web Server</AdapterType>
                    <WebSiteURL>https://dxo20qa.ez-data.com/dxoapp/siadapter?service-name=Life Quote</WebSiteURL>
                </SIAdapter>
            </SIAdapterList>
        </GetAdapterDetails> 
    </method>
    <_status>OK</_status> 
    <_systime>2015-07-23T07:02:04</_systime> 
    <!-- Cost 51 mill seconds. --> 
</response>

-- DinosLambropoulos - 03 Aug 2015
Topic revision: 06 Oct 2015, DinosLambropoulos
 

This site is powered by FoswikiCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Foswiki? Send feedback