Name | Description | Type | Additional information |
---|---|---|---|
Id |
The primary key of the record in the Hobsons database. Ignored for POST requests sent to the API. |
integer |
None. |
InteractionId |
A reference to the primary key of the Interaction record that is the parent of this record. |
integer |
Required Range: inclusive between 1 and 99999999 |
OrderNumber |
The order number among the collection of InteractionCourse records for the same parent Interaction record. During POST requests sent to the API, InteractionCourse records must be created in sequential order of OrderNumber (starting from 1). Hence gaps and duplicates between OrderNumber values, for the same parent Interaction record, are not allowed. I.e. among the collection of InteractionCourse records for the same parent Interaction record, the first created record must have an OrderNumber value set to 1, the second created record must have an OrderNumber value set to 2 and so on. |
integer |
Required Range: inclusive between 1 and 9999 |
StudyLevelId |
A reference to the primary key of the StudyLevel record that is associated with this record. During POST requests sent to the API, this value is ignored if CourseId is specified and value will be derived from the StudyLevelId field of the matched CourseId record. |
integer |
Range: inclusive between 1 and 99999999 |
StudyLevelName |
The name of the StudyLevel record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
FacultyId |
A reference to the primary key of the Faculty record that is associated with this record. During POST requests sent to the API, this value is ignored if CourseId is specified and value will be derived from the FacultyId field of the matched CourseId record. |
integer |
Range: inclusive between 1 and 99999999 |
FacultyName |
The name of the Faculty record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
CourseId |
A reference to the primary key of the Course record that is associated with this record. During POST requests sent to the API, at least one of the following values must be specified: CourseId, StudyLevelId, FacultyId, DepartmentId, CampusId, StudyAreaId |
integer |
Range: inclusive between 1 and 99999999 |
CourseName |
The name of the Course record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
DepartmentId |
A reference to the primary key of the Department record that is associated with this record. During POST requests sent to the API, this value is ignored if CourseId is specified and value will be derived from the DepartmentId field of the matched CourseId record. |
integer |
Range: inclusive between 1 and 99999999 |
DepartmentName |
The name of the Department record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
CampusId |
A reference to the primary key of the Campus record that is associated with this record. |
integer |
Range: inclusive between 1 and 99999999 |
CampusName |
The name of the Campus record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
StudyAreaId |
A reference to the primary key of the StudyArea record that is associated with this record. During POST requests sent to the API, if CourseId is specified then the StudyArea record must be available for the Course record matching the specified CourseId. |
integer |
Range: inclusive between 1 and 99999999 |
StudyAreaName |
The name of the StudyArea record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |