U bent hier:
InsCensusServiceStd:addMembers
Gebruik deze service om leden van de groepstelling toe te voegen aan een groepstelling met behulp van een invoer-JSON.
Klasse: InsCensusServiceStd
Methode: addMembers
De manier waarop het werkt...
De service neemt de leden mee in de JSON van de volkstelling en voegt ze toe aan de opgegeven censusId. Het retourneert een lijst van de ID's van de toegevoegde leden ( censusMemberIds ).
De service parseert de lidgegevens.
Parseert gegevens van leden met de velden die in kopteksten zijn opgegeven. Kopteksten moeten alle metagegevens van de velden bevatten die in de ledenlijst worden gebruikt.
Scheidt primaire leden en afhankelijke leden op basis van
RelationshipToPrimaryMember. Als de ledenlijst primaire leden en afhankelijke personen bevat, moet de invoerSourceSystemIdentifierhebben voor alle leden. Alle leden moeten uniekeSourceSystemIdentifierhebben. Daarnaast moeten alle afhankelijke personenPrimaryMemberSourceofPrimaryGroupCensusMemberIdhebben (als het primaire lid al aanwezig is in de volkstelling).Genereert
MemberKey.Verwerkt nieuwe
GroupClass. AlsGroupClass.Namewordt gegeven aan service in plaats vanGroupClassId, haalt de serviceGroupClassop met de naam en maakt een nieuweGroupClassmet dezelfde naam als deze niet wordt gevonden. De koptekst voorGroupClass.Name is {"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}. Als de opgegevenGroupClass.Nameongeldig is, wordt er een fout geretourneerd. De service gebruikt een nieuwe parameterquoteEffectiveDateomGroupClasste valideren. DeGroupClasswordt als geldig beschouwd als:Opmerking Als erGroupClass.Nameis verstrekt, neemt u ookAccountIdop in de gegevens van leden.GroupClassis gekoppeld aan de groepsaccount van het lid.quoteEffectiveDateligt tussenGroupClassStartDateenEndDate. AlsquoteEffectiveDateniet wordt opgegeven als parameter voor service, wordt deze validatie overgeslagen.
Verwerkt
PrimaryMemberSourcevoor afhankelijken metPrimaryGroupCensusMemberId. Als zowelPrimaryMemberSourcealsPrimaryGroupCensusMemberIdin lidgegevens worden opgegeven, verbruikt de servicePrimaryGroupCensusMemberIdals bron en werktPrimaryMemberSourcevan afhankelijk bij omSourceSystemIdentifiervan primair te bevatten.
Slaat alle primaire leden op. De service gebruikt
MemberKeyom duplicaten te identificeren. Als er een duplicaatlid is, werkt de service de velden van dat reeds bestaande lid bij. DeMemberKeymoet een unieke combinatie van tekenreeksen zijn.Parseert afhankelijken om weesafhankelijken (afhankelijken zonder
PrimaryMemberSource) te identificeren.Slaat alle geldige afhankelijken op. De service gebruikt
MemberKeyom duplicaten te identificeren. Als er een duplicaatlidrecord is, werkt de service de velden van dat reeds bestaande lid bij in plaats van een nieuwe record te maken.Werkt
DependentCountbij van alle primaire leden in de ledenlijst.
Servicewerking
Begrijp hoe verschillende invoer van invloed is op de service-uitvoer.
| Invoer | Service-uitvoer |
|---|---|
Nee censusId |
De service retourneert een fout: Specify a censusId. |
| Geen volkstellingsinvoer-JSON | De service retourneert een fout: The census input is missing. |
PrimaryMemberSource aan primaire lid |
De service retourneert een fout: The PrimaryMemberSource must be null for primary members. |
headers ontbreekt in Invoertelling |
De service retourneert een fout: The header node is missing in the census input. |
members ontbreekt in Invoertelling |
De service retourneert een fout: The members node is missing in the census input. |
Voor weeskinderen (De afhankelijken zonder PrimaryMemberSource of PrimaryGroupCensusMemberId) |
De service retourneert een fout: Dependent has no primary member. |
Externe opties
Optie |
Beschrijving |
|---|---|
|
Verplicht. ID van de groepstelling waaraan leden moeten worden toegevoegd. |
|
Verplicht. Invoer-JSON van de toe te voegen leden. JSON voor telling bestaat uit twee lijsten - headers en members. headers is de lijst van metagegevens van velden die bestaat uit fieldId, type, label en name. Hier is naam de API-naam van het veld (met naamruimte voor beheerde pakket- en aangepaste velden). members is de lijst van leden die aan de telling moeten worden toegevoegd. |
duplicateKey
|
Optioneel. Lijst van velden om |
Invoer-JSON
De invoer-JSON bestaat uit twee lijsten - headers en members. headers is de lijst van metagegevens van velden die bestaat uit fieldId, type, label en name. Hier is naam de API-naam van het veld (met naamruimte voor beheerde pakket- en aangepaste velden). members is de lijst van leden die aan de telling moeten worden toegevoegd.
{
"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"
}
]
}
}
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.
{
"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"
}