breadcrumbDescription
InsEnrollmentService: getEnrolleePolicies
Brug denne tjeneste til at tillade en bruger at søge efter politikker for et givent sæt af tilmeldte klienter.
Metode:getEnrolleePolicies
Sådan fungerer det
-
Tjenesten modtager den parsede JSON.
-
Hvis inputtet ikke indeholder et accountId, returneres der en fejl.
-
Hvis inputtet ikke indeholder en gyldig liste over kontakt-id'er, returneres der en fejl.
-
-
Tjenesten henter en liste over kontakter for hvert contactId.
-
Tjenesten henter en liste over policer og tilknytter dem til hver hentet kontakt, når blot deres gruppe er det angivne konto-id.
-
Hvis inputtet indeholder en effectiveDate, er det kun policer med den samme ikrafttrædelsesdato, der hentes.
-
Hvis inputtet indeholder en productType, hentes kun policer med samme productType.
-
Hvis inputssættene inkludererExpiredPolicies til true, hentes selv udløbne policer.
-
-
Produktdetaljerne for hentede policer hentes også, herunder listen over afhængige, der er registreret for en given politik.
-
Den hentede tilmeldingsliste med alle tildelte policedetaljer returneres i
data.
Input
Input |
Beskrivelse |
|---|---|
|
Liste over kontakt-id'er, der ejer de aktiver, der skal hentes. |
|
Id for den konto, der bruges til at filtrere hentede tilmeldinger. |
|
Valgfrit Streng Datostreng, der bruges til at filtrere listen over hentede tilmeldinger baseret på, hvornår politikken trådte i kraft. |
|
Valgfrit Streng Filtrerer listen over hentede tilmeldinger baseret på produkttypen. |
|
Valgfrit Boolesk Bestemmer, om tjenesten skal inkludere kontakter med udløbne policer |
Input JSON
JSON format:
{
"contactIds": [ContactId],
"accountId": accountId,
"effectiveDate": Date,
"productType": productType,
"includeExpiredPolicies": Boolean
}Eksempeldataoutput:
{
"contactIds": [ "0035w000034kiVwAAI" ],
"accountId": "0015w00002ADHiPAAX",
"effectiveDate": "6/12/2020",
"productType": "Medical",
"includeExpiredPolicies": true
}Output JSON
JSON format:
{
"data": [
{
"enrollments": [
{
"dependents": [
{
"partyId":Id,
"contactId": Id,
"relationshipType": String,
"LastName": String",
"FirstName": String,
"Id": Id
}
],
"EffectiveEnd": Date,
"EffectiveStart": Date,
"Name": String,
"productName": String,
"primaryMemberContactId": Id,
"policyNumber": String,
"accountId": Id,
"productId": Id,
"Id": Id
}
],
"AccountId": Id,
"Id": Id,
"LastName": String,
"FirstName": String,
"Name": String
}
],
"error": "OK"
}Eksempeldataoutput:
{
"data": [
{
"enrollments": [
{
"dependents": [
{
"partyId": "a0z3h0000036sJiAAI",
"contactId": "0033h00000BBybMAAT",
"relationshipType": "Dependent",
"LastName": "C1P1",
"FirstName": "D1",
"Id": "a4B3h000000IdiMEAS"
},
{
"partyId": "a0z3h0000036sJjAAI",
"contactId": "0033h00000BBybNAAT",
"relationshipType": "Dependent",
"LastName": "C1P1",
"FirstName": "D2",
"Id": "a4B3h000000IdiNEAS"
}
],
"EffectiveEnd": null,
"EffectiveStart": "2020-06-12",
"Name": "Policy1",
"productName": "MedPlan A",
"primaryMemberContactId": "0033h00000BBybLAAT",
"policyNumber": null,
"accountId": "0013h00000Gx5UqAAJ",
"productId": "01t3h000002T4JmAAK",
"Id": "02i3h00000037xxAAA"
}
],
"AccountId": "0013h00000Gx5UqAAJ",
"Id": "0033h00000BBybLAAT",
"LastName": "C1P1",
"FirstName": "P1",
"Name": "P1 C1P1"
},
{
"enrollments": [
{
"dependents": [
{
"partyId": "a0z3h0000036sJlAAI",
"contactId": "0033h00000BBybPAAT",
"relationshipType": "Dependent",
"LastName": "C1P2",
"FirstName": "D1",
"Id": "a4B3h000000IdiOEAS"
},
{
"partyId": "a0z3h0000036sJmAAI",
"contactId": "0033h00000BBybQAAT",
"relationshipType": "Dependent",
"LastName": "C1P2",
"FirstName": "D2",
"Id": "a4B3h000000IdiPEAS"
}
],
"EffectiveEnd": null,
"EffectiveStart": "2020-06-12",
"Name": "Policy2",
"productName": null,
"primaryMemberContactId": "0033h00000BBybOAAT",
"policyNumber": null,
"accountId": "0013h00000Gx5UqAAJ",
"productId": null,
"Id": "02i3h00000037xyAAA"
}
],
"AccountId": "0013h00000Gx5UqAAJ",
"Id": "0033h00000BBybOAAT",
"LastName": "C1P2",
"FirstName": "P2",
"Name": "P2 C1P2"
}
],
"error": "OK"
}