List Assignments

GET

api

learn

assignments

List Assignments

curl --request GET \
  --url https://api.example.com/api/v1/learn/assignments \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userName": "<string>",
      "userEmail": "<string>",
      "shipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shipName": "<string>",
      "role": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "isActive": true,
      "shipImoNumber": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": false,
  "totalCount": 123
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

ship_id

string | null

Filter by ship (single UUID or comma-separated UUIDs for OR)

is_active

boolean | null

Filter by active status

limit

integer

default:10

Items per page

Required range: 1 <= x <= 1000

cursor

string | null

Pagination cursor

string | null

Search term

Maximum string length: 200

include_count

boolean

default:false

Include total count

Response

Successful Response

items

AssignmentDetailDTO · object[]

required

Show child attributes

nextCursor

string | null

hasMore

boolean

default:false

totalCount

integer | null

Create AssignmentCreate a new crew assignment. Requires admin role.

List Assignments

curl --request GET \
  --url https://api.example.com/api/v1/learn/assignments \
  --header 'Authorization: Bearer <token>'

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userName": "<string>",
      "userEmail": "<string>",
      "shipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "shipName": "<string>",
      "role": "<string>",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "isActive": true,
      "shipImoNumber": "<string>"
    }
  ],
  "nextCursor": "<string>",
  "hasMore": false,
  "totalCount": 123
}