InsCensusServiceStd:getFields

Fonctionnement

1. Le service récupère la liste des champs de GroupCensusMember qui font partie du jeu de champs transmis dans le fieldsetName du paramètre d'entrée.

2. Si le paramètre withPlans est true, le service récupère également la liste des champs de GroupCensusMemberPlan​​.

3. La liste des définitions de champ (types de données de champ, étiquettes de champ, noms d'API de champ et en-têtes .csv de champ) est combinée pour former le headers .

   • Si ​​GroupClassId est inclus dans la liste des champs récupérés, le service ajoute un nœud sous les en-têtes - GroupClassId.Name​.

4. La liste des noms d'API de champ est combinée pour former le nœud JSON.

   • Si GroupClassId est inclus dans la liste des champs récupérés, le service ajoute un nœud sous les champs - GroupClassId.Name .

Options distantes

JSON d'entrée

{
    "fieldsetName": "memberFields",
    "withPlans": true,
    "planFieldsetName": "planFields"
}

JSON de sortie

Le service renvoie la liste de tous les noms d'API de champ qui font partie de l'ensemble de champs myFieldsetName dans l'objet GroupCensusMember. Si le paramètre withPlans est true, la sortie inclut également les noms d'API de champ qui font partie de la myPlanFieldsetName d'ensemble de champs dans l'objet GroupCensusMemberPlan.

Les en-têtes contiennent une liste de noms d'API de champ, d'étiquettes de champ, de type de données de champ et d'en-tête CSV de champ pour tous les champs récupérés par le service.

Le service renvoie un JSON de sortie formaté comme dans cet exemple :

{
  "fields": [
    "vlocityins__AttributeSelectedValues__c",
    "AccountId",
    "Gender",
    "ContractGroupPlanId",
  ],
  "headers": [
    {
      "fieldId": "",
      "type": "StringPlusClob",
      "label": "Attribute Selected Values",
      "name": "vlocityins__AttributeSelectedValues__c"
    },
    {
      "fieldId": "",
      "type": "EntityId",
      "label": "Account ID",
      "name": "AccountId"
    },
    {
      "fieldId": "",
      "type": "DynamicEnum",
      "label": "Gender",
	  "name": "Gender"
      "options": [
        {
          "label": "Male",
          "name": "Male"
        },
        {
          "label": "Female",
          "name": "Female"
        }
      ],
    },
    {
      "fieldId": "",
      "type": "EntityId",
      "label": "Contract Group Plan ID",
      "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"
				}
			  ]
           }
      ]
    }
  ]
}