Du är här:
InsEnrollmentServiceStd:enrollFamily
Använd denna tjänst för att registrera en familj inom en rotplan som inkluderar en primär medlem och associerade beroenden med täckningar.
Klass: InsEnrollmentServiceStd
Metod: enrollFamily
Så fungerar det
- Tjänsten validerar först indata för att verifiera:
Obligatoriska begärandedata tillhandahålls.
Den tillhandahållna
flowNameoch dess version är giltiga och aktiva.Den tillhandahållna
primaryMemberIdär giltig och det finns en post som matchar för en givenprimaryMemberIdochcensusId.Den tillhandahållna
contractIdellerrootPlanIdär giltig eller så ärcontractGroupPlanför den tillhandahållnarootPlanIdassocierad med den tillhandahållnacontractId.Registreringsstatusen är slutförd för de
rootPlanIdochprimaryMemberIdsom anges iGroupCensusMemberPlan.Det finns en post associerad med den specificerade
rootPlanIdochprimaryCensusMemberId.
-
Om indata är giltiga anropar tjänsten registreringsflödet.
-
Registreringsflödet skapar Försäkringspolicyer, Försäkringspolicydeltagare och Försäkringspolicytäckningar.
-
Tjänsten returnerar Policy-ID om utförandet skulle lyckas.
-
Tjänsten returnerar fel med feldetaljer i händelse av några fel i validerings- eller registreringsflödet.
Fjärralternativ
| ALTERNATIV | BESKRIVNING |
|---|---|
flowName
|
Obligatoriskt Namn på registreringsflödet som används för individuell registrering. |
groupCensusId
|
Obligatoriskt ID för gruppräkningen som innehåller alla folkräkningsmedlemmar i familjen som ska registreras. |
contractId
|
Obligatoriskt Id för kontraktet som medlemmarna hör till och planerna som de ska registrera sig för. |
primaryMemberId
|
Obligatoriskt ID för den primära medlem som ska registreras. |
rootPlanId
|
Obligatoriskt ID för rotkontraktgruppplanen för registreringsprodukten. |
isProrated
|
Valfritt. Om |
isSaveMemberPremium
|
Valfri Anger om policypremiebeloppet måste anges för alla InsurancePolicyParticipant-poster. Om |
userInputs
|
Valfri Uppsättningen indata som värderingsförfarandet använder för att få fram priset på produkten. |
additionalInputs
|
Valfri Serialiserad nyckelvärdeskarta över ytterligare inmatningar som används för produktklassificering. |
matchingKeysList
|
Obligatoriskt Ett kommaavgränsat fält i objektet Konto att använda för dubblettidentifiering mot befintliga kontoposter om personAccount har aktiverats i en organisation. Ett kommaavgränsat fält i objektet Kontakt att använda för dubblettidentifiering mot befintliga kontaktposter om personAccount inte är aktiverat i en organisation. |
inputKeysList
|
Valfri En kommaavgränsad lista över inmatningsnycklar från värderingsinmatningarna att använda för att inkludera i de individuella värderingsresultaten. |
emailEncodingKey
|
Krävs om åberopbar åtgärd för att skapa portalanvändare används. Den e-postkodningsnyckel som ska användas för att skapa användarposterna. Till exempel ISO-8859-1 eller UTF-8. |
languageLocaleKey
|
Valfri Krävs om åberopbar åtgärd för att skapa portalanvändare används. |
localeSidKey
|
Krävs om åberopbar åtgärd för att skapa portalanvändare används. SID-nyckeln för platsen att använda för att skapa användarposter. |
timezoneSidKey
|
Krävs om åberopbar åtgärd för att skapa portalanvändare används. Den tidszon-SID-nyckel som används för att skapa användarposterna. |
profileId
|
Valfri ID för profilposten som ska associeras med användarposten. |
Indata-JSON
Här är exempel-JSON för indata:
{
'flowName': 'Individual_Enrollment',
'groupCensusId':'0rfSG00000003fRYAQ',
'contractId':'800RN000000jyCRYAY',
'primaryMemberId':'0r6SG0000000j1xYAA',
'rootPlanId':'0rgRN0000000320YAA',
'isProrated': true,
'isSaveMemberPremium':true,
'emailEncodingKey':'ISO-8859-1',
'languageLocaleKey':'en_US',
'localeSidKey':'en_US',
'timezoneSidKey':'America/Los_Angeles',
'profileId':'00eSG00000120ug',
'userInputs':{"ratingType": "Enrollment"},
'additionalInputs':{"mergeList": "true", "includeOptionalCovSelectFlag":true}
'matchingKeysList':'FirstName,LastName',
'inputKeysList':'aggByKey,primaryMember,groupCensusMemberId'
}JSON för utdata för fel
Här är exempel på JSON för felresultat:
{
"errors":[
{
"error":"already enrolled",
"rootPlanId":"0rgRN0000000320YAA",
"censusMemberId":"0r6RN0000006HOJYA2"
},
]
}