Retrieves a list of class enrollment custom fields

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

Retreives a list of all available custom fields for your organization.

Security
API Key
Header parameter nameapi_key
Responses
200

OK Response

Expand All
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).

Results
Array of object (ClassEnrollmentCustomFields)

This is the full list of class enrollment custom fields available to the requesting organization.

object
Id
integer (int32)

The custom field's unique identifier

Example10
Name
string

The name of the custom field

ExampleCustomClassEnrollmentFieldName1
Description
string | null

The description of the custom field

ExampleSample custom class enrollment field name 1
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
Example10
ListValues
Array of string

An array of type String representing the available selectable options in the case of Dropdown List and Checkbox List, for all other data types it will be an empty array ([])

Example[ "string 1", "string 2", "string 3" ]
string
SortOrder
integer (int32)

The order in which this field will appear in the JSON response.

Example2