Vacancy

Get Vacancy

HTTP Request

GET /api/vacancies/{id}

📋 Description: Retrieves detailed information about a specific job vacancy identified by its unique ID, enabling businesses to access essential recruitment data for informed decision-making.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

200

OK

OK

VacancyDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "unit": "string",
10  "area": 0,
11  "unitMeasureId": 0,
12  "vacantFrom": "2019-08-24",
13  "vacantTo": "2019-08-24",
14  "marketValue": 0,
15  "eligible": true,
16  "applicationDate": "2019-08-24",
17  "followUpDate": "2019-08-24",
18  "vacancyStatusId": 0,
19  "credit": 0,
20  "creditReceived": 0,
21  "note": "string",
22  "assessmentId": 0,
23  "assessmentExternalId": "string",
24  "unitMeasure": {
25    "createdBy": "string",
26    "lastModifiedBy": "string",
27    "createdDate": "2019-08-24T14:15:22Z",
28    "lastModifiedDate": "2019-08-24T14:15:22Z",
29    "archived": true,
30    "externalId": "string",
31    "id": 0,
32    "priority": 0,
33    "internalId": 0,
34    "pickListCode": "string",
35    "pickListLabel": "string",
36    "label": "string",
37    "cultureId": 0,
38    "labelDtos": [
39      {
40        "createdBy": "string",
41        "lastModifiedBy": "string",
42        "createdDate": "2019-08-24T14:15:22Z",
43        "lastModifiedDate": "2019-08-24T14:15:22Z",
44        "archived": true,
45        "externalId": "string",
46        "id": 0,
47        "cultureId": 0,
48        "value": "string"
49      }
50    ]
51  },
52  "vacancyStatus": {
53    "createdBy": "string",
54    "lastModifiedBy": "string",
55    "createdDate": "2019-08-24T14:15:22Z",
56    "lastModifiedDate": "2019-08-24T14:15:22Z",
57    "archived": true,
58    "externalId": "string",
59    "id": 0,
60    "priority": 0,
61    "internalId": 0,
62    "pickListCode": "string",
63    "pickListLabel": "string",
64    "label": "string",
65    "cultureId": 0,
66    "labelDtos": [
67      {
68        "createdBy": "string",
69        "lastModifiedBy": "string",
70        "createdDate": "2019-08-24T14:15:22Z",
71        "lastModifiedDate": "2019-08-24T14:15:22Z",
72        "archived": true,
73        "externalId": "string",
74        "id": 0,
75        "cultureId": 0,
76        "value": "string"
77      }
78    ]
79  }
80}

Update Vacancy

HTTP Request

PUT /api/vacancies/{id}

📋 Description: Updates the details of a specific job vacancy identified by its unique ID, enabling organizations to maintain accurate and current job listings.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

body

body

VacancyDto

true

Request body containing the updated vacancy details, including position title, description, and required qualifications, to ensure accurate workforce planning.

Body Parameters

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "unit": "string",
10  "area": 0,
11  "unitMeasureId": 0,
12  "vacantFrom": "2019-08-24",
13  "vacantTo": "2019-08-24",
14  "marketValue": 0,
15  "eligible": true,
16  "applicationDate": "2019-08-24",
17  "followUpDate": "2019-08-24",
18  "vacancyStatusId": 0,
19  "credit": 0,
20  "creditReceived": 0,
21  "note": "string",
22  "assessmentId": 0,
23  "assessmentExternalId": "string",
24  "unitMeasure": {
25    "createdBy": "string",
26    "lastModifiedBy": "string",
27    "createdDate": "2019-08-24T14:15:22Z",
28    "lastModifiedDate": "2019-08-24T14:15:22Z",
29    "archived": true,
30    "externalId": "string",
31    "id": 0,
32    "priority": 0,
33    "internalId": 0,
34    "pickListCode": "string",
35    "pickListLabel": "string",
36    "label": "string",
37    "cultureId": 0,
38    "labelDtos": [
39      {
40        "createdBy": "string",
41        "lastModifiedBy": "string",
42        "createdDate": "2019-08-24T14:15:22Z",
43        "lastModifiedDate": "2019-08-24T14:15:22Z",
44        "archived": true,
45        "externalId": "string",
46        "id": 0,
47        "cultureId": 0,
48        "value": "string"
49      }
50    ]
51  },
52  "vacancyStatus": {
53    "createdBy": "string",
54    "lastModifiedBy": "string",
55    "createdDate": "2019-08-24T14:15:22Z",
56    "lastModifiedDate": "2019-08-24T14:15:22Z",
57    "archived": true,
58    "externalId": "string",
59    "id": 0,
60    "priority": 0,
61    "internalId": 0,
62    "pickListCode": "string",
63    "pickListLabel": "string",
64    "label": "string",
65    "cultureId": 0,
66    "labelDtos": [
67      {
68        "createdBy": "string",
69        "lastModifiedBy": "string",
70        "createdDate": "2019-08-24T14:15:22Z",
71        "lastModifiedDate": "2019-08-24T14:15:22Z",
72        "archived": true,
73        "externalId": "string",
74        "id": 0,
75        "cultureId": 0,
76        "value": "string"
77      }
78    ]
79  }
80}

Responses

Status

Meaning

Description

Schema

200

OK

OK

VacancyDto

Example Responses

 1{
 2  "createdBy": "string",
 3  "lastModifiedBy": "string",
 4  "createdDate": "2019-08-24T14:15:22Z",
 5  "lastModifiedDate": "2019-08-24T14:15:22Z",
 6  "archived": true,
 7  "externalId": "string",
 8  "id": 0,
 9  "unit": "string",
10  "area": 0,
11  "unitMeasureId": 0,
12  "vacantFrom": "2019-08-24",
13  "vacantTo": "2019-08-24",
14  "marketValue": 0,
15  "eligible": true,
16  "applicationDate": "2019-08-24",
17  "followUpDate": "2019-08-24",
18  "vacancyStatusId": 0,
19  "credit": 0,
20  "creditReceived": 0,
21  "note": "string",
22  "assessmentId": 0,
23  "assessmentExternalId": "string",
24  "unitMeasure": {
25    "createdBy": "string",
26    "lastModifiedBy": "string",
27    "createdDate": "2019-08-24T14:15:22Z",
28    "lastModifiedDate": "2019-08-24T14:15:22Z",
29    "archived": true,
30    "externalId": "string",
31    "id": 0,
32    "priority": 0,
33    "internalId": 0,
34    "pickListCode": "string",
35    "pickListLabel": "string",
36    "label": "string",
37    "cultureId": 0,
38    "labelDtos": [
39      {
40        "createdBy": "string",
41        "lastModifiedBy": "string",
42        "createdDate": "2019-08-24T14:15:22Z",
43        "lastModifiedDate": "2019-08-24T14:15:22Z",
44        "archived": true,
45        "externalId": "string",
46        "id": 0,
47        "cultureId": 0,
48        "value": "string"
49      }
50    ]
51  },
52  "vacancyStatus": {
53    "createdBy": "string",
54    "lastModifiedBy": "string",
55    "createdDate": "2019-08-24T14:15:22Z",
56    "lastModifiedDate": "2019-08-24T14:15:22Z",
57    "archived": true,
58    "externalId": "string",
59    "id": 0,
60    "priority": 0,
61    "internalId": 0,
62    "pickListCode": "string",
63    "pickListLabel": "string",
64    "label": "string",
65    "cultureId": 0,
66    "labelDtos": [
67      {
68        "createdBy": "string",
69        "lastModifiedBy": "string",
70        "createdDate": "2019-08-24T14:15:22Z",
71        "lastModifiedDate": "2019-08-24T14:15:22Z",
72        "archived": true,
73        "externalId": "string",
74        "id": 0,
75        "cultureId": 0,
76        "value": "string"
77      }
78    ]
79  }
80}

Delete Vacancy

HTTP Request

DELETE /api/vacancies/{id}

📋 Description: Deletes a specific vacancy identified by its unique ID, ensuring that the vacancy is no longer available for job seekers and streamlining the recruitment process.

Parameters

Name

In

Type

Required

Description

id

path

integer(int64)

true

Unique identifier for the resource

Responses

Status

Meaning

Description

Schema

204

No Content

No Content

None