breadcrumbDescription
InsCensusServiceStd:updateMembersWithPlans
Brug denne tjeneste til at udfylde en gruppetælling med primære medlemmer, deres afhængige og deres plan, der er tilmeldt på forhånd. Denne tjeneste opdaterer eksisterende GroupCensusMember efter memberKey og opretter GroupCensusMemberPlan for eksisterende GroupCensusMember. Den bruger de ContractGroupPlans, der er angivet i input-JSON til at opdatere planer for hver GroupCensusMember.
Kategori: InsCensusServiceStd
Metode: updateMembersWithPlans
Sådan fungerer det
-
Tjenesten overfører censusId og census-input-JSON for at opdatere medlemmer med planer.
-
census JSON består af to lister -
headersogmembers.-
headerser listen over felternes metadata, der består affieldId,type,labelogname. Her er navnet feltets API-navn (med navneområdet for den administrerede pakke og tilpassede felter).headersskal indeholdeContactGroupPlanId. -
memberser listen over medlemmer, der skal opdateres i folketællingen.membersskal indeholdeContactGroupPlanIdadskilt med semikolon(;) for flere planer.
-
-
Tjenesten kalder
updateMembersby MemberKey for at gemme data om medlemmerne, parsing gennem medlemmerne i JSON-objektet. -
Tjenesten tilføjer
isNewMembersom true for alle nye medlemmer. Den udfylder også Id for hvert GroupCensusMember. -
Tjenesten ringer derefter til
InsCensusServiceStd: addPlanSelectionsfor at opretteGroupCensusMemberPlanfor hvert medlem. Den accepterer også valgfri dækning pr. medlem, så primære medlemmer og afhængige er tilmeldt forskellige dækninger under den samme plan.
updateMembers by MemberKey (opdater medlemmer efter medlemsnøgle)
-
Tjenesten parser medlemmernes data med felterne i
headers.headersskal indeholde alle felternes metadata, der bruges på medlemmernes liste. -
Tjenesten adskiller primære medlemmer og afhængige medlemmer baseret på
RelationshipToPrimaryMember.-
Hvis medlemslisten indeholder primære medlemmer og afhængige, skal inputtet have
SourceSystemIdentifierfor alle medlemmerne. Alle medlemmer skal have en unikSourceSystemIdentifier. Derudover skal alle afhængige havePrimaryMemberSourceellerPrimaryGroupCensusMemberId(hvis det primære medlem allerede er til stede i folketællingen). -
Hvis listen er en kombination af primære og afhængige medlemmer, skal du sørge for, at alle afhængige medlemmer og primære medlemmer findes på medlemmernes liste.
-
-
Tjenesten behandler nye
GroupClass. Hvis tjenesten harGroupClass.Namei stedet forGroupClassId, henter denGroupClassmed navnet og opretter en nyGroupClassmed det samme navn, hvis den ikke findes.- Hvis tjenesten har
GroupClass.Name, skal du også inkludereAccountIdi medlemmets data. -
headerforGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}. -
Hvis den angivne
GroupClasser ugyldig, returneres der en fejl.GroupClassanses for gyldig, hvis:-
GroupClasser linket til medlemmets gruppekonto. -
Kontraktens ikrafttrædelsesperiode er mellem
StartDateogEndDateafGroupClass. -
Kontraktens
StartDateogEndDatehentes ved brug afContractId, der leveres som input til service
-
- Hvis tjenesten har
-
Tjenesten behandler
PrimaryMemberSourcefor afhængige medPrimaryGroupCensusMemberId.-
Hvis tjenesten har både
PrimaryMemberSourceogPrimaryGroupCensusMemberId, tager tjenestenPrimaryGroupCensusMemberIdsom kilde og opdatererPrimaryMemberSourceaf afhængige til at indeholdeSourceSystemIdentifieraf primær.
-
-
Tjenesten gemmer alle primære medlemmer først.
-
Det parser afhængige for at identificere forældreløse afhængige (afhængige uden
PrimaryMemberSource). -
Den gemmer alle gyldige afhængige.
-
Tjenesten opdaterer
DependentCountfor alle primære medlemmer på medlemmernes liste.
Fjernindstillinger
Indstilling |
Beskrivelse |
|---|---|
|
Påkrævet Id for folketællingen med medlemmer, der skal opdateres. Validerer, at |
|
Påkrævet. Input JSON med detaljer for medlemmer, der skal opdateres. |
|
Påkrævet Id for kontoens aktuelle kontrakt. Validerer, at hvert medlems planer er del af kontrakten. |
|
Boolesk Hvis det er sandt, slettes nye medlemmer uden poster i |
|
Valgfrit Liste over felter til generering af Standardfelter på listen: |
| Input | Serviceoutput |
|---|---|
Nej censusId |
Tjenesten returnerer en fejl: Specify a censusId. |
Ingen censusinput-JSON |
Tjenesten returnerer en fejl: |
PrimaryMemberSource, der leveres til det primære medlem |
Tjenesten returnerer en fejl: The PrimaryMemberSource must be null for primary members. |
headers mangler i Inputopgørelsen |
Tjenesten returnerer en fejl: The header node is missing in the census input. |
members mangler i Inputopgørelsen |
Tjenesten returnerer en fejl: The members node is missing in the census input. |
For afhængige forældreløse (afhængige uden PrimaryMemberSource eller PrimaryGroupCensusMemberId) |
Tjenesten returnerer en fejl: Dependent has no primary member. |
Ingen contractId eller ugyldigt contractId |
Tjenesten opdaterer ingen medlemsplan. |
Ugyldig ContractGroupPlanId for den angivne kontrakt |
Tjenesten opretter ingen medlemsplan. Hvis
|
Ugyldig ContractGroupPlanId for medlemmet (på grund af framelding) |
Medlemsplan er ikke oprettet Hvis
|
| Det primære medlem framelder sig en produkttype |
Hvis det primære medlem framelder sig en produkttype, framelder afhængige sig også denne produkttype. |
| Afhængigt medlem framelder sig en produkttype |
Hvis det primære medlem framelder sig en produkttype, framelder afhængige sig også denne produkttype. Hvis |
Input JSON
Sådan ser formatet ud for input-JSON'en:
{
"census": {
"headers": [
{
"type": "STRING",
"label": "Last Name",
"fieldId": "",
"name": "Lastname"
},
{
"type": "STRING",
"label": "First Name",
"fieldId": "",
"name": "FirstName"
},
{
"type": "DOUBLE",
"label": "FTE",
"fieldId": "",
"name": "FullTimeEquivalent"
},
{
"type": "PICKLIST",
"label": "Gender",
"fieldId": "",
"name": "Gender"
},
{
"type": "DATE",
"label": "Birthday",
"fieldId": "",
"name": "Birthdate"
},
{
"type": "PICKLIST",
"label": "Relationship To Primary",
"fieldId": "",
"name": "RelationshipToPrimaryMember"
},
{
"type": "BOOLEAN",
"label": "Is Opt-out All Plans",
"fieldId": "",
"name": "IsOptOutAllPlans"
},
{
"type": "MULTIPICKLIST",
"label": "Opt-Out Plan Types",
"fieldId": "",
"name": "OptOutPlanTypes"
},
{
"type": "ENTITYID",
"label": "Account",
"fieldId": "",
"name": "AccountId"
},
{
"type": "EMAIL",
"label": "Email",
"fieldId": "",
"name": "Email"
},
{
"type": "STRING",
"label": "Primary Member Identifier",
"fieldId": "",
"name": "PrimaryMemberSource"
},
{
"type": "STRING",
"label": "Member Identifier",
"fieldId": "",
"name": "SourceSystemIdentifier"
},
{
"type": "ENTITYID",
"label": "Contract Group Plan",
"fieldId": "",
"name": "ContractGroupPlanId"
}
],
"members": [
{
"MemberKey": "cd64a62573825ee11b87ce91110aa576",
"Lastname": "KoffinsUpdated",
"FirstName": "RajUpdated",
"FullTimeEquivalent": 1,
"Gender": "Male",
"Birthdate": "1965-10-13",
"SourceSystemIdentifier": "1.primary",
"PrimaryMemberSource": null,
"Email": "testrajUpdated@mail.com",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
},
{
"MemberKey": "f2f8735bbb66b3f7d7b2bae794c00650",
"Lastname": "Koffins",
"FirstName": "KrisUpdated",
"Gender": "Male",
"Birthdate": "2010-05-13",
"RelationshipToPrimaryMember": "Child",
"SourceSystemIdentifier": "1.child",
"PrimaryMemberSource": "1.primary",
"Email": "testkrisUpdated@mail.com",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
},
{
"Lastname": "WarnerUpdated",
"MemberKey": "5a5bc4e3c05cf461a65a2d7fdc0ab8e0",
"FirstName": "Christopher",
"FullTimeEquivalent": 0.75,
"Gender": "Male",
"Birthdate": "1985-10-13",
"SourceSystemIdentifier": "2.primary",
"PrimaryMemberSource": null,
"Email": "testchristopherUpdated@mail.com",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
},
{
"Lastname": "WarnerUpdated",
"MemberKey": "157b2052fc732d8261984c2922a3261b",
"FirstName": "Steph",
"Gender": "Male",
"Birthdate": "1985-10-13",
"RelationshipToPrimaryMember": "Spouse",
"SourceSystemIdentifier": "2.spouse",
"PrimaryMemberSource": "2.primary",
"Email": "teststephUpdated.com",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
}
]
}
}Output JSON
Tjenesten returnerer succesmeddelelsen, hvis forløbet er fuldført, ellers returnerer den fejlen i tilfælde af eventuelle undtagelser.
-
censusMemberIds: Listen overGroupCensusMemberIdsaf gemte medlemmer. -
fejl: Listen over medlemmer med fejl. Hvert listeelement består af inputmedlemsdata og fejl.
-
relatedFieldsUpdateSuccessCount: Antal primære medlemmer, somDependentCountopdateres efter service for. -
relatedFieldsUpdateErrorCount: Antal primære medlemmer, for hvilkeDependentCountreturnerer fejl. -
relatedFieldsUpdateErrors: Listen over fejl, der blev returneret under opdatering afDependentCountaf primære medlemmer. -
memberPlanIds: Listen over indsatteGroupCensusMemberPlanIds.
{
"result": "success",
"relatedFieldsUpdateErrors": [],
"relatedFieldsUpdateErrorCount": 0,
"relatedFieldsUpdateSuccessCount": 2,
"errors": [
{
"error": "[Email]: INVALID_EMAIL_ADDRESS - Email: invalid email address: teststephUpdated.com",
"Birthdate": "1985-10-13",
"Gender": "Male",
"Lastname": "WarnerUpdated",
"RelationshipToPrimaryMember": "Spouse",
"MemberKey": "157b2052fc732d8261984c2922a3261b",
"SourceSystemIdentifier": "2.spouse",
"FirstName": "Steph",
"Email": "teststephUpdated.com",
"PrimaryMemberSource": "2.primary",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
}
],
"censusMemberIds": [
"0r6RO00000005pZYAQ",
"0r6RO00000005paYAA",
"0r6RO00000005pbYAA"
],
"memberPlanIds":[
"a4B4P000006jKsMUAU",
"a4B4P000006jKsNUAU",
"a4B4P000006jKsOUAU",
"a4B4P000006jKsPUAU",
"a4B4P000006jKsQUAU",
"a4B4P000006jKsRUAU"
],
"errorCode": "INVOKE-200",
"error": "OK"
}