Validate Group Census Members Plans Action

Validate the specified group census member plan records and assign default values to the specified fields.

This action is available in API version 66.0 and later.

Special Access Rules

To use this invocable action, you must have Digital Insurance Group Benefits Census Management user access and the org must be enabled with the Digital Insurance Group Benefits feature.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/validateGrpCensusMembersPlans

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

You must specify one of these input parameters for the validation process.

  • contextId
  • groupCensusMembers
  • memberPlansToDelete
  • memberPlansToValidate
Input Type Description
contextId string ID of the context definition that contains information about root plans and coverages that are configured for the current list of group census members.
groupCensusMembers sobject Group census member records that must be validated.
memberPlansToDelete sobject Group census member plan records that must be deleted.
memberPlansToValidate sobject Group census member plan records that must be validated.
shouldExecuteConfigurationRule boolean Indicates whether the product configuration rules must be executed for member plans in the enrollment census ( true ) or not ( false ).

Outputs

Output Type Description
errorsData Apex-defined Validation errors that occurred while validating the group census member and plans records.
validatedGroupCensusMemberPlans sobject Group census member plan records that are validated and assigned with default values.
validatedGroupCensusMembers sobject Group census member records that are validated and assigned with default values.

Example

POST

This sample request is for the Validate Group Census Members Plans action.

{
  "inputs": [
    {
      "groupCensusMembers": [
        {
          "Id": "a1b2c3d4e5f6g7h8",
          "MemberRefId": "M001",
          "FirstName": "John",
          "LastName": "Doe",
          "GroupCensus": "gc_12345"
        },
        {
          "Id": "b2c3d4e5f6g7h8i9",
          "MemberRefId": "M002",
          "FirstName": "Jane",
          "LastName": "Smith",
          "GroupCensus": "gc_12345"
        }
      ],
      "memberPlansToValidate": [
        {
          "ContractGroupPlan": "plan_medical_001",
          "GroupCensusMember": "a1b2c3d4e5f6g7h8",
          "MemberRefId": "M001"
        },
        {
          "ContractGroupPlan": "plan_dental_001",
          "GroupCensusMember": "a1b2c3d4e5f6g7h8",
          "MemberRefId": "M001"
        }
      ],
      "memberPlansToDelete": [
        {
          "ContractGroupPlan": "plan_old_001",
          "GroupCensusMember": "b2c3d4e5f6g7h8i9",
          "MemberRefId": "M002"
        }
      ],
      "contextId": "ctx_validation_12345",
      "shouldExecuteConfigurationRule": true
    }
  ]
}

This sample response is for the Validate Group Census Members Plans action.

{
  "outputs": [
    {
      "validatedGroupCensusMembers": [
        {
          "Id": "a1b2c3d4e5f6g7h8",
          "MemberRefId": "M001",
          "FirstName": "John",
          "LastName": "Doe",
          "Information": "Plans validated successfully",
          "CensusMgmtUploadMemError": null
        },
        {
          "Id": "b2c3d4e5f6g7h8i9",
          "MemberRefId": "M002",
          "FirstName": "Jane",
          "LastName": "Smith",
          "Information": "Plan deletion validated",
          "CensusMgmtUploadMemError": null
        }
      ],
      "validatedGroupCensusMemberPlans": [
        {
          "ContractGroupPlan": "plan_medical_001",
          "GroupCensusMember": "a1b2c3d4e5f6g7h8",
          "MemberRefId": "M001",
          "PlanType": "AUTO_ADDED"
        },
        {
          "ContractGroupPlan": "plan_dental_001",
          "GroupCensusMember": "a1b2c3d4e5f6g7h8",
          "MemberRefId": "M001",
          "PlanType": "AUTO_ADDED"
        },
        {
          "ContractGroupPlan": "plan_old_001",
          "GroupCensusMember": "b2c3d4e5f6g7h8i9",
          "MemberRefId": "M002",
          "CensusMgmtUploadMemError": "Plan successfully marked for deletion"
        }
      ],
      "errorsData": []
    }
  ]
}