Ti trovi qui:
InsEnrollmentService: findEnrollees
Utilizzare questo servizio per consentire a un utente di cercare un elenco di clienti iscritti.
Metodo:findEnrollees
Funzionamento
-
Il servizio riceve il JSON analizzato.
-
Se l'oggetto analizzato ha un parametro searchKey, recupera un elenco di referenti con Nome, Cognome o ID membro che inizia con searchKey specificato.
-
Per impostazione predefinita, il servizio non restituisce referenti con polizze scadute.
-
Se l'oggetto analizzato ha un parametro productType, l'elenco dei referenti recuperati viene ulteriormente filtrato in base al tipo di prodotto della policy.
-
Se l'oggetto analizzato ha un parametro includeExpiredPolicies, i referenti vengono recuperati indipendentemente dalla data di scadenza della policy
-
-
Il servizio recupera un elenco di policy e le mappa a ogni referente recuperato, a condizione che il gruppo sia l'ID account specificato.
-
Se l'input contiene un effectiveDate, vengono recuperate solo le polizze con la stessa data effettiva.
-
Se l'input contiene un productType, vengono recuperate solo le policy con lo stesso productType.
-
Se gli insiemi di input includonoExpiredPolicies su true, vengono recuperate anche le policy scadute.
-
-
L'elenco degli iscritti recuperati con tutti i dettagli della policy assegnati viene restituito nel nodo dati.
Input
Input |
Descrizione |
|---|---|
|
Facoltativo Stringa Utilizzato per controllare FirstName, LastName o MemberId dei referenti |
|
Facoltativo Stringa Tipo di prodotto utilizzato per filtrare l'elenco dei membri in base ai tipi di polizze |
|
Facoltativo Booleano Utilizzato per determinare se il servizio deve includere referenti con polizze scadute |
Input JSON
Input JSON formattato come segue:
{
"searchKey": String,
"productType": productType,
"includeExpiredPolicies": Boolean
}Esempio di input JSON con dati:
{
"searchKey": "Adam",
"productType": "Medical",
"includeExpiredPolicies": true
}JSON di output
L'output JSON è un elenco di iscritti, con le seguenti proprietà sotto il nodo fields:
{
"data": {
"records": [
{
"fields": {
"Id": "0035w000039SsoSAAS",
"AccountId": "0015w00002ADHiPAAX",
"LastName": "C2P1",
"FirstName": "P1",
"Name": "C2P1 P1"
}
}
]
}
}Esempio di output JSON con dati:
{
"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"
}