Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Create and manage academic programs. Courses are the central entity linking institutions, modules, cohorts, and certificates.
{
"uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"code": "BCS-2024",
"name": "Bachelor of Computer Science",
"description": "A 4-year undergraduate program in computer science.",
"workload_hours": 3200,
"area": "Technology",
"version": "2024.1",
"status": "active",
"institution": {
"uuid": "550e8400-e29b-41d4-a716-446655440000",
"name": "Federal University of Technology"
},
"organization": null,
"created_at": "2024-01-15T10:00:00.000000Z"
}
| Field | Type | Description |
|---|---|---|
uuid | string | Unique identifier |
code | string | Internal course code |
name | string | Course name (max 255 chars) |
description | string | Description of the program |
workload_hours | integer | Total program hours |
area | string | Knowledge area (e.g., Technology, Health) |
version | string | Curriculum version |
status | enum | draft, active, archived |
institution | object | Parent institution |
organization | object|null | Optional sub-unit (faculty/department) |
GET /courses
curl "https://api.dokstamp.com/courses?where[status]=active&sort[column]=name" \
-H "Authorization: Bearer {TOKEN}" \
-H "Accept: application/json" \
-H "X-Tenant: {TENANT}"
POST /courses
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Course name |
institution_uuid | string | Yes | Parent institution UUID |
code | string | No | Internal code |
description | string | No | Program description |
workload_hours | integer | No | Total program hours |
area | string | No | Knowledge area |
version | string | No | Curriculum version |
status | enum | No | draft (default), active, archived |
organization_uuid | string | No | Sub-unit (faculty/department) UUID |
curl -X POST https://api.dokstamp.com/courses \
-H "Authorization: Bearer {TOKEN}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "X-Tenant: {TENANT}" \
-d '{
"name": "Bachelor of Computer Science",
"code": "BCS-2024",
"institution_uuid": "550e8400-e29b-41d4-a716-446655440000",
"workload_hours": 3200,
"area": "Technology",
"version": "2024.1",
"status": "active"
}'
201:
{
"data": {
"uuid": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"name": "Bachelor of Computer Science",
"status": "active",
...
}
}
GET /courses/{uuid}
PATCH /courses/{uuid}
PUT /courses/{uuid}
DELETE /courses/{uuid}
DELETE /courses/batch/destroy
| Status | Meaning |
|---|---|
draft | Course is being configured — not yet accepting enrollments |
active | Course is live — certificates can be issued |
archived | Course is no longer offered — historical records remain |