Courses
Courses in Coassemble are the cornerstone of the platform. Using the API, you can search for, and create new courses.
Endpoints
Get courses
GET /api/v1/courses
Returns a list of the courses that your account has access to. The courses are returned sorted by creation date, with the most recently created courses appearing first. Filter courses using the query parameters listed in the table.
Query parameters
| Field | Type | Description | Required | Default | Pattern |
|---|---|---|---|---|---|
owner | string | User ID | No | null | \d+ |
group | string | Group ID | No | null | \d+ |
category | string | Category ID | No | null | \d+ |
search | string | Search by course title or code | No | "" | [\w\-\s\:]+ |
sort | string | Sort by | No | "created" | (alpha|recent|created) |
page | string | Which page of items to display, starting with zero | No | "0" | \d+ |
length | string | Items per page (0-100) | No | "10" | \d+ |
Responses
| Code | Description |
|---|---|
| 200 | Returned when successful |
Create a new course
POST /api/v1/courses
Use this endpoint to create new courses in your workspace.
Body properties
| Field | Type | Description | Required |
|---|---|---|---|
title | string | Title for the newly-created course. | Yes |
category | integer | ID of category in which to create the new course. | Yes |
code | string | Course code (optional, will be displayed prior to course title). | No |
overview | string | Short description of the course's content. May contain HTML formatting. | No |
Responses
| Code | Description |
|---|---|
| 201 | Created successfully |
| 422 | Title not specified. |
Search for a specific course
GET /api/v1/courses/{course}
Search for a specific course using the course ID.
Path variables
| Field | Description |
|---|---|
course | ID of course. |
Responses
| Code | Description |
|---|---|
| 200 | Returned when successful |