Sie befinden sich hier:
InsEnrollmentService:findEnrollees
Verwenden Sie diesen Service, damit ein Benutzer nach einer Liste registrierter Kunden suchen kann.
Methode:findEnrollees
Funktionsweise
-
Der Service empfängt die analysierte JSON.
-
Wenn das analysierte Objekt einen Parameter vom Typ searchKey aufweist, wird eine Liste für Kontakte mit Vorname, Nachname oder Mitglieds-ID abgerufen, die mit dem angegebenen searchKey beginnt.
-
Standardmäßig gibt der Service keine Kontakte mit abgelaufenen Richtlinien zurück.
-
Wenn das analysierte Objekt den Parameter productType aufweist, wird die Liste der abgerufenen Kontakte weiter nach Policenprodukttyp gefiltert.
-
Wenn das analysierte Objekt den Parameter includeExpiredPolicies aufweist, werden Kontakte unabhängig vom Ablaufdatum ihrer Richtlinie abgerufen.
-
-
Der Service ruft eine Liste der Policen ab und ordnet sie jedem abgerufenen Kontakt zu, sofern es sich bei seiner Gruppe um die angegebene Account-ID handelt.
-
Wenn die Eingabe ein effectiveDate enthält, werden nur Policen mit demselben Datum des Inkrafttretens abgerufen.
-
Wenn die Eingabe einen productType enthält, werden nur Policen mit demselben productType abgerufen.
-
Wenn die Eingabesätze ExpiredPolicies auf true setzen, werden sogar abgelaufene Richtlinien abgerufen.
-
-
Die abgerufene Teilnehmerliste mit allen zugewiesenen Richtliniendetails wird im Datenknoten zurückgegeben.
Eingaben
Eingabe |
Beschreibung |
|---|---|
|
Optional Zeichenfolge Wird zum Überprüfen von "FirstName", "LastName" oder "MemberId" der Kontakte verwendet |
|
Optional Zeichenfolge Produkttyp, der zum Filtern der Liste der Mitglieder nach den Typen ihrer Policen verwendet wird |
|
Optional Boolean (Boolesch) Wird verwendet, um zu bestimmen, ob der Service Kontakte mit abgelaufenen Richtlinien enthalten soll |
Input JSON
JSON-Eingabe wie folgt formatiert:
{
"searchKey": String,
"productType": productType,
"includeExpiredPolicies": Boolean
}JSON-Beispieleingabe mit Daten:
{
"searchKey": "Adam",
"productType": "Medical",
"includeExpiredPolicies": true
}Ausgabe-JSON
Die JSON-Ausgabe ist eine Liste der Teilnehmer mit den folgenden Eigenschaften unter dem Knoten "fields":
{
"data": {
"records": [
{
"fields": {
"Id": "0035w000039SsoSAAS",
"AccountId": "0015w00002ADHiPAAX",
"LastName": "C2P1",
"FirstName": "P1",
"Name": "C2P1 P1"
}
}
]
}
}JSON-Beispielausgabe mit Daten:
{
"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"
}