CreateSVAdvisorUser Method

The CreateSVAdvisorUser method creates a SmartView for Advisors user account for a specified advisor contact.

The CreateSVAdvisorUser method is invoked using the MethodOperation.

The advisor contact must exist in the database before this method can be used. If the advisor contact does not exist, create it first using the InsertOperation.

Parameters

Name Type Description
AgentID String Required. This is the object ID of the advisor contact record.
LoginName String Required. This is the user name that the advisor will use to sign in to SmartOffice. The user name must be unique in the office.
ExtLink String This is the value passed in NameID when SAML SSO is used.
AdvisorVUType String This specifies the format of the SmartView for Advisors user account being created. Valid values are 0 (SmartView for Advisors) or 1 (SmartView Case Status). If this parameter is not specified, it defaults to 0.

Examples

First, use the InsertOperation to create the advisor contact if it does not exist. At minimum, specify the advisor's last name, first name and e-mail address. You will also specify the client type (7) for advisor contacts.

Request XML
<request version='1.0'>
    <header>
        <office>myoffice</office>
        <user>jdoe</user>
        <password>password</password>
    </header>
    <insert>
        <Agent>
            <Contact>
                <LastName>Hannes</LastName>
                <FirstName>Walter</FirstName>
                <ClientType>7</ClientType>
                <WebAddresses>
                    <WebAddress>
                        <Address>walter.hannes@ebix.com</Address>
                        <WebAddressType>1</WebAddressType>
                    </WebAddress>
                </WebAddresses>
            </Contact>
        </Agent>
    </insert>
</request>

Response XML
<response version="1.0">
    <header>
        <sessionClosed/>
    </header>
    <insert>
        <Agent id="Agent.1.210" _type="obj" _status="inserted">
            <Contact id="Contact.1.211" _type="obj" _status="inserted">
                <WebAddresses _type="objs">
                    <WebAddress id="WebAddress.1.93" _type="obj" _status="inserted"/>
                </WebAddresses>
            </Contact>
        </Agent>
    </insert>
    <_status>OK</_status>
</response>

Capture the Agent ID from the XML response for use in the next request, which creates the SmartView for Advisors user account.

XML Request
<request version='1.0'>
    <header>
        <office>myoffice</office>
        <user>jdoe</user>
        <password>password</password>
    </header>
    <method>
        <CreateSVAdvisorUser>
            <AgentID>Agent.1.210</AgentID>
            <LoginName>walter.hannes</LoginName>
            <ExtLink>EVAL6_SDC_Walter.Hannes</ExtLink>
            <AdvisorVUType>1</AdvisorVUType>
        </CreateSVAdvisorUser>
    </method>
</request>

A successful response returns the object ID of the new user account.

XML Response
<?xml version="1.0" encoding="UTF-8" ?> 
<response version="1.0">
    <header>
        <sessionClosed /> 
    </header>
    <method>
        <CreateSVAdvisorUser>
            <User id="User.1.9" _type="obj" _status="inserted" /> 
        </CreateSVAdvisorUser>
    </method>
    <_status>OK</_status> 
    <_systime>2017-03-13T23:58:29</_systime> 
    <!-Cost 1083 mill seconds.--> 
</response>

-- Main.DavidEshelbrenner - 13 Aug 2012
Topic revision: 13 Mar 2017, 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