# Functions
# function to activate a job role
path = /activateJobRole?id=<item_to_activate id>
method = PUT
authentication = Bearer token
# RESPONSE
if all good
status : 200
{
"id" : deleted role id
}
if error
{
"error": error message,
}
*/.
# function to add a role to database
route = /addJobRole
body = json
Request = POST
example = {
"name":type string,
"skills":type string,
"experience": type int,
"minATS": type int,
}
# RESPONSE
if all good
status code : 201
{
"id": "48e160e1-3a66-4dc5-a9ee-aba701fc1fb5",
"name": "Go developer",
"skills": "GO,CSS,HTML,JAVASCRIPT,AWS",
"experience": 3,
"minATS": 80,
"createdBy": "a6316878-b270-4b41-9d29-647e0478d1e3",
"expired": false,
"createdAt": "2024-11-29T19:48:49.925669Z",
"updatedAt": "2024-11-29T19:48:49.925669Z"
}
if error
{
"error": error message,
}
*/.
# function to get all job role of an admin
path = /allJobRole
method = GET
authentication = Bearer token
# RESPONSE
if all good
status : 200
[
{
"id": "48e160e1-3a66-4dc5-a9ee-aba701fc1fb5",
"name": "Go developer",
"skills": "GO,CSS,HTML,JAVASCRIPT,AWS",
"experience": 3,
"minATS": 80,
"createdBy": "a6316878-b270-4b41-9d29-647e0478d1e3",
"expired": false,
"createdAt": "2024-11-29T19:48:49.925669Z",
"updatedAt": "2024-11-29T19:48:49.925669Z"
},
]
if error
{
"error": error message,
}
*/.
# function to delete a job role
path = /deleteJobRole?id=<item_to_delete id>
method = DELETE
authentication = Bearer token
# RESPONSE
if all good
status : 200
{
"id" : deleted role id
}
if error
{
"error": error message,
}
*/.
# function to expire a job role
path = /expireJobRole?id=<item_to_expire id>
method = PUT
authentication = Bearer token
# RESPONSE
if all good
status : 200
{
"id" : deleted role id
}
if error
{
"error": error message,
}
*/.
# function to delete a job role
path = /singleJobRole?id=<role id>
method = GET
authentication = Bearer token
# RESPONSE
if all good
status : 200
{
"id": "3a4c0070-b6fd-47c2-8c26-047d395a34e9",
"name": "IT Specialist",
"skills": "HTML, CSS, JS, Ruby on rails",
"experience": 1,
"minATS": 80,
"createdBy": "94625258-5132-4034-b2b6-83b5f48c31b9",
"expired": true,
"createdAt": "2024-12-12T14:07:07.54Z",
"updatedAt": "2024-12-12T14:54:26.083Z"
}
if error
{
"error": error message,
}
*/.
# function to update a job role
path = /updateJobRole
method = POST
authentication = Bearer token
example payload = {
"id": "48e160e1-3a66-4dc5-a9ee-aba701fc1fb5",
"name": "Go developer",
"skills": "GO,CSS,HTML,JAVASCRIPT,AWS",
"experience": 3,
"minATS": 80,
"createdBy": "a6316878-b270-4b41-9d29-647e0478d1e3",
"expired": false,
"createdAt": "2024-11-29T19:48:49.925669Z",
"updatedAt": "2024-11-29T19:48:49.925669Z"
}
# RESPONSE
if all good
status code : 201
{
"id": "48e160e1-3a66-4dc5-a9ee-aba701fc1fb5",
"name": "Go developer",
"skills": "GO,CSS,HTML,JAVASCRIPT,AWS",
"experience": 3,
"minATS": 80,
"createdBy": "a6316878-b270-4b41-9d29-647e0478d1e3",
"expired": false,
"createdAt": "2024-11-29T19:48:49.925669Z",
"updatedAt": "2024-11-29T19:48:49.925669Z"
}
if error
{
"error": error message,
}
*/.