The employer LIST STATES function returns the internal and displayable fields for the state definitions used in the database. It is important that the state “slug” (the internal field) is stored when updating or creating locational fields.

URL

https://apprenticeshipcentral.com.au/api/employer/list/

Request

• type (string) – states. 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
  • state (string) – the displayable state.
  • state_slug (string) – the internal state string.

Errors

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

Return to Employer API List