InsCensusServiceStd:updateMembers

Você está aqui:

InsCensusServiceStd:updateMembers

Use esse serviço para atualizar os valores de membros existentes em um censo.

Classe: InsCensusServiceStd

Método: updateMembers

Como funciona

Esse serviço pega os membros de um JSON de entrada e atualiza o censo (de acordo com a censusId dada) com os novos dados.
censo JSON consiste em duas listas - headers e members.
1. headers é a lista de metadados de campos que consiste em fieldId, type, label e name. Aqui, o nome é o Nome da API do campo (com o namespace para pacote gerenciado e campos personalizados).
2. members é a lista de membros a ser atualizada no censo.
O serviço procura pelo campo updateById. É um campo booleano que decide o curso de ação para o serviço. Os membros podem ser atualizados destas duas maneiras:
1. updateMembers por MemberKey
  
  Essa opção é aplicável quando a updateById é falsa. Os dados do membro devem ter uma chave de membro.
2. updateMembers por ID de GroupCensusMember
  
  Essa opção é aplicável quando updateById for verdadeiro. Os dados dos membros devem ter um ID de membro do censo do grupo.

updateMembers por MemberKey

O serviço analisa os dados dos membros com os campos fornecidos em headers. Os headers devem conter todos os metadados dos campos usados na lista de membros.
O serviço separa membros principais e dependentes com base na RelationshipToPrimaryMember.
1. Se a lista de membros contiver membros principais e dependentes, a entrada deverá ter SourceSystemIdentifier para todos os membros. Todos os membros devem ter uma SourceSystemIdentifier única. Além disso, todos os dependentes devem ter PrimaryMemberSource ou PrimaryGroupCensusMemberId (se o membro principal já estiver presente no censo).
2. Se a lista for uma combinação de membros principais e dependentes, garanta que todos os membros dependentes e membros principais existam na lista de membros.
O serviço processa novas GroupClass. Se o serviço tiver GroupClass.Name em vez de GroupClassId, ele buscará GroupClass com o nome e criará um novo GroupClass com o mesmo nome se não for encontrado.
1. Se o serviço tiver GroupClass.Name, inclua também AccountId nos dados dos membros.
2. header paraGroupClass.Name: {"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.
3. Se a GroupClass.Name fornecida for inválida, será retornado um erro. O serviço usa um novo parâmetro quoteEffectiveDate para validar GroupClass. A GroupClass é considerada válida se:
  - O GroupClass está vinculado à conta do grupo do membro.
  - quoteEffectiveDate está entre GroupClass StartDate e EndDate. Se quoteEffectiveDate não for fornecido como um parâmetro para o serviço, essa validação será ignorada.
Os serviços processam PrimaryMemberSource para dependentes com PrimaryGroupCensusMemberId.
1. Se o serviço tiver tanto PrimaryMemberSource quanto PrimaryGroupCensusMemberId, o serviço considerará PrimaryGroupCensusMemberId como fonte e atualizará PrimaryMemberSource de dependente para conter SourceSystemIdentifier de principal.
O serviço salva todos os membros principais primeiro.
Ele analisa dependentes para identificar dependentes órfãos (Dependentes sem PrimaryMemberSource).
Ele salva todos os dependentes válidos.
O serviço atualiza as DependentCount de todos os membros principais na lista de membros.

updateMembers por ID

O serviço analisa os dados dos membros com os campos fornecidos em headers. Os headers devem conter todos os metadados dos campos usados na lista de membros.
Os dados de members devem ter ID. Se o ID não for encontrado nos dados do membro, o serviço gerará um erro.
O serviço processa novas GroupClass. Se o serviço tiver GroupClass.Name em vez de GroupClassId, ele buscará GroupClass com o nome e criará um novo GroupClass com o mesmo nome se não for encontrado.
1. Se o serviço tiver GroupClass.Name, inclua também AccountId nos dados dos membros.
2. header paraGroupClass.Name: {"type":"STRING","label":"Group Class Name","fieldId":"","name":"GroupClass.Name"}.
O serviço processa PrimaryGroupCensusMemberId para dependentes com PrimaryMemberSource.
1. Se você fornecer PrimaryMemberSource, o serviço também atualizará o PrimaryGroupCensusMemberId.
Os serviços processam PrimaryMemberSource para dependentes com PrimaryGroupCensusMemberId.
1. Se o serviço tiver tanto PrimaryMemberSource quanto PrimaryGroupCensusMemberId, o serviço considerará PrimaryGroupCensusMemberId como fonte e atualizará PrimaryMemberSource de dependente para conter SourceSystemIdentifier de principal.
O serviço salva todos os membros, incluindo dependentes.
O serviço não identifica dependentes órfãos.
O serviço atualiza as DependentCount de todos os membros principais na lista de membros.

Opções remotas

Opção	Descrição
`censusId`	Obrigatório. ID do censo com membros para atualizar.
`census`	Obrigatório. JSON de entrada com detalhes para membros a serem atualizados.
`updateById`	Opcional Se definido como verdadeiro, o serviço seguirá o fluxo `updateMembers` por ID. O valor padrão é falso.

Opção

Descrição

censusId

Obrigatório.

ID do censo com membros para atualizar.

census

Obrigatório.

JSON de entrada com detalhes para membros a serem atualizados.

updateById

Opcional

Se definido como verdadeiro, o serviço seguirá o fluxo updateMembers por ID.

O valor padrão é falso.

Comportamento do serviço

Entenda como diferentes entradas afetam as saídas de serviço.

Entrada	updateById	Saída de serviço
Não `censusId`	true ou false	O serviço retorna um erro: `Specify a censusId.`
Sem entrada de censo JSON	true ou false	O serviço retorna um erro: `The census input is missing.`
O valor dos `PrimaryMemberSource` fornecidos ao membro principal	false	O serviço retorna um erro: `The PrimaryMemberSource must be null for primary members.`
`headers` está ausente no censo de entrada	true ou false	O serviço retorna um erro: `The header node is missing in the census input.`
`members` está ausente no censo de entrada	true ou false	O serviço retorna um erro: `The members node is missing in the census input.`
Para dependentes órfãos (Os dependentes sem PrimaryMemberSource ou PrimaryGroupCensusMemberId)	false	O serviço retorna um erro: `Dependent has no primary member.`
O ID está ausente nos dados dos membros	verdadeiro	O serviço retorna um erro: `Specify Id of the census member.`

JSON de entrada

O JSON de entrada inclui headers, que lista os campos a serem atualizados; e members, que lista os membros com seus pares de valor de campo correspondentes, incluindo fieldId.

JSON de entrada de amostra (updateMembers por 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"
      }
    ]
  }
}

JSON de entrada de amostra (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"
      }
    ]
  }
}

JSON de saída

O serviço retornará uma mensagem de sucesso se o fluxo for concluído, caso contrário, retornará o erro em caso de exceções.

censusMemberIds: A lista de GroupCensusMemberIds de membros salvos.
erros: A lista de membros com erros. Cada item de lista consiste em dados de membro de entrada e erro.
relatedFieldsUpdateSuccessCount: Número de membros principais para os quais o DependentCount é atualizado por serviço.
relatedFieldsUpdateErrorCount: Número de membros primários para os quais a atualização de DependentCount retorna erros.
relatedFieldsUpdateErrors: A lista de erros retornados ao atualizar os DependentCount dos membros principais.

JSON de saída de amostra (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"
}

JSON de saída de amostra - (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"
}

Este artigo resolveu seu problema?

Diga-nos para podermos melhorar!

Este texto foi traduzido pelo sistema de tradução automática da Salesforce. Mais detalhes aqui.

InsCensusServiceStd:updateMembers

Como funciona

updateMembers por MemberKey

updateMembers por ID

Opções remotas

Comportamento do serviço

JSON de entrada

JSON de saída

General Information

Required Cookies

Functional Cookies

Advertising Cookies

General Information

Required Cookies

Functional Cookies

Advertising Cookies

Cookie List

Este texto foi traduzido pelo sistema de tradução automática da Salesforce. Mais detalhes aqui.Alternar para inglêsAgora não

Área de produtos

Impacto do recurso

Edição

Experiência

InsCensusServiceStd:updateMembers

Como funciona

updateMembers por MemberKey

updateMembers por ID

Opções remotas

Comportamento do serviço

JSON de entrada

JSON de saída

Este texto foi traduzido pelo sistema de tradução automática da Salesforce. Mais detalhes aqui.