Difference: CreateSVAdvisorUser (r2 vs. r1)

CreateSVAdvisorUser Method

The CreateSVAdvisorUser MethodCreateSVAdvisorUserallows you to create new method creates a SmartView for Advisors user account for a specified advisor contact. SmartView? Users through SmartIntegrator.

You The have to do it in two requests, one that will create the Advisor Contact record in SmartOffice CreateSVAdvisorUser and another that will create method is invoked using the a User from that Advisor Contact. MethodOperation.

To create The advisor contact must exist in the Advisor record with minimal data to database before this method can be used. If the advisor contact does not exist, create a it first using the SmartView?InsertOperationUser . out of you will need to populated LastName?, FirstName?, and Address (email) like in the sample below. ClientType? 7 means they are an Advisor and WebAddressType? 1 means it is an Email address, so you can just hard-code those if you want.

 <dxoproxy-request version='1.0.1'>
  <transaction action='adapter.xmlEngine'>
    <data>
      <DXOUserName>EVAL6_SDC_BRYAN_ESHELBRENNER</DXOUserName>
      <siData>
        <request version='1.0'>
          <header>
            <office/>
            <user/>
            <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>
      </siData>
    </data>
  </transaction>
</dxoproxy-request>

Parameters

This request will give you a response that looks like this if it is successful:

NameTypeDescription
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.
<dxoproxy-response time="1312908184837" version="1.0.1">
  <transaction action="adapter.xmlEngine">
    <data>
      <response version="1.0">
        <header>
          <sessionClosed/>
        </header>
        <insert office="CBIZ" user="aberry">
          <Agent id="Agent.1001523711.210" _type="obj" _status="inserted">
            <Contact id="Contact.1001523711.211" _type="obj" _status="inserted">
              <WebAddresses _type="objs">
                <WebAddress id="WebAddress.1001523711.93" _type="obj" _status="inserted"/>
              </WebAddresses>
            </Contact>
          </Agent>
        </insert>
        <_status>OK</_status>
      </response>
    </data>
    <_status>OK</_status>
  </transaction>
</dxoproxy-response>

Examples

You First, need to capture the Agent id attribute and use it in the second request. 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.

The second Request XML request will convert this Advisor Contact to a SmartView? User. Here is the XML Request:

   EVAL6_SDC_BRYAN_ESHELBRENNER   
myoffice jdoe password
Agent.1001523711.210 Walter.Hannes EVAL6_SDC_Walter.Hannes 1 Hannes Walter 7
walter.hannes@ebix.com
1

The Response XMLAgentID? is the id attribute you picked up from the response. The LoginName? is the SmartOffice User Name. This value is mandatory and must be unique within the office. The ExtLink? value is the value you are going to pass in NameID? if you are using SAML SSO. AdvisorVUType? determine the SmartView? version (i.e. For Advisors, Cast Status, etc).

-- DavidEshelbrenner - 13 Aug 2012

<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

View topic | View difference side by side | History: r2 < r1 | More topic actions
 
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