Task endpoints
Base URL: /tenants/{tenantName}/users/{userId}/tasks
Get tasks
Get tasks assigned to a given user.
URL: /tenants/{tenantName}/users/{userId}/tasks/
Method: GET
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| userId | Integer (int32) | Yes | The id of the user that the task relates to |
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |
Get by id
Get specific task by integer ID.
URL: /tenants/{tenantName}/users/{userId}/tasks/{taskId}
Method: GET
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| userId | Integer (int32) | Yes | The id of the user that the task relates to |
| taskId | Integer (int32) | Yes | The id of the task to retrieve |
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |
Response body
{
id: integer (int32)
details: string
url: string
date: string (date)
startTime: string (hh:mm)
endTime: string (hh:mm)
type: string (Enum: Networking, Training, Reasearch, Opportunity, Appointment, Placement, Miscellaneous)
creator: integer (int32) adminId
}
Create task
Creates a new task.
URL: /tenants/{tenantName}/users/{userId}/tasks/
Method: POST
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| userId | Integer (int32) | Yes | The id of the user that the task relates to |
Request body
{
details: string
url: string
date: string (date)
startTime: string (hh:mm)
endTime: string (hh:mm)
type: string (Enum: Networking, Training, Research, Opportunity, Appointment, Placement, Miscellaneous)
creator: integer (int32) adminId
}
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
Response body
{
id: integer (int32)
details: string
url: string
date: string (date)
startTime: string (hh:mm)
endTime: string (hh:mm)
type: string (Enum: Networking, Training, Reasearch, Opportunity, Appointment, Placement, Miscellaneous)
creator: integer (int32) adminId
}
Update task
Updates an existing task.
URL: /tenants/{tenantName}/users/{userId}/tasks/{taskId}
Method: PUT
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| userId | Integer (int32) | Yes | The id of the user that the task relates to |
| taskId | Integer (int32) | Yes | The id of the task to retrieve |
Request body
{
details: string
url: string
date: string (date)
startTime: string (hh:mm)
endTime: string (hh:mm)
type: string (Enum: Networking, Training, Reasearch, Opportunity, Appointment, Placement, Miscellaneous)
creator: integer (int32) adminId
}
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |
Response body
{
id: integer (int32)
details: string
url: string
date: string (date)
startTime: string (hh:mm)
endTime: string (hh:mm)
type: string (Enum: Networking, Training, Reasearch, Opportunity, Appointment, Placement, Miscellaneous)
creator: integer (int32) adminId
}
Delete task
Deletes an existing task where found.
URL: /tenants/{tenantName}/users/{userId}/tasks/{taskId}
Method: DELETE
Parameters:
| Name | Type | Required | Description |
| tenantName | String | Yes | The name of the tenant |
| userId | Integer (int32) | Yes | The id of the user that the task relates to |
| taskId | Integer (int32) | Yes | The id of the task to retrieve |
Responses:
| Status code | Status Description |
| 200 | Successful operations |
| 400 | Invalid input |
| 401 | Unauthorised |
| 403 | Permission denied |
| 404 | Not found |