AssignContactstoAgent Method

The AssignContactstoAgent method mass assigns a SmartView for Advisors user to multiple contact records under specific conditions. This method works when office security is enabled.

The AssignContactstoAgent method is invoked using the MethodOperation.

The user invoking this method must have the Mass Assignments user right.

A user assignment is created successfully when any of the following conditions exist:
  • The SmartView for Advisors user is the contact's primary advisor.
  • The SmartView for Advisors user is an advisor on any of the contact's policies or investment accounts.
If none of these conditions are met, or if the request parameters contain incorrect values, the XML response contains the message, "No contacts for Assignment."

Parameters

Name Type Description
AgentID String Required. This is the ID of the advisor record linked to the SmartView for Advisors user account. Note that this value is the primary key (e.g., 112), not the full object ID (e.g., Agent.1.112).
AgentOfficeID String Required. This is the ID of the office in which the SmartView for Advisors user account resides. Note that this value is the primary key (e.g., 1), not the full object ID (e.g., Office.1).

Examples

The following example assigns a SmartView for Advisors user (whose agent ID 112) to all contacts that meet the method's assignment conditions. The response includes the advisor's object ID and a confirmation message.

Request XML
<request version='1.0'>
    <header>
        <office>myoffice</office>
        <user>jdoe</user>
        <password>password</password>
    </header>
    <method>
        <AssignContactstoAgent>
            <AgentID>112</AgentID>
            <AgentOfficeID>1</AgentOfficeID>
        </AssignContactstoAgent>
    </method>
</request>

Response XML
<response version="1.0">
    <header>
        <sessionClosed/>
    </header>
    <method>
        <AssignContactstoAgent>
            <Response id="Agent.1.112">Contact Assignment is Done</Response>
        </AssignContactstoAgent>
    </method>
    <_status>OK</_status>
    <_systime>2015-10-09T22:49:16</_systime>
    <!--Cost 90 mill seconds.-->
</response>

-- DinosLambropoulos - 09 Oct 2015
Topic revision: 10 Dec 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