@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api v1
@base https://webtris.highwaysengland.co.uk/api
@version v1
@common_fields {version: any}
@endpoints 10
@toc v{version}(10)

@endpoint GET /v{version}/areas
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/areas/{area_Ids}
@required {area_Ids: any}
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/quality/overall
@required {sites: any, start_date: any, end_date: any}
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/quality/daily
@required {siteId: any, start_date: any, end_date: any}
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/reports/{report_type}
@required {report_type: any, sites: any, start_date: any, end_date: any, page: any, page_size: any}
@optional {reportSubTypeId: any}
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/reports/{start_date}/to/{end_date}/{report_type}
@required {report_type: any, sites: any, start_date: any, end_date: any, page: any, page_size: any}
@optional {reportSubTypeId: any}
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/sites
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/sites/{site_Ids}
@required {site_Ids: any}
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/sitetypes
@returns(200)
@errors {400, 500}

@endpoint GET /v{version}/sitetypes/{siteType_Id}/sites
@required {siteType_Id: any}
@returns(200)
@errors {400, 404, 500}

@end
