Du er her:
InsCensusServiceStd:updateMembers
Bruk denne tjenesten til å oppdatere verdiene for eksisterende medlemmer i en folketelling.
Klasse: InsCensusServiceStd
Metode: updateMembers
Slik virker det
-
Denne tjenesten tar medlemmene fra en inndata JSON og oppdaterer folketellingen (i henhold til gitt
censusId) med de nye dataene. -
JSON består av to lister -
headersogmembers.-
headerser en liste over feltets metadata som består avfieldId,type,labelogname. Her er navnet feltets API-navn (med navneområdet for administrert pakke og tilpassede felt). -
memberser listen over medlemmer som skal oppdateres i folketellingen.
-
-
Tjenesten ser etter
updateById-felt. Det er et boolsk felt som bestemmer handlingsplanen for tjenesten. Medlemmene kan oppdateres på disse to måtene:-
updateMembersavMemberKeyDette alternativet gjelder når
updateByIder usann. Medlemsdataene må ha en medlemsnøkkel. -
updateMembersby Id ofGroupCensusMemberDette alternativet gjelder når
updateByIder sann. Medlemsdataene må ha ID for gruppebestemmelsesmedlem.
-
updateMembers by MemberKey
-
Tjenesten analyserer medlemmenes data med feltene i
headers.headersmå inneholde alle feltets metadata som brukes i medlemslisten. -
Tjenesten skiller primære medlemmer og avhengige medlemmer basert på
RelationshipToPrimaryMember.-
Hvis medlemslisten inneholder primære medlemmer og avhengige, må inndataene ha
SourceSystemIdentifierfor alle medlemmene. Alle medlemmer må ha en unikSourceSystemIdentifier. I tillegg må alle avhengige haPrimaryMemberSourceellerPrimaryGroupCensusMemberId(hvis det primære medlemmet allerede er til stede i folketellingen). -
Hvis listen er en kombinasjon av primære og avhengige medlemmer, må du forsikre deg om at alle avhengige medlemmer og primære medlemmer finnes i medlemslisten.
-
-
Tjenesten behandler nye
GroupClass. Hvis tjenesten harGroupClass.Namei stedet forGroupClassId, henter denGroupClassmed navnet og oppretter en nyGroupClassmed samme navn hvis den ikke blir funnet.- Hvis tjenesten har
GroupClass.Name, inkluderer du ogsåAccountIdi medlemmenes data. -
headerforGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}. -
Hvis den gitte
GroupClass.Nameer ugyldig, returneres det en feil. Tjenesten bruker en ny parameterquoteEffectiveDatefor å validereGroupClass.GroupClassanses som gyldig hvis-
GroupClasser knyttet til medlemmets gruppekonto. -
quoteEffectiveDateligger mellomGroupClassStartDateogEndDate. HvisquoteEffectiveDateikke oppgis som en parameter til tjenesten, hoppes denne valideringen over.
-
- Hvis tjenesten har
-
Tjenestene behandler
PrimaryMemberSourcefor avhengige medPrimaryGroupCensusMemberId.-
Hvis tjenesten har både
PrimaryMemberSourceogPrimaryGroupCensusMemberId, vurderer tjenestenPrimaryGroupCensusMemberIdsom kilde og oppdatererPrimaryMemberSourceav avhengig til å inneholdeSourceSystemIdentifierav primær.
-
-
Tjenesten lagrer alle primære medlemmer først.
-
Den analyserer avhengige for å identifisere foreldreløse avhengige (avhengige uten
PrimaryMemberSource). -
Den lagrer alle gyldige avhengige.
-
Tjenesten oppdaterer
DependentCountfor alle primære medlemmer i medlemslisten.
updateMembers by Id (oppdateringsmedlemmer etter ID)
-
Tjenesten analyserer medlemmenes data med feltene i
headers.headersmå inneholde alle feltets metadata som brukes i medlemslisten. -
membersmå ha Id. Hvis ID-en ikke blir funnet i medlemsdata, utløser tjenesten en feil. -
Tjenesten behandler nye
GroupClass. Hvis tjenesten harGroupClass.Namei stedet forGroupClassId, henter denGroupClassmed navnet og oppretter en nyGroupClassmed samme navn hvis den ikke blir funnet.- Hvis tjenesten har
GroupClass.Name, inkluderer du ogsåAccountIdi medlemmenes data. -
headerforGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.
- Hvis tjenesten har
-
Tjenesten behandler
PrimaryGroupCensusMemberIdfor avhengige medPrimaryMemberSource.- Hvis du oppgir
PrimaryMemberSource, oppdaterer tjenesten ogsåPrimaryGroupCensusMemberId.
- Hvis du oppgir
-
Tjenestene behandler
PrimaryMemberSourcefor avhengige medPrimaryGroupCensusMemberId.-
Hvis tjenesten har både
PrimaryMemberSourceogPrimaryGroupCensusMemberId, vurderer tjenestenPrimaryGroupCensusMemberIdsom kilde og oppdatererPrimaryMemberSourceav avhengig til å inneholdeSourceSystemIdentifierav primær.
-
-
Tjenesten lagrer alle medlemmer, inkludert avhengige.
-
Tjenesten identifiserer ikke foreldreløse avhengige.
-
Tjenesten oppdaterer
DependentCountfor alle primære medlemmer i medlemslisten.
Eksterne alternativer
Alternativ |
Beskrivelse |
|---|---|
|
Obligatorisk. ID-en til folketellingen med medlemmer som skal oppdateres. |
|
Obligatorisk. Inndata-JSON-kode med detaljer om at medlemmer skal oppdateres. |
updateById
|
Valgfritt Hvis angitt til true, følger service Standardverdien er false. |
Virkemåte for service
Forstå hvordan forskjellige inndata påvirker tjenesteutdataene.
| Inndata | updateById | Tjenesteutdata |
|---|---|---|
Nei censusId |
true eller false | Tjenesten returnerer en feil: |
| Ingen JSON-kode for folketelling | true eller false | Tjenesten returnerer en feil: The census input is missing. |
Verdien av PrimaryMemberSource som gis til primære medlemmer |
false | Tjenesten returnerer en feil: The PrimaryMemberSource must be null for primary members. |
headers mangler i inndatacensus |
true eller false | Tjenesten returnerer en feil: The header node is missing in the census input. |
members mangler i inndatacensus |
true eller false | Tjenesten returnerer en feil: The members node is missing in the census input. |
| For foreldreløse avhengige (Avhengige uten PrimaryMemberSource eller PrimaryGroupCensusMemberId) | false | Tjenesten returnerer en feil: Dependent has no primary member. |
| Id mangler i medlemmets data | true | Tjenesten returnerer en feil: Specify Id of the census member. |
Inndata-JSON
JSON-koden inkluderer headers, som viser feltene som skal oppdateres, og members, som viser medlemmer med sine tilsvarende felt-verdi-par, inkludert fieldId.
Eksempel på inndata-JSON (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"
}
]
}
}Eksempel på inndata-JSON (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"
}
]
}
}
Utdata-JSON
Tjenesten returnerer meldingen om vellykket utførelse hvis flyten er fullført, ellers returnerer den feilen i tilfelle det oppstår unntak.
-
censusMemberIds: Listen overGroupCensusMemberIdsav lagrede medlemmer. -
feil: Listen over medlemmer med feil. Hvert listeelement består av inndata og feil.
-
relatedFieldsUpdateSuccessCount: Antall primære medlemmer somDependentCountoppdateres for etter tjeneste. -
relatedFieldsUpdateErrorCount: Antall primære medlemmer somDependentCount-oppdateringen returnerer feil for. -
relatedFieldsUpdateErrors: Listen over feil som returneres ved oppdatering avDependentCountav primære medlemmer.
Eksempel på utdata-JSON (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"
}Eksempel på utdata-JSON - (updateMembers etter 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"
}