Vous êtes ici :
InsCensusService:getMembers
Utilisez ce service pour récupérer les membres d'un recensement. Il récupère également les champs. L'accès des utilisateurs invités est activé pour ce service.
Méthode : getMembers
Fonctionnement
Ce service a deux fonctions clés :
-
Récupérez la liste des champs GroupCensusMember__c basés sur un jeu de champs défini dans le paramètre fieldset Name. La sortie contient toujours MemberIdentifier__c, PrimaryMemberIdentifier__c, RelatedCensusMemberId__c, IsPrimaryMember__c et IsSpouse__c, même s'ils ne sont pas dans le jeu de champs.
-
Récupérez les enregistrements
GroupCensusMember__c.-
Le service utilise un
censusIdpour récupérer les membres du recensement dans lesGroupCensusMember__c. -
Si le paramètre offset a une valeur, il récupère 2000 lignes après le décalage.
-
La liste des membres est placée dans le nœud
members.
-
Options distantes
Options |
Description |
|---|---|
|
Obligatoire Récupère le recensement avec les membres. |
|
Obligatoire
|
|
Facultatif
|
|
Facultatif
|
JSON de sortie
Le service renvoie un JSON de sortie, mis en forme comme dans l'exemple ci-dessous, avec les détails des membres du recensement, où headers est une liste de champs valides selon l'ensemble de champs Membre du recensement EditableTable et members est une liste de membres qui contient un fieldId pour chaque membre.
{
"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"
}
]
}