You are here:
InsCensusService:getMembers
Use this service to retrieve the members of a census. It also retrieves the fields. Guest user access is enabled for this service.
Method: getMembers
How It Works
This service has two key functions:
-
Retrieve the list of GroupCensusMember__c fields based on a fieldset defined in fieldset Name parameter. The output always contain MemberIdentifier__c, PrimaryMemberIdentifier__c, RelatedCensusMemberId__c, IsPrimaryMember__c and IsSpouse__c even if they are not in the fieldset.
-
Retrieve the
GroupCensusMember__crecords.-
The service uses a
censusIdto retrieve census members fromGroupCensusMember__c. -
If the offset parameter has value, it retrieves 2000 rows after the offset.
-
The list of members is placed into the
membersnode.
-
Remote Options
Options |
Description |
|---|---|
|
Required Retrieves census with members. |
|
Required
|
|
Optional
|
|
Optional
|
Output JSON
The service returns an output JSON, formatted as per the example below, with
details for the members in the census, where headers is a list of
valid fields according to the Census Member fieldset EditableTable
and members is a list of members which includes a fieldId for each
member.
{
"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"
},
{
"type": "REFERENCE",
"label": "Primary Census Member",
"fieldId": "",
"name": "vlocity_ins__RelatedCensusMemberId__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__RelatedCensusMemberId__c" : null
},
{
"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":"1",
"vlocity_ins__Email__c": "test1@vlocity.com",
"vlocity_ins__RelatedCensusMemberId__c" : "a3yf4000000MdtrAAC"
}
]
}