Retrieves the custom field values for a specific class enrollment

  • Updated on Jul 16, 2024
  • 1 minute(s) read
Prev Next
Get
/GetClassEnrollmentCustomFieldValues

Retrieves the current values of a specific custom field for a class enrollment.

Security
API Key
Header parameter nameapi_key
Query parameters
customFieldId
stringRequired

The ID of the custom field.

classEnrollmentId
stringRequired

The ID of the class enrollment holding the custom field.

Responses
200

OK Response

object
Status
integer (int32)

Indicates the status of the API request.

0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example10
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

Id
integer (int32)

The custom field's unique identifier

Name
string

The name of the custom field

DataTypeId
integer (int32)

The data type id of the custom field
0 - Textbox
10 - Dropdown List
20 - Checkbox
30 - Number
60 - User Selector
70 - Checkbox List

TextValue
string | null

The text value of a custom field, if any.

NumericValue
integer (int32) | null

The integer value of a custom field, if any.

BooleanValue
boolean | null

The boolean value of a custom field, if any.

SeparatedListValue
string | null

A tab separated list of the selected values of a custom field.