Du är här:
InsCensusServiceStd:updateMembers
Använd denna tjänst för att uppdatera värdena för befintliga medlemmar i en folkräkning.
Klass: InsCensusServiceStd
Metod: updateMembers
Så här fungerar det
-
Denna tjänst tar medlemmarna från en indata-JSON och uppdaterar folkräkningen (enligt den givna
censusId) med de nya data. -
census JSON består av två listor -
headersochmembers.-
headersär listan över fältens metadata som består avfieldId,type,labelochname. Här är namn fältets API-namn (med namnutrymmet för hanterade paket och egna fält). -
membersär listan över medlemmar som ska uppdateras i folkräkningen.
-
-
Tjänsten letar efter
updateById. Det är ett booleskt fält som bestämmer tillvägagångssättet för tjänsten. Medlemmarna kan uppdateras på dessa två sätt:-
updateMembersmedMemberKey:Detta alternativ gäller om
updateByIdär falskt. Medlemsdata måste ha en medlemsnyckel. -
updateMembersefter ID förGroupCensusMemberDetta alternativ gäller när
updateByIdär sant. Medlemsdata måste ha ett ID för gruppräkningsmedlem.
-
updateMembers by MemberKey
-
Tjänsten tolkar medlemmarnas data med fälten i
headers.headersmåste innehålla alla fältens metadata som används i medlemslistan. -
Tjänsten separerar primära medlemmar och beroende medlemmar baserat på
RelationshipToPrimaryMember.-
Om medlemslistan innehåller primära medlemmar och beroenden måste indata ha
SourceSystemIdentifierför alla medlemmar. Alla medlemmar måste ha en unikSourceSystemIdentifier. Dessutom måste alla underordnade haPrimaryMemberSourceellerPrimaryGroupCensusMemberId(om den primära medlemmen redan finns i folkräkningen). -
Om listan är en kombination av primära och beroende medlemmar, se till att varje beroende medlem och primär medlem finns i medlemslistan.
-
-
Tjänsten bearbetar nya
GroupClass. Om tjänsten harGroupClass.Nameistället förGroupClassIdhämtar denGroupClassmed namnet och skapar en nyGroupClassmed samma namn om den inte hittas.- Om tjänsten har
GroupClass.Name, inkludera ävenAccountIdi medlemmarnas data. -
headerförGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}. -
Om den angivna
GroupClass.Nameär ogiltig returneras ett fel. Tjänsten tar en ny parameterquoteEffectiveDateför att valideraGroupClass.GroupClassanses vara giltigt om:-
GroupClassär länkat till medlemmens gruppkonto. -
quoteEffectiveDateligger mellanGroupClassStartDateochEndDate. OmquoteEffectiveDateinte anges som en parameter till tjänsten hoppas denna validering över.
-
- Om tjänsten har
-
Tjänsterna bearbetar
PrimaryMemberSourceför beroenden medPrimaryGroupCensusMemberId.-
Om tjänsten har både
PrimaryMemberSourceochPrimaryGroupCensusMemberIdöverväger tjänstenPrimaryGroupCensusMemberIdsom källa och uppdaterarPrimaryMemberSourceför beroende till att innehållaSourceSystemIdentifierför primär.
-
-
Tjänsten sparar alla huvudmedlemmar först.
-
Den tolkar beroenden för att identifiera föräldralösa beroenden (beroenden utan
PrimaryMemberSource). -
Det sparar alla giltiga beroenden.
-
Tjänsten uppdaterar
DependentCountöver alla primära medlemmar i medlemslistan.
updateMembers by Id
-
Tjänsten tolkar medlemmarnas data med fälten i
headers.headersmåste innehålla alla fältens metadata som används i medlemslistan. -
membersmåste ha ID. Om ID inte hittas i medlemsdata ger tjänsten ett fel. -
Tjänsten bearbetar nya
GroupClass. Om tjänsten harGroupClass.Nameistället förGroupClassIdhämtar denGroupClassmed namnet och skapar en nyGroupClassmed samma namn om den inte hittas.- Om tjänsten har
GroupClass.Name, inkludera ävenAccountIdi medlemmarnas data. -
headerförGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.
- Om tjänsten har
-
Servicen bearbetar
PrimaryGroupCensusMemberIdför beroenden medPrimaryMemberSource.- Om du tillhandahåller
PrimaryMemberSourceuppdaterar tjänsten ävenPrimaryGroupCensusMemberId.
- Om du tillhandahåller
-
Tjänsterna bearbetar
PrimaryMemberSourceför beroenden medPrimaryGroupCensusMemberId.-
Om tjänsten har både
PrimaryMemberSourceochPrimaryGroupCensusMemberIdöverväger tjänstenPrimaryGroupCensusMemberIdsom källa och uppdaterarPrimaryMemberSourceför beroende till att innehållaSourceSystemIdentifierför primär.
-
-
Tjänsten sparar alla medlemmar inklusive beroenden.
-
Tjänsten identifierar inte föräldralösa anhöriga.
-
Tjänsten uppdaterar
DependentCountöver alla primära medlemmar i medlemslistan.
Fjärralternativ
Alternativ |
Beskrivning |
|---|---|
|
Obligatoriskt. ID för folkräkningen med medlemmar att uppdatera. |
|
Obligatoriskt. Ange JSON med detaljer för medlemmar som ska uppdateras. |
updateById
|
Valfri Om satt till sant följer tjänsten Standardvärdet är falskt. |
Servicebeteende
Förstå hur olika inmatningar påverkar serviceresultaten.
| Indata | updateById | Serviceresultat |
|---|---|---|
Nej censusId |
sant eller falskt | Tjänsten returnerar ett fel: |
| Ingen JSON för folkräkningsinmatning | sant eller falskt | Tjänsten returnerar ett fel: The census input is missing. |
Värdet på PrimaryMemberSource som ges till huvudmedlemmen |
falskt | Tjänsten returnerar ett fel: The PrimaryMemberSource must be null for primary members. |
headers saknas i indataräkningen |
sant eller falskt | Tjänsten returnerar ett fel: The header node is missing in the census input. |
members saknas i indataräkningen |
sant eller falskt | Tjänsten returnerar ett fel: The members node is missing in the census input. |
| För överordnade beroende (De beroende utan PrimaryMemberSource eller PrimaryGroupCensusMemberId) | falskt | Tjänsten returnerar ett fel: Dependent has no primary member. |
| ID saknas i medlemmars data | true | Tjänsten returnerar ett fel: Specify Id of the census member. |
Indata-JSON
JSON för indata inkluderar headers, som listar de fält som ska uppdateras, och members, som listar medlemmar med motsvarande fältvärdepar, inklusive fieldId.
JSON för provinmatning (updateMembers By MemberKey)
{
"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": [
{
"MemberKey": "cd64a62573825ee11b87ce91110aa576",
"Lastname": "KoffinsUpdated",
"FirstName": "RajUpdated",
"FullTimeEquivalent": 1,
"Gender": "Male",
"Birthdate": "1965-10-13",
"SourceSystemIdentifier": "1.primary",
"PrimaryMemberSource": null,
"Email": "testrajUpdated@mail.com"
},
{
"MemberKey": "f2f8735bbb66b3f7d7b2bae794c00650",
"Lastname": "Koffins",
"FirstName": "KrisUpdated",
"Gender": "Male",
"Birthdate": "2010-05-13",
"RelationshipToPrimaryMember": "Child",
"SourceSystemIdentifier": "1.child",
"PrimaryMemberSource": "1.primary",
"Email": "testkrisUpdated@mail.com"
},
{
"Lastname": "WarnerUpdated",
"MemberKey": "5a5bc4e3c05cf461a65a2d7fdc0ab8e0",
"FirstName": "Christopher",
"FullTimeEquivalent": 0.75,
"Gender": "Male",
"Birthdate": "1985-10-13",
"SourceSystemIdentifier": "2.primary",
"PrimaryMemberSource": null,
"Email": "testchristopherUpdated@mail.com"
},
{
"Lastname": "WarnerUpdated",
"MemberKey": "157b2052fc732d8261984c2922a3261b",
"FirstName": "Steph",
"Gender": "Male",
"Birthdate": "1985-10-13",
"RelationshipToPrimaryMember": "Spouse",
"SourceSystemIdentifier": "2.spouse",
"PrimaryMemberSource": "2.primary",
"Email": "teststephUpdated.com"
}
]
}
}JSON för provinmatning (updateMembers By Id)
{
"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": [
{
"Id":"0r6RO00000005pZYAQ",
"Lastname": "KoffinsUpdatedById",
"FirstName": "RajUpdatedById",
"Birthdate": "1965-10-13",
"Email": "testrajUpdated@mail.com"
},
{
"Id":"0r6RO00000005pbYAA",
"Lastname": "Koffins",
"FirstName": "KrisUpdatedById",
"Gender": "Male",
"Birthdate": "2010-05-13",
"RelationshipToPrimaryMember": "Child",
"Email": "testkrisUpdatedById@mail.com"
},
{
"Id":"0r6RO00000005paYAA",
"Lastname": "WarnerUpdatedById",
"FirstName": "Christopher",
"FullTimeEquivalent": 0.75,
"Gender": "Male",
"Birthdate": "1985-10-13",
"Email": "testchristopherUpdatedById@mail.com"
},
{
"Lastname": "WarnerUpdatedById",
"FirstName": "Steph",
"Birthdate": "1985-10-13",
"Email": "teststephUpdated.com"
}
]
}
}
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.
Exempel på JSON för utdata (updateMembers By MemberKey)
{
"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"
}
],
"censusMemberIds": [
"0r6RO00000005pZYAQ",
"0r6RO00000005paYAA",
"0r6RO00000005pbYAA"
],
"deletedCensusMemberIds": [],
"errorCode": "INVOKE-200",
"error": "OK"
}Exempel på JSON för utdata - (updateMembers By Id)
{
"result": "success",
"relatedFieldsUpdateErrors": [],
"relatedFieldsUpdateErrorCount": 0,
"relatedFieldsUpdateSuccessCount": 2,
"errors": [
{
"error": "Specify Id of the census member.",
"Birthdate": "1985-10-13",
"Lastname": "WarnerUpdatedById",
"FirstName": "Steph",
"Email": "teststephUpdated.com"
}
],
"censusMemberIds": [
"0r6RO00000005pZYAQ",
"0r6RO00000005pbYAA",
"0r6RO00000005paYAA"
],
"errorCode": "INVOKE-200",
"error": "OK"
}