Validate Group Census Members Action

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

This action is available in API version 65.0 and later.

Supported REST HTTP Methods 

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

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 

InputTypeDescription
duplicateDetectionKeysListstringComma-separated list of field names that are used to identify the unique group census member records. For example, FirstName , LastName , GroupCensusId , and AssociationWithPrimaryMbr .
groupCensusIdstringID of the parent group census record that’s associated with the group census member records.
groupCensusMemberssobjectCollection of group census member records that must be validated. Maximum list size is 2000.

Outputs 

OutputTypeDescription
errorsDataApex-definedDetails of the validation errors that occurred while validating the group census member records. Maximum limit is 2000.
validatedGroupCensusMemberssobjectCollection of group census member records that are validated and assigned with default values. Records with validation errors aren’t shown. Maximum limit is 2000.

Example 

Sample Request

1{
2  "inputs": [
3    {
4      "groupCensusId": "0rfDR0000000Cn6YAE",
5      "groupCensusMembers": [
6        {
7          "Name": "RossFarley",
8          "FirstName": "Ross",
9          "Lastname": "Farley",
10          "Gender": "Male",
11          "GroupClassName": "Manager",
12          "Email": "ross.farley_0001@insgroup.co.in",
13          "AssociationWithPrimaryMbr": "Self"
14        },
15        {
16          "Name": "Fakeem Huber",
17          "FirstName": "Fakeem",
18          "Lastname": "Huber",
19          "Gender": "Male",
20          "GroupClassName": "Associate",
21          "Email": "fakeem.huber_0432@insgroup.co.in",
22          "AssociationWithPrimaryMbr": "Self"
23        }
24      ]
25    }
26  ]
27}

Sample Response

1{
2  "validatedGroupCensusMembers": [
3    {
4      "attributes": {
5        "type": "GroupCensusMember"
6      },
7      "Email": "ross.farley_0001@insgroup.co.in",
8      "AssociationWithPrimaryMbr": "Self",
9      "FirstName": "Ross",
10      "MemberKey": "a66e329bd537b9b0be9d04f326eeed94",
11      "RelationshipToPrimaryMember": "Self",
12      "Lastname": "Farley",
13      "Gender": "Male",
14      "GroupClassId": "0rEDR000000085k2AA",
15      "GroupCensusId": "0rfDR0000000Cn6YAE",
16      "Name": "RossFarley"
17    },
18    {
19      "attributes": {
20        "type": "GroupCensusMember"
21      },
22      "Email": "fakeem.huber_0432@insgroup.co.in",
23      "AssociationWithPrimaryMbr": "Self",
24      "FirstName": "Fakeem",
25      "MemberKey": "fa26049af8a10b70bd68ce9a6912425f",
26      "RelationshipToPrimaryMember": "Self",
27      "Lastname": "Huber",
28      "Gender": "Male",
29      "GroupClassId": "0rEDR000000085p2AA",
30      "GroupCensusId": "0rfDR0000000Cn6YAE",
31      "Name": "Fakeem Huber"
32    }
33  ]
34}