{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:highwaysengland-co-uk/areas-get":{"get":{"operationId":"open_data_highwaysengland_co_uk_areas_get","summary":"Returns list of areas","description":"GET /v{version}/areas","tags":["open-data"],"parameters":[{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/get-v-version-areas-area-ids":{"get":{"operationId":"open_data_highwaysengland_co_uk_get_v_version_areas_area_ids","summary":"Returns details of selected area","description":"GET /v{version}/areas/{area_Ids}","tags":["open-data"],"parameters":[{"name":"area_Ids","in":"query","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/quality-get-daily-data-quality-for-site":{"get":{"operationId":"open_data_highwaysengland_co_uk_quality_get_daily_data_quality_for_site","summary":"Get Site DailyQuality","description":"GET /v{version}/quality/daily","tags":["open-data"],"parameters":[{"name":"siteId","in":"query","required":true,"schema":{"type":"string"}},{"name":"start_date","in":"query","required":true,"description":"The start date of the report in the format ddmmyyyy (i.e 31012016)","schema":{"type":"string","description":"The start date of the report in the format ddmmyyyy (i.e 31012016)"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the report in the format ddmmyyyy (i.e 31012016)","schema":{"type":"string","description":"The end date of the report in the format ddmmyyyy (i.e 31012016)"}},{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/quality-get-overall-data-quality-for-sites":{"get":{"operationId":"open_data_highwaysengland_co_uk_quality_get_overall_data_quality_for_sites","summary":"Get Site OverallQuality","description":"GET /v{version}/quality/overall","tags":["open-data"],"parameters":[{"name":"sites","in":"query","required":true,"description":"Get site quality by site id delimited by ,","schema":{"type":"string","description":"Get site quality by site id delimited by ,"}},{"name":"start_date","in":"query","required":true,"description":"The start date of the report in the format ddmmyyyy (i.e 31012016)","schema":{"type":"string","description":"The start date of the report in the format ddmmyyyy (i.e 31012016)"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the report in the format ddmmyyyy (i.e 31012016)","schema":{"type":"string","description":"The end date of the report in the format ddmmyyyy (i.e 31012016)"}},{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/reports-index":{"get":{"operationId":"open_data_highwaysengland_co_uk_reports_index","summary":"Gets the daily report.","description":"GET /v{version}/reports/{report_type}","tags":["open-data"],"parameters":[{"name":"report_type","in":"query","required":true,"description":"Report Type Id (i.e Daily, Monthly, Annual)","schema":{"type":"string","description":"Report Type Id (i.e Daily, Monthly, Annual)"}},{"name":"sites","in":"query","required":true,"description":"Comma separated list of site Ids.","schema":{"type":"string","description":"Comma separated list of site Ids."}},{"name":"start_date","in":"query","required":true,"description":"The start date of the report in the format ddmmyyyy (i.e 31012016)","schema":{"type":"string","description":"The start date of the report in the format ddmmyyyy (i.e 31012016)"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the report in the format ddmmyyyy (i.e 31012016)","schema":{"type":"string","description":"The end date of the report in the format ddmmyyyy (i.e 31012016)"}},{"name":"page","in":"query","required":true,"description":"The page offset to return.","schema":{"type":"integer","description":"The page offset to return."}},{"name":"page_size","in":"query","required":true,"description":"The number of rows to return.","schema":{"type":"integer","description":"The number of rows to return."}},{"name":"reportSubTypeId","in":"query","required":false,"schema":{"type":"integer"}},{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/get-v-version-reports-start-date-to-end-date-report-type":{"get":{"operationId":"open_data_highwaysengland_co_uk_get_v_version_reports_start_date_to_end_date_report_type","summary":"Gets the daily report.","description":"GET /v{version}/reports/{start_date}/to/{end_date}/{report_type}","tags":["open-data"],"parameters":[{"name":"report_type","in":"query","required":true,"description":"Report Type Id (i.e Daily, Monthly, Annual)","schema":{"type":"string","description":"Report Type Id (i.e Daily, Monthly, Annual)"}},{"name":"sites","in":"query","required":true,"description":"Comma separated list of site Ids.","schema":{"type":"string","description":"Comma separated list of site Ids."}},{"name":"start_date","in":"query","required":true,"description":"The start date of the report in the format ddmmyyyy (i.e 31012016)","schema":{"type":"string","description":"The start date of the report in the format ddmmyyyy (i.e 31012016)"}},{"name":"end_date","in":"query","required":true,"description":"The end date of the report in the format ddmmyyyy (i.e 31012016)","schema":{"type":"string","description":"The end date of the report in the format ddmmyyyy (i.e 31012016)"}},{"name":"page","in":"query","required":true,"description":"The page offset to return.","schema":{"type":"integer","description":"The page offset to return."}},{"name":"page_size","in":"query","required":true,"description":"The number of rows to return.","schema":{"type":"integer","description":"The number of rows to return."}},{"name":"reportSubTypeId","in":"query","required":false,"schema":{"type":"integer"}},{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/sites-index":{"get":{"operationId":"open_data_highwaysengland_co_uk_sites_index","summary":"Get a list of sites","description":"GET /v{version}/sites","tags":["open-data"],"parameters":[{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/get-v-version-sites-site-ids":{"get":{"operationId":"open_data_highwaysengland_co_uk_get_v_version_sites_site_ids","summary":"Get selected sites","description":"GET /v{version}/sites/{site_Ids}","tags":["open-data"],"parameters":[{"name":"site_Ids","in":"query","required":true,"description":"site id","schema":{"type":"string","description":"site id"}},{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/site-types-index":{"get":{"operationId":"open_data_highwaysengland_co_uk_site_types_index","summary":"Return list of site types","description":"GET /v{version}/sitetypes","tags":["open-data"],"parameters":[{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:highwaysengland-co-uk/site-types-get-sites-for-public-facing-api":{"get":{"operationId":"open_data_highwaysengland_co_uk_site_types_get_sites_for_public_facing_api","summary":"Returns the layer metadata for the LayerId specified.","description":"GET /v{version}/sitetypes/{siteType_Id}/sites","tags":["open-data"],"parameters":[{"name":"siteType_Id","in":"query","required":true,"description":"1 = MIDAS, 2 = TAME, 3 = TMU, 4 = TRADS Legacy","schema":{"type":"integer","description":"1 = MIDAS, 2 = TAME, 3 = TMU, 4 = TRADS Legacy"}},{"name":"version","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}