{ "openapi": "3.1.0", "info": { "title": "State school enrolments by school and year level, February census, Queensland 2015 to 2019 query API", "version": "2022-09-19", "summary": "Filter, page and aggregate State school enrolments by school and year level, February census, Queensland 2015 to 2019 from Department of Education.", "description": "The query API returns only the rows you ask for, as JSON, NDJSON or CSV, from the same typed rows as the files. It needs no key. The API allows 60 requests in 10 seconds from one address. Above that it answers 429 for 10 seconds with a `Retry-After` header, a `RateLimit-Policy` header and a JSON body that gives the limit. Every API answer carries the same `RateLimit-Policy`. A client should wait the `Retry-After` seconds, or read the files, which have no limit. Every JSON answer carries the version, licence and attribution. CSV and NDJSON answers carry them in response headers. Department of Education has not endorsed this site. The whole site is described in https://publicdata.au/openapi.json.", "license": { "name": "CC BY 4.0", "url": "https://creativecommons.org/licenses/by/4.0/" } }, "servers": [ { "url": "https://publicdata.au" } ], "externalDocs": { "url": "https://publicdata.au/d/qld-state-school-enrolments-february/#query" }, "tags": [ { "name": "query" } ], "paths": { "/api/v1/datasets/qld-state-school-enrolments-february/rows": { "get": { "tags": [ "query" ], "summary": "Query State school enrolments by school and year level, February census, Queensland 2015 to 2019", "operationId": "queryRows_qld_state_school_enrolments_february", "description": "Rows of State school enrolments by school and year level, February census, Queensland 2015 to 2019 in the newest loaded version, filtered and paged. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "school_name", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "school_code", "in": "query", "schema": { "type": "string" }, "description": "string. Kept as text to keep leading zeros." }, { "name": "collection_year", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 2015, 2016, 2017, 2018, 2019.", "examples": [ "eq.2019" ] }, { "name": "year_level", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Preparatory Year, Year 1, Year 10, Year 11, Year 12, Year 2, Year 3, Year 4, Year 5, Year 6, Year 7, Year 8, Year 9.", "examples": [ "eq.Year 9" ] }, { "name": "region", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Central Queensland, Darling Downs South West, Far North Queensland, Metropolitan, North Coast, North Queensland, South East.", "examples": [ "eq.South East" ] }, { "name": "local_government_area", "in": "query", "schema": { "type": "string" }, "description": "string.", "examples": [ "eq.Yarrabah (S)" ] }, { "name": "remoteness_area", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Inner Regional Australia, Major Cities of Australia, Outer Regional Australia, Remote Australia, Very Remote Australia.", "examples": [ "eq.Very Remote Australia" ] }, { "name": "school_category", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Combined, Primary, Secondary, Special.", "examples": [ "eq.Special" ] }, { "name": "school_type", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Community School, Educational Unit, School of Distance Education, Special School, Specific Purpose School, State High School, State School.", "examples": [ "eq.State School" ] }, { "name": "ft_enrolments", "in": "query", "schema": { "type": "string" }, "description": "integer. From 1 to 586." }, { "name": "select", "in": "query", "schema": { "type": "string" }, "description": "Fields to return, comma-separated. Every field when absent." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/qld-state-school-enrolments-february/versions/{version}/rows": { "get": { "tags": [ "query" ], "summary": "Query State school enrolments by school and year level, February census, Queensland 2015 to 2019", "operationId": "queryRows_qld_state_school_enrolments_february_version", "description": "Rows of State school enrolments by school and year level, February census, Queensland 2015 to 2019 in one dated version, filtered and paged. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "A dated version loaded for queries, from the versions path. Answers for a dated version never change." }, { "name": "school_name", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "school_code", "in": "query", "schema": { "type": "string" }, "description": "string. Kept as text to keep leading zeros." }, { "name": "collection_year", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 2015, 2016, 2017, 2018, 2019.", "examples": [ "eq.2019" ] }, { "name": "year_level", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Preparatory Year, Year 1, Year 10, Year 11, Year 12, Year 2, Year 3, Year 4, Year 5, Year 6, Year 7, Year 8, Year 9.", "examples": [ "eq.Year 9" ] }, { "name": "region", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Central Queensland, Darling Downs South West, Far North Queensland, Metropolitan, North Coast, North Queensland, South East.", "examples": [ "eq.South East" ] }, { "name": "local_government_area", "in": "query", "schema": { "type": "string" }, "description": "string.", "examples": [ "eq.Yarrabah (S)" ] }, { "name": "remoteness_area", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Inner Regional Australia, Major Cities of Australia, Outer Regional Australia, Remote Australia, Very Remote Australia.", "examples": [ "eq.Very Remote Australia" ] }, { "name": "school_category", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Combined, Primary, Secondary, Special.", "examples": [ "eq.Special" ] }, { "name": "school_type", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Community School, Educational Unit, School of Distance Education, Special School, Specific Purpose School, State High School, State School.", "examples": [ "eq.State School" ] }, { "name": "ft_enrolments", "in": "query", "schema": { "type": "string" }, "description": "integer. From 1 to 586." }, { "name": "select", "in": "query", "schema": { "type": "string" }, "description": "Fields to return, comma-separated. Every field when absent." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/aggregate": { "get": { "tags": [ "query" ], "summary": "Counts, sums, averages, minimums and maximums by group", "operationId": "aggregate", "description": "Groups and totals of any dataset in the newest loaded version. Filters work as they do on rows. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "qld-state-school-enrolments-february" ] }, "description": "The dataset's slug, as in its page URL `/d//`." }, { "name": "group", "in": "query", "schema": { "type": "string" }, "description": "On `aggregate`, fields to group by, comma-separated." }, { "name": "metric", "in": "query", "schema": { "type": "string", "default": "count" }, "description": "On `aggregate`, `count`, `sum.field`, `avg.field`, `min.field` or `max.field`, comma-separated. `count` when absent." }, { "name": "school_name", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "school_code", "in": "query", "schema": { "type": "string" }, "description": "string. Kept as text to keep leading zeros." }, { "name": "collection_year", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 2015, 2016, 2017, 2018, 2019.", "examples": [ "eq.2019" ] }, { "name": "year_level", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Preparatory Year, Year 1, Year 10, Year 11, Year 12, Year 2, Year 3, Year 4, Year 5, Year 6, Year 7, Year 8, Year 9.", "examples": [ "eq.Year 9" ] }, { "name": "region", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Central Queensland, Darling Downs South West, Far North Queensland, Metropolitan, North Coast, North Queensland, South East.", "examples": [ "eq.South East" ] }, { "name": "local_government_area", "in": "query", "schema": { "type": "string" }, "description": "string.", "examples": [ "eq.Yarrabah (S)" ] }, { "name": "remoteness_area", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Inner Regional Australia, Major Cities of Australia, Outer Regional Australia, Remote Australia, Very Remote Australia.", "examples": [ "eq.Very Remote Australia" ] }, { "name": "school_category", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Combined, Primary, Secondary, Special.", "examples": [ "eq.Special" ] }, { "name": "school_type", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Community School, Educational Unit, School of Distance Education, Special School, Specific Purpose School, State High School, State School.", "examples": [ "eq.State School" ] }, { "name": "ft_enrolments", "in": "query", "schema": { "type": "string" }, "description": "integer. From 1 to 586." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/versions/{version}/aggregate": { "get": { "tags": [ "query" ], "summary": "Counts, sums, averages, minimums and maximums by group", "operationId": "aggregateVersion", "description": "Groups and totals of any dataset in one dated version. Filters work as they do on rows. Each filter is `field=operator.value` in the query string, and every filter must match. A number or date field compares as a number or date, and a text field compares as text. Values are case-sensitive except with `ilike`. Prefix `not.` to negate a filter, as `not.eq.value`. Operators: `eq.value`, `neq.value`, `gt.value`, `gte.value`, `lt.value`, `lte.value`, `like.*text*`, `ilike.*text*`, `in.(a,b,c)`, `is.null`.", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "qld-state-school-enrolments-february" ] }, "description": "The dataset's slug, as in its page URL `/d//`." }, { "name": "version", "in": "path", "required": true, "schema": { "type": "string", "format": "date" }, "description": "A dated version loaded for queries, from the versions path. Answers for a dated version never change." }, { "name": "group", "in": "query", "schema": { "type": "string" }, "description": "On `aggregate`, fields to group by, comma-separated." }, { "name": "metric", "in": "query", "schema": { "type": "string", "default": "count" }, "description": "On `aggregate`, `count`, `sum.field`, `avg.field`, `min.field` or `max.field`, comma-separated. `count` when absent." }, { "name": "school_name", "in": "query", "schema": { "type": "string" }, "description": "string." }, { "name": "school_code", "in": "query", "schema": { "type": "string" }, "description": "string. Kept as text to keep leading zeros." }, { "name": "collection_year", "in": "query", "schema": { "type": "string" }, "description": "integer. Values: 2015, 2016, 2017, 2018, 2019.", "examples": [ "eq.2019" ] }, { "name": "year_level", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Preparatory Year, Year 1, Year 10, Year 11, Year 12, Year 2, Year 3, Year 4, Year 5, Year 6, Year 7, Year 8, Year 9.", "examples": [ "eq.Year 9" ] }, { "name": "region", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Central Queensland, Darling Downs South West, Far North Queensland, Metropolitan, North Coast, North Queensland, South East.", "examples": [ "eq.South East" ] }, { "name": "local_government_area", "in": "query", "schema": { "type": "string" }, "description": "string.", "examples": [ "eq.Yarrabah (S)" ] }, { "name": "remoteness_area", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Inner Regional Australia, Major Cities of Australia, Outer Regional Australia, Remote Australia, Very Remote Australia.", "examples": [ "eq.Very Remote Australia" ] }, { "name": "school_category", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Combined, Primary, Secondary, Special.", "examples": [ "eq.Special" ] }, { "name": "school_type", "in": "query", "schema": { "type": "string" }, "description": "string. Values: Community School, Educational Unit, School of Distance Education, Special School, Specific Purpose School, State High School, State School.", "examples": [ "eq.State School" ] }, { "name": "ft_enrolments", "in": "query", "schema": { "type": "string" }, "description": "integer. From 1 to 586." }, { "name": "order", "in": "query", "schema": { "type": "string" }, "description": "`field.asc` or `field.desc`, comma-separated. The publisher's row order when absent." }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 10000, "default": 100 }, "description": "Rows per page, 1 to 10,000. 100 when absent." }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Rows to skip. The `next` URL in each answer sets it for you." }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "json", "ndjson", "csv" ], "default": "json" }, "description": "`json`, `ndjson` or `csv`. JSON carries the provenance header, and the others carry it in response headers." } ], "responses": { "200": { "description": "Rows with the version, licence and attribution. `next` is the URL of the following page, or null." }, "400": { "description": "The query names a field the dataset does not have, or a value of the wrong type." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } }, "/api/v1/datasets/{slug}/versions": { "get": { "tags": [ "query" ], "summary": "The versions loaded for queries, newest first, with the URLs to query each", "operationId": "queryVersions", "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "qld-state-school-enrolments-february" ] }, "description": "The dataset's slug, as in its page URL `/d//`." } ], "responses": { "200": { "description": "Loaded versions with row counts and URLs." }, "404": { "description": "The dataset or version is not loaded for queries." }, "429": { "description": "More than 60 requests in 10 seconds from one address. Blocked for 10 seconds. Wait `Retry-After` seconds.", "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds until the block lifts." }, "RateLimit-Policy": { "schema": { "type": "string" }, "description": "The limit, as \"fair-use\";q=60;w=10." } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string" }, "status": { "type": "integer", "const": 429 }, "limit": { "type": "integer" }, "window_seconds": { "type": "integer" }, "block_seconds": { "type": "integer" }, "docs": { "type": "string", "format": "uri" }, "files": { "type": "string" } } } } } } } } } } }