Loading
Insurance
Table of Contents
Filter by (0)Add
Select Filters

          No results
          No results
          Here are some search tips

          Check the spelling of your keywords.
          Use more general search terms.
          Select fewer filters to broaden your search.

            Search all of Salesforce Help
            Search all of Salesforce Help
            InsCensusService:getFields

            You are here:

            1. Salesforce Help
            2. Docs
            3. Digital Insurance

            InsCensusService:getFields

            Use this service to retrieve field definitions and field API names for group census members and group census plans. Guest user access is enabled for this service.

            Important
            Important From Winter '23 onward, we have InsCensusServiceStd:getFields service enabled to work with Salesforce Standard Data Model for Financial Services Cloud and Health Cloud. Existing customers can continue to use this service, but no further enhancements will be provided in the Insurance Managed Package.

            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

            Option

            Description

            fieldsetName

            Retrieves GroupCensusMember__c fields that are part of the field set for any valid values.

            No fields returned for values with no field sets.

            Default = EditableTable

            planFieldsetName

            Retrieves GroupCensusMemberPlan__c fields that are part of the field set for any valid values.

            • No fields returned for values with no field sets.

            • All GroupCensusMemberPlan__c fields returned if fields contain no values.

            withPlans

            Boolean

            If true, includes fields from GroupCensusMemberPlan__c.

            Default = false.

            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"
    }
  ]
}
             
            Loading
            Salesforce Help | Article