Skip to main content
PATCH
/
api
/
v1
/
assignments
/
{assignment_id}
Update Assignment
curl --request PATCH \
  --url https://api.seamind.xyz/api/v1/assignments/{assignment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "role": "<string>",
  "startDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "endDate": "2023-12-25"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "userName": "<string>",
  "userEmail": "<string>",
  "shipId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "shipName": "<string>",
  "shipImoNumber": "<string>",
  "role": "<string>",
  "startDate": "2023-12-25",
  "dueDate": "2023-12-25",
  "endDate": "2023-12-25",
  "isActive": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
assignment_id
string<uuid>
required

Body

application/json

Admin assignment update request.

​
role
string | null
​
startDate
string<date> | null
​
dueDate
string<date> | null
​
endDate
string<date> | null

Response

Successful Response

Assignment with denormalized user/ship names for API responses.

​
id
string<uuid>
required
​
userId
string<uuid>
required
​
userName
string
required
​
userEmail
string
required
​
shipId
string<uuid>
required
​
shipName
string
required
​
shipImoNumber
string
required
​
role
string
required
​
startDate
string<date> | null
required
​
dueDate
string<date> | null
required
​
endDate
string<date> | null
required
​
isActive
boolean
required