GET api/activitycourses?activityId={activityId}&dateCreatedFrom={dateCreatedFrom}&dateCreatedTo={dateCreatedTo}&offset={offset}&limit={limit}&returnTotal={returnTotal}
Get all ActivityCourses optionally filtered by any of the arguments specified in the query string.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| activityId |
Optional filter on ActivityCourses with a parent Activity Id that matches the provided value. |
integer |
None. |
| dateCreatedFrom |
Optional filter on ActivityCourses that were created on a date from the provided value. |
date |
None. |
| dateCreatedTo |
Optional filter on ActivityCourses that were created on a date up to (inclusive) the provided value. |
date |
None. |
| offset |
The position in the collection of ActivityCourses from which to start returning data from. |
integer |
Default value is 0 |
| limit |
The maximum amount of ActivityCourses that can be returned in any one call. Maximum allowed is 500. |
integer |
Default value is 100 |
| returnTotal |
Whether to include the total amount of ActivityCourses in the database that match the filter specified. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
ActivityCourseDto| 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. |
| ActivityId |
A reference to the primary key of the Activity record that is the parent of this record. |
integer |
Required Range: inclusive between 1 and 99999999 |
| DateCreated |
The date that the ActivityCourse record was created (in the Hobsons database). Ignored for POST requests sent to the API. |
date |
None. |
| PreferenceNumber |
The preference number among the collection of ActivityCourse records for the same parent Activity record. During POST requests sent to the API, ActivityCourse records must be created in sequential order of PreferenceNumber (starting from 1). Hence gaps and duplicates between PreferenceNumber values, for the same parent Activity record, are not allowed. I.e. among the collection of ActivityCourse records for the same parent Activity record, the first created record must have a PreferenceNumber value set to 1, the second created record must have a PreferenceNumber value set to 2 and so on. |
integer |
Required Range: inclusive between 1 and 99 |
| SubChannelId |
A reference to the primary key of the SubChannel record that is associated with this record. For POST requests sent to the API, the SubChannel record must belong to the parent Channel named 'External'. |
integer |
Required Range: inclusive between 1 and 99999999 |
| SubChannelName |
The name of the SubChannel record that is associated with this record. Ignored for POST requests sent to the API. |
string |
None. |
| 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,
"ActivityId": 2,
"DateCreated": "2024-05-20T07:56:56.1323401+10:00",
"PreferenceNumber": 3,
"SubChannelId": 4,
"SubChannelName": "sample string 5",
"StudyLevelId": 1,
"StudyLevelName": "sample string 6",
"FacultyId": 1,
"FacultyName": "sample string 7",
"CourseId": 1,
"CourseName": "sample string 8",
"DepartmentId": 1,
"DepartmentName": "sample string 9",
"CampusId": 1,
"CampusName": "sample string 10",
"StudyAreaId": 1,
"StudyAreaName": "sample string 11"
}