Du är här:
InsCensusService:getMembers
Använd denna tjänst för att hämta medlemmarna i en folkräkning. Den hämtar även fälten. Gästanvändaråtkomst har aktiverats för denna tjänst.
Metod: getMembers
Så här fungerar det
Denna tjänst har två nyckelfunktioner:
-
Hämta listan över GroupCensusMember__c-fält baserat på en fältuppsättning som definieras i fältuppsättningsparametern Namn. Utmatningen innehåller alltid MemberIdentifier__c, PrimaryMemberIdentifier__c, RelatedCensusMemberId__c, IsPrimaryMember__c och IsSpouse__c även om de inte finns i fältuppsättningen.
-
Hämta
GroupCensusMember__cposterna.-
Tjänsten använder ett
censusIdför att hämta folkräkningsmedlemmar frånGroupCensusMember__c. -
Om parametern offset har värde hämtar den 2000 rader efter offset.
-
Listan över medlemmar placeras i
members.
-
Fjärralternativ
Alternativ |
Beskrivning |
|---|---|
|
Obligatoriskt Hämtar folkräkning med medlemmar. |
|
Obligatoriskt
|
|
Valfri
|
|
Valfri
|
JSON för utdata
Tjänsten returnerar en JSON för utdata, formaterad enligt exemplet nedan, med detaljer om medlemmarna i folkräkningen, där headers är en lista över giltiga fält enligt fältuppsättningen EditableTable för folkräkningsmedlem och members är en lista över medlemmar som innehåller ett fieldId för varje medlem.
{
"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"
}
]
}