{"swagger":"2.0","info":{"version":"v1","title":""},"host":"webtris.highwaysengland.co.uk","basePath":"/api","schemes":["https"],"paths":{"/v{version}/areas":{"get":{"tags":["Areas"],"summary":"Returns list of areas","operationId":"Areas_Get","consumes":[],"produces":["application/json"],"parameters":[{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/AreaResponse"}}},"deprecated":false}},"/v{version}/areas/{area_Ids}":{"get":{"tags":["Areas"],"summary":"Returns details of selected area","operationId":"Areas_Get","consumes":[],"produces":["application/json"],"parameters":[{"name":"area_Ids","in":"path","required":true,"type":"string"},{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/AreaResponse"}}},"deprecated":false}},"/v{version}/quality/overall":{"get":{"tags":["Quality"],"summary":"Get Site OverallQuality","operationId":"Quality_GetOverallDataQualityForSites","consumes":[],"produces":["application/json"],"parameters":[{"name":"sites","in":"query","description":"Get site quality by site id delimited by ,","required":true,"type":"string"},{"name":"start_date","in":"query","description":"The start date of the report in the format ddmmyyyy (i.e 31012016)","required":true,"type":"string"},{"name":"end_date","in":"query","description":"The end date of the report in the format ddmmyyyy (i.e 31012016)","required":true,"type":"string"},{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/OverallQualityResponse"}}},"deprecated":false}},"/v{version}/quality/daily":{"get":{"tags":["Quality"],"summary":"Get Site DailyQuality","operationId":"Quality_GetDailyDataQualityForSite","consumes":[],"produces":["application/json"],"parameters":[{"name":"siteId","in":"query","required":true,"type":"string"},{"name":"start_date","in":"query","description":"The start date of the report in the format ddmmyyyy (i.e 31012016)","required":true,"type":"string"},{"name":"end_date","in":"query","description":"The end date of the report in the format ddmmyyyy (i.e 31012016)","required":true,"type":"string"},{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/DailyQualityResponse"}}},"deprecated":false}},"/v{version}/reports/{report_type}":{"get":{"tags":["Reports"],"summary":"Gets the daily report.","description":"Get's the report.","operationId":"Reports_Index","consumes":[],"produces":["application/json"],"parameters":[{"name":"report_type","in":"path","description":"Report Type Id (i.e Daily, Monthly, Annual)","required":true,"type":"string"},{"name":"sites","in":"query","description":"Comma separated list of site Ids.","required":true,"type":"string"},{"name":"start_date","in":"query","description":"The start date of the report in the format ddmmyyyy (i.e 31012016)","required":true,"type":"string"},{"name":"end_date","in":"query","description":"The end date of the report in the format ddmmyyyy (i.e 31012016)","required":true,"type":"string"},{"name":"page","in":"query","description":"The page offset to return.","required":true,"type":"integer","format":"int32"},{"name":"page_size","in":"query","description":"The number of rows to return.","required":true,"type":"integer","format":"int32"},{"name":"reportSubTypeId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/v{version}/reports/{start_date}/to/{end_date}/{report_type}":{"get":{"tags":["Reports"],"summary":"Gets the daily report.","description":"Get's the report.","operationId":"Reports_Index","consumes":[],"produces":["application/json"],"parameters":[{"name":"report_type","in":"path","description":"Report Type Id (i.e Daily, Monthly, Annual)","required":true,"type":"string"},{"name":"sites","in":"query","description":"Comma separated list of site Ids.","required":true,"type":"string"},{"name":"start_date","in":"path","description":"The start date of the report in the format ddmmyyyy (i.e 31012016)","required":true,"type":"string"},{"name":"end_date","in":"path","description":"The end date of the report in the format ddmmyyyy (i.e 31012016)","required":true,"type":"string"},{"name":"page","in":"query","description":"The page offset to return.","required":true,"type":"integer","format":"int32"},{"name":"page_size","in":"query","description":"The number of rows to return.","required":true,"type":"integer","format":"int32"},{"name":"reportSubTypeId","in":"query","required":false,"type":"integer","format":"int32"},{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/Object"}}},"deprecated":false}},"/v{version}/sites":{"get":{"tags":["Sites"],"summary":"Get a list of sites","operationId":"Sites_Index","consumes":[],"produces":["application/json"],"parameters":[{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/SiteResponse"}}},"deprecated":false}},"/v{version}/sites/{site_Ids}":{"get":{"tags":["Sites"],"summary":"Get selected sites","operationId":"Sites_Index","consumes":[],"produces":["application/json"],"parameters":[{"name":"site_Ids","in":"path","description":"site id","required":true,"type":"string"},{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/SiteResponse"}}},"deprecated":false}},"/v{version}/sitetypes":{"get":{"tags":["SiteTypes"],"summary":"Return list of site types","operationId":"SiteTypes_Index","consumes":[],"produces":["application/json"],"parameters":[{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"200":{"description":"","schema":{"$ref":"#/definitions/SiteTypeResponse"}}},"deprecated":false}},"/v{version}/sitetypes/{siteType_Id}/sites":{"get":{"tags":["SiteTypes"],"summary":"Returns the layer metadata for the LayerId specified.","operationId":"SiteTypes_GetSitesForPublicFacingAPI","consumes":[],"produces":["application/json"],"parameters":[{"name":"siteType_Id","in":"path","description":"1 = MIDAS, 2 = TAME, 3 = TMU, 4 = TRADS Legacy","required":true,"type":"integer","format":"int32"},{"name":"version","in":"path","required":true,"type":"string"}],"responses":{"400":{"description":"Bad request"},"500":{"description":"Internal Server Error"},"404":{"description":"Layer not found"},"200":{"description":"","schema":{"$ref":"#/definitions/SiteTypeLayer"}}},"deprecated":false}}},"definitions":{"AreaResponse":{"type":"object","properties":{"row_count":{"format":"int32","type":"integer"},"areas":{"type":"array","items":{"$ref":"#/definitions/Area"}}}},"Area":{"required":["Name","Description","XLongitude","XLatitude","YLongitude","YLatitude"],"type":"object","properties":{"Id":{"type":"string"},"Name":{"type":"string"},"Description":{"type":"string"},"XLongitude":{"pattern":"^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,15})?))$","type":"string"},"XLatitude":{"pattern":"^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,15})?))$","type":"string"},"YLongitude":{"pattern":"^(\\+|-)?(?:90(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\\.[0-9]{1,15})?))$","type":"string"},"YLatitude":{"pattern":"^(\\+|-)?(?:180(?:(?:\\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\\.[0-9]{1,15})?))$","type":"string"}}},"OverallQualityResponse":{"type":"object","properties":{"row_count":{"format":"int32","type":"integer"},"start_date":{"type":"string"},"end_date":{"type":"string"},"data_quality":{"format":"int32","type":"integer"},"sites":{"type":"string"}}},"DailyQualityResponse":{"type":"object","properties":{"row_count":{"format":"int32","type":"integer"},"Qualities":{"type":"array","items":{"$ref":"#/definitions/Qualities"}}}},"Qualities":{"type":"object","properties":{"Date":{"format":"date-time","type":"string"},"Quality":{"format":"int32","type":"integer"}}},"Object":{"type":"object","properties":{}},"SiteResponse":{"type":"object","properties":{"row_count":{"format":"int32","type":"integer"},"sites":{"type":"array","items":{"$ref":"#/definitions/SiteResult"}}}},"SiteResult":{"type":"object","properties":{"Id":{"type":"string"},"Name":{"type":"string"},"Description":{"type":"string"},"Longitude":{"format":"double","type":"number"},"Latitude":{"format":"double","type":"number"},"Status":{"type":"string"}}},"SiteTypeResponse":{"type":"object","properties":{"row_count":{"format":"int32","type":"integer"},"sitetypes":{"type":"array","items":{"$ref":"#/definitions/SiteType"}}}},"SiteType":{"type":"object","properties":{"Id":{"type":"string"},"Description":{"type":"string"}}},"SiteTypeLayer":{"type":"object","properties":{"Sites":{"type":"array","items":{"$ref":"#/definitions/Sites"}}}},"Sites":{"type":"object","properties":{"Id":{"type":"array","items":{"type":"string"}},"Description":{"type":"array","items":{"type":"string"}},"SiteId":{"type":"array","items":{"type":"string"}},"Longitude":{"type":"array","items":{"format":"double","type":"number"}},"Lattitude":{"type":"array","items":{"format":"double","type":"number"}},"Active":{"type":"array","items":{"type":"boolean"}}}}}}