Public API
Public API
The Public API is a set of functions that provide programmatic access to Apprenticeship Central (AC) jobs data, the same as is viewable on the AC site (un-logged in).
Access to the API is granted via an AC Administration-provided user name. Keys can be requested from AC via the Contact Us page.
All calls to the API must furnish a valid user credential, in conjunction with properly formed parameters appropriate to the function being called.
The request format and the response format are both JSON. Here is an example of a typical call: –
https://apprenticeshipcentral.com.au/api/public/v2/
Request
user
(string) – AC Administration-provided user name.
Additional parameters in the request are described in the relevant function descriptions, which also detail the response format. These are as follows: –
- ALL – request summary data for all positions (limited to 100 most recent).
- SEARCH – request summary data for a subset of the positions, filtered by keyword.
- DETAIL – request all the available information about a single item.
Errors
Errors relating the the authorisation process are describe below. Specific functional errors are described in the relevant section.
- 0-9 – JSON related error codes
- 100 – unknown user name.