@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
@desc Returns list of areas
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/areas/{area_Ids}
@desc Returns details of selected area
@required {area_Ids: any}
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/quality/overall
@desc Get Site OverallQuality
@required {sites: any # Get site quality by site id delimited by ,, start_date: any # The start date of the report in the format ddmmyyyy (i.e 31012016), end_date: any # The end date of the report in the format ddmmyyyy (i.e 31012016)}
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/quality/daily
@desc Get Site DailyQuality
@required {siteId: any, start_date: any # The start date of the report in the format ddmmyyyy (i.e 31012016), end_date: any # The end date of the report in the format ddmmyyyy (i.e 31012016)}
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/reports/{report_type}
@desc Gets the daily report.
@required {report_type: any # Report Type Id (i.e Daily, Monthly, Annual), sites: any # Comma separated list of site Ids., start_date: any # The start date of the report in the format ddmmyyyy (i.e 31012016), end_date: any # The end date of the report in the format ddmmyyyy (i.e 31012016), page: any # The page offset to return., page_size: any # The number of rows to return.}
@optional {reportSubTypeId: any}
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/reports/{start_date}/to/{end_date}/{report_type}
@desc Gets the daily report.
@required {report_type: any # Report Type Id (i.e Daily, Monthly, Annual), sites: any # Comma separated list of site Ids., start_date: any # The start date of the report in the format ddmmyyyy (i.e 31012016), end_date: any # The end date of the report in the format ddmmyyyy (i.e 31012016), page: any # The page offset to return., page_size: any # The number of rows to return.}
@optional {reportSubTypeId: any}
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/sites
@desc Get a list of sites
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/sites/{site_Ids}
@desc Get selected sites
@required {site_Ids: any # site id}
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/sitetypes
@desc Return list of site types
@returns(200)
@errors {400: Bad request, 500: Internal Server Error}

@endpoint GET /v{version}/sitetypes/{siteType_Id}/sites
@desc Returns the layer metadata for the LayerId specified.
@required {siteType_Id: any # 1 = MIDAS, 2 = TAME, 3 = TMU, 4 = TRADS Legacy}
@returns(200)
@errors {400: Bad request, 404: Layer not found, 500: Internal Server Error}

@end