GET api/interactions/{id}/interactioncourses?offset={offset}&limit={limit}&returnTotal={returnTotal}
Get all InteractionCourses that are related to the supplied Interaction id.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The primary key of the Interaction record. |
integer |
Required |
| offset |
The position in the collection of InteractionCourses from which to start returning data from. |
integer |
Default value is 0 |
| limit |
The maximum amount of InteractionCourses that can be returned in any one call. Maximum allowed is 250. |
integer |
Default value is 50 |
| returnTotal |
Whether to include the total amount of InteractionCourses in the database that match the filter specified. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
InteractionCourseDto| 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. |
Response Formats
application/json, text/json
{
"Id": 1,
"InteractionId": 2,
"OrderNumber": 3,
"StudyLevelId": 1,
"StudyLevelName": "sample string 4",
"FacultyId": 1,
"FacultyName": "sample string 5",
"CourseId": 1,
"CourseName": "sample string 6",
"DepartmentId": 1,
"DepartmentName": "sample string 7",
"CampusId": 1,
"CampusName": "sample string 8",
"StudyAreaId": 1,
"StudyAreaName": "sample string 9"
}