Loading
Insurance
InsCensusServiceStd:getMembersWithPlans

Vous êtes ici :

  1. Aide de Salesforce
  2. Documents
  3. Assurance numérique

InsCensusServiceStd:getMembersWithPlans

Utilisez ce service pour récupérer la liste des membres du recensement pour une censusId donnée. Correspondant à ces membres du recensement, le service récupère les ContractGroupPlanIds de GroupCensusMemberPlan. Le service récupère également les en-têtes en fonction des fieldsetName et des planFieldsetName.

Classe: InsCensusServiceStd​​

Méthode : getMembersWithPlans

Fonctionnement

Ce service a deux fonctions clés :

  1. Récupère la liste des champs dans GroupCensusMember et GroupCensusMemberPlan .

    • Le service utilise le paramètre ​fieldsetName pour récupérer la liste des champs de GroupCensusMember​​. En l'absence de valeur, les champs sont récupérés à partir de l'ensemble de champs par défaut. Si la valeur saisie ne trouve pas de correspondance, aucun champ n'est récupéré.

    • Le service utilise le paramètre planFieldsetName​ pour récupérer la liste des champs de GroupCensusMemberPlan. En l'absence de valeur, tous les champs sont récupérés. Si la valeur saisie ne trouve pas de correspondance, aucun champ n'est récupéré.

    • Récupère les champs de relation combinés pour former le nœud d'en-têtes JSON, même si ces champs ne sont pas inclus dans le fieldsetName. Les champs suivants sont : PrimaryGroupCensusMemberId, RelationshipToPrimaryMember, SourceSystemIdentifier et PrimaryMemberSource.

    • Si le paramètre contractGroupPlanId a une valeur, il remplit la liste des enregistrements de ligne de contrat avec les détails suivants du contrat :

      • Nom du plan de groupe de contrats

      • Type de produit

      • ID des plans de groupe de contrats

  2. Le service utilise censusId pour récupérer la liste des membres du recensement à partir des enregistrements GroupCensusMember et des plans de groupe de contrats à partir des GroupCensusMemberPlan de chaque membre.

    • Si le décalage a une valeur, il récupère les lignes de GroupCensusMember principal (organisées par ID) après le décalage, puis récupère toutes les personnes dépendantes de ces Membres principaux.

    • Si une valeur limite existe, le service récupère les lignes de GroupCensusMember principal (organisées par ID) qui ne dépassent pas la limite spécifiée. Il récupère ensuite toutes les personnes dépendantes de ces Membres principaux. La limite ne peut pas dépasser 500.

    • Si searchKey a une valeur, le service récupère les lignes de GroupCensusMember (organisées par ID) avec la famille correspondante, qui contient searchKey en tant que sous-chaîne présente dans leur FirstName ou LastName. Si GroupCensusMember contient des personnes dépendantes, le service récupère les membres principaux correspondant à ces personnes dépendantes.

    • Si memberIds a une valeur, il récupère les lignes de GroupCensusMember (organisées par ID) dont l'ID fait partie du tableau memberIds. memberIds ou searchKey doit être fourni dans l'entrée.

    • Les informations récupérées pour chaque membre sont basées sur les champs récupérés dans GroupCensusMember et GroupCensusMemberPlan.

    • La liste des membres est placée dans le nœud members.

Comportement de service

Comprenez comment les différentes entrées affectent les sorties de service.

Entrée Sortie de service

Aucun censusId ou censusId non valide

Le service ne récupère aucun membre du recensement.
censusId non fieldsetName et valide

Le service récupère :

  • En cas de présence de StandardFieldset, le service récupère la liste des champs de GroupCensusMember présents dans le jeu de champs standard et la liste des GroupCensusMember avec ContractGroupPlanIds.

  • Si le jeu de champs standard n'est pas présent, le service prend la liste des champs de GroupCensusMember présents dans le jeu de champs Tableau modifiable et récupère la liste des GroupCensusMember avec ContractGroupPlanIds.

  • Si StandardFieldset et Modifiable Table Fieldset ne sont pas présents, le service renvoie une erreur.
fieldsetName valides et censusId valides Le service répertorie les champs de GroupCensusMember selon le fieldsetName spécifié et récupère la liste des GroupCensusMember avec ContractGroupPlanIds.
Aucune fieldsetName planFieldsetName valide et censusId valide Le service répertorie les champs de GroupCensusMember selon les champs fieldsetName, ContractGroupPlanId et Nom spécifiés dans GroupCensusMemberPlan. Il récupère la liste des GroupCensusMember avec ContractGroupPlanIds.
Valide planFieldsetName valide fieldsetName et valide censusId

Le service récupère :

  • GroupCensusMember les champs selon le fieldsetName spécifié.

  • GroupCensusMemberPlan les champs selon la planFieldsetName spécifiée.

  • Liste de GroupCensusMember avec ContractGroupPlanIds.
contractId valide Le service récupère le nom du plan de groupe de contrats, le type de produit, les produits enfants et l'ID de plan de groupe de contrats sous forme d'options dans le champ d'en-tête du ContractGroupPlanId.
limit valide

Le service récupère :

  • GroupCensusMember fields conformément au fieldsetName spécifié.

  • GroupCensusMemberPlan les champs selon la planFieldsetName spécifiée.

  • Liste de GroupCensusMember avec ContractGroupPlanIds

  • Le nombre de GroupCensusMember principales récupérées est inférieur ou égal à la limite.

  • Les personnes dépendantes associées au GroupCensusMember principal dans la liste.
offset valide

Le service récupère :

  • GroupCensusMember les champs selon la fieldsetName spécifiée.

  • GroupCensusMemberPlan les champs selon la planFieldsetName spécifiée.

  • Liste de GroupCensusMember avec ContractGroupPlanIds

  • L'ID de chaque GroupCensusMember principal récupéré est supérieur à offset.

  • Les personnes dépendantes associées au GroupCensusMember principal dans la liste.
limit valide offset et valide

Le service récupère :

  • GroupCensusMember les champs selon la fieldsetName spécifiée.

  • GroupCensusMemberPlan les champs selon la planFieldsetName spécifiée.

  • Liste de GroupCensusMember avec ContractGroupPlanIds

  • Le nombre de GroupCensusMember principales récupérées est inférieur ou égal à la limite.

  • Les personnes dépendantes associées au GroupCensusMember principal dans la liste.

  • L'ID de chaque GroupCensusMember principal récupéré est supérieur à offset.
searchKey valide

Le service récupère :

  • GroupCensusMember les champs selon le fieldsetName spécifié.

  • Champs de GroupCensusMemberPlan selon la planFieldsetName spécifiée

  • Liste de GroupCensusMember avec ContractGroupPlanIds

  • Si la liste contient des personnes dépendantes, le service récupère les membres principaux correspondant à ces personnes dépendantes.

  • Tous les membres contiennent une searchKey en tant que sous-chaîne dans leur FirstName ou LastName.
searchKey valides et limit valides

Le service récupère :

  • GroupCensusMember les champs selon le fieldsetName spécifié.

  • GroupCensusMemberPlan les champs selon la planFieldsetName spécifiée.

  • Liste de GroupCensusMember avec ContractGroupPlanIds

  • Si la liste contient des personnes dépendantes, le service récupère les membres principaux correspondant à ces personnes dépendantes.

  • Tous les membres contiennent une searchKey en tant que sous-chaîne dans leur FirstName ou LastName.

  • Le nombre de GroupCensusMember récupérés est inférieur ou égal à la limite spécifiée.

searchKey valides et offset valides

Le service récupère :

  • GroupCensusMember les champs selon la fieldsetName spécifiée.

  • GroupCensusMemberPlan les champs selon la planFieldsetName spécifiée.

  • Liste de GroupCensusMember avec ContractGroupPlanIds

  • Si la liste contient des personnes dépendantes, le service récupère les membres principaux correspondant à ces personnes dépendantes.

  • Tous les membres contiennent une searchKey en tant que sous-chaîne dans leur FirstName ou LastName.

  • L'ID de chaque GroupCensusMember récupéré est supérieur à offset.
searchKey valide, limit valide et offset valide

Le service récupère :

  • GroupCensusMember les champs selon la fieldsetName spécifiée.

  • GroupCensusMemberPlan les champs selon la planFieldsetName spécifiée.

  • Liste de GroupCensusMember avec ContractGroupPlanIds

  • Si la liste contient des personnes dépendantes, le service récupère les membres principaux correspondant à ces personnes dépendantes.

  • Tous les membres contiennent une searchKey en tant que sous-chaîne dans leur FirstName ou LastName.

  • Le nombre de GroupCensusMember récupérés est inférieur ou égal à la limite spécifiée.

  • L'ID de chaque GroupCensusMember récupéré est supérieur à offset.

Options distantes

Options​ ​Description​

​​​censusId​​​

Requis.

ID de recensement dont les membres doivent être récupérés.

​​​contractId

Obligatoire .

ID du contrat actuel du compte.

Récupère le nom du plan de groupe de contrats, le type de produit et le groupe de contrats

​​​

fieldsetName​​​

Facultatif.

Nom de l'ensemble de champs pour récupérer les champs GroupCensusMember.

Si la valeur n'est pas valide, le service ne renvoie aucun champ.

En l'absence de valeur, le service utilise l'ensemble de champs par défaut pour récupérer les champs GroupCensusMember.

​​​planFieldsetName​​​

Facultatif.

Récupère les champs GroupCensusMemberPlan et GroupCensusMember lorsqu'il existe une valeur d'ensemble de champs de plan valide.

Aucun champ n'est renvoyé si la valeur n'est pas valide.

Tous les champs GroupCensusMemberPlan sont renvoyés quand il n'y a aucune valeur.

​limit​

Optional.​

Le nombre de membres du recensement à récupérer.

​​​offset​​​

Facultatif .

L'ID du membre du recensement après lequel les membres du recensement doivent être récupérés.

​searchKey​

Une chaîne de recherche d'enregistrements de membre du recensement correspondants.

JSON d'entrée

Ce service ne prend pas de JSON d'entrée.

JSON de sortie

Le service renvoie un JSON de sortie formaté comme dans l'exemple ci-dessous. La sortie contient les détails des membres du recensement, où les en-têtes sont une liste de noms d'API de champ de GroupCensusMember et de GroupCensusMemberPlan. Le nœud members renvoie la liste des plans sélectionnés pour le membre avec ContractGroupPlanId délimité par ;. Le champ lastOffset affiche l'ID du dernier membre du recensement récupéré. Cette valeur peut être utilisée comme paramètre de décalage pour récupérer les lignes suivantes.

Voici l'exemple de format JSON de sortie :

{ 
   "census":{ 
      "members":[ 
         { 
            "ContractGroupPlanId":"ID1;ID2",
            "Id":"ID",
            "fieldAPI1":"value"
         }
      ],
      "headers":[ 
         { 
            "type":"field type",
            "label":"field label",
            "fieldId":"",
            "name":"fieldAPI1"
         },
         { 
            "options":[ 
               { 
                  "value":"ID",
                  "type":"Product Type",
                  "name":"Contract Group Plan Name"
               }
            ],
            "type":"REFERENCE",
            "label":"Plan",
            "fieldId":"",
            "name":"ContractGroupPlanId"
         }
      ]
   },
   "lastOffset" : "census member Id"
}

Voici l'exemple de JSON de sortie :


{ 
   "census":{ 
      "members":[ 
         { 
            "ContractGroupPlanId":"",
            "Id":"a4C4P000000dNdbUAE",
            "LastName":member1,
            "FirstName":primary,
            "Birthdate":"1999-08-08"
         },
         { 
            "ContractGroupPlanId":"a2N4P000006ygEjUAI",
            "Id":"a4C4P000000dNdcUAE",
            "LastName":member1,
            "FirstName":dependent,
            "Birthdate":"1994-08-08"
         },
         { 
            "ContractGroupPlanId":"a2N4P000006ygEjUAI;a2N4P000006ygEiUAI",
            "Id":"a4C4P000000dNdeUAE",
            "LastName":member2,
            "FirstName":primary,
            "Birthdate":"1985-08-08"
         }
      ],
      "headers":[ 
         { 
            "type":"STRING",
            "label":"First Name",
            "fieldId":"",
            "name":"FirstName"
         },
         { 
            "type":"DATE",
            "label":"Birthday",
            "fieldId":"",
            "name":"Birthdate"
         },
         { 
            "type":"STRING",
            "label":"Last Name",
            "fieldId":"",
            "name":"LastName"
         },
         { 
            "type":"REFERENCE",
            "label":"Plan",
            "fieldId":"",
            "name":"ContractGroupPlanId",
             "options":[
               {
                    "value":"a2N4P000006ygEiUAI",
                    "type":"Medical",
                    "name":"rootProd",
                    "childProducts": [
                        {
                            "value": "0rgDC000000000RYAQ",
                            "IsOptional": false,
                            "name": "MandatoryCoverage"
                        },
                        {  
                            "value": "0rgDC000000000RYBQ",
                            "IsOptional": true,
                            "name": "OptionalCoverage"
                        }
                    ]
                },
                {
                    "value":"a2N4P000006ygEjUAI",
                    "type":"Dental",
                    "name":"rootProd2",
                    "childProducts": [
                        {
                            "value": "0rgDC000000000RYCQ",
                            "IsOptional": false,
                            "name": "MandatoryCoverage"
                        },
                        {
                            "value": "0rgDC000000000RYDQ",
                            "IsOptional": true,
                            "name": "OptionalCoverage"
                        }
                    ]
                }
            ]
         }
      ]
   },
   "lastOffset" : "a4C4P000000dNdeUAE"
}
 
Chargement
Salesforce Help | Article