Você está aqui:
InsCensusService:getMembers
Use esse serviço para recuperar os membros de um censo. Também recupera os campos. O acesso do usuário convidado está habilitado para esse serviço.
Método: getMembers
Como funciona
Esse serviço tem duas funções principais:
-
Recupere a lista de campos GroupCensusMember__c com base em um conjunto de campos definido no parâmetro Name do conjunto de campos. A saída sempre contém MemberIdentifier__c, PrimaryMemberIdentifier__c, RelatedCensusMemberId__c, IsPrimaryMember__c e IsSpouse__c, mesmo que não estejam no conjunto de campos.
-
Recupere os registros de
GroupCensusMember__c.-
O serviço usa um
censusIdpara recuperar membros do censo deGroupCensusMember__c. -
Se o parâmetro de deslocamento tiver um valor, ele recuperará 2.000 linhas após o deslocamento.
-
A lista de membros é colocada no nó
members.
-
Opções remotas
Opções |
Descrição |
|---|---|
|
Obrigatório Recupera o censo com membros. |
|
Obrigatório
|
|
Opcional
|
|
Opcional
|
JSON de saída
O serviço retorna um JSON de saída, formatado conforme o exemplo abaixo, com detalhes para os membros no censo, em que headers é uma lista de campos válidos de acordo com o conjunto de campos de membro do censo EditableTable e members é uma lista de membros que inclui um fieldId para cada membro.
{
"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"
}
]
}