InsCensusService:getFields

Class: InsCensusService

Method: getFields

How It Works

• The service retrieves the list of GroupCensusMember__c fields.

• If the withPlans parameter is set to true, the service also retrieves the list of GroupCensusMemberPlan__c fields.

• The list of fields definitions are combined to form the headers JSON node.

  • If GroupClassId __c is included in the list of fields retrieved, an additional node is added under the headers - GroupClassId__r.Name.

• The list of field API names are combined to form the fields JSON node.

  • If GroupClassId __c is included in the list of fields retrieved, an additional node is added under the fields - GroupClassId__r.Name.

Remote Options

Input JSON

This service does not take an input JSON.

Output JSON

The service returns an output JSON formatted as per the example below:

{
  "fields": [
    "Name",
    "vlocity_ins__Birthdate__c",
    "vlocity_ins__FirstName__c",
    "vlocity_ins__Gender__c",
    "vlocity_ins__LastName__c",
    "vlocity_ins__RelatedCensusMemberId__c",
    "vlocity_ins__IsPrimaryMember__c",
    "vlocity_ins__IsSpouse__c",
    "vlocity_ins__MemberIdentifier__c",
    "vlocity_ins__PrimaryMemberIdentifier__c"
  ],
  "headers": [
    {
      "type": "STRING",
      "label": "Name",
      "fieldId": "",
      "name": "Name"
    },
    {
      "type": "DATE",
      "label": "Birthdate",
      "fieldId": "",
      "name": "vlocity_ins__Birthdate__c"
    },
    {
      "type": "STRING",
      "label": "First Name",
      "fieldId": "",
      "name": "vlocity_ins__FirstName__c"
    },
    {
      "options": [
        {
          "value": "Male",
          "label": "Male"
        },
        {
          "value": "Female",
          "label": "Female"
        }
      ],
      "type": "PICKLIST",
      "label": "Gender",
      "fieldId": "",
      "name": "vlocity_ins__Gender__c"
    },
    {
      "type": "STRING",
      "label": "Last Name",
      "fieldId": "",
      "name": "vlocity_ins__LastName__c"
    },
    {
      "type": "REFERENCE",
      "label": "Primary Census Member",
      "fieldId": "",
      "name": "vlocity_ins__RelatedCensusMemberId__c"
    },
    {
      "type": "BOOLEAN",
      "label": "Primary",
      "fieldId": "",
      "name": "vlocity_ins__IsPrimaryMember__c"
    },
    {
      "type": "BOOLEAN",
      "label": "Is Spouse",
      "fieldId": "",
      "name": "vlocity_ins__IsSpouse__c"
    },
    {
      "type": "STRING",
      "label": "Member Identifier",
      "fieldId": "",
      "name": "vlocity_ins__MemberIdentifier__c"
    },
    {
      "type": "STRING",
      "label": "Primary Member Identifier",
      "fieldId": "",
      "name": "vlocity_ins__PrimaryMemberIdentifier__c"
    }
  ]
}