Você está aqui:
InsEnrollmentService:findEnrollees
Use esse serviço para permitir que um usuário pesquise uma lista de clientes inscritos.
Método:findEnrollees
Como funciona
-
O serviço recebe o JSON analisado.
-
Se o objeto analisado tiver um parâmetro searchKey, ele recuperará uma lista para Contatos com Primeiro nome, Sobrenome ou ID do membro que comece com a searchKey fornecida.
-
Por padrão, o serviço não retorna contatos com apólices expiradas.
-
Se o objeto analisado tiver um parâmetro productType, a lista de Contatos recuperados será filtrada ainda mais por tipo de produto de apólice.
-
Se o objeto analisado tiver um parâmetro includeExpiredPolicies, os Contatos serão recuperados independentemente da data de expiração da política
-
-
O serviço recupera uma lista de apólices e as mapeia para cada contato recuperado, desde que o grupo seja o ID da conta fornecido.
-
Se a entrada contiver effectiveDate, somente apólices com a mesma data efetiva serão recuperadas.
-
Se a entrada contiver um productType, somente apólices com o mesmo productType serão recuperadas.
-
Se os conjuntos de entrada incluíremExpiredPolicies como true, até mesmo apólices expiradas serão recuperadas.
-
-
A lista de inscritos recuperados com todos os detalhes da política atribuída é retornada no nó de dados.
Contribuições
Entrada |
Descrição |
|---|---|
|
Opcional String Usado para verificar FirstName, LastName ou MemberId dos contatos |
|
Opcional String Tipo de produto usado para filtrar a lista de membros pelos tipos de apólices |
|
Opcional Booleano Usado para determinar se o serviço deve incluir contatos com apólices expiradas |
JSON de entrada
Entrada JSON formatada da seguinte maneira:
{
"searchKey": String,
"productType": productType,
"includeExpiredPolicies": Boolean
}Exemplo de entrada JSON com dados:
{
"searchKey": "Adam",
"productType": "Medical",
"includeExpiredPolicies": true
}JSON de saída
A saída JSON é uma lista de inscritos, com as seguintes propriedades sob o nó fields:
{
"data": {
"records": [
{
"fields": {
"Id": "0035w000039SsoSAAS",
"AccountId": "0015w00002ADHiPAAX",
"LastName": "C2P1",
"FirstName": "P1",
"Name": "C2P1 P1"
}
}
]
}
}Saída JSON de amostra com dados:
{
"data": [
{
"AccountId": "0013h00000Gx5UqAAJ",
"Id": "0033h00000BBybMAAT",
"LastName": "C1P1",
"FirstName": "D1",
"Name": "D1 C1P1"
},
{
"AccountId": "0013h00000Gx5UqAAJ",
"Id": "0033h00000BBybPAAT",
"LastName": "C1P2",
"FirstName": "D1",
"Name": "D1 C1P2"
},
{
"AccountId": "0013h00000Gx5UrAAJ",
"Id": "0033h00000BBybSAAT",
"LastName": "C2P1",
"FirstName": "D1",
"Name": "D1 C2P1"
}
],
"error": "OK"
}