InsCensusServiceStd:updateMembers

Sådan fungerer det

1. Denne tjeneste tager medlemmerne fra en input JSON og opdaterer folketællingen (i henhold til den givne censusId) med de nye data.

2. census JSON består af to lister - headers og members.

   1. headers er listen over felternes metadata, der består af fieldId, type, label og name. Her er navnet feltets API-navn (med navneområdet for den administrerede pakke og tilpassede felter).

   2. members er listen over medlemmer, der skal opdateres i folketællingen.

3. Tjenesten søger efter updateById. Det er et boolesk felt, der bestemmer handlingsforløbet for tjenesten. Medlemmerne kan opdateres på disse to måder:

   1. updateMembers efter MemberKey

      Denne indstilling gælder, når updateById er falsk. Medlemsdataene skal have en medlemsnøgle.

   2. updateMembers efter Id for GroupCensusMember

      Denne indstilling gælder, når updateById er sand. Medlemsdataene skal have id for gruppebeskrivelsesmedlem.

updateMembers by MemberKey (opdater medlemmer efter medlemsnøgle)

1. Tjenesten parser medlemmernes data med felterne i headers. headers skal indeholde alle felternes metadata, der bruges på medlemmernes liste.

2. Tjenesten adskiller primære medlemmer og afhængige medlemmer baseret på RelationshipToPrimaryMember.

   1. Hvis medlemslisten indeholder primære medlemmer og afhængige, skal inputtet have SourceSystemIdentifier for alle medlemmerne. Alle medlemmer skal have en unik SourceSystemIdentifier. Derudover skal alle afhængige have PrimaryMemberSource eller PrimaryGroupCensusMemberId (hvis det primære medlem allerede er til stede i folketællingen).

   2. Hvis listen er en kombination af primære og afhængige medlemmer, skal du sørge for, at alle afhængige medlemmer og primære medlemmer findes på medlemmernes liste.

3. Tjenesten behandler nye GroupClass. Hvis tjenesten har GroupClass.Name i stedet for GroupClassId, henter den GroupClass med navnet og opretter en ny GroupClass med det samme navn, hvis den ikke findes.

   1. Hvis tjenesten har GroupClass.Name, skal du også inkludere AccountId i medlemmets data.

   2. header forGroupClass.Name: {"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.

   3. Hvis den angivne GroupClass.Name er ugyldig, returneres der en fejl. Tjenesten bruger en ny parameter quoteEffectiveDate for at validere GroupClass. GroupClass anses for gyldig, hvis:

      • GroupClass er linket til medlemmets gruppekonto.

      • quoteEffectiveDate ligger mellem GroupClass StartDate og EndDate. Hvis quoteEffectiveDate ikke angives som en parameter til tjenesten, ignoreres denne validering.

4. Tjenesten behandler PrimaryMemberSource for afhængige med PrimaryGroupCensusMemberId.

   1. Hvis tjenesten har både PrimaryMemberSource og PrimaryGroupCensusMemberId, tager tjenesten PrimaryGroupCensusMemberId som kilde og opdaterer PrimaryMemberSource af afhængige til at indeholde SourceSystemIdentifier af primær.

5. Tjenesten gemmer alle primære medlemmer først.

6. Det parser afhængige for at identificere forældreløse afhængige (afhængige uden PrimaryMemberSource).

7. Den gemmer alle gyldige afhængige.

8. Tjenesten opdaterer DependentCount for alle primære medlemmer på medlemmernes liste.

updateMembers by Id (opdater medlemmer efter id)

1. Tjenesten parser medlemmernes data med felterne i headers. headers skal indeholde alle felternes metadata, der bruges på medlemslisten.

2. members skal have Id. Hvis Id'et ikke findes i medlemsdata, medfører tjenesten en fejl.

3. Tjenesten behandler nye GroupClass. Hvis tjenesten har GroupClass.Name i stedet for GroupClassId, henter den GroupClass med navnet og opretter en ny GroupClass med det samme navn, hvis den ikke findes.

   1. Hvis tjenesten har GroupClass.Name, skal du også inkludere AccountId i medlemmets data.

   2. header forGroupClass.Name: {"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.

4. Tjenesten behandler PrimaryGroupCensusMemberId for afhængige med PrimaryMemberSource.

   1. Hvis du angiver PrimaryMemberSource, opdaterer tjenesten også PrimaryGroupCensusMemberId.

5. Tjenesten behandler PrimaryMemberSource for afhængige med PrimaryGroupCensusMemberId.

   1. Hvis tjenesten har både PrimaryMemberSource og PrimaryGroupCensusMemberId, tager tjenesten PrimaryGroupCensusMemberId som kilde og opdaterer PrimaryMemberSource af afhængige til at indeholde SourceSystemIdentifier af primær.

6. Tjenesten gemmer alle medlemmer inklusive afhængige.

7. Tjenesten identificerer ikke forældreløse afhængige.

8. Tjenesten opdaterer DependentCount for alle primære medlemmer på medlemmernes liste.

Fjernindstillinger

Serviceadfærd

Forstå, hvordan forskellige input påvirker serviceoutput.

Input JSON

Input-JSON indeholder headers, som viser de felter, der skal opdateres, og members, som viser medlemmer med deres tilsvarende felt-værdi-par, herunder fieldId.

{
  "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"
      }
    ]
  }
}

Eksempel på input-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"
      }
    ]
  }
}

Output JSON

Tjenesten returnerer succesmeddelelsen, hvis forløbet er fuldført, ellers returnerer den fejlen i tilfælde af eventuelle undtagelser.

• censusMemberIds: Listen over GroupCensusMemberIds af gemte medlemmer.

• fejl: Listen over medlemmer med fejl. Hvert listeelement består af inputmedlemsdata og fejl.

• ​ ​ ​ relatedFieldsUpdateSuccessCount: Antal primære medlemmer, som DependentCount opdateres efter service for.

• ​ ​ ​ relatedFieldsUpdateErrorCount: Antal primære medlemmer, som DependentCount-opdateringen returnerer fejl for.

• relatedFieldsUpdateErrors: Listen over fejl, der blev returneret under opdatering af DependentCount af primære medlemmer.

{
  "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"
}

Eksempel på output-JSON - (updateMembers By 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"
}