The Employer API is a set of functions that provide programmatic access to an Employer’s Apprenticeship Central (AC) account data.

Access to the API is granted via the combination of an API Key and an existing AC account user name. The key can be sourced from the account area of the logged in user.

All calls to the API must furnish a valid set of credentials, 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/employer/list/

Request

• apikey (string) – the API Key for the calling account.
• user (string) – the AC user name (usually an email address).

Additional parameters in the request are described in the relevant function descriptions, which also detail the response format. These are as follows: –

• LIST – request summary data.
  • LIST JOBS
  • LIST LOCATIONS
  • LIST CATEGORIES
  • LIST SUBCATEGORIES
  • LIST QUALIFICATIONS
  • LIST ROLES
  • LIST STATES
  • LIST REGIONS
• DETAIL – request all the information about a single item.
  • DETAIL JOB
  • DETAIL LOCATION
• UPDATE – modify an existing item.
  • UPDATE JOB
  • UPDATE LOCATION
• CREATE – insert a new item.
  • CREATE JOB
  • CREATE LOCATION

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 – mismatched username and key.
• 101 – username not provided.
• 102 – API key not provided.
• 999 – you have been very, very bad …