U bent hier:
InsEnrollmentService:findEnrollees
Gebruik deze service om een gebruiker toe te staan te zoeken naar een lijst van geregistreerde klanten.
Methode:findEnrollees
De manier waarop het werkt...
-
De service ontvangt de geparseerde JSON.
-
Als het geparseerde object een parameter searchKey heeft, haalt het een lijst op voor Contactpersonen met Voornaam, Achternaam of Lid-ID die begint met de opgegeven searchKey.
-
Standaard retourneert de service geen contactpersonen met verlopen polissen.
-
Als het geparseerde object een parameter productType heeft, wordt de lijst van opgehaalde contactpersonen verder gefilterd op beleidsproducttype.
-
Als het geparseerde object een parameter includeExpiredPolicies heeft, worden contactpersonen opgehaald ongeacht de vervaldatum van hun beleid.
-
-
De service haalt een lijst van beleidsvormen op en wijst deze toe aan elke opgehaalde contactpersoon, zolang de groep ervan de opgegeven account-ID is.
-
Als de invoer een effectiveDate bevat, worden alleen polissen met dezelfde ingangsdatum opgehaald.
-
Als de invoer een productType bevat, worden alleen polissen met hetzelfde productType opgehaald.
-
Als de invoersets includeExpiredPolicies op true (waar) zetten, worden zelfs vervallen beleidsvormen opgehaald.
-
-
De opgehaalde lijst van ingeschrevenen met alle toegewezen beleidsdetails wordt geretourneerd in het gegevensknooppunt.
Invoer
Invoer |
Beschrijving |
|---|---|
|
Optioneel Tekenreeks Gebruikt om FirstName, LastName of MemberId van de contactpersonen te controleren |
|
Optioneel Tekenreeks Producttype dat wordt gebruikt om de lijst van leden te filteren op de typen polissen |
|
Optioneel Booleaans Gebruikt om te bepalen of de service contactpersonen met verlopen polissen moet bevatten |
Invoer-JSON
JSON-invoer als volgt ingedeeld:
{
"searchKey": String,
"productType": productType,
"includeExpiredPolicies": Boolean
}Voorbeeld van JSON-invoer met gegevens:
{
"searchKey": "Adam",
"productType": "Medical",
"includeExpiredPolicies": true
}Uitvoer-JSON
De JSON-uitvoer is een lijst van ingeschrevenen, met de volgende eigenschappen onder het knooppunt fields:
{
"data": {
"records": [
{
"fields": {
"Id": "0035w000039SsoSAAS",
"AccountId": "0015w00002ADHiPAAX",
"LastName": "C2P1",
"FirstName": "P1",
"Name": "C2P1 P1"
}
}
]
}
}Voorbeeld van JSON-uitvoer met gegevens:
{
"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"
}