API Reference

Also see Swagger documentation o the API.

API Specification Details

GET /

Retrieve information about this API and its relationship with HSDS.

Retrieve information about this API and its relationship with HSDS.

Status Codes

  • 200 OK – A JSON response providing information about this API.

GET /services/{id}

Retrieves a fully nested service with all related data with id.

Retrieve fully nested service with all related data with id.

Parameters

  • id (string) – The id of the service that the request is intended to retrieve.

Status Codes

  • 200 OK – A Service matching the {id}, with all related data according to the HSDS Specification for Service.

GET /services

Retrieves paginated listings of services that only have one-to-one fields in them.

Retrieve fully nested service with all related data with id.

Query Parameters

  • search (string) – Full text search.

  • page (integer) – Page number of paginated result.

  • per_page (integer) – Number of results requested in a single page.

  • taxonomy_term_id (string) – Search for services with particular taxonomy_term.

  • taxonomy_id (string) – Search for services which contain any term with this taxonomy.

  • minimum_age (number) – Return services with a minimum age of at least the specified value.

  • maximum_age (number) – Return services with a maximum age of at equal to or below the specified value.

  • start_time (time) – Return services with a start time of at least the specified value.

  • end_time (time) – Return services with a end time of at equal to or below the specified value.

  • day (string) – Return services with a day equal to the specified value.

Status Codes

  • 200 OK – A paginated list of services that only have one-to-one fields in them.

GET /taxonomies/{id}

Retrieves full information on a taxonomy by {id}.

Full information on taxonomy.

Parameters

  • id (string) – The id of the taxonomy that the request is intended to retrieve.

Status Codes

  • 200 OK – Full information on taxonomy.

GET /taxonomies

Paginated listing of taxonomies.

Paginated listing of taxonomies.

Query Parameters

  • page (integer) – Page number of paginated result.

  • per_page (integer) – Number of results requested in a single page.

Status Codes

  • 200 OK – Paginated listing of taxonomies.

GET /taxonomy_terms/{id}

Full information on a taxonomy term.

Full information on a taxonomy term.

Parameters

  • id (string) – The id of the taxonomy terms that the request is intended to retrieve.

Status Codes

  • 200 OK – Full information on a taxonomy term.

GET /taxonomy_terms

Paginated listing of taxonomy terms

Full information on a taxonomy term

Query Parameters

  • page (integer) – Page number of paginated result.

  • per_page (integer) – Number of results requested in a single page.

Status Codes

  • 200 OK – Paginated listing of taxonomy terms

GET /service_at_locations/{id}

Retrieve fully nested service_at_location with all related data with specified id.

Retrieve fully nested service_at_location with all related data with specified id.

Parameters

  • id (string) – The id of the service that the request is intended to retrieve.

Status Codes

  • 200 OK – Retrieve fully nested service_at_location with all related data with specified id.

GET /service_at_locations

Retrieve paginated listings of service_at_location that only have one-to-one fields in them.

Retrieve paginated listings of service_at_location that only have one-to-one fields in them.

Query Parameters

  • search (string) – Full text search.

  • page (integer) – Page number of paginated result.

  • per_page (integer) – Number of results requested in a single page.

  • taxonomy_term_id (string) – Search for services with particular taxonomy_term.

  • taxonomy_id (string) – Search for services which contain any term with this taxonomy.

  • minimum_age (number) – Return services with a minimum age of at least the specified value.

  • maximum_age (number) – Return services with a maximum age of at equal to or below the specified value.

  • start_time (time) – Return services with a start time of at least the specified value.

  • end_time (time) – Return services with a end time of at equal to or below the specified value.

  • day (string) – Return services with a day equal to the specified value.

  • postcode (string) – The postcode or zip code of a point used to check service coverage. If service_area is available, only return results where the postcode exists within the service_area. If proximity is provided, only show results within the proximity from the centroid of the postcode.

  • proximity (string) – Return services that exist within meters from the centroid of the provided postcode

Status Codes

  • 200 OK – Retrieve paginated listings of service_at_location that only have one-to-one fields in them.