U bent hier:
InsCensusServiceStd:updateMembers
Gebruik deze service om de waarden van bestaande leden in een telling bij te werken.
Klasse: InsCensusServiceStd
Methode: updateMembers
De manier waarop het werkt...
-
Deze service haalt de leden uit een ingevoerde JSON en werkt de telling (volgens de opgegeven
censusId) bij met de nieuwe gegevens. -
census JSON bestaat uit twee lijsten -
headersenmembers.-
headersis de lijst van metagegevens van velden die bestaat uitfieldId,type,labelenname. Hier is de naam de API-naam van het veld (met de naamruimte voor beheerde pakketten en aangepaste velden). -
membersis de lijst van leden die moeten worden bijgewerkt in de volkstelling.
-
-
De service zoekt naar het veld
updateById. Het is een booleaans veld dat de handelwijze voor de service bepaalt. De leden kunnen op deze twee manieren worden bijgewerkt:-
updateMembersopMemberKeyDeze optie is van toepassing wanneer
updateByIdfalse (onwaar) is. De ledengegevens moeten een lidsleutel hebben. -
updateMembersop ID vanGroupCensusMemberDeze optie is van toepassing wanneer
updateByIdtrue (waar) is. De gegevens van de leden moeten een ID van een lid van een groepstelling hebben.
-
updateMembers by MemberKey
-
De service parseert de gegevens van de leden met de velden die in
headerszijn opgegeven.headersmoet alle metagegevens van de velden bevatten die in de lijst van leden worden gebruikt. -
De service scheidt primaire leden en afhankelijke leden op basis van
RelationshipToPrimaryMember.-
Als de ledenlijst primaire leden en afhankelijke personen bevat, moet de invoer
SourceSystemIdentifierhebben voor alle leden. Alle leden moeten een uniekeSourceSystemIdentifierhebben. Daarnaast moeten alle afhankelijke personenPrimaryMemberSourceofPrimaryGroupCensusMemberIdhebben (als het primaire lid al aanwezig is in de telling). -
Als de lijst een combinatie is van primaire en afhankelijke leden, zorgt u ervoor dat elk afhankelijk lid en elk primair lid voorkomt in de lijst van leden.
-
-
De service verwerkt nieuwe
GroupClass. Als de serviceGroupClass.Namein plaats vanGroupClassIdheeft, haalt dezeGroupClassmet de naam op en maakt een nieuweGroupClassmet dezelfde naam als deze niet wordt gevonden.- Als de service
GroupClass.Nameheeft, neemt u ookAccountIdop in de gegevens van de leden. -
headervoorGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}. -
Als de opgegeven
GroupClass.Nameongeldig is, wordt er een fout geretourneerd. De service gebruikt een nieuwe parameterquoteEffectiveDateomGroupClasste valideren. DeGroupClasswordt als geldig beschouwd als:-
GroupClassis gekoppeld aan de groepsaccount van het lid. -
quoteEffectiveDateligt tussenGroupClassStartDateenEndDate. AlsquoteEffectiveDateniet is opgegeven als parameter voor de service, wordt deze validatie overgeslagen.
-
- Als de service
-
De services verwerken
PrimaryMemberSourcevoor afhankelijken metPrimaryGroupCensusMemberId.-
Als de service zowel
PrimaryMemberSourcealsPrimaryGroupCensusMemberIdheeft, beschouwt de servicePrimaryGroupCensusMemberIdals bron en werktPrimaryMemberSourcevan afhankelijk bij omSourceSystemIdentifiervan primair te bevatten.
-
-
De service slaat eerst alle primaire leden op.
-
Het parseert afhankelijken om weesafhankelijken (afhankelijken zonder
PrimaryMemberSource) te identificeren. -
Hiermee worden alle geldige afhankelijken opgeslagen.
-
De service werkt de
DependentCountbij van alle primaire leden in de ledenlijst.
updateMembers op ID
-
De service parseert de gegevens van de leden met de velden die in
headerszijn opgegeven.headersmoet alle metagegevens van de velden bevatten die in de lijst van leden worden gebruikt. -
membersmoeten ID hebben. Als de ID niet wordt gevonden in lidgegevens, geeft de service een fout. -
De service verwerkt nieuwe
GroupClass. Als de serviceGroupClass.Namein plaats vanGroupClassIdheeft, haalt dezeGroupClassmet de naam op en maakt een nieuweGroupClassmet dezelfde naam als deze niet wordt gevonden.- Als de service
GroupClass.Nameheeft, neemt u ookAccountIdop in de gegevens van de leden. -
headervoorGroupClass.Name:{"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.
- Als de service
-
De service verwerkt
PrimaryGroupCensusMemberIdvoor afhankelijken metPrimaryMemberSource.- Als u
PrimaryMemberSourcelevert, werkt de service ookPrimaryGroupCensusMemberIdbij.
- Als u
-
De services verwerken
PrimaryMemberSourcevoor afhankelijken metPrimaryGroupCensusMemberId.-
Als de service zowel
PrimaryMemberSourcealsPrimaryGroupCensusMemberIdheeft, beschouwt de servicePrimaryGroupCensusMemberIdals bron en werktPrimaryMemberSourcevan afhankelijk bij omSourceSystemIdentifiervan primair te bevatten.
-
-
De service slaat alle leden inclusief afhankelijke personen op.
-
De service identificeert geen weesafhankelijken.
-
De service werkt de
DependentCountbij van alle primaire leden in de ledenlijst.
Externe opties
Optie |
Beschrijving |
|---|---|
|
Verplicht. ID van de telling met bij te werken leden. |
|
Verplicht. Voer JSON in met details voor leden die moeten worden bijgewerkt. |
updateById
|
Optioneel Indien ingesteld op true (waar), volgt service de stroom De standaardwaarde is false (onwaar). |
Servicewerking
Begrijp hoe verschillende invoer van invloed is op de service-uitvoer.
| Invoer | updateById | Service-uitvoer |
|---|---|---|
Nee censusId |
waar of onwaar | De service retourneert een fout: |
| Geen volkstellingsinvoer-JSON | waar of onwaar | De service retourneert een fout: The census input is missing. |
De waarde van de PrimaryMemberSource die aan het primaire lid is verstrekt |
false (onwaar) | De service retourneert een fout: The PrimaryMemberSource must be null for primary members. |
headers ontbreekt in Invoertelling |
waar of onwaar | De service retourneert een fout: The header node is missing in the census input. |
members ontbreekt in Invoertelling |
waar of onwaar | De service retourneert een fout: The members node is missing in the census input. |
| Voor weesafhankelijken (De afhankelijken zonder PrimaryMemberSource of PrimaryGroupCensusMemberId) | false (onwaar) | De service retourneert een fout: Dependent has no primary member. |
| ID ontbreekt in gegevens van leden | true (waar) | De service retourneert een fout: Specify Id of the census member. |
Invoer-JSON
De invoer-JSON omvat headers, dat de bij te werken velden vermeldt, en members, dat leden vermeldt met hun overeenkomende veld-waardeparen, inclusief fieldId.
Voorbeeld van invoer-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"
}
]
}
}Voorbeeld van invoer-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"
}
]
}
}
Uitvoer-JSON
De service retourneert het succesbericht als de stroom is voltooid, anders retourneert deze de fout in geval van uitzonderingen.
-
censusMemberIds: De lijst vanGroupCensusMemberIdsvan opgeslagen leden. -
fouten: De lijst van leden met fouten. Elk lijstitem bestaat uit invoerlidgegevens en fouten.
-
relatedFieldsUpdateSuccessCount: Aantal primaire leden voor wie deDependentCountwordt bijgewerkt door service. -
relatedFieldsUpdateErrorCount: Aantal primaire leden waarvoor deDependentCountfouten retourneert. -
relatedFieldsUpdateErrors: De lijst van fouten die worden geretourneerd tijdens het bijwerken vanDependentCountvan primaire leden.
Voorbeeld van uitvoer-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"
}Voorbeeld van uitvoer-JSON - (updateMembers op 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"
}