JOB POSITIONS

LIST: GET /api/job_position/list

Returns collection of job position in JSON format. Company ID must be provided as URL param.

Resource URL 

/api/job_position/list or /api/job_position/list?companyId={companyId} or 
/api/job_position/list?companyId={companyId}&start={start}&limit={limit}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
companyId number required The ID of the company for which to return the job positions.
start number optional Specify beginning of paging
limit number optional Specify end of paging

Example <base_url>/api/job_position/list?companyId=2132

Response

{
   "count": 2,
   "list":
   [
       {
           "id": 3424,
           "jobTitle": "Software Engineer",
           "jobTitleId": 3413,
           "positionName": "SW1",
           "descr": "",
           "positionId": "SW1",
           "employmentStatus": "FULL_TIME_PERMANENT",
           "vacant": "YES",
           "active": "YES",
           "companyId": null
       },
       {
           "id": 3425,
           "jobTitle": "Software Engineer",
           "jobTitleId": 3413,
           "positionName": "SW2",
           "descr": "",
           "positionId": "SW2",
           "employmentStatus": "FULL_TIME_PERMANENT",
           "vacant": "YES",
           "active": "YES",
           "companyId": null
       }
   ]
}

LOAD: GET /api/job_position/load/{id}

Returns Job position details in JSON format. ID must be provided as path parameter.

Resource URL 

/api/job_position/load/{id}

Resource Properties

PROPERTY DESCRIPTION
Method GET
Response formats JSON
Requires authentication? Yes

URL Params

Always specify companyId param

PARAM TYPE REQUIRED/OPTIONAL DESCRIPTION
id number required The ID of the job position to load details.

Response status

HTTP Status Code Reason
200 Found Record
404 Record not found
405 Invalid input
500 Internal server error

Example <base_url>/api/job_position/load/3424

Response

{
   "id": 3424,
   "jobTitle": "Software Engineer",
   "jobTitleId": 3413,
   "positionName": "SW1",
   "descr": "",
   "positionId": "SW1",
   "employmentStatus": "FULL_TIME_PERMANENT",
   "vacant": "YES",
   "active": "YES",
   "companyId": null
}

SAVE: POST /api/job_position/save

Saves job position details, either when creating new job position or updating a job position record. Company ID must be provided in the payload

Resource URL 

/api/job_position/save

Resource Properties

PROPERTY DESCRIPTION
Method POST
Request representations application/json
Requires authentication? Yes

Data Params/Body payload

{
   "id": number [required on updating],
   "jobTitleId": number [required],
   "positionName": text [required],
   "descr": text [optional],
   "positionId": text [required],
   "employmentStatus": text of [FULL_TIME_PERMANENT,PART_TIME_PERMANENT,INTERNSHIP,PART_TIME_CONTRACT,
   FULL_TIME_CONTRACT,TEMPORARY_STATUS,PROBATION,CASUAL] [optional],
   "vacant": text of [YES,NO] [required],
   "active": text of [YES,NO] [required]
}

Response status

HTTP Status Code Reason
200 Successfully saved
405 Invalid input
500 Internal server error

Example <base_url>/api/job_position/save

Payload

{
   "jobTitleId": 3413,
   "positionName": "SW3",
   "descr": "Sofware engineer position",
   "positionId": "SW3",
   "employmentStatus": "FULL_TIME_PERMANENT",
   "vacant": "YES",
   "active": "YES"
}

Response

{
   "success": "true",
   "message": "Successful"
}