Olet tässä:
InsCensusServiceStd:addMembers
Käytä tätä palvelua lisätäksesi ryhmän rekisteröinnin jäseniä ryhmän rekisteröintiin käyttämällä syötettyä JSON-tiedostoa.
Luokka: InsCensusServiceStd
Metodi: addMembers
Miten se toimii?
Palvelu ottaa rekisteröinnin syöttämässä JSON-tiedostossa olevat jäsenet ja lisää ne annettuun censusId. Se palauttaa luettelon lisättyjen jäsenten ( censusMemberIds ) tunnuksista.
Palvelu jäsentää jäsenten tiedot.
Jäsentää jäsenten tiedot otsakkeissa olevilla kentillä. Ylätunnisteiden täytyy sisältää kaikki jäsenluettelossa käytetyt kenttien metadata.
Erottelee ensisijaiset jäsenet ja sidonnaiset jäsenet
RelationshipToPrimaryMemberperusteella. Jos jäsenten luettelo sisältää ensisijaisia jäseniä ja sidonnaisia, input-arvona täytyy olla kaikkien jäsentenSourceSystemIdentifier. Kaikilla jäsenillä täytyy olla yksilöllinenSourceSystemIdentifier. Lisäksi kaikilla riippuvaisilla täytyy ollaPrimaryMemberSourcetaiPrimaryGroupCensusMemberId(jos ensisijainen jäsen on jo läsnä väestönlaskennassa).Luo
MemberKey.Käsittelee uudet
GroupClass. Jos palvelulle annetaanGroupClass.NameGroupClassIdsijaan, palvelu noutaa nimen sisältävänGroupClassja luo uudenGroupClass, jolla on sama nimi, jos sitä ei löydy.GroupClass.Name-otsake on {"type":"STRING","label":"Group Class Name","fieldId":","name":"GroupClass.Name"}. Jos annettuGroupClass.Nameon virheellinen, virhe palautetaan. Palvelu suorittaa uuden parametrinquoteEffectiveDatevahvistaakseenGroupClass.GroupClasskatsotaan kelvolliseksi, jos:Huomautus JosGroupClass.Nameon annettu, sisällytä myösAccountIdjäsenten tietoihin.GroupClasson linkitetty jäsenen ryhmätiliin.quoteEffectiveDatesijaitsee välissäGroupClassStartDatejaEndDate. Jos palvelun parametrinä ei ole määritettyquoteEffectiveDate-arvoa, tämä vahvistus ohitetaan.
Käsittelee
PrimaryMemberSource-objektin riippuvaisille, joilla onPrimaryGroupCensusMemberId. Jos jäsenten datassa on sekäPrimaryMemberSourceettäPrimaryGroupCensusMemberId, palvelu kuluttaa lähteenäPrimaryGroupCensusMemberIdja päivittää sidonnaistenPrimaryMemberSourcesisältämään ensisijaisenSourceSystemIdentifier.
Tallentaa kaikki ensisijaiset jäsenet. Palvelu käyttää identtisten tietueiden tunnistamiseen
MemberKey-funktiota. Jos olemassa on identtinen jäsen, palvelu päivittää sen kentät.MemberKeytäytyy olla yksilöllinen merkkijonojen yhdistelmä.Jäsentää huolletut tunnistaakseen orpo-huolletut (huolletut ilman
PrimaryMemberSource).Tallentaa kaikki kelvolliset sidonnaiset. Palvelu käyttää identtisten tietueiden tunnistamiseen
MemberKey-funktiota. Jos jäsenen tietue on identtinen, palvelu päivittää sen kentät uuden tietueen luomisen sijaan.Päivittää jäsenluettelon kaikkien ensisijaisten jäsenten
DependentCount.
Palvelun toimintatapa
Katso miten eri syötteet vaikuttavat palvelutuloksiin.
| Input | Palvelun output |
|---|---|
Ei censusId |
Palvelu palauttaa virheen: Specify a censusId. |
| Ei kyselyn syöttämää JSON-tiedostoa | Palvelu palauttaa virheen: The census input is missing. |
Ensisijaiselle jäsenelle annettu PrimaryMemberSource-arvo |
Palvelu palauttaa virheen: The PrimaryMemberSource must be null for primary members. |
headers puuttuu Input-kyselyssä |
Palvelu palauttaa virheen: The header node is missing in the census input. |
members puuttuu Input-kyselyssä |
Palvelu palauttaa virheen: The members node is missing in the census input. |
Orpojen huollettaville (huollettaville, joilla ei ole PrimaryMemberSource tai PrimaryGroupCensusMemberId) |
Palvelu palauttaa virheen: Dependent has no primary member. |
Etäasetukset
Vaihtoehto |
Kuvaus |
|---|---|
|
Pakollinen. Sen ryhmän tunnus, johon jäsenet lisätään. |
|
Pakollinen. Lisättävien jäsenten syöttämä JSON-tiedosto. census JSON koostuu kahdesta luettelosta - ylätunnisteista ja jäsenistä. headers on kenttien metadatan luettelo, joka koostuu fieldId-arvosta, tyypistä, otsikosta ja nimestä. Tämä nimi on kentän API-nimi (hallitun paketin ja mukautettujen kenttien nimitilalla). jäsenet on luettelo jäsentekoon lisättävistä jäsenistä. |
duplicateKey
|
Valinnainen. Luettelo kentistä, joilla voi luoda |
Syötetty JSON
Syötetty JSON koostuu kahdesta luettelosta - ylätunnisteet ja jäsenet. headers on kenttien metadatan luettelo, joka koostuu fieldId-arvosta, tyypistä, otsikosta ja nimestä. Tämä nimi on kentän API-nimi (hallitun paketin ja mukautettujen kenttien nimitilalla). jäsenet on luettelo jäsentekoon lisättävistä jäsenistä.
{
"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"
}
]
}
}
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 virheet. -
relatedFieldsUpdateErrors: Ensisijaisten jäsentenDependentCount-arvojen päivittämisen yhteydessä palautettujen virheiden luettelo.
{
"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"
}