Response schemas
The v1 schema is separate from each record's dataset_version. Required array fields contain arrays, including when empty. Unavailable optional fields are omitted. Zero is a valid value. Text fields are ready to display. IDs remain stable across spelling changes. Breaking field or type changes require a new API version.
Holiday
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9-]*$"
},
"date": {
"type": "string",
"format": "date"
},
"names": {
"type": "object",
"properties": {
"pap": {
"type": "string",
"minLength": 1
},
"nl": {
"type": "string",
"minLength": 1
},
"en": {
"type": "string",
"minLength": 1
}
},
"required": [
"nl"
]
},
"type": {
"type": "string",
"enum": [
"public_holiday",
"partial_public_holiday"
]
},
"all_day": {
"type": "boolean"
},
"fixed_date": {
"type": "boolean"
},
"observed_date": {
"type": "string",
"format": "date"
},
"notes": {
"type": "string"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"date",
"names",
"type",
"all_day",
"fixed_date",
"provenance"
]
}
Provenance
{
"type": "object",
"properties": {
"source": {
"type": "string",
"minLength": 1
},
"source_url": {
"type": "string",
"format": "uri"
},
"retrieved_at": {
"type": "string",
"format": "date-time"
},
"source_updated_at": {
"type": "string",
"format": "date-time"
},
"dataset_version": {
"type": "string",
"minLength": 1
},
"license": {
"type": "string",
"minLength": 1
}
},
"required": [
"source",
"source_url",
"retrieved_at",
"dataset_version"
]
}
Geozone
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"name": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"country_code": {
"type": "string",
"enum": [
"CW"
]
},
"centroid": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"latitude",
"longitude"
]
},
"geometry_available": {
"type": "boolean"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"name",
"aliases",
"country_code",
"geometry_available",
"provenance"
]
}
Neighborhood
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"name": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"country_code": {
"type": "string",
"enum": [
"CW"
]
},
"centroid": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"latitude",
"longitude"
]
},
"geometry_available": {
"type": "boolean"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
},
"geozone_id": {
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"population": {
"type": "object",
"properties": {
"census_year": {
"type": "integer"
},
"total": {
"type": "integer",
"minimum": 0
}
},
"required": [
"census_year",
"total"
]
}
},
"required": [
"id",
"name",
"aliases",
"country_code",
"geometry_available",
"provenance",
"geozone_id"
]
}
NeighborhoodContext
{
"type": "object",
"properties": {
"as_of": {
"type": "string",
"format": "date"
},
"neighborhood": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"name": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"country_code": {
"type": "string",
"enum": [
"CW"
]
},
"centroid": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"latitude",
"longitude"
]
},
"geometry_available": {
"type": "boolean"
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string",
"minLength": 1
},
"source_url": {
"type": "string",
"format": "uri"
},
"retrieved_at": {
"type": "string",
"format": "date-time"
},
"source_updated_at": {
"type": "string",
"format": "date-time"
},
"dataset_version": {
"type": "string",
"minLength": 1
},
"license": {
"type": "string",
"minLength": 1
}
},
"required": [
"source",
"source_url",
"retrieved_at",
"dataset_version"
]
},
"geozone_id": {
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"population": {
"type": "object",
"properties": {
"census_year": {
"type": "integer"
},
"total": {
"type": "integer",
"minimum": 0
}
},
"required": [
"census_year",
"total"
]
}
},
"required": [
"id",
"name",
"aliases",
"country_code",
"geometry_available",
"provenance",
"geozone_id"
]
},
"geozone": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"available",
"no_data",
"unavailable"
]
},
"record": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"name": {
"type": "string"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
},
"country_code": {
"type": "string",
"enum": [
"CW"
]
},
"centroid": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"latitude",
"longitude"
]
},
"geometry_available": {
"type": "boolean"
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string",
"minLength": 1
},
"source_url": {
"type": "string",
"format": "uri"
},
"retrieved_at": {
"type": "string",
"format": "date-time"
},
"source_updated_at": {
"type": "string",
"format": "date-time"
},
"dataset_version": {
"type": "string",
"minLength": 1
},
"license": {
"type": "string",
"minLength": 1
}
},
"required": [
"source",
"source_url",
"retrieved_at",
"dataset_version"
]
}
},
"required": [
"id",
"name",
"aliases",
"country_code",
"geometry_available",
"provenance"
]
},
"dataset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,79}$"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"version": {
"type": [
"string",
"null"
]
},
"last_updated": {
"type": [
"string",
"null"
]
},
"record_count": {
"type": "integer"
},
"source": {
"type": "object",
"properties": {
"authority": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"redistribution_status": {
"type": "string",
"enum": [
"permitted",
"restricted",
"unknown",
"internal_only"
]
},
"contributors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"authority": {
"type": "string",
"minLength": 1
},
"url": {
"type": "string",
"format": "uri"
},
"redistribution_status": {
"type": "string",
"enum": [
"permitted",
"restricted",
"unknown",
"internal_only"
]
},
"license": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"authority",
"url",
"redistribution_status",
"license"
]
},
"minItems": 2
}
},
"required": [
"authority",
"url",
"redistribution_status"
]
},
"license": {
"type": [
"string",
"null"
]
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"json"
]
}
}
},
"required": [
"id",
"name",
"status",
"version",
"last_updated",
"record_count",
"source",
"license",
"formats"
]
}
},
"required": [
"status",
"record",
"dataset"
]
},
"census": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"available",
"no_data",
"unavailable"
]
},
"dataset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,79}$"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"version": {
"type": [
"string",
"null"
]
},
"last_updated": {
"type": [
"string",
"null"
]
},
"record_count": {
"type": "integer"
},
"source": {
"type": "object",
"properties": {
"authority": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"redistribution_status": {
"type": "string",
"enum": [
"permitted",
"restricted",
"unknown",
"internal_only"
]
},
"contributors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"authority": {
"type": "string",
"minLength": 1
},
"url": {
"type": "string",
"format": "uri"
},
"redistribution_status": {
"type": "string",
"enum": [
"permitted",
"restricted",
"unknown",
"internal_only"
]
},
"license": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"authority",
"url",
"redistribution_status",
"license"
]
},
"minItems": 2
}
},
"required": [
"authority",
"url",
"redistribution_status"
]
},
"license": {
"type": [
"string",
"null"
]
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"json"
]
}
}
},
"required": [
"id",
"name",
"status",
"version",
"last_updated",
"record_count",
"source",
"license",
"formats"
]
},
"indicators": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"geography_id": {
"anyOf": [
{
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
{
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
}
]
},
"geography_type": {
"type": "string",
"enum": [
"geozone",
"neighborhood"
]
},
"geozone_id": {
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"indicator": {
"type": "string"
},
"census_year": {
"type": "number",
"enum": [
2023
]
},
"value": {
"type": "number"
},
"unit": {
"type": "string",
"enum": [
"count",
"persons_per_household"
]
},
"table": {
"type": "string",
"enum": [
"G-1",
"G-2",
"G-3",
"G-4",
"G-5"
]
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string",
"minLength": 1
},
"source_url": {
"type": "string",
"format": "uri"
},
"retrieved_at": {
"type": "string",
"format": "date-time"
},
"source_updated_at": {
"type": "string",
"format": "date-time"
},
"dataset_version": {
"type": "string",
"minLength": 1
},
"license": {
"type": "string",
"minLength": 1
}
},
"required": [
"source",
"source_url",
"retrieved_at",
"dataset_version"
]
}
},
"required": [
"id",
"geography_id",
"geography_type",
"indicator",
"census_year",
"value",
"unit",
"table",
"provenance"
]
},
"maxItems": 100
},
"limit": {
"type": "number",
"enum": [
100
]
},
"next_cursor": {
"type": [
"string",
"null"
]
}
},
"required": [
"status",
"dataset",
"indicators",
"limit",
"next_cursor"
]
},
"waste": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"available",
"no_match",
"unavailable"
]
},
"zones_dataset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,79}$"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"version": {
"type": [
"string",
"null"
]
},
"last_updated": {
"type": [
"string",
"null"
]
},
"record_count": {
"type": "integer"
},
"source": {
"type": "object",
"properties": {
"authority": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"redistribution_status": {
"type": "string",
"enum": [
"permitted",
"restricted",
"unknown",
"internal_only"
]
},
"contributors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"authority": {
"type": "string",
"minLength": 1
},
"url": {
"type": "string",
"format": "uri"
},
"redistribution_status": {
"type": "string",
"enum": [
"permitted",
"restricted",
"unknown",
"internal_only"
]
},
"license": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"authority",
"url",
"redistribution_status",
"license"
]
},
"minItems": 2
}
},
"required": [
"authority",
"url",
"redistribution_status"
]
},
"license": {
"type": [
"string",
"null"
]
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"json"
]
}
}
},
"required": [
"id",
"name",
"status",
"version",
"last_updated",
"record_count",
"source",
"license",
"formats"
]
},
"collections_dataset": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]{0,79}$"
},
"name": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"version": {
"type": [
"string",
"null"
]
},
"last_updated": {
"type": [
"string",
"null"
]
},
"record_count": {
"type": "integer"
},
"source": {
"type": "object",
"properties": {
"authority": {
"type": "string"
},
"url": {
"type": "string",
"format": "uri"
},
"redistribution_status": {
"type": "string",
"enum": [
"permitted",
"restricted",
"unknown",
"internal_only"
]
},
"contributors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1
},
"authority": {
"type": "string",
"minLength": 1
},
"url": {
"type": "string",
"format": "uri"
},
"redistribution_status": {
"type": "string",
"enum": [
"permitted",
"restricted",
"unknown",
"internal_only"
]
},
"license": {
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"authority",
"url",
"redistribution_status",
"license"
]
},
"minItems": 2
}
},
"required": [
"authority",
"url",
"redistribution_status"
]
},
"license": {
"type": [
"string",
"null"
]
},
"formats": {
"type": "array",
"items": {
"type": "string",
"enum": [
"json"
]
}
}
},
"required": [
"id",
"name",
"status",
"version",
"last_updated",
"record_count",
"source",
"license",
"formats"
]
},
"collections_status": {
"type": "string",
"enum": [
"available",
"unavailable"
]
},
"upcoming_limit_per_zone": {
"type": "number",
"enum": [
3
]
},
"matches": {
"type": "array",
"items": {
"type": "object",
"properties": {
"zone": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^wz_[a-z0-9_]+$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"provider_id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$"
},
"provider_name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"service": {
"type": "string",
"enum": [
"bulky_waste",
"household_waste"
]
}
},
"required": [
"id",
"name",
"provider_id",
"provider_name",
"service"
]
},
"relationship": {
"type": "string",
"enum": [
"place_match",
"neighborhood_coverage"
]
},
"places": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^wp_[a-z0-9_]+$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"neighborhood_id": {
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
}
},
"required": [
"id",
"name"
]
}
},
"upcoming_collections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^wc_[a-z0-9_]+$"
},
"zone_id": {
"type": "string",
"pattern": "^wz_[a-z0-9_]+$"
},
"set_out_window": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
},
"required": [
"start_date",
"end_date"
]
},
"collection_window": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
},
"required": [
"start_date",
"end_date"
]
},
"instructions": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"provenance": {
"type": "object",
"properties": {
"source": {
"type": "string",
"minLength": 1
},
"source_url": {
"type": "string",
"format": "uri"
},
"retrieved_at": {
"type": "string",
"format": "date-time"
},
"source_updated_at": {
"type": "string",
"format": "date-time"
},
"dataset_version": {
"type": "string",
"minLength": 1
},
"license": {
"type": "string",
"minLength": 1
}
},
"required": [
"source",
"source_url",
"retrieved_at",
"dataset_version"
]
}
},
"required": [
"id",
"zone_id",
"set_out_window",
"instructions",
"provenance"
]
},
"maxItems": 3
},
"has_more": {
"type": "boolean"
}
},
"required": [
"zone",
"relationship",
"places",
"upcoming_collections",
"has_more"
]
},
"maxItems": 100
}
},
"required": [
"status",
"zones_dataset",
"collections_dataset",
"collections_status",
"upcoming_limit_per_zone",
"matches"
]
}
},
"required": [
"as_of",
"neighborhood",
"geozone",
"census",
"waste"
]
}
Address
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^adr_[a-f0-9]{24}$"
},
"street_id": {
"type": "string",
"pattern": "^str_[a-f0-9]{24}$"
},
"street_name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"house_number": {
"type": "string",
"minLength": 1,
"maxLength": 40
},
"formatted_address": {
"type": "string",
"minLength": 1,
"maxLength": 260
},
"country_code": {
"type": "string",
"enum": [
"CW"
]
},
"coordinate": {
"type": "object",
"properties": {
"latitude": {
"type": "number",
"minimum": -90,
"maximum": 90
},
"longitude": {
"type": "number",
"minimum": -180,
"maximum": 180
}
},
"required": [
"latitude",
"longitude"
]
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"street_id",
"street_name",
"house_number",
"formatted_address",
"country_code",
"coordinate",
"provenance"
]
}
Street
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^str_[a-f0-9]{24}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"aliases": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 200
}
},
"country_code": {
"type": "string",
"enum": [
"CW"
]
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"name",
"aliases",
"country_code",
"provenance"
]
}
AddressingProfile
{
"type": "object",
"properties": {
"country_code": {
"type": "string",
"enum": [
"CW"
]
},
"country_name": {
"type": "string",
"enum": [
"Curaçao"
]
},
"has_postal_codes": {
"type": "boolean",
"enum": [
false
]
},
"postal_code_required": {
"type": "boolean",
"enum": [
false
]
},
"locality_kind": {
"type": "string",
"enum": [
"neighborhood"
]
},
"recommended_form_fields": {
"type": "array",
"items": {
"type": "string",
"enum": [
"street_name",
"house_number",
"locality_id"
]
}
},
"notes": {
"type": "string"
}
},
"required": [
"country_code",
"country_name",
"has_postal_codes",
"postal_code_required",
"locality_kind",
"recommended_form_fields",
"notes"
]
}
Locality
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"name": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"neighborhood"
]
},
"geozone_id": {
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"aliases": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"id",
"name",
"kind",
"geozone_id",
"aliases"
]
}
AddressSuggestion
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"locality",
"street",
"address"
]
},
"id": {
"type": "string"
},
"label": {
"type": "string"
},
"locality_id": {
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"street_id": {
"type": "string"
},
"house_number": {
"type": "string"
}
},
"required": [
"kind",
"id",
"label"
]
}
Business
{
"type": "object",
"properties": {
"registry_number": {
"type": "string",
"pattern": "^[0-9]{1,20}$"
},
"name": {
"type": "string",
"minLength": 1
},
"trade_names": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"legal_form": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive",
"dissolved",
"unknown"
]
},
"registered_at": {
"type": "string",
"format": "date"
},
"incorporated_at": {
"type": "string",
"format": "date"
},
"address": {
"type": "object",
"properties": {
"street": {
"type": "string"
},
"locality": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"country_code": {
"type": "string",
"enum": [
"CW"
]
}
},
"required": [
"country_code"
]
},
"activities": {
"type": "array",
"items": {
"type": "string",
"minLength": 1
}
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"registry_number",
"name",
"trade_names",
"status",
"activities",
"provenance"
]
}
SchoolVacation
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^[a-z][a-z0-9-]*$"
},
"school_year": {
"type": "string",
"pattern": "^\\d{4}-\\d{4}$"
},
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
},
"names": {
"type": "object",
"properties": {
"pap": {
"type": "string",
"minLength": 1
},
"nl": {
"type": "string",
"minLength": 1
},
"en": {
"type": "string",
"minLength": 1
}
},
"required": [
"nl"
]
},
"covers_school_boards": {
"type": "array",
"items": {
"type": "string"
}
},
"source_school_days": {
"type": "integer"
},
"notes": {
"type": "string"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"school_year",
"start_date",
"end_date",
"names",
"covers_school_boards",
"provenance"
]
}
TariffObservation
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"product": {
"type": "string"
},
"effective_from": {
"type": "string",
"format": "date"
},
"observation_kind": {
"type": "string",
"enum": [
"advertising_end_user",
"decree_retail_maximum"
]
},
"unit": {
"type": "string"
},
"amount": {
"type": "string",
"pattern": "^-?\\d+(?:\\.\\d+)?$"
},
"currency_as_printed": {
"type": "string"
},
"currency_code": {
"type": "string",
"enum": [
"ANG",
"XCG"
]
},
"unit_code": {
"type": "string",
"enum": [
"liter",
"cylinder",
"kilowatt_hour",
"cubic_meter",
"hour",
"month",
"year"
]
},
"rate_group": {
"type": "string"
},
"band": {
"type": "string"
},
"base_amount": {
"type": "string",
"pattern": "^-?\\d+(?:\\.\\d+)?$"
},
"fuel_amount": {
"type": "string",
"pattern": "^-?\\d+(?:\\.\\d+)?$"
},
"amount_at_pump_as_printed": {
"type": "string",
"pattern": "^-?\\d+(?:\\.\\d+)?$"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"product",
"effective_from",
"observation_kind",
"unit",
"amount",
"currency_as_printed",
"provenance"
]
}
CensusIndicator
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"geography_id": {
"anyOf": [
{
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
{
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
}
]
},
"geography_type": {
"type": "string",
"enum": [
"geozone",
"neighborhood"
]
},
"geozone_id": {
"type": "string",
"pattern": "^gz_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"indicator": {
"type": "string"
},
"census_year": {
"type": "number",
"enum": [
2023
]
},
"value": {
"type": "number"
},
"unit": {
"type": "string",
"enum": [
"count",
"persons_per_household"
]
},
"table": {
"type": "string",
"enum": [
"G-1",
"G-2",
"G-3",
"G-4",
"G-5"
]
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"geography_id",
"geography_type",
"indicator",
"census_year",
"value",
"unit",
"table",
"provenance"
]
}
TourismArrival
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"period": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
},
"metric": {
"type": "string",
"enum": [
"stayover",
"cruise",
"day_trippers"
]
},
"value": {
"type": "integer",
"minimum": 0
},
"unit": {
"type": "string",
"enum": [
"arrivals"
]
},
"market": {
"type": "string"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"period",
"metric",
"value",
"unit",
"provenance"
]
}
StatutoryRate
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"code": {
"type": "string"
},
"kind": {
"type": "string",
"enum": [
"min_wage",
"poverty_line",
"contribution_ceiling"
]
},
"effective_from": {
"type": "string",
"format": "date"
},
"effective_to": {
"type": "string",
"format": "date"
},
"applicability": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"employees"
]
},
"ages": {
"type": "object",
"properties": {
"minimum": {
"type": "integer",
"minimum": 0
},
"maximum": {
"type": "integer",
"minimum": 0
}
},
"required": [
"minimum"
],
"additionalProperties": false
},
"earnings_basis": {
"type": "string",
"enum": [
"gross",
"net"
]
}
},
"required": [
"kind",
"ages",
"earnings_basis"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"household"
]
},
"composition": {
"type": "object",
"properties": {
"adults": {
"type": "integer",
"exclusiveMinimum": 0
},
"children": {
"type": "integer",
"minimum": 0
}
},
"required": [
"adults",
"children"
],
"additionalProperties": false
}
},
"required": [
"kind",
"composition"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"insured_persons"
]
},
"scheme": {
"type": "string"
}
},
"required": [
"kind",
"scheme"
]
}
]
},
"amount": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$"
},
"currency_as_printed": {
"type": "string"
},
"currency_code": {
"type": "string",
"enum": [
"ANG",
"XCG"
]
},
"unit_code": {
"type": "string",
"enum": [
"liter",
"cylinder",
"kilowatt_hour",
"cubic_meter",
"hour",
"month",
"year"
]
},
"unit": {
"type": "string"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"code",
"kind",
"effective_from",
"applicability",
"amount",
"currency_as_printed",
"unit",
"provenance"
]
}
OfficialExchangeRate
{
"type": "object",
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"rate_date": {
"type": "string",
"format": "date"
},
"currency_as_printed": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"currency": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$"
},
"buy_notes": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$"
},
"buy_cheques": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$"
},
"sell": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$"
},
"sell_cheques": {
"type": "string",
"pattern": "^\\d+(?:\\.\\d+)?$"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"rate_date",
"currency_as_printed",
"currency",
"buy_notes",
"buy_cheques",
"sell",
"provenance"
]
}
CpiObservation
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"period": {
"type": "string",
"pattern": "^\\d{4}-(0[1-9]|1[0-2])$"
},
"category_code": {
"type": "string"
},
"category_name": {
"type": "string"
},
"weight_2016": {
"type": "integer"
},
"index_level": {
"type": "string",
"pattern": "^-?\\d+(?:\\.\\d+)?$"
},
"monthly_change_percent": {
"type": "string",
"pattern": "^-?\\d+(?:\\.\\d+)?$"
},
"base": {
"type": "string"
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"period",
"category_code",
"category_name",
"base",
"provenance"
]
}
WasteZone
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^wz_[a-z0-9_]+$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"provider_id": {
"type": "string",
"pattern": "^[a-z][a-z0-9_]*$"
},
"provider_name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"service": {
"type": "string",
"enum": [
"bulky_waste",
"household_waste"
]
},
"places": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^wp_[a-z0-9_]+$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"neighborhood_id": {
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
}
},
"required": [
"id",
"name"
]
}
},
"covered_neighborhood_ids": {
"type": "array",
"items": {
"type": "string",
"pattern": "^nbh_[a-z0-9]+(?:_[a-z0-9]+)*$"
},
"maxItems": 500
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"name",
"provider_id",
"provider_name",
"service",
"places",
"covered_neighborhood_ids",
"provenance"
]
}
WasteCollection
{
"type": "object",
"properties": {
"id": {
"type": "string",
"pattern": "^wc_[a-z0-9_]+$"
},
"zone_id": {
"type": "string",
"pattern": "^wz_[a-z0-9_]+$"
},
"set_out_window": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
},
"required": [
"start_date",
"end_date"
]
},
"collection_window": {
"type": "object",
"properties": {
"start_date": {
"type": "string",
"format": "date"
},
"end_date": {
"type": "string",
"format": "date"
}
},
"required": [
"start_date",
"end_date"
]
},
"instructions": {
"type": "string",
"minLength": 1,
"maxLength": 2000
},
"provenance": {
"$ref": "#/components/schemas/Provenance"
}
},
"required": [
"id",
"zone_id",
"set_out_window",
"instructions",
"provenance"
]
}