JobReady Direct API
API Endpoint
https://subdomain.jobreadydirect.com.auA RESTful API for managing JobReady Direct.
Overview
-
JobReady Direct is a Recruitment Management System for Group Training and Apprenticeship Centres.
-
This RESTful API provides programmatic access to read and write data to JobReady Direct.
Authentication
-
We require applications to authenticate all of their requests with OAuth 2.0 or Application-only authentication.
-
Please contact JobReady.Direct to have an API key allocated.
Tenants
-
JobReady.Direct is a multi-tenant application.
-
It is important to note that the API end points remain the same, it is just the sub domain that changes with tenant
API Support
-
If you have any API related issues/queries, you can lodge a ticket on: https://jobready.zendesk.com
-
If you are a 3rd party developer, please have your JobReady client contact us to authorise your access.
API Pricing
- As the API is an additional module, please contact our Customer Experience Team to help you get started.
API FAQs
JobReady Web Service Access - FAQs
Q1: What is the Tenant name (URL) for Production?
-
The Tenant name URL for production is
https://[tenant_name].jobreadydirect.com.au
-
Each client has a unique tenant name which must be used.
Changelog ¶
All notable changes to this project will be documented in this section.
The format is based on Keep a Changelog
2018-02-12
- HTML Documentation Initialised
2018-03-06
-
Release of HTML Documentation
-
Added Overview
-
Added Candidate Assessments
-
Added Candidate Locations
-
Added Company Locations
2018-03-20
-
Added Candidates
-
Added Companies
-
Added Vacancies
-
Added Company Contacts
2018-04-04
- Fixed an issue in the document under the phones attributes section on a new company POST request.
2018-05-29
-
Moved Candidate & Company locations separately.
-
Added descriptions to Candidate & Company locations.
-
Fixed an issue in the document where the Candidate locations are being retrieved by their location ID’s instead of location_type (e.g. home & postal).
Candidates ¶
Candidates ¶
Headers
Content-Type: application/json
Body
[
{
"candidate": {
"given_name": "Amanda",
"middle_name": "Ann",
"family_name": "Morant",
"site_id": 1,
"site_name": "Default Site",
"email": "[email protected]",
"birth_date": "01/09/1988",
"home_phone_number": "0288000111",
"mobile_phone_number": "0011223399",
"work_phone_number": "0288050000",
"gender": "M",
"salutation": "Mr",
"highest_completed_school_year_level": "8",
"school_finished_date": "01/01/2012",
"date_education_commenced": "01/01/2014",
"date_education_completed": "01/01/2016",
"properties": {
"currently_employed": true,
"non_english_speaking_background": true,
"highest_completed_school_date": "01/03/2013",
"willing_to_travel": true
}
}
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
Headers
Content-Type: application/json
Body
[
{
"candidate": {
"given_name": "Amanda",
"middle_name": "Ann",
"family_name": "Morant",
"site_id": 1,
"site_name": "Default Site",
"email": "[email protected]",
"birth_date": "01/09/1988",
"home_phone_number": "0288000111",
"mobile_phone_number": "0011223399",
"work_phone_number": "0288050000",
"gender": "M",
"salutation": "Mr",
"highest_completed_school_year_level": "8",
"school_finished_date": "01/01/2012",
"date_education_commenced": "01/01/2014",
"date_education_completed": "01/01/2016",
"properties": {
"currently_employed": true,
"non_english_speaking_background": true,
"highest_completed_school_date": "01/03/2013",
"willing_to_travel": true
}
}
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
Headers
Content-Type: application/json
Body
{
"candidate": {
"given_name": "Amanda",
"middle_name": "Ann",
"family_name": "Morant",
"site_id": 1,
"site_name": "Default Site",
"email": "[email protected]",
"birth_date": "01/09/1988",
"home_phone_number": "0288000111",
"mobile_phone_number": "0011223399",
"work_phone_number": "0288050000",
"gender": "M",
"salutation": "Mr",
"highest_completed_school_year_level": "8",
"school_finished_date": "01/01/2012",
"date_education_commenced": "01/01/2014",
"date_education_completed": "01/01/2016",
"properties": {
"currently_employed": true,
"non_english_speaking_background": true,
"highest_completed_school_date": "01/03/2013",
"willing_to_travel": true
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"candidate": {
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First name"
},
"middle_name": {
"type": "string",
"description": "Middle name"
},
"family_name": {
"type": "string",
"description": "Last name"
},
"site_id": {
"type": "number",
"description": "Office id"
},
"site_name": {
"type": "string",
"description": "Office Name"
},
"email": {
"type": "string",
"description": "Email Address"
},
"birth_date": {
"type": "string",
"description": "Date of Birth (dd/mm/YYYY format)"
},
"home_phone_number": {
"type": "string",
"description": "Home Phone Number"
},
"mobile_phone_number": {
"type": "string",
"description": "Mobile Phone Number"
},
"work_phone_number": {
"type": "string",
"description": "Work Phone Number"
},
"gender": {
"type": "string",
"enum": [
"M",
"F",
"X"
],
"description": "Gender"
},
"salutation": {
"type": "string",
"enum": [
"Mr",
"Master",
"Mrs",
"Miss",
"Dr",
"Hon",
"Ms",
"Prof",
"Rev"
],
"description": "Salutation"
},
"highest_completed_school_year_level": {
"type": "string",
"enum": [
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22"
],
"description": "Highest Completed Level of School or Education"
},
"school_finished_date": {
"type": "string",
"description": "The date when the candidate left their school (dd/mm/YYYY format)"
},
"date_education_commenced": {
"type": "string",
"description": "Education Commencement Date (dd/mm/YYYY format)"
},
"date_education_completed": {
"type": "string",
"description": "Education Completed Date (dd/mm/YYYY format)"
},
"properties": {
"type": "object",
"properties": {
"currently_employed": {
"type": "boolean"
},
"non_english_speaking_background": {
"type": "boolean"
},
"highest_completed_school_date": {
"type": "string",
"description": "Should be in (dd/mm/YYYY format)"
},
"willing_to_travel": {
"type": "boolean"
}
},
"description": "Candidate Properties"
}
},
"required": [
"given_name",
"family_name",
"site_id",
"site_name"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"candidate": {
"given_name": "Amanda",
"middle_name": "Ann",
"family_name": "Morant",
"site_id": 1,
"site_name": "Default Site",
"email": "[email protected]",
"birth_date": "01/09/1988",
"home_phone_number": "0288000111",
"mobile_phone_number": "0011223399",
"work_phone_number": "0288050000",
"gender": "M",
"salutation": "Mr",
"highest_completed_school_year_level": "8",
"school_finished_date": "01/01/2012",
"date_education_commenced": "01/01/2014",
"date_education_completed": "01/01/2016",
"properties": {
"currently_employed": true,
"non_english_speaking_background": true,
"highest_completed_school_date": "01/03/2013",
"willing_to_travel": true
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"candidate": {
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First name"
},
"middle_name": {
"type": "string",
"description": "Middle name"
},
"family_name": {
"type": "string",
"description": "Last name"
},
"site_id": {
"type": "number",
"description": "Office id"
},
"site_name": {
"type": "string",
"description": "Office Name"
},
"email": {
"type": "string",
"description": "Email Address"
},
"birth_date": {
"type": "string",
"description": "Date of Birth (dd/mm/YYYY format)"
},
"home_phone_number": {
"type": "string",
"description": "Home Phone Number"
},
"mobile_phone_number": {
"type": "string",
"description": "Mobile Phone Number"
},
"work_phone_number": {
"type": "string",
"description": "Work Phone Number"
},
"gender": {
"type": "string",
"enum": [
"M",
"F",
"X"
],
"description": "Gender"
},
"salutation": {
"type": "string",
"enum": [
"Mr",
"Master",
"Mrs",
"Miss",
"Dr",
"Hon",
"Ms",
"Prof",
"Rev"
],
"description": "Salutation"
},
"highest_completed_school_year_level": {
"type": "string",
"enum": [
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22"
],
"description": "Highest Completed Level of School or Education"
},
"school_finished_date": {
"type": "string",
"description": "The date when the candidate left their school (dd/mm/YYYY format)"
},
"date_education_commenced": {
"type": "string",
"description": "Education Commencement Date (dd/mm/YYYY format)"
},
"date_education_completed": {
"type": "string",
"description": "Education Completed Date (dd/mm/YYYY format)"
},
"properties": {
"type": "object",
"properties": {
"currently_employed": {
"type": "boolean"
},
"non_english_speaking_background": {
"type": "boolean"
},
"highest_completed_school_date": {
"type": "string",
"description": "Should be in (dd/mm/YYYY format)"
},
"willing_to_travel": {
"type": "boolean"
}
},
"description": "Candidate Properties"
}
},
"required": [
"given_name",
"family_name",
"site_id",
"site_name"
]
}
}
}
CreatePOST/api/v1/candidates
Headers
Content-Type: application/json
Body
{
"candidate": {
"given_name": "Amanda",
"middle_name": "Ann",
"family_name": "Morant",
"site_id": 1,
"site_name": "Default Site",
"email": "[email protected]",
"birth_date": "01/09/1988",
"home_phone_number": "0288000111",
"mobile_phone_number": "0011223399",
"work_phone_number": "0288050000",
"gender": "M",
"salutation": "Mr",
"highest_completed_school_year_level": "8",
"school_finished_date": "01/01/2012",
"date_education_commenced": "01/01/2014",
"date_education_completed": "01/01/2016",
"properties": {
"currently_employed": true,
"non_english_speaking_background": true,
"highest_completed_school_date": "01/03/2013",
"willing_to_travel": true
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"candidate": {
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First name"
},
"middle_name": {
"type": "string",
"description": "Middle name"
},
"family_name": {
"type": "string",
"description": "Last name"
},
"site_id": {
"type": "number",
"description": "Office id"
},
"site_name": {
"type": "string",
"description": "Office Name"
},
"email": {
"type": "string",
"description": "Email Address"
},
"birth_date": {
"type": "string",
"description": "Date of Birth (dd/mm/YYYY format)"
},
"home_phone_number": {
"type": "string",
"description": "Home Phone Number"
},
"mobile_phone_number": {
"type": "string",
"description": "Mobile Phone Number"
},
"work_phone_number": {
"type": "string",
"description": "Work Phone Number"
},
"gender": {
"type": "string",
"enum": [
"M",
"F",
"X"
],
"description": "Gender"
},
"salutation": {
"type": "string",
"enum": [
"Mr",
"Master",
"Mrs",
"Miss",
"Dr",
"Hon",
"Ms",
"Prof",
"Rev"
],
"description": "Salutation"
},
"highest_completed_school_year_level": {
"type": "string",
"enum": [
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22"
],
"description": "Highest Completed Level of School or Education"
},
"school_finished_date": {
"type": "string",
"description": "The date when the candidate left their school (dd/mm/YYYY format)"
},
"date_education_commenced": {
"type": "string",
"description": "Education Commencement Date (dd/mm/YYYY format)"
},
"date_education_completed": {
"type": "string",
"description": "Education Completed Date (dd/mm/YYYY format)"
},
"properties": {
"type": "object",
"properties": {
"currently_employed": {
"type": "boolean"
},
"non_english_speaking_background": {
"type": "boolean"
},
"highest_completed_school_date": {
"type": "string",
"description": "Should be in (dd/mm/YYYY format)"
},
"willing_to_travel": {
"type": "boolean"
}
},
"description": "Candidate Properties"
}
},
"required": [
"given_name",
"family_name",
"site_id",
"site_name"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"candidate": {
"given_name": "Amanda",
"middle_name": "Ann",
"family_name": "Morant",
"site_id": 1,
"site_name": "Default Site",
"email": "[email protected]",
"birth_date": "01/09/1988",
"home_phone_number": "0288000111",
"mobile_phone_number": "0011223399",
"work_phone_number": "0288050000",
"gender": "M",
"salutation": "Mr",
"highest_completed_school_year_level": "8",
"school_finished_date": "01/01/2012",
"date_education_commenced": "01/01/2014",
"date_education_completed": "01/01/2016",
"properties": {
"currently_employed": true,
"non_english_speaking_background": true,
"highest_completed_school_date": "01/03/2013",
"willing_to_travel": true
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"candidate": {
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First name"
},
"middle_name": {
"type": "string",
"description": "Middle name"
},
"family_name": {
"type": "string",
"description": "Last name"
},
"site_id": {
"type": "number",
"description": "Office id"
},
"site_name": {
"type": "string",
"description": "Office Name"
},
"email": {
"type": "string",
"description": "Email Address"
},
"birth_date": {
"type": "string",
"description": "Date of Birth (dd/mm/YYYY format)"
},
"home_phone_number": {
"type": "string",
"description": "Home Phone Number"
},
"mobile_phone_number": {
"type": "string",
"description": "Mobile Phone Number"
},
"work_phone_number": {
"type": "string",
"description": "Work Phone Number"
},
"gender": {
"type": "string",
"enum": [
"M",
"F",
"X"
],
"description": "Gender"
},
"salutation": {
"type": "string",
"enum": [
"Mr",
"Master",
"Mrs",
"Miss",
"Dr",
"Hon",
"Ms",
"Prof",
"Rev"
],
"description": "Salutation"
},
"highest_completed_school_year_level": {
"type": "string",
"enum": [
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22"
],
"description": "Highest Completed Level of School or Education"
},
"school_finished_date": {
"type": "string",
"description": "The date when the candidate left their school (dd/mm/YYYY format)"
},
"date_education_commenced": {
"type": "string",
"description": "Education Commencement Date (dd/mm/YYYY format)"
},
"date_education_completed": {
"type": "string",
"description": "Education Completed Date (dd/mm/YYYY format)"
},
"properties": {
"type": "object",
"properties": {
"currently_employed": {
"type": "boolean"
},
"non_english_speaking_background": {
"type": "boolean"
},
"highest_completed_school_date": {
"type": "string",
"description": "Should be in (dd/mm/YYYY format)"
},
"willing_to_travel": {
"type": "boolean"
}
},
"description": "Candidate Properties"
}
},
"required": [
"given_name",
"family_name",
"site_id",
"site_name"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"candidate": {
"given_name": "Amanda",
"middle_name": "Ann",
"family_name": "Morant",
"site_id": 1,
"site_name": "Default Site",
"email": "[email protected]",
"birth_date": "01/09/1988",
"home_phone_number": "0288000111",
"mobile_phone_number": "0011223399",
"work_phone_number": "0288050000",
"gender": "M",
"salutation": "Mr",
"highest_completed_school_year_level": "8",
"school_finished_date": "01/01/2012",
"date_education_commenced": "01/01/2014",
"date_education_completed": "01/01/2016",
"properties": {
"currently_employed": true,
"non_english_speaking_background": true,
"highest_completed_school_date": "01/03/2013",
"willing_to_travel": true
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"candidate": {
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First name"
},
"middle_name": {
"type": "string",
"description": "Middle name"
},
"family_name": {
"type": "string",
"description": "Last name"
},
"site_id": {
"type": "number",
"description": "Office id"
},
"site_name": {
"type": "string",
"description": "Office Name"
},
"email": {
"type": "string",
"description": "Email Address"
},
"birth_date": {
"type": "string",
"description": "Date of Birth (dd/mm/YYYY format)"
},
"home_phone_number": {
"type": "string",
"description": "Home Phone Number"
},
"mobile_phone_number": {
"type": "string",
"description": "Mobile Phone Number"
},
"work_phone_number": {
"type": "string",
"description": "Work Phone Number"
},
"gender": {
"type": "string",
"enum": [
"M",
"F",
"X"
],
"description": "Gender"
},
"salutation": {
"type": "string",
"enum": [
"Mr",
"Master",
"Mrs",
"Miss",
"Dr",
"Hon",
"Ms",
"Prof",
"Rev"
],
"description": "Salutation"
},
"highest_completed_school_year_level": {
"type": "string",
"enum": [
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22"
],
"description": "Highest Completed Level of School or Education"
},
"school_finished_date": {
"type": "string",
"description": "The date when the candidate left their school (dd/mm/YYYY format)"
},
"date_education_commenced": {
"type": "string",
"description": "Education Commencement Date (dd/mm/YYYY format)"
},
"date_education_completed": {
"type": "string",
"description": "Education Completed Date (dd/mm/YYYY format)"
},
"properties": {
"type": "object",
"properties": {
"currently_employed": {
"type": "boolean"
},
"non_english_speaking_background": {
"type": "boolean"
},
"highest_completed_school_date": {
"type": "string",
"description": "Should be in (dd/mm/YYYY format)"
},
"willing_to_travel": {
"type": "boolean"
}
},
"description": "Candidate Properties"
}
},
"required": [
"given_name",
"family_name",
"site_id",
"site_name"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"candidate": {
"given_name": "Amanda",
"middle_name": "Ann",
"family_name": "Morant",
"site_id": 1,
"site_name": "Default Site",
"email": "[email protected]",
"birth_date": "01/09/1988",
"home_phone_number": "0288000111",
"mobile_phone_number": "0011223399",
"work_phone_number": "0288050000",
"gender": "M",
"salutation": "Mr",
"highest_completed_school_year_level": "8",
"school_finished_date": "01/01/2012",
"date_education_commenced": "01/01/2014",
"date_education_completed": "01/01/2016",
"properties": {
"currently_employed": true,
"non_english_speaking_background": true,
"highest_completed_school_date": "01/03/2013",
"willing_to_travel": true
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"candidate": {
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First name"
},
"middle_name": {
"type": "string",
"description": "Middle name"
},
"family_name": {
"type": "string",
"description": "Last name"
},
"site_id": {
"type": "number",
"description": "Office id"
},
"site_name": {
"type": "string",
"description": "Office Name"
},
"email": {
"type": "string",
"description": "Email Address"
},
"birth_date": {
"type": "string",
"description": "Date of Birth (dd/mm/YYYY format)"
},
"home_phone_number": {
"type": "string",
"description": "Home Phone Number"
},
"mobile_phone_number": {
"type": "string",
"description": "Mobile Phone Number"
},
"work_phone_number": {
"type": "string",
"description": "Work Phone Number"
},
"gender": {
"type": "string",
"enum": [
"M",
"F",
"X"
],
"description": "Gender"
},
"salutation": {
"type": "string",
"enum": [
"Mr",
"Master",
"Mrs",
"Miss",
"Dr",
"Hon",
"Ms",
"Prof",
"Rev"
],
"description": "Salutation"
},
"highest_completed_school_year_level": {
"type": "string",
"enum": [
"8",
"9",
"10",
"11",
"12",
"13",
"14",
"15",
"16",
"17",
"18",
"19",
"20",
"21",
"22"
],
"description": "Highest Completed Level of School or Education"
},
"school_finished_date": {
"type": "string",
"description": "The date when the candidate left their school (dd/mm/YYYY format)"
},
"date_education_commenced": {
"type": "string",
"description": "Education Commencement Date (dd/mm/YYYY format)"
},
"date_education_completed": {
"type": "string",
"description": "Education Completed Date (dd/mm/YYYY format)"
},
"properties": {
"type": "object",
"properties": {
"currently_employed": {
"type": "boolean"
},
"non_english_speaking_background": {
"type": "boolean"
},
"highest_completed_school_date": {
"type": "string",
"description": "Should be in (dd/mm/YYYY format)"
},
"willing_to_travel": {
"type": "boolean"
}
},
"description": "Candidate Properties"
}
},
"required": [
"given_name",
"family_name",
"site_id",
"site_name"
]
}
}
}
Candidate Locations ¶
Candidate Locations ¶
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": 1,
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "number",
"enum": [
1,
2
],
"description": "Location Types (1: postal, 2: home)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": 1,
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "number",
"enum": [
1,
2
],
"description": "Location Types (1: postal, 2: home)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
RetrieveGET/api/v1/candidates/{candidate_id}/locations/{location_type}
Description
This request will retrieve a location of the {candidate_id} by passing a {location_type}
Candidate Location Types:
- home
- postal
- candidate_id
string
(required) Example: 241- location_type
string
(required) Example: postal
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": 1,
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "number",
"enum": [
1,
2
],
"description": "Location Types (1: postal, 2: home)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": 1,
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "number",
"enum": [
1,
2
],
"description": "Location Types (1: postal, 2: home)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
CreatePOST/api/v1/candidates/{candidate_id}/locations
Description
This request will create a location of the {candidate_id} by passing a "location_type" in JSON format.
Candidate Location Types:
[1, ‘Postal Address’]
[2, ‘Home Address’]
- candidate_id
string
(required) Example: 241
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": 1,
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "number",
"enum": [
1,
2
],
"description": "Location Types (1: postal, 2: home)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": 1,
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "number",
"enum": [
1,
2
],
"description": "Location Types (1: postal, 2: home)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
UpdatePATCH/api/v1/candidates/{candidate_id}/locations/{location_type}
Description
This request will update a location of the {candidate_id} by passing a {location_type}
Candidate Location Types:
- home
- postal
- candidate_id
string
(required) Example: 5411- location_type
string
(required) Example: postal
Candidate Assessments ¶
Candidate Assessments ¶
Headers
Content-Type: application/json
Body
{
"name": "Pre-Employment Assessment for General Apprentice",
"completed_date": "2018-02-16T00:00:00.000Z",
"category_a": "80%",
"category_b": "70%",
"category_c": "76%",
"grade": 75
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Assessment Name"
},
"completed_date": {
"type": "string",
"description": "Completion Date (An ISO8601 date time format)"
},
"category_a": {
"type": "string",
"description": "Category A score"
},
"category_b": {
"type": "string",
"description": "Category B score"
},
"category_c": {
"type": "string",
"description": "Category C score"
},
"grade": {
"type": "number",
"description": "Grade Percentage score"
}
}
}
Headers
Content-Type: application/json
Body
{
"name": "Pre-Employment Assessment for General Apprentice",
"completed_date": "2018-02-16T00:00:00.000Z",
"category_a": "80%",
"category_b": "70%",
"category_c": "76%",
"grade": 75
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Assessment Name"
},
"completed_date": {
"type": "string",
"description": "Completion Date (An ISO8601 date time format)"
},
"category_a": {
"type": "string",
"description": "Category A score"
},
"category_b": {
"type": "string",
"description": "Category B score"
},
"category_c": {
"type": "string",
"description": "Category C score"
},
"grade": {
"type": "number",
"description": "Grade Percentage score"
}
}
}
CreatePOST/api/v1/candidates/{candidate_id}/assessments/
- candidate_id
string
(required) Example: 123
Headers
Content-Type: application/json
Body
{
"name": "Pre-Employment Assessment for General Apprentice",
"completed_date": "2018-02-16T00:00:00.000Z",
"category_a": "80%",
"category_b": "70%",
"category_c": "76%",
"grade": 75
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Assessment Name"
},
"completed_date": {
"type": "string",
"description": "Completion Date (An ISO8601 date time format)"
},
"category_a": {
"type": "string",
"description": "Category A score"
},
"category_b": {
"type": "string",
"description": "Category B score"
},
"category_c": {
"type": "string",
"description": "Category C score"
},
"grade": {
"type": "number",
"description": "Grade Percentage score"
}
}
}
Headers
Content-Type: application/json
Body
{
"name": "Pre-Employment Assessment for General Apprentice",
"completed_date": "2018-02-16T00:00:00.000Z",
"category_a": "80%",
"category_b": "70%",
"category_c": "76%",
"grade": 75
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Assessment Name"
},
"completed_date": {
"type": "string",
"description": "Completion Date (An ISO8601 date time format)"
},
"category_a": {
"type": "string",
"description": "Category A score"
},
"category_b": {
"type": "string",
"description": "Category B score"
},
"category_c": {
"type": "string",
"description": "Category C score"
},
"grade": {
"type": "number",
"description": "Grade Percentage score"
}
}
}
UpdatePATCH/api/v1/candidates/{candidate_id}/assessments/{assessment_id}
- candidate_id
string
(required) Example: 123- assessment_id
string
(required) Example: 11
Candidate Preferred Trades ¶
List All ¶
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Body
[
{
"id": "25",
"name": "Aged Care",
"enabled": "true"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
List AllGET/api/v1/candidates/{candidate_id}/preferred_trades
- candidate_id
string
(required) Example: 214
Create ¶
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Body
[
{
"id": "25",
"name": "Aged Care",
"enabled": "true"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
CreatePOST/api/v1/candidates/{candidate_id}/add_trade?trade_id={trade_id}
- candidate_id
string
(required) Example: 214- trade_id
string
(required) Example: 25Note: Grab the trade id from the URL (https://[tenant_name].jobreadydirect.com.au/admin/trades) in the system
Delete ¶
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Body
[
{
"id": "25",
"name": "Aged Care",
"enabled": "true"
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
DeleteDELETE/api/v1/candidates/{candidate_id}/remove_trade?trade_id={trade_id}
- candidate_id
string
(required) Example: 214- trade_id
string
(required) Example: 25Note: Grab the trade id from the URL (https://[tenant_name].jobreadydirect.com.au/admin/trades) in the system
Companies ¶
Companies ¶
Headers
Content-Type: application/json
Body
[
{
"company": {
"legal_name": "Pet Tech Pty Ltd",
"trading_name": "JobReady Solutions Pty Ltd",
"abn": "12345678908",
"contact_attributes": {
"given_name": "John",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones_attributes": {
"0": {
"phone_number": "0411223399",
"phone_type": "1"
}
}
},
"head_office_attributes": {
"short_name": "Head Office",
"address_street1": "84 Alexander Street",
"suburb_id": 396
}
}
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
Headers
Content-Type: application/json
Body
[
{
"company": {
"legal_name": "Pet Tech Pty Ltd",
"trading_name": "JobReady Solutions Pty Ltd",
"abn": "12345678908",
"contact_attributes": {
"given_name": "John",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones_attributes": {
"0": {
"phone_number": "0411223399",
"phone_type": "1"
}
}
},
"head_office_attributes": {
"short_name": "Head Office",
"address_street1": "84 Alexander Street",
"suburb_id": 396
}
}
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
Headers
Content-Type: application/json
Body
{
"company": {
"legal_name": "Pet Tech Pty Ltd",
"trading_name": "JobReady Solutions Pty Ltd",
"abn": "12345678908",
"contact_attributes": {
"given_name": "John",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones_attributes": {
"0": {
"phone_number": "0411223399",
"phone_type": "1"
}
}
},
"head_office_attributes": {
"short_name": "Head Office",
"address_street1": "84 Alexander Street",
"suburb_id": 396
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"legal_name": {
"type": "string",
"description": "Legal Name"
},
"trading_name": {
"type": "string",
"description": "Trading Name"
},
"abn": {
"type": "string",
"description": "ABN Number"
},
"contact_attributes": {
"type": "object",
"properties": {
"given_name": {
"type": "string"
},
"family_name": {
"type": "string"
},
"email": {
"type": "string"
},
"position": {
"type": "string"
},
"phones_attributes": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"description": "Phone Number"
},
"phone_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Phone Types"
}
},
"required": [
"phone_number",
"phone_type"
]
}
}
}
},
"required": [
"given_name",
"family_name",
"phones_attributes"
]
},
"head_office_attributes": {
"type": "object",
"properties": {
"short_name": {
"type": "string"
},
"address_street1": {
"type": "string"
},
"suburb_id": {
"type": "number"
}
},
"required": [
"address_street1",
"suburb_id"
]
}
},
"required": [
"legal_name"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"company": {
"legal_name": "Pet Tech Pty Ltd",
"trading_name": "JobReady Solutions Pty Ltd",
"abn": "12345678908",
"contact_attributes": {
"given_name": "John",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones_attributes": {
"0": {
"phone_number": "0411223399",
"phone_type": "1"
}
}
},
"head_office_attributes": {
"short_name": "Head Office",
"address_street1": "84 Alexander Street",
"suburb_id": 396
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"legal_name": {
"type": "string",
"description": "Legal Name"
},
"trading_name": {
"type": "string",
"description": "Trading Name"
},
"abn": {
"type": "string",
"description": "ABN Number"
},
"contact_attributes": {
"type": "object",
"properties": {
"given_name": {
"type": "string"
},
"family_name": {
"type": "string"
},
"email": {
"type": "string"
},
"position": {
"type": "string"
},
"phones_attributes": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"description": "Phone Number"
},
"phone_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Phone Types"
}
},
"required": [
"phone_number",
"phone_type"
]
}
}
}
},
"required": [
"given_name",
"family_name",
"phones_attributes"
]
},
"head_office_attributes": {
"type": "object",
"properties": {
"short_name": {
"type": "string"
},
"address_street1": {
"type": "string"
},
"suburb_id": {
"type": "number"
}
},
"required": [
"address_street1",
"suburb_id"
]
}
},
"required": [
"legal_name"
]
}
}
}
CreatePOST/api/v1/companies
Headers
Content-Type: application/json
Body
{
"company": {
"legal_name": "Pet Tech Pty Ltd",
"trading_name": "JobReady Solutions Pty Ltd",
"abn": "12345678908",
"contact_attributes": {
"given_name": "John",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones_attributes": {
"0": {
"phone_number": "0411223399",
"phone_type": "1"
}
}
},
"head_office_attributes": {
"short_name": "Head Office",
"address_street1": "84 Alexander Street",
"suburb_id": 396
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"legal_name": {
"type": "string",
"description": "Legal Name"
},
"trading_name": {
"type": "string",
"description": "Trading Name"
},
"abn": {
"type": "string",
"description": "ABN Number"
},
"contact_attributes": {
"type": "object",
"properties": {
"given_name": {
"type": "string"
},
"family_name": {
"type": "string"
},
"email": {
"type": "string"
},
"position": {
"type": "string"
},
"phones_attributes": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"description": "Phone Number"
},
"phone_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Phone Types"
}
},
"required": [
"phone_number",
"phone_type"
]
}
}
}
},
"required": [
"given_name",
"family_name",
"phones_attributes"
]
},
"head_office_attributes": {
"type": "object",
"properties": {
"short_name": {
"type": "string"
},
"address_street1": {
"type": "string"
},
"suburb_id": {
"type": "number"
}
},
"required": [
"address_street1",
"suburb_id"
]
}
},
"required": [
"legal_name"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"company": {
"legal_name": "Pet Tech Pty Ltd",
"trading_name": "JobReady Solutions Pty Ltd",
"abn": "12345678908",
"contact_attributes": {
"given_name": "John",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones_attributes": {
"0": {
"phone_number": "0411223399",
"phone_type": "1"
}
}
},
"head_office_attributes": {
"short_name": "Head Office",
"address_street1": "84 Alexander Street",
"suburb_id": 396
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"legal_name": {
"type": "string",
"description": "Legal Name"
},
"trading_name": {
"type": "string",
"description": "Trading Name"
},
"abn": {
"type": "string",
"description": "ABN Number"
},
"contact_attributes": {
"type": "object",
"properties": {
"given_name": {
"type": "string"
},
"family_name": {
"type": "string"
},
"email": {
"type": "string"
},
"position": {
"type": "string"
},
"phones_attributes": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"description": "Phone Number"
},
"phone_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Phone Types"
}
},
"required": [
"phone_number",
"phone_type"
]
}
}
}
},
"required": [
"given_name",
"family_name",
"phones_attributes"
]
},
"head_office_attributes": {
"type": "object",
"properties": {
"short_name": {
"type": "string"
},
"address_street1": {
"type": "string"
},
"suburb_id": {
"type": "number"
}
},
"required": [
"address_street1",
"suburb_id"
]
}
},
"required": [
"legal_name"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"company": {
"legal_name": "Pet Tech Pty Ltd",
"trading_name": "JobReady Solutions Pty Ltd",
"abn": "12345678908",
"contact_attributes": {
"given_name": "John",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones_attributes": {
"0": {
"phone_number": "0411223399",
"phone_type": "1"
}
}
},
"head_office_attributes": {
"short_name": "Head Office",
"address_street1": "84 Alexander Street",
"suburb_id": 396
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"legal_name": {
"type": "string",
"description": "Legal Name"
},
"trading_name": {
"type": "string",
"description": "Trading Name"
},
"abn": {
"type": "string",
"description": "ABN Number"
},
"contact_attributes": {
"type": "object",
"properties": {
"given_name": {
"type": "string"
},
"family_name": {
"type": "string"
},
"email": {
"type": "string"
},
"position": {
"type": "string"
},
"phones_attributes": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"description": "Phone Number"
},
"phone_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Phone Types"
}
},
"required": [
"phone_number",
"phone_type"
]
}
}
}
},
"required": [
"given_name",
"family_name",
"phones_attributes"
]
},
"head_office_attributes": {
"type": "object",
"properties": {
"short_name": {
"type": "string"
},
"address_street1": {
"type": "string"
},
"suburb_id": {
"type": "number"
}
},
"required": [
"address_street1",
"suburb_id"
]
}
},
"required": [
"legal_name"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"company": {
"legal_name": "Pet Tech Pty Ltd",
"trading_name": "JobReady Solutions Pty Ltd",
"abn": "12345678908",
"contact_attributes": {
"given_name": "John",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones_attributes": {
"0": {
"phone_number": "0411223399",
"phone_type": "1"
}
}
},
"head_office_attributes": {
"short_name": "Head Office",
"address_street1": "84 Alexander Street",
"suburb_id": 396
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"company": {
"type": "object",
"properties": {
"legal_name": {
"type": "string",
"description": "Legal Name"
},
"trading_name": {
"type": "string",
"description": "Trading Name"
},
"abn": {
"type": "string",
"description": "ABN Number"
},
"contact_attributes": {
"type": "object",
"properties": {
"given_name": {
"type": "string"
},
"family_name": {
"type": "string"
},
"email": {
"type": "string"
},
"position": {
"type": "string"
},
"phones_attributes": {
"type": "object",
"properties": {
"0": {
"type": "object",
"properties": {
"phone_number": {
"type": "string",
"description": "Phone Number"
},
"phone_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Phone Types"
}
},
"required": [
"phone_number",
"phone_type"
]
}
}
}
},
"required": [
"given_name",
"family_name",
"phones_attributes"
]
},
"head_office_attributes": {
"type": "object",
"properties": {
"short_name": {
"type": "string"
},
"address_street1": {
"type": "string"
},
"suburb_id": {
"type": "number"
}
},
"required": [
"address_street1",
"suburb_id"
]
}
},
"required": [
"legal_name"
]
}
}
}
Company Contacts ¶
Contacts ¶
Headers
Content-Type: application/json
Body
[
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
Headers
Content-Type: application/json
Body
[
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
List AllGET/api/v1/companies/{company_id}/contacts
- company_id
string
(required) Example: 123
Headers
Content-Type: application/json
Body
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First Name"
},
"middle_name": {
"type": "string",
"description": "Middle Name"
},
"family_name": {
"type": "string",
"description": "Surname"
},
"email": {
"type": "string",
"description": "Email Address"
},
"position": {
"type": "string",
"description": "Position"
},
"phones": {
"type": "array"
}
},
"required": [
"given_name",
"family_name",
"email",
"phones"
]
}
Headers
Content-Type: application/json
Body
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First Name"
},
"middle_name": {
"type": "string",
"description": "Middle Name"
},
"family_name": {
"type": "string",
"description": "Surname"
},
"email": {
"type": "string",
"description": "Email Address"
},
"position": {
"type": "string",
"description": "Position"
},
"phones": {
"type": "array"
}
},
"required": [
"given_name",
"family_name",
"email",
"phones"
]
}
CreatePOST/api/v1/companies/{company_id}/contacts
- company_id
string
(required) Example: 123
Headers
Content-Type: application/json
Body
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First Name"
},
"middle_name": {
"type": "string",
"description": "Middle Name"
},
"family_name": {
"type": "string",
"description": "Surname"
},
"email": {
"type": "string",
"description": "Email Address"
},
"position": {
"type": "string",
"description": "Position"
},
"phones": {
"type": "array"
}
},
"required": [
"given_name",
"family_name",
"email",
"phones"
]
}
Headers
Content-Type: application/json
Body
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First Name"
},
"middle_name": {
"type": "string",
"description": "Middle Name"
},
"family_name": {
"type": "string",
"description": "Surname"
},
"email": {
"type": "string",
"description": "Email Address"
},
"position": {
"type": "string",
"description": "Position"
},
"phones": {
"type": "array"
}
},
"required": [
"given_name",
"family_name",
"email",
"phones"
]
}
RetrieveGET/api/v1/companies/{company_id}/contacts/{contact_id}
- company_id
string
(required) Example: 123- contact_id
string
(required) Example: 3
Headers
Content-Type: application/json
Body
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First Name"
},
"middle_name": {
"type": "string",
"description": "Middle Name"
},
"family_name": {
"type": "string",
"description": "Surname"
},
"email": {
"type": "string",
"description": "Email Address"
},
"position": {
"type": "string",
"description": "Position"
},
"phones": {
"type": "array"
}
},
"required": [
"given_name",
"family_name",
"email",
"phones"
]
}
Headers
Content-Type: application/json
Body
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First Name"
},
"middle_name": {
"type": "string",
"description": "Middle Name"
},
"family_name": {
"type": "string",
"description": "Surname"
},
"email": {
"type": "string",
"description": "Email Address"
},
"position": {
"type": "string",
"description": "Position"
},
"phones": {
"type": "array"
}
},
"required": [
"given_name",
"family_name",
"email",
"phones"
]
}
UpdatePATCH/api/v1/companies/{company_id}/contacts/{contact_id}
- company_id
string
(required) Example: 123- contact_id
string
(required) Example: 3
Headers
Content-Type: application/json
Body
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First Name"
},
"middle_name": {
"type": "string",
"description": "Middle Name"
},
"family_name": {
"type": "string",
"description": "Surname"
},
"email": {
"type": "string",
"description": "Email Address"
},
"position": {
"type": "string",
"description": "Position"
},
"phones": {
"type": "array"
}
},
"required": [
"given_name",
"family_name",
"email",
"phones"
]
}
Headers
Content-Type: application/json
Body
{
"given_name": "John",
"middle_name": "Craig",
"family_name": "Smith",
"email": "[email protected]",
"position": "HR Manager",
"phones": [
{
"phone_number": "0411223399",
"phone_type": "1"
}
]
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"given_name": {
"type": "string",
"description": "First Name"
},
"middle_name": {
"type": "string",
"description": "Middle Name"
},
"family_name": {
"type": "string",
"description": "Surname"
},
"email": {
"type": "string",
"description": "Email Address"
},
"position": {
"type": "string",
"description": "Position"
},
"phones": {
"type": "array"
}
},
"required": [
"given_name",
"family_name",
"email",
"phones"
]
}
DeleteDELETE/api/v1/companies/{company_id}/locations/{contact_id}
Note
The last remaining company contact cannot be deleted.
- company_id
string
(required) Example: 123- contact_id
string
(required) Example: 3
Company Locations ¶
Company Locations ¶
Headers
Content-Type: application/json
Body
[
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
Headers
Content-Type: application/json
Body
[
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
]
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "array"
}
List AllGET/api/v1/companies/{company_id}/locations
Description
This request will retrieve (list all) the available locations of the {company_id}
Example:
Head Office
Postal Address
Work Site etc.
- company_id
string
(required) Example: 5411
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
CreatePOST/api/v1/companies/{company_id}/locations
Description
This request will create a company location for the {company_id} by passing a "location_type" in JSON format.
Company Location Types:
[1, ‘Postal Address’]
[2, ‘Home Address’]
[3, ‘Head Office’]
[4, ‘Work Site’]
[5, ‘Training Facility’]
- company_id
string
(required) Example: 5411
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
RetrieveGET/api/v1/companies/{company_id}/locations/{location_id}
Description
This request will retrieve a location of the {company_id} by passing a {location_id}
Note: You can find the {location_id} of a particular company by hovering the mouse pointer on the edit button under the locations tab.
- company_id
string
(required) Example: 5411- location_id
string
(required) Example: 354
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
UpdatePATCH/api/v1/companies/{company_id}/locations/{location_id}
Description
The updated location details can be sent through this request
Note: You can find the {location_id} of a particular company by hovering the mouse pointer on the edit button under the locations tab.
- company_id
string
(required) Example: 5411- location_id
string
(required) Example: 354
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
DeleteDELETE/api/v1/companies/{company_id}/locations/{location_id}
Note
The last remaining company location or any location associated with a vacancy cannot be deleted.
- company_id
string
(required) Example: 5411- location_id
string
(required) Example: 354
Vacancies ¶
Vacancies ¶
Headers
Content-Type: application/json
Body
{
"vacancy": {
"company_id": 12,
"contact_id": 4,
"job_title": "Motor Mechanic",
"closing_date": "2019-01-24T00:00:00+00:00Z",
"opening_date": "2017-03-06T00:00:00+00:00Z",
"brief_job_description": "Maintenance works",
"job_description": "Preventive maintenance such as, engine tune-ups, oil changes, wheel balancing, replacing filters",
"hours_per_week": "38.0",
"trade_id": 34,
"positions_available": "12",
"status": "Pending",
"properties": {
"own_car_required": true,
"license_required": true,
"blue_card_required": true,
"preferred_rto": "RTO Name",
"police_check_required": true
},
"location": {
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"vacancy": {
"type": "object",
"properties": {
"company_id": {
"type": "number",
"description": "Company ID"
},
"contact_id": {
"type": "number",
"description": "Contact ID"
},
"job_title": {
"type": "string",
"description": "Job Title"
},
"closing_date": {
"type": "string",
"description": "Closing Date (An ISO8601 date time format)"
},
"opening_date": {
"type": "string",
"description": "Opening Date (An ISO8601 date time format)"
},
"brief_job_description": {
"type": "string",
"description": "Brief Job Description"
},
"job_description": {
"type": "string",
"description": "Job Description"
},
"hours_per_week": {
"type": "string",
"description": "Number of working hours per week"
},
"trade_id": {
"type": "number",
"description": "Grab the trade id from the URL (https://[tenant_name].jobreadydirect.com.au/admin/trades) in the system"
},
"positions_available": {
"type": "string",
"description": "Available Positions"
},
"status": {
"type": "string",
"enum": [
"Pending",
"Open",
"On Hold",
"Filled",
"Withdrawn",
"On Trail",
"Closed"
],
"description": "Vacancy Status"
},
"properties": {
"type": "object",
"properties": {
"own_car_required": {
"type": "boolean"
},
"license_required": {
"type": "boolean"
},
"blue_card_required": {
"type": "boolean"
},
"preferred_rto": {
"type": "string"
},
"police_check_required": {
"type": "boolean"
}
},
"description": "Vacancy Properties"
},
"location": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
},
"required": [
"company_id",
"contact_id",
"job_title",
"positions_available",
"status"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"vacancy": {
"company_id": 12,
"contact_id": 4,
"job_title": "Motor Mechanic",
"closing_date": "2019-01-24T00:00:00+00:00Z",
"opening_date": "2017-03-06T00:00:00+00:00Z",
"brief_job_description": "Maintenance works",
"job_description": "Preventive maintenance such as, engine tune-ups, oil changes, wheel balancing, replacing filters",
"hours_per_week": "38.0",
"trade_id": 34,
"positions_available": "12",
"status": "Pending",
"properties": {
"own_car_required": true,
"license_required": true,
"blue_card_required": true,
"preferred_rto": "RTO Name",
"police_check_required": true
},
"location": {
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"vacancy": {
"type": "object",
"properties": {
"company_id": {
"type": "number",
"description": "Company ID"
},
"contact_id": {
"type": "number",
"description": "Contact ID"
},
"job_title": {
"type": "string",
"description": "Job Title"
},
"closing_date": {
"type": "string",
"description": "Closing Date (An ISO8601 date time format)"
},
"opening_date": {
"type": "string",
"description": "Opening Date (An ISO8601 date time format)"
},
"brief_job_description": {
"type": "string",
"description": "Brief Job Description"
},
"job_description": {
"type": "string",
"description": "Job Description"
},
"hours_per_week": {
"type": "string",
"description": "Number of working hours per week"
},
"trade_id": {
"type": "number",
"description": "Grab the trade id from the URL (https://[tenant_name].jobreadydirect.com.au/admin/trades) in the system"
},
"positions_available": {
"type": "string",
"description": "Available Positions"
},
"status": {
"type": "string",
"enum": [
"Pending",
"Open",
"On Hold",
"Filled",
"Withdrawn",
"On Trail",
"Closed"
],
"description": "Vacancy Status"
},
"properties": {
"type": "object",
"properties": {
"own_car_required": {
"type": "boolean"
},
"license_required": {
"type": "boolean"
},
"blue_card_required": {
"type": "boolean"
},
"preferred_rto": {
"type": "string"
},
"police_check_required": {
"type": "boolean"
}
},
"description": "Vacancy Properties"
},
"location": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
},
"required": [
"company_id",
"contact_id",
"job_title",
"positions_available",
"status"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"vacancy": {
"company_id": 12,
"contact_id": 4,
"job_title": "Motor Mechanic",
"closing_date": "2019-01-24T00:00:00+00:00Z",
"opening_date": "2017-03-06T00:00:00+00:00Z",
"brief_job_description": "Maintenance works",
"job_description": "Preventive maintenance such as, engine tune-ups, oil changes, wheel balancing, replacing filters",
"hours_per_week": "38.0",
"trade_id": 34,
"positions_available": "12",
"status": "Pending",
"properties": {
"own_car_required": true,
"license_required": true,
"blue_card_required": true,
"preferred_rto": "RTO Name",
"police_check_required": true
},
"location": {
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"vacancy": {
"type": "object",
"properties": {
"company_id": {
"type": "number",
"description": "Company ID"
},
"contact_id": {
"type": "number",
"description": "Contact ID"
},
"job_title": {
"type": "string",
"description": "Job Title"
},
"closing_date": {
"type": "string",
"description": "Closing Date (An ISO8601 date time format)"
},
"opening_date": {
"type": "string",
"description": "Opening Date (An ISO8601 date time format)"
},
"brief_job_description": {
"type": "string",
"description": "Brief Job Description"
},
"job_description": {
"type": "string",
"description": "Job Description"
},
"hours_per_week": {
"type": "string",
"description": "Number of working hours per week"
},
"trade_id": {
"type": "number",
"description": "Grab the trade id from the URL (https://[tenant_name].jobreadydirect.com.au/admin/trades) in the system"
},
"positions_available": {
"type": "string",
"description": "Available Positions"
},
"status": {
"type": "string",
"enum": [
"Pending",
"Open",
"On Hold",
"Filled",
"Withdrawn",
"On Trail",
"Closed"
],
"description": "Vacancy Status"
},
"properties": {
"type": "object",
"properties": {
"own_car_required": {
"type": "boolean"
},
"license_required": {
"type": "boolean"
},
"blue_card_required": {
"type": "boolean"
},
"preferred_rto": {
"type": "string"
},
"police_check_required": {
"type": "boolean"
}
},
"description": "Vacancy Properties"
},
"location": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
},
"required": [
"company_id",
"contact_id",
"job_title",
"positions_available",
"status"
]
}
}
}
Headers
Content-Type: application/json
Body
{
"vacancy": {
"company_id": 12,
"contact_id": 4,
"job_title": "Motor Mechanic",
"closing_date": "2019-01-24T00:00:00+00:00Z",
"opening_date": "2017-03-06T00:00:00+00:00Z",
"brief_job_description": "Maintenance works",
"job_description": "Preventive maintenance such as, engine tune-ups, oil changes, wheel balancing, replacing filters",
"hours_per_week": "38.0",
"trade_id": 34,
"positions_available": "12",
"status": "Pending",
"properties": {
"own_car_required": true,
"license_required": true,
"blue_card_required": true,
"preferred_rto": "RTO Name",
"police_check_required": true
},
"location": {
"location": {
"location_type": "1",
"short_name": "Postal Address",
"address_street1": "84 Alexander Street",
"suburb_name": "Crows Nest",
"state_code": "NSW",
"country_code": "AU"
}
}
}
}
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"vacancy": {
"type": "object",
"properties": {
"company_id": {
"type": "number",
"description": "Company ID"
},
"contact_id": {
"type": "number",
"description": "Contact ID"
},
"job_title": {
"type": "string",
"description": "Job Title"
},
"closing_date": {
"type": "string",
"description": "Closing Date (An ISO8601 date time format)"
},
"opening_date": {
"type": "string",
"description": "Opening Date (An ISO8601 date time format)"
},
"brief_job_description": {
"type": "string",
"description": "Brief Job Description"
},
"job_description": {
"type": "string",
"description": "Job Description"
},
"hours_per_week": {
"type": "string",
"description": "Number of working hours per week"
},
"trade_id": {
"type": "number",
"description": "Grab the trade id from the URL (https://[tenant_name].jobreadydirect.com.au/admin/trades) in the system"
},
"positions_available": {
"type": "string",
"description": "Available Positions"
},
"status": {
"type": "string",
"enum": [
"Pending",
"Open",
"On Hold",
"Filled",
"Withdrawn",
"On Trail",
"Closed"
],
"description": "Vacancy Status"
},
"properties": {
"type": "object",
"properties": {
"own_car_required": {
"type": "boolean"
},
"license_required": {
"type": "boolean"
},
"blue_card_required": {
"type": "boolean"
},
"preferred_rto": {
"type": "string"
},
"police_check_required": {
"type": "boolean"
}
},
"description": "Vacancy Properties"
},
"location": {
"type": "object",
"properties": {
"location": {
"type": "object",
"properties": {
"location_type": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "Location Types (1: Postal Address, 2: Home Address, 3: Head Office, 4: Work Site, 5: Training Facility)"
},
"short_name": {
"type": "string",
"description": "Location Name"
},
"address_street1": {
"type": "string",
"description": "Address"
},
"suburb_name": {
"type": "string",
"description": "Suburb Name"
},
"state_code": {
"type": "string",
"description": "State Code should be in ISO 3166-2:AU format"
},
"country_code": {
"type": "string",
"description": "Country Code should be in ISO 3166-1 alpha-2 format"
}
},
"required": [
"location_type",
"address_street1",
"suburb_name",
"state_code",
"country_code"
]
}
}
}
},
"required": [
"company_id",
"contact_id",
"job_title",
"positions_available",
"status"
]
}
}
}
CreatePOST/api/v1/vacancies/
Generated by aglio on 31 May 2018