This API provides functionality for creating, updating, and deleting projects and adverts.
UserMS Auth
This API uses the following error codes:
400 Bad Request
- The request was malformed or missing required parameters.401 Unauthorized
- The user does not have permission to access the requested resource.404 Not Found
- The requested resource was not found.500 Internal Server Error
- There was an error processing the request.
POST /project
Creates a new project.
title
(string, required): The title of the project.department
(string, required): The department responsible for the project.goals
(string, required): The goals of the project.summary
(string): A summary of the project.startdate
(string, required): The start date of the project.enddate
(date): The end date of the project.is_finished
(boolean): Whether the project is finished.
Response
result
(boolean): Whether the project was created successfully.
GET /project
Gets a list of all projects.
project_id
(objectId): The ID of the project to retrieve.
title
(string): The title of the project.department
(string): The department responsible for the project.goals
(string): The goals of the project.summary
(string): A summary of the project.startdate
(string): The start date of the project.enddate
(date): The end date of the project.is_finished
(boolean): Whether the project is finished.
PATCH /project
Updates an existing project.
project_id
(objectId, required): The ID of the project to update.title
(string): The new title of the project.department
(string): The new department responsible for the project.goals
(string): The new goals of the project.summary
(string): The new summary of the project.startdate
(string): The new start date of the project.enddate
(date): The new end date of the project.is_finished
(boolean): Whether the project is finished.
result
(boolean): Whether the project was updated successfully.
DELETE /project
Deletes an existing project.
project_id
(objectId, required): The ID of the project to delete.
result
(boolean): Whether the project was deleted successfully.
POST /advert
Creates a new advert.
project_id
(objectId, required): The ID of the project associated with the advert.title
(string, required): The title of the advert.requirements
(string, required): The requirements for the position advertised.publish_date
(date): The date the advert was published.deadline
(date): The deadline for applications.
result
(boolean): Whether the advert was created successfully.
GET /advert
Gets a list of all adverts.
project_id
(objectId): The ID of the project associated with the advert.advert_id
(objectId): The ID of the advert to retrieve.
project_id
(objectId): The ID of the project associated with the advert.title
(string): The title of the advert.requirements
(string): The requirements for the position advertised.publish_date
(date): The date the advert was published.deadline
(date): The deadline for applications.
PATCH /advert
Updates an existing advert.
project_id
(objectId, required): The ID of the project associated with the advert.advert_id
(objectId, required): The ID of the advert to update.title
(string): The new title of the advert.requirements
(string): The new requirements for the position advertised.publish_date
(date): The new date the advert was published.deadline
(date): The new deadline for applications.
result
(boolean): Whether the advert was updated successfully.
DELETE /advert
Deletes an existing advert.
project_id
(objectId, required): The ID of projectadvert_id
(objectId, required): The ID of advert
result
(boolean): Whether the advert was deleted successfully.