Public API Detail
Public API Detail
The public API DETAIL function returns all the information about a specific position on Apprenticeship Central.
URL
https://apprenticeshipcentral.com.au/api/public/v2/
Request
id
(string) – the term that should be used to filter the results. Required.
Response
response
success_count
(int) – set to 1 if the query ran without errors (regardless of the number of results returned).error_count
(int) – set to 1 if there was a query error.count
(int) – the number of results returned by the query (if any).
data
id
(int) – the position ID.position_name
(string) – the position’s title.position_description
(string) – the full position description.position_category
(string) – the position’s “industry” in slug format (e.g.building-and-construction
).position_subcategory
(string) – the position’s “Area of Interest” (e.g.carpentry-joinery-cabinetmaking
).location_address
(string) – the Employer’s address.location_suburb
(string) – the Employer’s suburb.location_state
(string) – the Employer’s state.employer_intro
(string) – the Employer’s online introduction.position_updated
(datetime) – the position’s last update date and time.public_url
(string) – the URL for this position on Apprenticeship Central.
Errors
- 201 – No valid type passed.
- 202 – Database query error – these should be reported.
Return to Public API