breadcrumbDescription
InsCensusServiceStd:addMembers
Brug denne tjeneste til at føje gruppebehandlingsmedlemmer til en gruppetælling ved brug af et input-JSON.
Kategori: InsCensusServiceStd
Metode: addMembers
Sådan fungerer det
Tjenesten tager medlemmerne i census input JSON og føjer dem til den givne censusId. Den returnerer en liste over id'erne for de tilføjede medlemmer ( censusMemberIds ).
Tjenesten parser medlemsdataene.
Parser medlemmernes data med de felter, der er angivet i sidehoveder. Sidehoveder skal indeholde alle felternes metadata, der bruges i medlemslisten.
Adskiller primære medlemmer og afhængige medlemmer baseret på
RelationshipToPrimaryMember. Hvis medlemslisten indeholder primære medlemmer og afhængige, skal inputtet haveSourceSystemIdentifierfor alle medlemmerne. Alle medlemmer skal have entydigeSourceSystemIdentifier. Desuden skal alle afhængige havePrimaryMemberSourceellerPrimaryGroupCensusMemberId(hvis det primære medlem allerede er til stede i folketællingen).Genererer
MemberKey.Behandler nye
GroupClass. HvisGroupClass.Nameer givet til service i stedet forGroupClassId, henter tjenestenGroupClassmed navnet og opretter et nytGroupClassmed det samme navn, hvis det ikke findes. Sidehovedet forGroupClass.Name er {"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}. Hvis den angivneGroupClass.Nameer ugyldig, returneres der en fejl. Tjenesten bruger en ny parameterquoteEffectiveDatefor at validereGroupClass.GroupClassanses for gyldig, hvis:Bemærk Hvis der er angivetGroupClass.Name, skal du også inkludereAccountIdi medlemmernes data.GroupClasser linket til medlemmets gruppekonto.quoteEffectiveDateligger mellemGroupClassStartDateogEndDate. HvisquoteEffectiveDateikke er angivet som en parameter til service, ignoreres denne validering.
Behandler
PrimaryMemberSourcefor afhængige medPrimaryGroupCensusMemberId. Hvis bådePrimaryMemberSourceogPrimaryGroupCensusMemberIdangives i medlemsdata, forbruger tjenestenPrimaryGroupCensusMemberIdsom kilde og opdatererPrimaryMemberSourceaf afhængige til at indeholdeSourceSystemIdentifieraf primær.
Gemmer alle primære medlemmer. Tjenesten bruger
MemberKeytil at identificere dubletter. Hvis der er et dubletmedlem, opdaterer tjenesten felterne for det pågældende allerede eksisterende medlem.MemberKeyskal være en unik kombination af strenge.Parses afhængige for at identificere forældreløse afhængige (afhængige uden
PrimaryMemberSource).Gemmer alle gyldige afhængige. Tjenesten bruger
MemberKeytil at identificere dubletter. I en dubletmedlemsregistrering opdaterer tjenesten felterne for dette allerede eksisterende medlem i stedet for at oprette en ny registrering.Opdaterer
DependentCountfor alle primære medlemmer på medlemslisten.
Serviceadfærd
Forstå, hvordan forskellige input påvirker serviceoutput.
| Input | Serviceoutput |
|---|---|
Nej censusId |
Tjenesten returnerer en fejl: Specify a censusId. |
| Ingen censusinput-JSON | Tjenesten returnerer en fejl: The census input is missing. |
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. |
Fjernindstillinger
Indstilling |
Beskrivelse |
|---|---|
|
Påkrævet. Id for den gruppenummering, som medlemmer skal føjes til. |
|
Påkrævet. Input JSON for de medlemmer, der skal tilføjes. census JSON består af to lister - sidehoveder og medlemmer. headers er listen over feltets metadata, der består af fieldId, type, betegnelse og navn. Her er navnet feltets API-navn (med navneområde for administreret pakke og tilpassede felter). medlemmer er listen over medlemmer, der skal føjes til folketællingen. |
duplicateKey
|
Valgfrit. Liste over felter til at generere |
Input JSON
Input-JSON består af to lister - sidehoveder og medlemmer. headers er listen over feltets metadata, der består af fieldId, type, betegnelse og navn. Her er navnet feltets API-navn (med navneområde for administreret pakke og tilpassede felter). medlemmer er listen over medlemmer, der skal føjes til folketællingen.
{
"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"
}
],
"members": [
{
"Lastname": "Koffins",
"FirstName": "Raj",
"FullTimeEquivalent": 1,
"Gender": "Male",
"Birthdate": "1985-10-13",
"SourceSystemIdentifier": "1.primary",
"PrimaryMemberSource": null,
"Email": "testraj@mail.com",
"AccountId":"001B000001QOqJHIA1",
"IsOptOutAllPlans":true,
"OptOutPlanTypes":"Medical;Dental"
},
{
"Lastname": "Koffins",
"FirstName": "Rita",
"Gender": "Female",
"Birthdate": "1987-07-13",
"RelationshipToPrimaryMember": "Spouse",
"SourceSystemIdentifier": "1.spouse",
"PrimaryMemberSource": null,
"Email": "testrita@mail.com",
"AccountId":"001B000001QOqJHIA1",
"IsOptOutAllPlans":true,
"OptOutPlanTypes":"Medical;Dental"
},
{
"Lastname": "Koffins",
"FirstName": "Kris",
"Gender": "Male",
"Birthdate": "2016-05-13",
"RelationshipToPrimaryMember": "Child",
"SourceSystemIdentifier": "1.child",
"PrimaryMemberSource": "1.primary",
"Email": "testkris@mail.com",
"AccountId":"001B000001QOqJHIA1",
"IsOptOutAllPlans":true,
"OptOutPlanTypes":"Medical;Dental"
},
{
"Lastname": "Warner",
"FirstName": "Christopher",
"FullTimeEquivalent": 0.5,
"Gender": "Male",
"Birthdate": "1985-10-13",
"SourceSystemIdentifier": "2.primary",
"PrimaryMemberSource": null,
"Email": "testchristopher@mail.com",
"AccountId":"001B000001QOqJHIA1",
"IsOptOutAllPlans":false,
"OptOutPlanTypes":"Medical"
},
{
"Lastname": "Warner",
"FirstName": "Steph",
"Gender": "Male",
"Birthdate": "1985-10-13",
"RelationshipToPrimaryMember": "Spouse",
"SourceSystemIdentifier": "2.spouse",
"PrimaryMemberSource": "2.primary",
"Email": "teststeph@mail.com",
"AccountId":"001B000001QOqJHIA1",
"IsOptOutAllPlans":false,
"OptOutPlanTypes":"Medical"
},
{
"Lastname": "Jose",
"FirstName": "Steve",
"Gender": "Male",
"Birthdate": "1989-10-13",
"FullTimeEquivalent":10,
"SourceSystemIdentifier": "3.primary",
"Email": "teststeve@mail.com",
"AccountId":"001B000001QOqJHIA1",
"IsOptOutAllPlans":false,
"OptOutPlanTypes":"Medical"
}
]
}
}
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, somDependentCount-opdateringen returnerer fejl for. -
relatedFieldsUpdateErrors: Listen over fejl, der blev returneret under opdatering afDependentCountaf primære medlemmer.
{
"result": "success",
"relatedFieldsUpdateErrors": [],
"relatedFieldsUpdateErrorCount": 0,
"relatedFieldsUpdateSuccessCount": 2,
"errors": [
{
"error": "[FullTimeEquivalent]: NUMBER_OUTSIDE_VALID_RANGE - Full Time Equivalent: value outside of valid range on numeric field: 10",
"Birthdate": "1989-10-13",
"Gender": "Male",
"IsOptOutAllPlans": false,
"Lastname": "Jose",
"SourceSystemIdentifier": "3.primary",
"FullTimeEquivalent": 10,
"FirstName": "Steve",
"AccountId": "001B000001QOqJHIA1",
"Email": "teststeve@mail.com",
"OptOutPlanTypes": "Medical"
},
{
"RelationshipToPrimaryMember": "Spouse",
"SourceSystemIdentifier": "1.spouse",
"OptOutPlanTypes": "Medical;Dental",
"PrimaryMemberSource": null,
"error": "Dependent has no primary member.",
"Birthdate": "1987-07-13",
"Gender": "Female",
"IsOptOutAllPlans": true,
"Lastname": "Koffins",
"FirstName": "Rita",
"AccountId": "001B000001QOqJHIA1",
"Email": "testrita@mail.com"
}
],
"censusMemberIds": [
"0r6B00000000ANcIAM",
"0r6B00000000ANdIAM",
"0r6B00000000ANeIAM",
"0r6B00000000ANfIAM"
],
"errorCode": "INVOKE-200",
"error": "OK"
}