Du är här:
InsCensusServiceStd:addMembers
Använd denna tjänst för att lägga till gruppräkningsmedlemmar i en gruppräkning med hjälp av en indata-JSON.
Klass: InsCensusServiceStd
Metod: addMembers
Så här fungerar det
Tjänsten tar medlemmarna i JSON för folkräkningsinmatning och lägger till dem i den angivna censusId. Den returnerar en lista över ID:n för de tillagda medlemmarna ( censusMemberIds ).
Tjänsten tolkar medlemsdata.
Tolkar medlemmars data med fälten i sidhuvuden. Sidhuvuden måste innehålla alla fältens metadata som används i medlemslistan.
Separerar primära medlemmar och beroende medlemmar baserat på
RelationshipToPrimaryMember. Om medlemslistan innehåller primära medlemmar och beroenden måste indata haSourceSystemIdentifierför alla medlemmar. Alla medlemmar måste ha unikaSourceSystemIdentifier. Dessutom måste alla underordnade haPrimaryMemberSourceellerPrimaryGroupCensusMemberId(om den primära medlemmen redan finns i folkräkningen).Genererar
MemberKey.Bearbetar nya
GroupClass. OmGroupClass.Nameges till service istället förGroupClassIdhämtar tjänstenGroupClassmed namnet och skapar ett nyttGroupClassmed samma namn om det inte hittas. Sidhuvudet förGroupClass.Name är {"type":"STRING","label":"Group Class Name","fieldId":","name":"GroupClass.Name"}. Om den angivnaGroupClass.Nameär ogiltig returneras ett fel. Tjänsten tar en ny parameterquoteEffectiveDateför att valideraGroupClass.GroupClassanses vara giltigt om:Anteckning OmGroupClass.Nametillhandahålls, inkludera ävenAccountIdi medlemmars data.GroupClassär länkat till medlemmens gruppkonto.quoteEffectiveDateligger mellanGroupClassStartDateochEndDate. OmquoteEffectiveDateinte anges som en parameter för service hoppas denna validering över.
Bearbetar
PrimaryMemberSourceför beroenden medPrimaryGroupCensusMemberId. Om bådePrimaryMemberSourceochPrimaryGroupCensusMemberIdanges i medlemsdata använder tjänstenPrimaryGroupCensusMemberIdsom källa och uppdaterarPrimaryMemberSourceberoende till att innehållaSourceSystemIdentifierav primär.
Sparar alla primära medlemmar. Tjänsten använder
MemberKeyför att identifiera dubbletter. Om det finns en dubblettmedlem uppdaterar tjänsten fälten för den redan befintliga medlemmen.MemberKeymåste vara en unik kombination av strängar.Tolkar beroenden för att identifiera beroenden utan
PrimaryMemberSource.Sparar alla giltiga beroenden. Tjänsten använder
MemberKeyför att identifiera dubbletter. I det finns en dubblettmedlemspost uppdaterar tjänsten fälten för den redan befintliga medlemmen istället för att skapa en ny post.Uppdaterar
DependentCountöver alla primära medlemmar i medlemslistan.
Servicebeteende
Förstå hur olika inmatningar påverkar serviceresultaten.
| Indata | Serviceresultat |
|---|---|
Nej censusId |
Tjänsten returnerar ett fel: Specify a censusId. |
| Ingen JSON för folkräkningsinmatning | Tjänsten returnerar ett fel: The census input is missing. |
PrimaryMemberSource som ges till huvudmedlemmen |
Tjänsten returnerar ett fel: The PrimaryMemberSource must be null for primary members. |
headers saknas i indataräkningen |
Tjänsten returnerar ett fel: The header node is missing in the census input. |
members saknas i indataräkningen |
Tjänsten returnerar ett fel: The members node is missing in the census input. |
För föräldralösa anhöriga (De beroende utan PrimaryMemberSource eller PrimaryGroupCensusMemberId) |
Tjänsten returnerar ett fel: Dependent has no primary member. |
Fjärralternativ
Alternativ |
Beskrivning |
|---|---|
|
Obligatoriskt. ID för gruppräkningen att lägga till medlemmar i. |
|
Obligatoriskt. Ange JSON för de medlemmar som ska läggas till. census JSON består av två listor - sidhuvuden och medlemmar. headers är listan över fälts metadata som består av fieldId, type, label och name. Här är namn fältets API-namn (med namnutrymme för hanterade paket och egna fält). members är listan över medlemmar som ska läggas till i folkräkningen. |
duplicateKey
|
Valfritt. Lista över fält för att skapa |
Indata-JSON
Indata-JSON består av två listor - sidhuvuden och medlemmar. headers är listan över fälts metadata som består av fieldId, type, label och name. Här är namn fältets API-namn (med namnutrymme för hanterade paket och egna fält). members är listan över medlemmar som ska läggas till i folkräkningen.
{
"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"
}
]
}
}
JSON för utdata
Tjänsten returnerar ett resultatmeddelande om flödet slutförs, annars returneras felet vid eventuella undantag.
-
censusMemberIds: Listan överGroupCensusMemberIdsöver sparade medlemmar. -
fel: Listan över medlemmar med fel. Varje listobjekt består av indata för medlemmar och fel.
-
relatedFieldsUpdateSuccessCount: Antal primära medlemmar somDependentCountuppdateras för efter tjänst. -
relatedFieldsUpdateErrorCount: Antal primära medlemmar somDependentCountreturnerar fel för. -
relatedFieldsUpdateErrors: Listan över fel som returnerades vid uppdatering avDependentCountöver primära medlemmar.
{
"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"
}