InsEnrollmentService:findEnrollees

Classe :InsEnrollmentService

Méthode :findEnrollees

Fonctionnement

1. Le service reçoit le JSON analysé.

2. Si l'objet analysé a un paramètre searchKey, il récupère une liste de Contacts avec Prénom, Nom ou ID de membre qui commence par la searchKey donnée.

   • Par défaut, le service ne renvoie pas les contacts dont la stratégie a expiré.

   • Si l'objet analysé a un paramètre productType, la liste des Contacts récupérés est filtrée davantage par type de produit de stratégie.

   • Si l'objet analysé a un paramètre includeExpiredPolicies, les Contacts sont récupérés quelle que soit la date d'expiration de leur stratégie

3. Le service récupère une liste de stratégies et les mappe avec chaque contact récupéré, à condition que leur groupe corresponde à l'ID de compte donné.

   • Si l'entrée contient une effectiveDate, seules les polices avec la même date effective sont récupérées.

   • Si l'entrée contient un productType, seules les stratégies avec le même productType sont récupérées.

   • Si les ensembles d'entrées incluentExpiredPolicies sur true, même les stratégies expirées sont récupérées.

4. La liste des participants récupérée avec tous les détails de la stratégie attribuée est renvoyée dans le nœud de données.

Entrées

JSON d'entrée

Entrée JSON formatée comme suit :

{
  "searchKey": String,
  "productType": productType,
  "includeExpiredPolicies": Boolean
}

Exemple d'entrée JSON avec des données :

{
    "searchKey": "Adam",
    "productType": "Medical",
    "includeExpiredPolicies": true
}

JSON de sortie

La sortie JSON est une liste de participants, avec les propriétés suivantes sous le nœud fields :

{
  "data": {
    "records": [
      {
        "fields": {
          "Id": "0035w000039SsoSAAS",
		  "AccountId": "0015w00002ADHiPAAX",
          "LastName": "C2P1",
          "FirstName": "P1",
		  "Name": "C2P1 P1"
        }
      }
    ]
  }
}

Exemple de sortie JSON avec des données :

{
  "data": [
    {
      "AccountId": "0013h00000Gx5UqAAJ",
      "Id": "0033h00000BBybMAAT",
      "LastName": "C1P1",
      "FirstName": "D1",
      "Name": "D1 C1P1"
    },
    {
      "AccountId": "0013h00000Gx5UqAAJ",
      "Id": "0033h00000BBybPAAT",
      "LastName": "C1P2",
      "FirstName": "D1",
      "Name": "D1 C1P2"
    },
    {
      "AccountId": "0013h00000Gx5UrAAJ",
      "Id": "0033h00000BBybSAAT",
      "LastName": "C2P1",
      "FirstName": "D1",
      "Name": "D1 C2P1"
    }
  ],
  "error": "OK"
}