InsCensusService:getMembersWithPlans

Class: InsCensusService

Method: getMembersWithPlans

How It Works

This service has two key functions:

1. Retrieves the list of fields in  GroupCensusMember__c and GroupCensusMemberPlan__c.

   • The service uses the parameter fieldsetName to retrieve the list of GroupCensusMember__c fields. If there is no value, fields are retrieved from the default fieldset that is EditableTable. If the entered value doesn't find a match no fields are retrieved.

   • The service uses the parameter planFieldsetName to retrieve the list of  GroupCensusMemberPlan__c fields. If there is no value, all fields are retrieved. If the entered value doesn't find a match no fields are retrieved.

   • If the contractId parameter has value, it populates ContractLineId__c.options  with the following details of the contract:

     • Product name

     • Product type

     • Id of the plans which are a part of the contract.

   • Retrieves relationship fields that are combined to form the JSON headers node:

     • MemberIdentifier__c

     • PrimaryMemberIdentifier__c

     • RelatedCensusMemberId__c

     • IsPrimaryMember__c

     • IsSpouse__c

     • Id

2. Retrieves the list of members in GroupCensusMember__c.

   • This service uses a censusId to retrieve census members from GroupCensusMember__c and census member plans from GroupCensusMemberPlan__c  for each member.

     

     Note

     The offset parameter value is used to retrieve the next 2000 GroupCensusMember__c rows (ordered by GroupCensusMember__c Id) after the offset.

     If there's no value for the offset parameter, the first 2000 rows are retrieved.

   • The information retrieved for each member is based on the fields retrieved from  GroupCensusMember__c and GroupCensusMemberPlan__c.

   • A list of members is placed into the members node.

Remote Options

Input JSON

This service does not take an input JSON.

Output JSON

The service returns an output JSON, formatted as per the example below:

{  
   "census":{  
      "members":[  
         {  
            "vlocity_ins__ContractLineId__c":"",
            "Id":"a4C4P000000dNdbUAE",
            "vlocity_ins__LastName__c":null,
            "vlocity_ins__FirstName__c":null,
            "vlocity_ins__Birthdate__c":"1999-08-08"
         },
         {  
            "vlocity_ins__ContractLineId__c":"a2N4P000006ygEjUAI",
            "Id":"a4C4P000000dNdcUAE",
            "vlocity_ins__LastName__c":null,
            "vlocity_ins__FirstName__c":null,
            "vlocity_ins__Birthdate__c":"1994-08-08"
         },
         {  
            "vlocity_ins__ContractLineId__c":"a2N4P000006ygEjUAI;a2N4P000006ygEiUAI",
            "Id":"a4C4P000000dNdeUAE",
            "vlocity_ins__LastName__c":null,
            "vlocity_ins__FirstName__c":null,
            "vlocity_ins__Birthdate__c":"1985-08-08"
         }
      ],
      "headers":[  
         {  
            "type":"STRING",
            "label":"First Name",
            "fieldId":"",
            "name":"vlocity_ins__FirstName__c"
         },
         {  
            "type":"DATE",
            "label":"Birthday",
            "fieldId":"",
            "name":"vlocity_ins__Birthdate__c"
         },
         {  
            "type":"STRING",
            "label":"Last Name",
            "fieldId":"",
            "name":"vlocity_ins__LastName__c"
         },
         {  
            "options":[  
               {  
                  "value":"a2N4P000006ygEiUAI",
                  "type":"Medical",
                  "name":"rootProd"
               },
               {  
                  "value":"a2N4P000006ygEjUAI",
                  "type":"Dental",
                  "name":"rootProd2"
               }
            ],
            "type":"REFERENCE",
            "label":"Plan",
            "fieldId":"",
            "name":"vlocity_ins__ContractLineId__c"
         }
      ]
   },
   "lastOffset" : "a4C4P000000dNdeUAE"
}