TITLE:
Vacancy
DESCRIPTION:
Contains API calls that can be used against the Vacancy entity.
BODY:
1.Get Vacancy By Id
Returns a specific vacancy based on the id parameter.In order to access this endpoint ensure that you do a GET request with an Authorization header containing your access token.
Parameters:
id: string - id of the vacancy
Headers:
Authorization: {token}
Result codes
403 Forbidden
200 OK
400 Bad request
500 Internal server error
Response
Calling this endpoint will return a full JSON object for the vacancy associated with the id on the url. The main properties of a vacancy are nested/grouped under a "main" property VacancyInfo.
{
VacancyInfo : { ... }
}
Vacancy properties
Please note that these properties are second level properties and thus returned/nested under a first level property VacancyInfo.
| Field | Type | Description |
|---|---|---|
| Id | int | Vacancy Identifier |
| CityId | int | Internal Id for the City |
| CityName | string | Name of the city |
| ClosedDate | datetime | Unpublished / closed date (GMT+2) |
| CompanyId | int | Internal Id for the company associated with the vacancy |
| CountryId | int | Internal country Id |
| Created | datetime | Created date (GMT+2) |
| CreatedById | int | Internal user who created the vacancy |
| CurrencyId | int | Internal Id of the salary currency for this vacancy |
| Address1 | Name of the province | |
| Address3 | Post Code | |
| DaysOpen | int | Number of days since that vacancy has been posted |
| Deleted | datetime | When was the vacancy was deleted (GMT+2) |
| DeletedById | int | Internal Id of the user who deleted the vacancy |
| DepartmentId | int | Internal Id for Department or Business Unit for this vacancy in the company |
| DepartmentName | string | Department or Business Unit for this vacancy in the company |
| Description | string | Job description |
| Disability | bool | Indicates if the vacancy is only opened to candidates with a disability or not |
| EmploymentEquity | bool | Indicates if the vacancy is only open to EE candidates or not |
| Hash | string | Internally generated unique key for the vacancy |
| InternalJobCode | string | Your internal job code or requisition Id |
| InternalNotes | string | Vacancy Internal notes |
| InternalSalaryMax | decimal | Internal max salary, not exposed |
| InternalSalaryMin | decimal | Internal min salary, not exposed |
| JobTitle | string | The title for the vacancy |
| PostDate | datetime | The date when the vacancy was published (GMT+2) |
| ProvinceId | int | Internal Id for the province |
| PublishInternal | bool | This vacancies are not listed on job boards or career portal. |
| PublishInternalSchedule | datetime | Desired data for Vacancies internally published only, to be published to the public (GMT+2) |
| SalaryMax | decimal | Max vacancy salary |
| SalaryMin | decimal | Min vacancy salary |
| SendToFreeJobsBoards | bool | Publish vacancy job on free job boards. |
| Telecommute | bool | Specifies whether this is a telecommute or work from home vacancy |
| Updated | datetime | Last updated date (GMT+2) |
| UpdatedById | int | Internal Id of the user who last updated the vacancy. |
| VacancyStatusId | int | The current status of the vacancy. See next row for list of status. |
| VacancyStatus | enum | The current status of the vacancy. 1 = Draft 2 = Published 3 = Closed 4 = Archived 5 = PendingApproval 6 = RejectedApproval 7 = AcceptedApproval 8 = PublishedInternal |
| PipeLineId | int | The current stage of the vacancy. 0 = None 1 = Sourced 2 = Reviewed 3 = Interviews 4 = Feedback 5 = Offer 6 = Disqualified 7 = Hired 8 = PendingOnBoardingApproval 9 = OnboardingRejected |
| ExperienceLevelId | int | Internal Id for minimum experience level. 1 = Not Applicable 2 = Internship 3 = Entry Level 4 = Associate 5 = Mid-Senior 6 = Director 7 = Executive |
| EmploymentTypeId | int | Internal id for type of employment. 1 = Permanent 2 = Contract 3 = Part-time 4 = Internship 5 = Volunteer |
| FunctionalAreaId | int | Internal Id for Vacancy functional area. 2 = Accounting/Auditing 3 = Administrative 4 = Advertising 8 = Art/Creative 5 = Business Analyst 9 = Business Development 10 = Consulting 11 = Customer Servce 6 = Data Analyst 13 = Design 12 = Distribution 14 = Education 15 = Engineering 16 = Finance 7 = Financial Analyst 1 = Functional Area 17 = General Business 18 = Health Care Provider 19 = Human Resources 20 = Information Technology 21 = Legal 22 = Management 23 = Manufacturing 24 = Marketing 25 = Operations 26 = Other 29 = Product Management 31 = Production 30 = Project Management 27 = Public Relations 28 = Purchasing 32 = Quality Assurance 33 = Research 34 = Sales 35 = Science 36 = Software Development 37 = Strategy/Planning 38 = Supply Chain 39 = Training 40 = UI/UX Design 41 = Writing/Editing |
| IndustryId | int | Internal Id for the company primary industry. 1 = Accounting 42 = Agriculture 2 = Airlines/Aviation 3 = Alternative Dispute Resolution 4 = Alternative Medicine 5 = Animation 6 = Apparel and Fashion 7 = Architecture and Planning 8 = Arts and Crafts 9 = Automotive 10 = Aviation and Aerospace 11 = Banking 12 = Biotechnology 13 = Broadcast Media 14 = Building Materials 15 = Business Supplies and Equipment 16 = Capital Markets 17 = Chemicals 18 = Civic and Social Organisation 19 = Civil Engineering 20 = Commercial Real Estate 24 = Computer and Network Security 21 = Computer Games 22 = Computer Hardware 23 = Computer Networking 25 = Computer Software 26 = Construction 27 = Consumer Electronics 28 = Consumer Goods 30 = Cosmetics 29 = Customer Services 31 = Dairy 32 = Defense and Space 33 = Design 34 = Education Management 35 = E-Learning 36 = Electrical/Electronic Management 37 = Entertainment 38 = Environmental Services 39 = Events Services 40 = Executive Office 41 = Facilities Services 43 = Financial Services 44 = Fine Art 45 = Fishery 46 = Food and Beverages 47 = Food Production 48 = Fund Raising 49 = Furniture 50 = Gambling and Casinos 51 = Government Administration 52 = Government Relations 53 = Graphic Design 54 = Health, Wellness and Fitness 55 = Higher Education 56 = Hospital and Healthcare 57 = Hospitality 58 = Human Resources 59 = Import and Export 60 = Individual and Family Services 61 = Industrial Automation 62 = Information Services 63 = Information Technology and Services 64 = Insurance 65 = International Affairs 66 = International Trade and Development 67 = Internet 68 = Investment Banking 69 = Investment Management 70 = Judiciary 71 = Law Enforcement 72 = Legal Services 73 = Legislative Office 74 = Leisure, Travel and Tourism 75 = Libraries 76 = Logistics and Supply Chain 77 = Luxury Goods and Jewelry 78 = Machinery 79 = Management Consulting 80 = Maritime 81 = Marketing and Advertising 82 = Mechanical or Industrial Engineering 83 = Media Production 84 = Medical Devices 86 = Medical Healthcare 85 = Medical Practice 87 = Military 88 = Mining and Metals 89 = Motion Pictures and Film 90 = Museums and Institutions 91 = Music 92 = Nanotechnology 93 = Newspapers 94 = Non-profit Organisation Management 95 = Oil and Energy 96 = Online Media 97 = Outsourcing and Offshoring 98 = Package and Freight Delivery 99 = Packaging and Containers 100 = Paper and Forest Products 101 = Performing Arts 103 = Philanthopy 102 = Phramceuticals 104 = Plastics 105 = Political Organisation 106 = Primary/Secondary Education 107 = Printing 108 = Professional Coaching and Training 109 = Programme Development 110 = Public Policy 111 = Public Relations and Communications 112 = Public Safety 113 = Publishing 114 = Railroad Manufacturing 115 = Real Estate 116 = Recreational Facilities and Services 117 = Religious Institutions 118 = Renewals and Environment 119 = Research 120 = Restaurants 121 = Retail 122 = Security and Investigations 123 = Semiconductors 124 = Shipbuilding 125 = Sporting Goods 126 = Sports 127 = Staffing and Recruiting 128 = Supermarkets 129 = Telecommunications 130 = Textiles 131 = Think Tanks 132 = Tobacco 133 = Translation and Localisation 134 = Transport/Trucking/Railroad 135 = Utilities 136 = Venture Capital and Private Equity 137 = Veternary 138 = Warehousing 139 = Wholesale 140 = Wine and Spirits 141 = Wireless 142 = Writing and Editing |
Sample Result
{
"VacancyInfo": {
"Id": 3560,
"Created": "2017-08-14T15:30:30.437",
"CreatedById": 4267,
"Updated": "2017-11-16T08:39:40.327",
"UpdatedById": 4267,
"Deleted": null,
"DeletedById": 0,
"PostDate": null,
"JobTitle": "C# Developer",
"InternalJobCode": "CDSLDEV3",
"Description": "Software Development house in the galaxy is looking for an exceptionally intelligent C# .Net Developer to join their brilliant team.",
"EmploymentTypeId": 1,
"ExperienceLevelId": 5,
"IndustryId": 63,
"CompanyId": 4153,
"FunctionalAreaId": 15,
"CurrencyId": 1,
"SalaryMin": 300000,
"SalaryMax": 350000,
"EmploymentEquity": false,
"Disability": false,
"CountryId": 1,
"Address1": "Gauteng",
"CityName": "Randburg",
"CityId": 31743,
"ProvinceId": 3,
"Address3": "7000",
"Telecommute": false,
"InternalSalaryMin": 350000,
"InternalSalaryMax": 380000,
"InternalNotes": "Consideration will be given to candidates with other Object-Oriented coding experience.",
"VacancyStatusId": 5,
"PipeLineId": 1,
"VacancyStatus": 5,
"DaysOpen": 0,
"DepartmentId": 11,
"DepartmentName": "sales",
"SendToFreeJobsBoards": true,
"Hash": "irzytj",
"IdParam": null,
"ClosedDate": null,
"PublishInternalSchedule": null,
"PublishInternal": null
}
}
2.Get Live Vacanies
Returns a paged list of all live vacancies.Returns 50 records at a time
Parameters:
page: int - page number, starts at 1
includeInternal: bool - indicates whether only published vacancies should be returned or both published and published internal vacancies.
Headers:
Authorization: {token}
Result codes
403 Forbidden
200 OK
400 Bad request
500 Internal server error
Response
Calling this method will return a collection of vacancy objects.
Sample Result
[
{
"Id":18,
"Created":"2017-07-17T14:25:12.087",
"CreatedById":28,
"Updated":"2017-07-17T14:30:36.12",
"UpdatedById":28,
"Deleted":null,
"DeletedById":0,
"PostDate":"2017-07-17T14:30:36.07",
"JobTitle":"National Sales Director",
"InternalJobCode":"JOB-123",
"Description":"<strong>Company Overview</strong>\n<p>All job descriptions should begin with an introduction</strong>",
"EmploymentTypeId":1,
"ExperienceLevelId":5,
"IndustryId":67,
"CompanyId":20,
"FunctionalAreaId":34,
"CurrencyId":1,
"SalaryMin":null,
"SalaryMax":null,
"EmploymentEquity":false,
"Disability":false,
"CountryId":1,
"Address1":"Gauteng",
"CityName":"Johannesburg",
"CityId":18,
"ProvinceId":null,
"Address3":"2001",
"Telecommute":false,
"InternalSalaryMin":500000.0000,
"InternalSalaryMax":1000000.0000,
"InternalNotes":null,
"VacancyStatusId":2,
"PipeLineId":1,
"VacancyStatus":2,
"DaysOpen":584,
"DepartmentId":16,
"DepartmentName":"Sales",
"SendToFreeJobsBoards":true,
"Hash":"5kn8qn",
"IdParam":null,
"DivisionSubDomain":null,
"ClosedDate":null,
"PublishInternalSchedule":null,
"PublishInternal":null,
"DivisionId":null,
"BusinessUnitId":null,
"BusinessUnitName":null,
"DivisionName":null,
"LogoId":null,
"AgencyClientId":null
}
]
3.Search
Returns a paged list of all live vacancies based on search criteria.Returns 50 records at a time
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| Page | int | Y | Page umber.Returns 50 at a time.Starts at 1. |
| IncludeInternal | bool | N | Specifies whether the call should return Published as well as Published Internal vacancies.Default is false. |
| CityId | int | N | Optional CityId |
| ProvinceId | int | N | Optional ProvinceId |
| FunctionalAreaId | int | N | Optional FunctionalAreaId(Category) |
| Title | string | N | Title of the vacancy.Tries to match vacancies with the exact or a partial title if the parameter contains a value. |
Sample Request Body
{
"Page": 1,
"IncludeInternal":false,
"CityId":992,
"ProvinceId":3,
"FunctionalAreaId":34,
"Title":"",
}
Result codes
403 Forbidden
200 OK
400 Bad request
500 Internal server error
Response
Calling this method will return a collection of vacancy objects.
Sample Result
[
{
"Id":3372,
"Created":"2018-10-01T05:36:48.433",
"CreatedById":269,
"Updated":"2019-02-07T09:56:10.117",
"UpdatedById":269,
"Deleted":null,
"DeletedById":0,
"PostDate":"2019-01-28T14:08:50.04",
"JobTitle":"Logistics Intern",
"InternalJobCode":null,
"Description":"Administration Clerk required in Heriotdale.",
"EmploymentTypeId":1,
"ExperienceLevelId":3,
"IndustryId":76,
"CompanyId":103,
"FunctionalAreaId":3,
"CurrencyId":1,
"SalaryMin":null,
"SalaryMax":null,
"EmploymentEquity":false,
"Disability":false,
"CountryId":1,
"Address1":"Gauteng",
"CityName":"Johannesburg",
"CityId":992,
"ProvinceId":3,
"Address3":"2094",
"Telecommute":false,
"InternalSalaryMin":null,
"InternalSalaryMax":null,
"InternalNotes":null,
"VacancyStatusId":2,
"PipeLineId":1,
"VacancyStatus":2,
"DaysOpen":24,
"DepartmentId":3,
"DepartmentName":"other",
"SendToFreeJobsBoards":false,
"Hash":"8ysgby",
"IdParam":null,
"DivisionSubDomain":null,
"ClosedDate":"2019-02-28T00:00:00",
"PublishInternalSchedule":null,
"PublishInternal":true,
"DivisionId":null,
"BusinessUnitId":null,
"BusinessUnitName":null,
"DivisionName":null,
"LogoId":null,
"AgencyClientId":1173
}
]