The public API SEARCH function returns summary information about a subset of active positions on Apprenticeship Central, filtered by a search keyword. The keyword supplied is sought within the position_name, position_description and position_category fields. The call returns the most recent 100 results.

URL

https://apprenticeshipcentral.com.au/api/public/v2/

Request

• keyword (string) – the term that should be used to filter the results. Required.
• mode (string) – and or or. Optional, defaults to or.

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” in slug format (e.g. carpentry-joinery-cabinetmaking).
  • employer_company_name (string) – the Employer name.
  • location_suburb (string) – the Employer’s suburb.
  • location_state (string) – the Employer’s state.
  • public_url (string) – the URL for this position on Apprenticeship Central.

Errors

• 201 – No valid function type passed.
• 202 – Database query error – these should be reported.

Return to Public API