Você está aqui:
InsCensusServiceStd:getMembers
Use este serviço para recuperar os membros de um censo do GroupCensusMember. Também recupera os cabeçalhos com base na fieldsetName.
Classe: InsCensusServiceStd
Método: getMembers
O serviço aceita entrada nesse formato.
| censusId | fieldsetName | Deslocamento | limite | searchKey |
|---|---|---|---|---|
| c101 | test_fieldset | cmember101 | inteiro | prefix |
O serviço usa valores de entrada para gerar saída que se encaixa no modelo de produto.
| censo | lastOffSet | |
|---|---|---|
| cabeçalhos | membros | ID do último membro do censo |
| Lista de campos | Lista de membros | |
Como funciona
Esse serviço tem duas funções principais:
-
Recupera a lista de campos de
GroupCensusMembere cabeçalhos com base nofieldetName. A saída sempre temPrimaryGroupCensusMemberId,RelationshipToPrimaryMember,SourceSystemIdentifierePrimaryMemberSource, mesmo que esses campos não estejam incluídos nofieldsetName. - O serviço usa
censusIdpara recuperar a lista de membros do censo de registros deGroupCensusMember.- Se o deslocamento tiver um valor, ele recuperará as linhas de
GroupCensusMemberprimárias (ordenadas por Id) após o deslocamento e, em seguida, recuperará todos os dependentes desses membros primários. Se houver um valor limite, o serviço recuperará as linhas de
GroupCensusMemberprincipal (ordenadas por Id) não superiores ao limite especificado. Em seguida, ele recupera todos os dependentes desses Membros principais. O limite não pode ser superior a 500.Se
searchKeytiver valor, o serviço recupera linhas deGroupCensusMember(ordenadas por Id) junto com a família correspondente, que têmsearchKeycomo uma substring presente em suasFirstNameouLastName.Se
memberIdstiver um valor, ele recuperará linhas deGroupCensusMember(ordenadas por Id) cujo ID faça parte da matriz dememberIds.memberIdsousearchKeydevem ser fornecidos na entrada.Se
withPlansestiver definido comotrue, o serviço recuperará uma lista de planos selecionados para cada membro. AsContractGroupPlanIdválidas para cada membro são delimitadas por ponto e vírgula e retornadas como uma string.As informações recuperadas para cada membro são baseadas nos campos recuperados da
GroupCensusMember.A lista de membros é colocada no nó
members.
- Se o deslocamento tiver um valor, ele recuperará as linhas de
Comportamento do serviço
Entenda como diferentes entradas afetam as saídas de serviço.
| Entrada | Saída de serviço |
|---|---|
Sem censusId ou censusId inválido |
O serviço não recupera nenhum membro do censo. |
Nenhum fieldsetName e censusId válido |
|
fieldsetName válida e censusId válida |
O serviço recupera a lista de campos de GroupCensusMember presentes no conjunto de campos fornecido e a lista de GroupCensusMember. |
limit válida |
O serviço recupera a lista de |
offset válida |
O serviço recupera a lista de
|
offset limit válida e válida |
O serviço recupera a lista de campos de
|
searchKey válida |
O serviço recupera a lista de campos de |
searchKey válida e limit válida |
O serviço recupera a lista de campos de |
searchKey offset válida e válida |
O serviço recupera a lista de campos de |
searchKey válido, limit válido e offset válido |
O serviço recupera a lista de campos de
|
Opções remotas
| Opções | Description |
|---|---|
|
Obrigatório. ID do censo cujos membros devem ser recuperados. |
|
Opcional. Nome do conjunto de campos para recuperar os campos de Se o valor for inválido, o serviço não retornará nenhum campo. Se não houver um valor, o serviço usará o conjunto de campos padrão para recuperar campos de |
|
Opcional. O número de membros do censo a serem recuperados. |
|
Opcional. O ID do membro do censo após o qual os membros do censo devem ser recuperados. |
|
Uma string para pesquisar registros de membro de censo correspondentes. |
JSON de entrada
Esse serviço não usa um JSON de entrada.
JSON de saída
O serviço retorna um JSON de saída com uma lista de campos, lista de membros e valor de lastOffSet.
{
"census":{
"members":[
{
"Id":"a4C4P000000dNdbUAE",
"LastName":member1,
"FirstName":primary,
"Birthdate":"1999-08-08"
},
{
"Id":"a4C4P000000dNdcUAE",
"LastName":member1,
"FirstName":dependent,
"Birthdate":"1994-08-08"
},
{
"Id":"a4C4P000000dNdeUAE",
"LastName":member2,
"FirstName":primary,
"Birthdate":"1985-08-08"
}
],
"headers":[
{
"type":"STRING",
"label":"First Name",
"fieldId":"",
"name":"FirstName"
},
{
"type":"DATE",
"label":"Birthday",
"fieldId":"",
"name":"Birthdate"
},
{
"type":"STRING",
"label":"Last Name",
"fieldId":"",
"name":"LastName"
}
]
},
"lastOffset" : "a4C4P000000dNdeUAE"
}