Student Lifecycle · Teaching & Delivery
Assignments
Work set — essays, quizzes, practicals, projects — with what was handed in and the marks given. A teacher sets work only for the sections they teach.
/api/slcm/assignmentsPublished as /api/v1/assignmentsOverview
| Package | Student Lifecycle |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Student Lifecycle › Assignments on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | slcm.assignments · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
12 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/slcm/assignmentsList assignments
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assignment_no": "ASS-000001",
"title": "Example",
"description": "text",
"assignment_type": "text",
"points_possible": "1250.00",
"weight_pct": "1250.00",
"assigned_date": "2026-10-30",
"due_at": "2026-10-30T09:00:00Z",
"allow_late": true,
"late_penalty_pct": "1250.00",
"is_published": true,
"created_at": "2026-10-30T09:00:00Z"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/slcm/assignments?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/slcm/assignments/{id}Read one assignments
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assignment_no": "ASS-000001",
"title": "Example",
"description": "text",
"assignment_type": "text",
"points_possible": "1250.00",
"weight_pct": "1250.00",
"assigned_date": "2026-10-30",
"due_at": "2026-10-30T09:00:00Z",
"allow_late": true,
"late_penalty_pct": "1250.00",
"is_published": true,
"created_at": "2026-10-30T09:00:00Z"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/assignmentsCreate a assignments
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
section_id | uuid | Yes | Section — The sections you teach. A head of department, dean or registrar can choose any section. |
title | text | Yes | Title |
description | text | No | Description |
assignment_type | text | No | Type |
points_possible | numeric | No | Points possible |
weight_pct | numeric | No | Weight (% of final) |
assigned_date | date | No | Assigned |
due_at | timestamp with time zone | No | Due |
allow_late | boolean | No | Accept late work |
late_penalty_pct | numeric | No | Late penalty % |
is_published | boolean | No | Published to students |
word_limit | integer | No | Word limit — For an essay: the most words expected. Up to a tenth over is accepted when it is handed in. |
rubric | text | No | Marking scheme — How it is marked, one criterion a line — e.g. “Anatomical accuracy — 20 marks”. Students see it. |
requires_declaration | boolean | No | Students declare it is their own work |
declaration_text | text | No | Declaration — What the student ticks. Blank: “I declare that this is my own work.” |
submission_mode | text | No | Handed in as Allowed: online_text file in_person |
set_by | uuid | No | Set by |
Sample body
{
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example",
"description": "text",
"assignment_type": "text",
"points_possible": "1250.00",
"weight_pct": "1250.00"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assignment_no": "ASS-000001",
"title": "Example",
"description": "text",
"assignment_type": "text",
"points_possible": "1250.00",
"weight_pct": "1250.00",
"assigned_date": "2026-10-30",
"due_at": "2026-10-30T09:00:00Z",
"allow_late": true,
"late_penalty_pct": "1250.00",
"is_published": true,
"created_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/assignments" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"section_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","title":"Example","description":"text","assignment_type":"text","points_possible":"1250.00","weight_pct":"1250.00"}'PUT/api/slcm/assignments/{id}Change a assignments
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
section_id | uuid | Yes | Section — The sections you teach. A head of department, dean or registrar can choose any section. |
title | text | Yes | Title |
description | text | No | Description |
assignment_type | text | No | Type |
points_possible | numeric | No | Points possible |
weight_pct | numeric | No | Weight (% of final) |
assigned_date | date | No | Assigned |
due_at | timestamp with time zone | No | Due |
allow_late | boolean | No | Accept late work |
late_penalty_pct | numeric | No | Late penalty % |
is_published | boolean | No | Published to students |
word_limit | integer | No | Word limit — For an essay: the most words expected. Up to a tenth over is accepted when it is handed in. |
rubric | text | No | Marking scheme — How it is marked, one criterion a line — e.g. “Anatomical accuracy — 20 marks”. Students see it. |
requires_declaration | boolean | No | Students declare it is their own work |
declaration_text | text | No | Declaration — What the student ticks. Blank: “I declare that this is my own work.” |
submission_mode | text | No | Handed in as Allowed: online_text file in_person |
set_by | uuid | No | Set by |
Sample body
{
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"title": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"section_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"assignment_no": "ASS-000001",
"title": "Example",
"description": "text",
"assignment_type": "text",
"points_possible": "1250.00",
"weight_pct": "1250.00",
"assigned_date": "2026-10-30",
"due_at": "2026-10-30T09:00:00Z",
"allow_late": true,
"late_penalty_pct": "1250.00",
"is_published": true,
"created_at": "2026-10-30T09:00:00Z"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"section_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","title":"Example"}'DELETE/api/slcm/assignments/{id}Delete a assignments
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"PATCH/api/slcm/assignments/{id}Patch assignments
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PATCH "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/assignments/{parentId}/submissionsSubmissions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submissions" \
-H "Authorization: Bearer $TOKEN"PUT/api/slcm/assignments/{parentId}/submissions/{lineId}Submissions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/slcm/assignments/{parentId}/submissions/{lineId}Submissions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
lineId | string (uuid) | The record's lineId, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submissions/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/slcm/assignments/{id}/submitSubmit
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
studentId, declaration, content, attachmentUrlResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submit" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"studentId":"value","declaration":"value","content":"value","attachmentUrl":"value"}'POST/api/slcm/assignments/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'GET/api/slcm/assignments/{parentId}/submissionsSubmissions
Path parameters
| Name | Type | Description |
|---|---|---|
parentId | string (uuid) | The record's parentId, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/slcm/assignments/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/submissions" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a assignments, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
section_id | uuid | read, write | Section — The sections you teach. A head of department, dean or registrar can choose any section. |
assignment_no | text | read only | Assignment no |
title | text | read, write | Title |
description | text | read, write | Description |
assignment_type | text | read, write | Type |
points_possible | numeric | read, write | Points possible |
weight_pct | numeric | read, write | Weight (% of final) |
assigned_date | date | read, write | Assigned |
due_at | timestamp with time zone | read, write | Due |
allow_late | boolean | read, write | Accept late work |
late_penalty_pct | numeric | read, write | Late penalty % |
is_published | boolean | read, write | Published to students |
created_at | timestamp with time zone | read only | Created at |
org_unit_id | uuid | read only | Org unit id |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
word_limit | integer | read, write | Word limit — For an essay: the most words expected. Up to a tenth over is accepted when it is handed in. |
rubric | text | read, write | Marking scheme — How it is marked, one criterion a line — e.g. “Anatomical accuracy — 20 marks”. Students see it. |
requires_declaration | boolean | read, write | Students declare it is their own work |
declaration_text | text | read, write | Declaration — What the student ticks. Blank: “I declare that this is my own work.” |
submission_mode | text | read, write | Handed in as Allowed: online_text file in_person |
set_by | uuid | read, write | Set by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Student Lifecycle › Assignments for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.