Task status
API version
Select a version to change the base URI
in syntax and code examples. Learn about versions:
in syntax and code examples. Learn about versions
Represents the application task status.
URI
/api/v9/applications/ID/tasks/ID/statusGET Get the task status
A request with the GET verb returns the status text about the application task in question.
Syntax
GET /api/v9/applications/123/tasks/1/status
Host: apply.example.edu
Authorization: DREAM apikey="..."Example request
Request
curl
curl \
-X GET \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
"https://apply.example.edu/api/v9/applications/123/tasks/1/status"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | application/json | Media type of the resource |
Content-Length | 1234 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The status was successfully returned |
404 Not Found | The application does not have this task |
Example response
Response
"I am preparing the documents for submission."PUT Set the task status
Set a status to the application task (identified by its ID) in question. This will check if the given status is already defined in the application task’s definition, and in case it’s not defined, this will add the status to the application task in question.
Syntax
PUT /api/v9/applications/123/tasks/1/status
Host: apply.example.edu
Authorization: DREAM apikey="..."Raw request body
This text will be set as the status of the application task. Up to 50 characters.
Request body
"The task has been completed"Example request
Request
curl
curl \
-X PUT \
-H "Authorization: DREAM apikey=\"YOUR-API-KEY\"" \
-d '"The task has been completed"' \
"https://apply.example.edu/api/v9/applications/123/tasks/1/status"Response headers
| Header | Value | Description |
|---|---|---|
Content-Type | text/plain | Media type of the resource |
Content-Length | 0 | Size of the response body in bytes |
Response codes
| Response code | Description |
|---|---|
200 OK | The status was successfully set. |
400 Bad Request | Invalid status. |
400 Bad Request | Invalid status. Please make sure that status is a valid JSON string with quotes. |
404 Not Found | The application does not have this task. |