Olet tässä:
InsCensusServiceStd:updateMembers
Käytä tätä palvelua päivittääksesi väestönlaskennan olemassa olevien jäsenten arvot.
Luokka: InsCensusServiceStd
Metodi: updateMembers
Miten se toimii?
-
Tämä palvelu noutaa jäsenet syötetystä JSON-tiedostosta ja päivittää tietyn
censusIdmukaisen kyselyn uusilla tiedoilla. -
census JSON koostuu kahdesta luettelosta -
headersjamembers.-
headerson kenttien metadatan luettelo, joka koostuufieldId,type,labeljaname. Tämä nimi on kentän API-nimi (hallitun paketin ja mukautettujen kenttien nimitila). -
memberson luettelo jäsenteessä päivitettävistä jäsenistä.
-
-
Palvelu etsii
updateById-kentän. Se on totuusarvokenttä, joka määrittää palvelun toimintatavan. Jäsenet voidaan päivittää kahdella tavalla:-
updateMembersMemberKeyTämä vaihtoehto on käytettävissä, kun
updateByIdon false. Jäsenten datalla täytyy olla jäsenavain. -
updateMembersby Id ofGroupCensusMemberTämä vaihtoehto on käytettävissä, kun
updateByIdon tosi. Jäsenten datalla täytyy olla ryhmän väestönlaskun jäsenen tunnus.
-
updateMembers MemberKey-arvon perusteella
-
Palvelu jäsentää jäsenten tiedot
headers-kentässä määritettyjen kenttien avulla.headerstäytyy sisältää kaikki jäsenten luettelossa käytettyjen kenttien metadata. -
Palvelu erottaa ensisijaiset jäsenet ja sidonnaiset jäsenet toisistaan
RelationshipToPrimaryMemberperusteella.-
Jos jäsenten luettelo sisältää ensisijaisia jäseniä ja sidonnaisia, input-arvona täytyy olla kaikkien jäsenten
SourceSystemIdentifier. Kaikilla jäsenillä täytyy olla yksilöllinenSourceSystemIdentifier. Lisäksi kaikilla huolletuilla täytyy ollaPrimaryMemberSourcetaiPrimaryGroupCensusMemberId(jos ensisijainen jäsen on jo läsnä väestönlaskennassa). -
Jos luettelo on ensisijaisten ja sidonnaisten jäsenten yhdistelmä, varmista, että kaikki sidonnaiset jäsenet ja ensisijaiset jäsenet ovat olemassa jäsenten luettelossa.
-
-
Palvelu käsittelee uudet
GroupClass. Jos palvelulla onGroupClass.NameGroupClassIdsijaan, se noutaa nimen sisältävänGroupClassja luo uuden samannimisenGroupClass, jos sitä ei löydy.- Jos palvelulla on
GroupClass.Name, sisällytä myösAccountIdjäsenten tietoihin. -
headerGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}. -
Jos annettu
GroupClass.Nameon virheellinen, virhe palautetaan. Palvelu suorittaa uuden parametrinquoteEffectiveDatevahvistaakseenGroupClass.GroupClasskatsotaan kelvolliseksi, jos:-
GroupClasson linkitetty jäsenen ryhmätiliin. -
quoteEffectiveDatesijaitsee välilläGroupClassStartDatejaEndDate. JosquoteEffectiveDate-parametriä ei ole annettu palvelulle, tämä vahvistus ohitetaan.
-
- Jos palvelulla on
-
Palvelut käsittelevät
PrimaryGroupCensusMemberId-henkilöidenPrimaryMemberSource.-
Jos palvelulla on sekä
PrimaryMemberSourceettäPrimaryGroupCensusMemberId, palvelu huomioi lähteenäPrimaryGroupCensusMemberIdja päivittää sidonnaistenPrimaryMemberSourcesisältämään ensisijaisenSourceSystemIdentifier.
-
-
Palvelu tallentaa kaikki ensisijaiset jäsenet ensin.
-
Se jäsentää huollettavia tunnistaakseen orpoja huollettavia (huollettavia ilman
PrimaryMemberSource). -
Se tallentaa kaikki kelvolliset sidonnaiset.
-
Palvelu päivittää jäsenluettelossa olevien kaikkien ensisijaisten jäsenten
DependentCount.
updateMembers tunnuksen mukaan
-
Palvelu jäsentää jäsenten tiedot
headers-kentässä määritettyjen kenttien avulla.headerstäytyy sisältää kaikki jäsenten luettelossa käytettyjen kenttien metadata. -
membersdatalla täytyy olla tunnus. Jos tunnusta ei löydy jäsenen tiedoista, palvelu aiheuttaa virheen. -
Palvelu käsittelee uudet
GroupClass. Jos palvelulla onGroupClass.NameGroupClassIdsijaan, se noutaa nimen sisältävänGroupClassja luo uuden samannimisenGroupClass, jos sitä ei löydy.- Jos palvelulla on
GroupClass.Name, sisällytä myösAccountIdjäsenten tietoihin. -
headerGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.
- Jos palvelulla on
-
Palvelu käsittelee
PrimaryMemberSource-henkilöidenPrimaryGroupCensusMemberId.- Jos annat
PrimaryMemberSource, myös palvelu päivittyyPrimaryGroupCensusMemberId.
- Jos annat
-
Palvelut käsittelevät
PrimaryGroupCensusMemberId-henkilöidenPrimaryMemberSource.-
Jos palvelulla on sekä
PrimaryMemberSourceettäPrimaryGroupCensusMemberId, palvelu huomioi lähteenäPrimaryGroupCensusMemberIdja päivittää sidonnaistenPrimaryMemberSourcesisältämään ensisijaisenSourceSystemIdentifier.
-
-
Palvelu tallentaa kaikki jäsenet, mukaan lukien sidonnaiset.
-
Palvelu ei tunnista orpoihin kuuluvia.
-
Palvelu päivittää jäsenluettelossa olevien kaikkien ensisijaisten jäsenten
DependentCount.
Etäasetukset
Vaihtoehto |
Kuvaus |
|---|---|
|
Pakollinen. Päivitettävän väestönlaskun tunnus. |
|
Pakollinen. Syötä JSON, joka sisältää lisätietoja jäsenille, jotka päivitetään. |
updateById
|
Valinnainen Jos arvo on true, palvelu seuraa Id-kulun Oletusarvo on false. |
Palvelutapa
Katso miten eri syötteet vaikuttavat palvelutuloksiin.
| Input | updateById | Palvelun output |
|---|---|---|
Ei censusId |
true tai false | Palvelu palauttaa virheen: |
| Ei kyselyn syöttämää JSON-tiedostoa | true tai false | Palvelu palauttaa virheen: The census input is missing. |
Ensisijaiselle jäsenelle annettujen PrimaryMemberSource-arvo |
false | Palvelu palauttaa virheen: The PrimaryMemberSource must be null for primary members. |
headers puuttuu Input-kyselyssä |
true tai false | Palvelu palauttaa virheen: The header node is missing in the census input. |
members puuttuu Input-kyselyssä |
true tai false | Palvelu palauttaa virheen: The members node is missing in the census input. |
| Orpoille sidonnaisille (riippuvaisille, joilla ei ole PrimaryMemberSource- tai PrimaryGroupCensusMemberId-arvoa) | false | Palvelu palauttaa virheen: Dependent has no primary member. |
| Tunnus puuttuu jäsenten tiedoista | true | Palvelu palauttaa virheen: Specify Id of the census member. |
Syötetty JSON
Syötetty JSON sisältää headers, joka sisältää päivitettävät kentät, ja members, joka sisältää jäsenet ja niiden vastaavat kenttäarvojen parit, mukaan lukien fieldId.
Esimerkki syötetystä JSON-tiedostosta (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"
}
]
}
}Esimerkki syötetystä JSON-tiedostosta (updateMembers tunnuksen mukaan)
{
"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"
}
]
}
}
Tulos-JSON
Palvelu palauttaa Onnistui-viestin, jos kulku on suoritettu, muussa tapauksessa se palauttaa virheen poikkeusten varalta.
-
censusMemberIds: Tallennettujen jäsentenGroupCensusMemberIds-luettelo. -
virheet: Virheitä sisältävien jäsenten luettelo. Jokainen luettelokohde koostuu syötetyistä jäsenten tiedoista ja virheistä.
-
relatedFieldsUpdateSuccessCount: Niiden ensisijaisten jäsenten määrä, joidenDependentCountpäivitetään palvelun perusteella. -
relatedFieldsUpdateErrorCount: Niiden ensisijaisten jäsenten määrä, joilleDependentCount-päivitys palauttaa virheitä. -
relatedFieldsUpdateErrors: Ensisijaisten jäsentenDependentCount-arvojen päivittämisen yhteydessä palautettujen virheiden luettelo.
Esimerkkitulos 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"
}Esimerkki output JSON - (updateMembers tunnuksen mukaan)
{
"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"
}