Get Group Census Members and Plans Action

The action processes bulk member data that are uploaded through census management workflows. This action validates the data, identifies duplicates, and returns structured member records for further processing. This action returns all transformed records, along with detailed error information for any records that fail validation.

This action is available in API version 65.0 and later.

Supported REST HTTP Methods

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

Where XX.X is the latest API version.

Formats: JSON

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access token.

Inputs

Input	Type	Description
asyncBulkRequestItem	sobject	Required. Asynchronous bulk request item record that contains the metadata about the CSV upload. This property must have the `AdditionalInformation` field with serialized JSON that contains these details. `contentDocumentId`—ID of content document `contentDocumentVersion`—Version of content document `csvColumnMapping`—Map of CSV column to field name `duplicateDetectionFields`—List of fields for duplicate detection `groupCensusId`—Parent Group Census ID `csvHeader`—CSV header row `startRowNumber`—Starting row to process `endRowNumber`—Ending row to process `duplicateRowNumbersList`—Pre-identified duplicate rows

Outputs

Output	Type	Description
`duplicateDetectionKeysList`	string	Comma-separated list of group census member fields that can be used to identify unique group census member records. This property is returned if duplicate detection fields are configured in the request.
`errorsData`	Apex-defined	Error records that occurred during the retrieval of group census member and plan records.
`groupCensusId`	string	Salesforce ID of the GroupCensus record which these members belong to. This property is used to associate members with their parent census.
`groupCensusMembers`	sobject	Collection of transformed GroupCensusMember SObject records that are parsed from the CSV file. Each record includes field values that are mapped from the corresponding CSV columns. Records with errors include an error field containing the error message. The maximum limit size is 2000.
`groupCensusMemberPlans`	sobject	Collection of plan records for group census members.
`shouldExecuteConfigurationRule`	boolean	Indicates whether the product configuration rules must be executed for member plans in the enrollment census ( `true` ) or not ( `false` ).

Example

Sample Request

{
  "AdditionalInformation": {
    "employeeBulkRequestInfo": {
      "groupCensusId": "0rfSG0000000vclYAA",
      "contentDocumentName": "Archit50Records With groupClass - Archit50Records With groupClass (1)",
      "contentDocumentId": "069SG000004lwPdYAI",
      "contentDocumentVersion": "068SG000004PIp3YAG",
      "duplicateDetectionFields": [
        "Gender",
        "FirstName",
        "Lastname",
        "AssociationWithPrimaryMbr",
        "GroupCensusId"
      ],
      "batchSize": null,
      "csvColumnMapping": {
        "First Name": "FirstName",
        "Last Name": "Lastname",
        "Gender": "Gender",
        "Birthdate": "Birthdate",
        "SmokerStatus": "SmokerStatus",
        "Relationship": "AssociationWithPrimaryMbr",
        "Group Class": "GroupClassName"
      },
      "executeRules": false
    },
    "startRowNumber": 1,
    "endRowNumber": 27,
    "startByteOffset": 83,
    "endByteOffset": 1717,
    "csvHeader": "First Name,Last Name,Gender,Birthdate,Relationship,SmokerStatus,Group Class,Errors",
    "duplicateRowNumbersList": [],
    "shouldExecuteConfigurationRule": false
  },
  "Id": "18cSG0000003DgfYAE"
}

Sample Response

[
  {
    "actionName": "getGroupCensusMembersAndPlans",
    "errors": null,
    "isSuccess": true,
    "outputValues": [
      {
        "GroupClassName": "Test_MGR",
        "AssociationWithPrimaryMbr": "Self",
        "FirstName": "Employee1",
        "Lastname": "Salesforce1",
        "Gender": "Male",
        "Birthdate": "1987-12-04",
        "SmokerStatus": "Tobacco"
      },
      {
        "AssociationWithPrimaryMbr": "Spouse",
        "FirstName": "Employee2",
        "Lastname": "Salesforce2",
        "Gender": "Female",
        "Birthdate": "1982-11-30",
        "SmokerStatus": "Tobacco"
      },
      {
        "AssociationWithPrimaryMbr": "Child",
        "FirstName": "Employee3",
        "Lastname": "Salesforce3",
        "Gender": "Male",
        "Birthdate": "1988-11-18",
        "SmokerStatus": "NonTobacco"
      }
    ]
  }
]