Job title resources

Job title resources

Get job titles

GET https://app.smartmansys.com/api/v1/job_titles

This endpoint allows you to get the job titles.

Headers

Name	Type	Description
Authorization	string	Authentication token

200 Cake successfully retrieved.

{
    "job_titles": [
        {
            "id": 1,
            "name": "Name of the job title"
        },
        {
            ...
        }
    ]
}

Create job title

POST https://app.smartmansys.com/api/v1/job_titles

Headers

Name	Type	Description
Authorization	string	Authentication token

Request Body

Name	Type	Description
job_title	object	Job title

200 Example response of a valid and invalid request

{
    "status": "OK",
    "job_title": {
        "id": 1,
        "name": "Name of the job title"
    }
}
{
    "status": "NOT-OK",
    "errors": {
        "name": ["Name is required"]
    }
}

// Job_title object
{
    "name": "Name of the jobTitle" // required
}

Update job title

PATCH https://app.smartmansys.com/api/v1/job_titles/:id

This method is also available under PUT.

Path Parameters

Name	Type	Description
id	integer	Id of the job title

Headers

Name	Type	Description
Authorization	string	Authentication token

Request Body

Name	Type	Description
Job_title	object	Job title

200 Example response of a valid an invalid request

{
    "status": "OK",
    "job_title": {
        "id": 1,
        "name": "Name of the job title"
    }
}
{
    "status": "NOT-OK",
    "errors": {
        "name": ["Name is required"]
    }
}

404 When the job title doesn't exists

// Job_title object
{
    "name": "Name of the jobTitle" // required
}

Delete job title

DELETE https://app.smartmansys.com/api/v1/job_titles/:id

Path Parameters

Name	Type	Description
id	integer	Id of the job title

Headers

Name	Type	Description
Authorization	string	Authentication token

200

{
    "status: "OK"
}

404 When the job title doesn't exists