Usted está aquí:
InsCensusService:getMembers
Utilice este servicio para recuperar los miembros de un censo. También recupera los campos. El acceso de usuario invitado está activado para este servicio.
Método: getMembers
Funcionamiento
Este servicio tiene dos funciones clave:
-
Recupere la lista de campos GroupCensusMember__c basándose en un conjunto de campos definido en el parámetro Nombre del conjunto de campos. El resultado siempre contiene MemberIdentifier__c, PrimaryMemberIdentifier__c, RelatedCensusMemberId__c, IsPrimaryMember__c e IsSpouse__c incluso si no están en el conjunto de campos.
-
Recupere los registros de
GroupCensusMember__c.-
El servicio utiliza una
censusIdpara recuperar miembros del censo deGroupCensusMember__c. -
Si el parámetro offset tiene valor, recupera 2000 filas después de la compensación.
-
La lista de miembros se coloca en el nodo
members.
-
Opciones remotas
Opciones |
Descripción |
|---|---|
|
Obligatorio Recupera el censo con miembros. |
|
Obligatorio
|
|
Opcional
|
|
Opcional
|
JSON de salida
El servicio devuelve un JSON de salida, con el formato del ejemplo siguiente, con detalles para los miembros en el censo, donde headers es una lista de campos válidos de acuerdo con la EditableTable del conjunto de campos Miembro del censo y members es una lista de miembros que incluye un fieldId para cada miembro.
{
"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"
}
]
}