U bent hier:
InsCensusServiceStd:updateMembersWithPlans
Gebruik deze service om een groepstelling in te vullen met primaire leden, hun afhankelijke personen en hun vooraf ingeschreven plan. Deze service werkt bestaande GroupCensusMember memberKey bij en maakt GroupCensusMemberPlan voor bestaande GroupCensusMember. Het gebruikt de ContractGroupPlans die is opgegeven in de invoer-JSON om plannen voor elke GroupCensusMember bij te werken.
Klasse: InsCensusServiceStd
Methode: updateMembersWithPlans
De manier waarop het werkt...
-
De service geeft censusId en censusinvoer-JSON door om leden met plannen bij te werken.
-
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). DeheadersmoetContactGroupPlanId.bevatten -
membersis de lijst van leden die moeten worden bijgewerkt in de volkstelling. DemembersmoetContactGroupPlanIdbevatten, gescheiden met een puntkomma(;) voor meerdere plannen.
-
-
De service roept
updateMembersdoor MemberKey aan om gegevens over de leden op te slaan, waarbij de leden worden geparseerd in het JSON-object. -
De service voegt
isNewMembertoe als true (waar) voor alle nieuwe leden. Het vult ook ID in voor elk GroupCensusMember. -
De service roept vervolgens
InsCensusServiceStd: addPlanSelectionsaan omGroupCensusMemberPlante maken voor elk lid. Het accepteert ook optionele dekkingen per lid, zodat primaire leden en personen ten laste worden geregistreerd bij verschillende dekkingen onder hetzelfde plan.
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
GroupClassongeldig is, wordt er een fout geretourneerd. DeGroupClasswordt als geldig beschouwd als:-
GroupClassis gekoppeld aan de groepsaccount van het lid. -
De geldigheidsperiode van het contract ligt tussen de
StartDateen deEndDatevan deGroupClass. -
De
StartDateenEndDatevan het contract worden opgehaald met behulp vanContractIddie zijn aangeleverd als invoer voor service
-
- 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.
Externe opties
Optie |
Beschrijving |
|---|---|
|
Verplicht ID van de telling met bij te werken leden. Valideert dat de |
|
Verplicht. Voer JSON in met details voor leden die moeten worden bijgewerkt. |
|
Verplicht ID van het huidige contract van Account. Valideert dat de plannen van elk lid deel uitmaken van het contract. |
|
Booleaans Indien true (waar), worden nieuwe leden zonder |
|
Optioneel Lijst van velden voor het genereren van Standaardvelden in de lijst: |
| Invoer | Service-uitvoer |
|---|---|
Nee censusId |
De service retourneert een fout: Specify a censusId. |
Geen volkstellingsinvoer-JSON |
De service retourneert een fout: |
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. |
Geen contractId of ongeldige contractId |
De service werkt geen ledenplan bij. |
Ongeldige ContractGroupPlanId voor het opgegeven contract |
De service maakt geen ledenplan. Als
|
Ongeldige ContractGroupPlanId voor het lid (vanwege afmelding) |
Ledenplan wordt niet gemaakt Als
|
| Het primaire lid meldt zich af voor een producttype |
Als het primaire lid zich afmeldt voor een producttype, melden de afhankelijken zich ook af voor dat producttype. |
| Afhankelijk lid meldt zich af voor een producttype |
Als het primaire lid zich afmeldt voor een producttype, melden de afhankelijken zich ook af voor dat producttype. Als |
Invoer-JSON
Zo ziet de indeling eruit voor de invoer-JSON:
{
"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"
},
{
"type": "ENTITYID",
"label": "Contract Group Plan",
"fieldId": "",
"name": "ContractGroupPlanId"
}
],
"members": [
{
"MemberKey": "cd64a62573825ee11b87ce91110aa576",
"Lastname": "KoffinsUpdated",
"FirstName": "RajUpdated",
"FullTimeEquivalent": 1,
"Gender": "Male",
"Birthdate": "1965-10-13",
"SourceSystemIdentifier": "1.primary",
"PrimaryMemberSource": null,
"Email": "testrajUpdated@mail.com",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
},
{
"MemberKey": "f2f8735bbb66b3f7d7b2bae794c00650",
"Lastname": "Koffins",
"FirstName": "KrisUpdated",
"Gender": "Male",
"Birthdate": "2010-05-13",
"RelationshipToPrimaryMember": "Child",
"SourceSystemIdentifier": "1.child",
"PrimaryMemberSource": "1.primary",
"Email": "testkrisUpdated@mail.com",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
},
{
"Lastname": "WarnerUpdated",
"MemberKey": "5a5bc4e3c05cf461a65a2d7fdc0ab8e0",
"FirstName": "Christopher",
"FullTimeEquivalent": 0.75,
"Gender": "Male",
"Birthdate": "1985-10-13",
"SourceSystemIdentifier": "2.primary",
"PrimaryMemberSource": null,
"Email": "testchristopherUpdated@mail.com",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
},
{
"Lastname": "WarnerUpdated",
"MemberKey": "157b2052fc732d8261984c2922a3261b",
"FirstName": "Steph",
"Gender": "Male",
"Birthdate": "1985-10-13",
"RelationshipToPrimaryMember": "Spouse",
"SourceSystemIdentifier": "2.spouse",
"PrimaryMemberSource": "2.primary",
"Email": "teststephUpdated.com",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
}
]
}
}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. -
memberPlanIds: De lijst van met succes ingevoegdeGroupCensusMemberPlanIds.
{
"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",
"ContractGroupPlanId":"a4D4P000000hbjSUAQ;a4D4P000000hbjSUAQ"
}
],
"censusMemberIds": [
"0r6RO00000005pZYAQ",
"0r6RO00000005paYAA",
"0r6RO00000005pbYAA"
],
"memberPlanIds":[
"a4B4P000006jKsMUAU",
"a4B4P000006jKsNUAU",
"a4B4P000006jKsOUAU",
"a4B4P000006jKsPUAU",
"a4B4P000006jKsQUAU",
"a4B4P000006jKsRUAU"
],
"errorCode": "INVOKE-200",
"error": "OK"
}