InsCensusService:addMembers

Class: InsCensusService

Method: addMembers

How It Works

The service takes the members in an input JSON, adds them to the given censusId, and outputs a list of the Ids of the added members (censusMemberIds).

Note

If the members list contains primary members and dependents, the input must have all of the members' id (vlocity_ins__MemberIdentifier__c). All the values should be unique.

Remote Options

Input JSON

The input JSON includes headers, which lists the fields to be added or set; and members, which list members with their corresponding field-value pairs.

{
    "headers": [
        {
            "type": "STRING",
            "label": "Last Name",
            "fieldId": "",
            "name": "vlocity_ins__LastName__c"
        },
        {
            "type": "STRING",
            "label": "First Name",
            "fieldId": "",
            "name": "vlocity_ins__FirstName__c"
        },
        {
            "type": "DOUBLE",
            "label": "FTE",
            "fieldId": "",
            "name": "vlocity_ins__FTE__c"
        },
        {
            "type": "PICKLIST",
            "label": "Gender",
            "fieldId": "",
            "name": "vlocity_ins__Gender__c"
        },
        {
            "type": "DATE",
            "label": "Birthday",
            "fieldId": "",
            "name": "vlocity_ins__Birthdate__c"
        },
        {
            "type": "BOOLEAN",
            "label": "Is Spouse",
            "fieldId": "",
            "name": "vlocity_ins__IsSpouse__c"
        },
        {
            "type": "BOOLEAN",
            "label": "Primary",
            "fieldId": "",
            "name": "vlocity_ins__IsPrimaryMember__c"
        },
        {
            "type": "REFERENCE",
            "label": "Group Class",
            "fieldId": "",
            "name": "vlocity_ins__GroupClassId__c"
        },
        {
            "type": "STRING",
            "label": "Primary Member Identifier",
            "fieldId": "",
            "name": "vlocity_ins__PrimaryMemberIdentifier__c"
        },
        {
            "type": "STRING",
            "label": "Member Identifier",
            "fieldId": "",
            "name": "vlocity_ins__MemberIdentifier__c"
        },
        {
            "type": "EMAIL",
            "label": "Email",
            "fieldId": "",
            "name": "vlocity_ins__Email__c"
        }
    ],
    "members": [
        {
            "vlocity_ins__LastName__c": "Robbins",
            "vlocity_ins__FirstName__c": "Timmy",
            "vlocity_ins__FTE__c": 1,
            "vlocity_ins__Gender__c": "Male",
            "vlocity_ins__Birthdate__c": "1985-12-13",
            "vlocity_ins__IsSpouse__c": true,
            "vlocity_ins__IsPrimaryMember__c": true,
            "vlocity_ins__GroupClassId__c": "a3yf4000000LdtrAAC",
            "vlocity_ins__MemberIdentifier__c": "1",
	             "vlocity_ins__PrimaryMemberIdentifier__c": null,
	             "vlocity_ins__Email__c": "test@vlocity.com"
        },
        {
            "vlocity_ins__LastName__c": "Robbins",
            "vlocity_ins__FirstName__c": "Jason",
            "vlocity_ins__FTE__c": 1,
            "vlocity_ins__Gender__c": "Male",
            "vlocity_ins__Birthdate__c": "1985-10-13",
            "vlocity_ins__IsSpouse__c": true,
            "vlocity_ins__IsPrimaryMember__c": true,
            "vlocity_ins__GroupClassId__c": "a3yf4000000LdtrAAC",
            "vlocity_ins__MemberIdentifier__c": "2",
	             "vlocity_ins__PrimaryMemberIdentifier__c": null,
	             "vlocity_ins__Email__c": "test1@vlocity.com"
        }
    ]
}

Output JSON

The service does not produce an output JSON. If any of the entries have errors, those are listed in the output.

{  
   "errors":[  
      {  
	      "error":"Birthdate is invalid",
            "vlocity_ins__LastName__c": "Robbins",
            "vlocity_ins__FirstName__c": "Jason",
            "vlocity_ins__FTE__c": 1,
            "vlocity_ins__Gender__c": "Male",
            "vlocity_ins__Birthdate__c": "1985-10-13",
            "vlocity_ins__IsSpouse__c": true,
            "vlocity_ins__IsPrimaryMember__c": true,
            "vlocity_ins__GroupClassId__c": "a3yf4000000LdtrAAC",
            "vlocity_ins__MemberIdentifier__c": "2",
	             "vlocity_ins__PrimaryMemberIdentifier__c": null,
	             "vlocity_ins__Email__c": "test1@vlocity.com"
        }
   ],
   "censusMemberIds":[  
      "a4C4P000000ed6dUAA"
   ]
}