Version: 0.1
Last Modified: 03/06/2015
This Version: api-reference-v0.1
Contact: Natural Resources Wales <datadistribution@cyfoethnaturiolcymru.gov.uk>
<hr />
This document details a web API for access to the live publication of Bathing Water information published by Natural Resources Wales for bathing waters in Wales that are monitored in order to meet UK reporting obligations under the EU Bathing Water Directive.
Bathing waters are places, designated by legislation, where there is a statutory requirement to monitor and report on the quality of bathing waters during the bathing-water season. The bathing water season runs from early May through to the end of September each year. During the season, weekly samples are collected from about 120 sampling points associated with bathing-waters in Wales. The samples are assessed in a lab. The weekly assessment results are both published in their own right and are used to produce an annual compliance assessment of how well each bathing-water complies with the requirements of the Revised EU Bathing Water Directive.
From the start of 2015 season reporting of bathing water quality for Welsh bathing waters has transitioned to a new site administered by Natural Resource Wales. Bathing water quality and profile information covering the whole of England and Wales prior to 2015 remain available here.
The data model for bathing water profiles, in-season and annual compliance assessments have been extended due to the completion of the transition to the Revised Bathing Water Directive (rBWD)
Natural Resources Wales and Environment Agency Bathing Water Data Model and API are nearly identical. For those familiar with the Environment Agency versions, the differences are described below
<hr />
The publication of bathing-water-quality information as linked data requires the creation or re-use of RDFS (Resource Description Framework Schema) or OWL (Web Ontology Language) vocabularies both for quality assessment data and for supporting reference information about bathing-waters, their zones of influence and sampling-points.
:bwq-vocab-and-dataset-3.png
Vocabulary, Reference and Assessment Information
The diagram above illustrates the primary vocabularies and datasets components that comprise this linked data bathing water quality publication and their top level URI (Uniform Resource Identifiers). Strictly, only the observation datasets contain bathing-water-quality information; the other components act as ‘infrastructure’ to enable its expression.
The diagram below summarises the vocabulary elements that are introduced in the following sections.
:bwq-data-model-rev3.png
Data Model
The vocabulary extract below (in turtle together with the diagram above illustrates the use of the cube vocabulary for in-season bathing-water sample assessments.
###############################################################
#
# Bathing water quality in-season sample assessment DSD.
#
###############################################################
:sampleDsd
a qb:DataStructureDefinition ;
rdfs:comment "A DSD for reporting Bathing Water Quality in-season samples."@en ;
rdfs:label "sampleAssessmentDsd"@en;
rdfs:isDefinedBy bwq-ttl: ;
qb:component
[qb:dimension :bathingWater ; qb:order 1 ],
[qb:dimension :samplingPoint ; qb:order 2 ],
[qb:dimension :sampleWeek ; qb:order 3 ],
[qb:dimension :sampleYear ; qb:order 4 ],
[qb:measure :totalColiformCount], [qb:attribute :totalColiformQualifier],
[qb:measure :faecalColiformCount], [qb:attribute :faecalColiformQualifier],
[qb:measure :faecalStreptococciCount], [qb:attribute :faecalStreptococciQualifier],
[qb:measure :entrovirusCount], [qb:attribute :entrovirusQualifier],
####################################################
## New counts/qualifiers for RBWD
####################################################
[qb:measure :intestinalEnterococciCount], [qb:attribute :intestinalEnterococciQualifier],
[qb:measure :escherichiaColiCount], [qb:attribute :escherichiaColiQualifier],
####################################################
[qb:measure :salmonellaPresent],
[qb:measure :sampleClassification],
[qb:attribute :sampleDateTime],
[qb:attribute :abnormalWeatherException],
[qb:attribute :recordStatus],
[qb:attribute :recordDate],
####################################################
# Additional Attributes for rBWD discounting 26/11/2014
####################################################
[qb:attribute :discountable],
[qb:attribute :discounted];
qb:sliceKey :bySamplingPointKey,
:byWeekKey,
:byYearKey,
:bySamplingPointYearKey;
.
Likewise the following fragment illustrates the cube data structure for annual compliance assessments
###############################################################
#
# Annual bathing water compliance DSD.
#
###############################################################
:complianceDsd
a qb:DataStructureDefinition;
rdfs:comment "A DSD for Bathing Water Quality Annual Compliance assessment reporting."@en;
rdfs:label "complianceDsd"@en;
rdfs:isDefinedBy bwq-ttl: ;
qb:component [qb:dimension :bathingWater; qb:order 1 ],
[qb:dimension :samplingPoint; qb:order 2 ],
[qb:dimension :sampleYear; qb:order 3 ],
[qb:measure :complianceClassification],
[qb:attribute :inYearDetail],
####################################################
# New attributes added for change to rBWD
# to indicate assessment regime and projected/actual nature or assessment
# where absent default values are :cBWD and :actual-assessment respectively
####################################################
[qb:attribute :assessmentRegime],
[qb:attribute :assessmentQualifier],
[qb:attribute :intestinalEnterococciStats],
[qb:attribute :escherichiaColiStats ],
[qb:attribute :firstSampleDate ],
[qb:attribute :finalSampleDate ],
[qb:attribute :latestStepChange ];
qb:sliceKey :complianceByYearKey,
:complianceBySamplingPointKey;
.
The diagram below shows the overall structure of the profile linked data. The properties of profiles, standard language collections and features are described in this document.
:bwp-data-model.png
Data Model
Bathing water profiles and information about features may change. For example, corrections may be made to spellings or the location of a feature may be corrected. In this data model, bathing water profiles and features are versioned, that is, whenever a property of one of those resources is changed, then a new version of the resource is created. Different versions of the ‘same’ bathing water profile or feature have very similar URIs, differing only in their version component. The structure of this versioning is illustrated in the diagram below.
:bwp-versioning-model.png
Versioning Model
The enduring resource is, in a sense, the thing that there are different versions of, say a bathing water profile or a feature. Each enduring resource is linked to each of its versions by a dcterms:hasVersion
property. Each version is in turn linked back to its enduring resource by a dcterms:isVersionOf
property.
Each version has a version:versionString
property whose value is a label for the version. Conventionally this version string will also appear in the versioned resource’s URI.
Each version also has a versionInterval property which indicates the time interval for which the version is current. The time interval must have a hasBeginning property which specifies the instant at which the versioned resource became current. If the version is no longer current, is must have a hasEnd property specifying the instant at which the versioned resource became no longer current. The interval may be thought of as closed at the beginning and open at the end, so that the end of one interval and the beginning of the next may share the same instant. In this case, the boundary instant is in the second interval but not in the first. Instants are described by inXSDDateTime properties whose values are dateTime typed literals.
<hr />
The major reference entities to which bathing-water-quality information needs to refer are the bathing-waters themselves and their sampling points. In addition we provide access to a zone-of-influence which indicates a region associated with a bathing-water where rain-fall may have a significant effect on water quality.
The following URI patterns are used to designate instances of the given class, but bear in mind that whilst they may provide useful ’hint’s URI are in-general considered to be opaque (see cooluris.
Class | URI Pattern | Example URI |
---|---|---|
BathingWater | http://environment.data.gov.uk/wales/bathing-waters/id/bathing-water/{eubwid} | http://environment.data.gov.uk/wales/bathing-waters/id/bathing-water/ukl1702-36800 |
SamplingPoint | http://environment.data.gov.uk/wales/bathing-waters/so/SamplingPoint/{samplePointId} | http://environment.data.gov.uk/wales/bathing-waters/so/SamplingPoint/36800 |
ZoneOfInfluence | http://environment.data.gov.uk/wales/bathing-waters/so/ZoneOfInfluence/{eubwid}:{version} | http://environment.data.gov.uk/wales/bathing-waters/so/ZoneOfInfluence/ukl1702-36800:1 |
Envelope | http://environment.data.gov.uk/wales/bathing-waters/so/Envelope/{eubwid}:{version} | http://environment.data.gov.uk/wales/bathing-waters/so/Envelope/ukl1702-36800:1 |
Property Short Name | Description | Property URL |
---|---|---|
eubwidNotation | The EU bathing-water id of a bathing-water | http://environment.data.gov.uk/def/bathing-water/eubwidNotation |
samplingPoint | A property for associating something, in this case a bathing-water, with a bathing-water sampling point with something else, | http://location.data.gov.uk/def/ef/SamplingPoint/samplingPoint |
zoneOfInfluence | A property for associating something, in this case a bathing-water, with a zone of influence spatial object | http://location.data.gov.uk/def/ef/ZoneOfInfluence/zoneOfInfluence |
uriSet | The URI Set that a thing, in this case a bathing-water, is a member of. | http://reference.data.gov.uk/def/reference/uriSet |
district | A reusable property used here to associate a bathing-water with its local authority district. | http://statistics.data.gov.uk/def/administrative-geography/district |
sameAs | A property for indicating things (bathing-waters in this case) that are identical. e.g.that multiple URI that refer to the same bathing water e.g.: http://environment.data.gov.uk/wales/bathing-waters/id/bathing-water/spittal and http://environment.data.gov.uk/wales/bathing-waters/id/bathing-water/ukc2102-03600 | http://www.w3.org/2002/07/owl#sameAs |
label | One or more names, in this case for a bathing-water. | http://www.w3.org/2000/01/rdf-schema#label |
name | A property for indicating the preferred name of a thing. At most one preferred name may be given per language. English and Welsh language variants are relevant in the case of this dataset. | http://www.w3.org/2004/02/skos/core#prefLabel |
latestSampleAssessment | Associates a bathing-water with its most recent in-season sample assessment | http://environment.data.gov.uk/def/bathing-water-quality/latestSampleAssessment |
latestComplianceAssessment | Associates a bathing-water with its most recent annual compliance assessment | http://environment.data.gov.uk/def/bathing-water-quality/latestComplianceAssessment |
waterQualityImpactedByHeavyRain | A boolean valued indicator of whether (true) or not (false) bathing water quality at the bathing-water is adversely affected by heavy rainfall within the corresponding zone of influence. | http://environment.data.gov.uk/def/bathing-water/waterQualityImpactedByHeavyRain |
(code) type | More detailed typing of bathing-waters using additional sub-classes of BathingWater (CoastalBathingWater, TransitionalBathingWater, LakeBathingWater or InlandBathingWater. | http://www.w3.org/1999/02/22-rdf-syntax-ns#type |
country | A reference to the country (eg. England, Wales or Scotland associated with the bathing-water. | http://statistics.data.gov.uk/def/administrative-geography/country |
county | A reference to the County (or Unitary Authority) associated with a bathing-water | http://statistics.data.gov.uk/def/administrative-geography/county. |
envelope | A reference to an Envelope that conveys map bounds for use in presenting a map of the locale of a bathing-water. | http://location.data.gov.uk/def/common/Geometry/envelope |
regionalOrganization | A reference to the regional organisation responsible for monitoring the water quality at a bathing-water. Typically this will refer to an Environment Agency regional office, however this is likely to vary across the UK. | http://environment.data.gov.uk/def/bathing-water/regionalOrganization |
(code) sedimentTypesPresent | A multi-valued property that conveys an indication of the main sediment types that are to be found at a bathing-water (marsh, mud, rock, sand, shingle or other. | http://environment.data.gov.uk/def/bathing-water/sedimentTypesPresent |
yearDesignated | A reference to the CalendarYear in which a bathing-water was designated as such. | http://environment.data.gov.uk/def/bathing-water/yearDesignated |
yearDedesignated | A reference to the CalendarYear in which a bathing-water was de-designated. | http://environment.data.gov.uk/def/bathing-water/yearDedesignated |
latestRiskPrediction | A reference to the most recently available short-term pollution risk prediction associated with a bathing-water . | http://environment.data.gov.uk/def/bwq-stp/latestRiskPrediction |
latestStepChange | A reference to the most recent step-change associated with a bathing-water . | http://environment.data.gov.uk/def/bathing-water-quality/latestStepChange |
Property Short Name | Description | Property URL |
---|---|---|
easting | The OSGB easting. | http://data.ordnancesurvey.co.uk/ontology/spatialrelations/easting |
northing | The OSGB northing. | http://data.ordnancesurvey.co.uk/ontology/spatialrelations/northing |
lat | The WGS84 latitude. | http://www.w3.org/2003/01/geo/wgs84_pos#lat |
long | The WGS84 longitude. | http://www.w3.org/2003/01/geo/wgs84_pos#long |
bathingWater | A property for associating something, in this case a sampling-point, with a bathing-water. | http://environment.data.gov.uk/def/bathing-water/bathingWater |
samplePointNotation | The Natural Resources Wales sampling point code of a sampling point | http://location.data.gov.uk/def/ef/SamplingPoint/samplePointNotation |
uriSet | The URI Set that a thing, in this case a sampling-point, is a member of. | http://reference.data.gov.uk/def/reference/uriSet |
district | A reusable property used here to associate a sampling-point with its local authority district. | http://statistics.data.gov.uk/def/administrative-geography/district |
label | One or more names, in this case for a sampling-point. | http://www.w3.org/2000/01/rdf-schema#label |
name | A property for indicating the preferred name of a thing. At most one preferred name may be given per language. English and Welsh language variants are relevant in the case of this dataset. | http://www.w3.org/2004/02/skos/core#prefLabel |
Property Short Name | Description | Property URL |
---|---|---|
bathingWater | A property for associating something, in this case a zone-of-influence, with a bathing-water. | http://environment.data.gov.uk/def/bathing-water/bathingWater |
samplingPoint | A property for associating something, in this case a zone-of-influence, with a bathing-water sampling point. | http://location.data.gov.uk/def/ef/SamplingPoint/samplingPoint |
zoiNotation | A zone-of-influence identifier derived from the EU bathing-water id of the corresponding bathing-water. | http://location.data.gov.uk/def/ef/ZoneOfInfluence/zoiNotation |
uriSet | The URI Set that a thing, in this case a zone-of-influence, is a member of. | http://reference.data.gov.uk/def/reference/uriSet |
extent | A reusable property for associating something, a zone-of-influence with its AbstractGeometry. | http://data.ordnancesurvey.co.uk/ontology/geometry/extent |
extent.asGML | A property associated with an a GML literal with an AbstractGeometry. | http://data.ordnancesurvey.co.uk/ontology/geometry/asGML |
label | One or more names, in this case for a zone-of-influence. | http://www.w3.org/2000/01/rdf-schema#label |
name | A property for indicating the preferred name of a thing. At most one preferred name may be given per language. English and Welsh language variants are relevant in the case of this dataset. | http://www.w3.org/2004/02/skos/core#prefLabel |
The bounding box for the map extent showing the locale of a bathing water is expressed as an Envelope illustrated in the diagram below.
:loc-geometry.png
Envelopes and Points
Geometry properties Online-version
Property Short Name | Description | Property URL |
---|---|---|
dimensions | The number of coordinate dimensions used in expressing a Geometry. | http://location.data.gov.uk/def/common/Geometry/dimensions |
(code) srs | The spatial reference system used in teh expression of a Geometry. For example the UK Ordnace Survey National Grid (OSGB-36) is referenced as http://www.opengis.net/def/crs/EPSG/0/27700. | http://location.data.gov.uk/def/common/Geometry/srs |
Point properties Online-version
Property Short Name | Description | Property URL |
---|---|---|
x-coord | x-coordinate of a Point position in the associated spatial reference system. For OSGB-36 this corresponds to an easting | http://location.data.gov.uk/def/common/Geometry/x |
y-coord | y-coordinate of a Point position in the associated spatial reference system. For OSGB-36 this corresponds to a northing | http://location.data.gov.uk/def/common/Geometry/y |
z-coord | z-coordinate of a Point position in the associated spatial reference system. | http://location.data.gov.uk/def/common/Geometry/z |
Envelope properties Online-version
Property Short Name | Description | Property URL |
---|---|---|
lowerCorner | The corner of an Envelope where all the coordinates are at their minimum value. | http://location.data.gov.uk/def/common/Geometry/lowerCorner |
upperCorner | The corner of an Envelope where all the coordinates are at their maximum value. | http://location.data.gov.uk/def/common/Geometry/upperCorner |
asGML | A property associated with an a GML literal with an AbstractGeometry | http://data.ordnancesurvey.co.uk/ontology/geometry/asGML |
<hr />
Class | URI Pattern | Example URI |
---|---|---|
SampleAssessment | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/sample/point/{samplePointId}/date/{sampleDate}/time/{sampleTime}/recordDate/{recordDate} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/sample/point/37800/date/20150507/time/102000/recordDate/20150507 |
ComplianceAssessment | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/compliance/point/{samplePointId}/year/{year} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/compliance/point/37800/year/2015 |
In addition to the main entities above, there are a number of dataset slices which collect in-season and annual compliance assessments into convenient groupings.
Class | URI Pattern | Example URI |
---|---|---|
In-Season LatestSampleSlice |
http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/latest | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/latest |
In-Season ByYearSlice |
http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/year/{year} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/year/2010 |
In-Season BySamplingPointSlice |
http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/point/{samplePointId} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/point/05300 |
In-Season BySamplingPointYearSlice |
http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/point/{samplePointId}/year/{year} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/point/05300/year/2008 |
In-Season ByWeekSlice |
http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/week/{yearWeek} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/in-season/slice/week/2000-W30 |
Annual ComplianceBySamplingPointSlice |
http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/compliance/slice/point/{samplePointId} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/compliance/slice/point/03600 |
Annual ComplianceByYearSlice |
http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/compliance/slice/year/{year} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/compliance/slice/year/2009 |
|. Property Short Name |{width:40%}. Description |_{width:40%}. Property URL |
|(code). abnormalWeatherException | Boolean valued indication of whether an exception waiver applies (true) or not (false) to a sample-assessment |(code). http://environment.data.gov.uk/def/bathing-water-quality/abnormalWeatherException |
|(code). bwq_bathingWater | Link to the bathing-water from which the sample was taken. |(code). http://environment.data.gov.uk/def/bathing-water-quality/bathingWater |
|(code). bwq_samplingPoint | Link to the sampling-point from which the sample was taken. |(code). http://environment.data.gov.uk/def/bathing-water-quality/samplingPoint |
|(code). sampleDateTime | The date and time at which the same sample was taken. |(code). http://environment.data.gov.uk/def/bathing-water-quality/sampleDateTime |
|(code). sampleWeek | The week for which the sample is representative. |(code). http://environment.data.gov.uk/def/bathing-water-quality/sampleWeek |
|(code). sampleYear | The year for which the sample is representative. |(code). http://environment.data.gov.uk/def/bathing-water-quality/sampleYear |
|(code). recordDate | The date of record for the assessment. The assessment may have a recordStatus which may be new for a first assessment of a sample, replacement for a replacement assessment of the same sample, or withdrawal which withdraws all earlier assessments of the same water sample. |(code). http://environment.data.gov.uk/def/bathing-water-quality/recordDate |
|(code). recordStatus | The status of sample assessment record, which may be new for a first assessment of a sample, replacement for a replacement assessment of the same sample, or withdrawal which withdraws all earlier assessments of the same water sample. |(code). http://environment.data.gov.uk/def/bathing-water-quality/recordStatus |
|(code). entrovirusCount | The number of colonies of entro virus grown per 100ml water sample.|(code). http://environment.data.gov.uk/def/bathing-water-quality/entrovirusCount |
|(code). entrovirusQualifier | moreThan, lessThan or actual count qualifier for entrovirusCount. |(code). http://environment.data.gov.uk/def/bathing-water-quality/entrovirusQualifier |
|(code). faecalColiformCount | The number of colonies of faecal coliform grown per 100ml water sample. |(code). http://environment.data.gov.uk/def/bathing-water-quality/faecalColiformCount |
|(code). faecalColiformCountQualifier | moreThan, lessThan or actual count qualifier for faecalColiformCount. |(code). http://environment.data.gov.uk/def/bathing-water-quality/faecalColiformCountQualifier |
|(code). faecalStreptococciCount | The number of colonies of faecal streptococci grown per 100ml water sample. |(code). http://environment.data.gov.uk/def/bathing-water-quality/faecalStreptococciCount |
|(code). faecalStreptococciCountQualifier | moreThan, lessThan or actual count qualifier for faecalStreptococciCount.|(code). http://environment.data.gov.uk/def/bathing-water-quality/faecalStreptococciCountQualifier |
|(code). salmonellaPresent | Salmonella present indicator for the sample assessement which may be: present, not-present or not-assessed . |(code). http://environment.data.gov.uk/def/bathing-water-quality/salmonellaPresent |
|(code). totalColiformCount | The total number of colonies of coliform grown per 100ml water sample. |(code). http://environment.data.gov.uk/def/bathing-water-quality/totalColiformCount |
|(code). totalColiformQualifier | moreThan, lessThan or actual count qualifier for totalColiformCount. |(code). http://environment.data.gov.uk/def/bathing-water-quality/totalColiformQualifier |
|(code). sampleClassification |
In season bathing water sample assessment classification:
Pre-2012 classifications
C (closed), G (Higher) formerly G (Excellent), I (Minimum) formerly I (Good), F (Fail) formerly F (Poor), N (Not classified)
2012-2014 rBWD transitional classifications
C (closed), G (Higher), I (Minimum), F (Fail), N (Not classified)
Note that each group of classifications use different URI.
Post 2014 rBWD classifications
The transition to monitoring and reporting under the Revised Bathing Water Directive (rBWD) completed at the end of the 2014 bathing-water season. For the 2015 and subsequent bathing water season reporting and monitoring will according to the requirements of the revised bathing-water directive. As a consequence of this individual in-seasons sample assessments are NOT classified. There are only annual compliance assessments have classifications that represent the aggregation of the results from upto 4 years of in-season sampling.
|(code). http://environment.data.gov.uk/def/bathing-water-quality/sampleClassification |
|(code). created | The date or dateTime when the RDF record of the sample assessment was created. |(code). http://purl.org/dc/terms/created |
|(code). source | Link source file and record for the sample assessment |(code). http://purl.org/dc/terms/source |
|(code). dataSet | Link to the Cube DataSet that contains the sample-assessment |(code). http://purl.org/linked-data/cube#dataSet |
|(code). intestinalEnterococciCount | The number of colonies of intenstinal enterococci grown per 100ml water sample |(code). http://environment.data.gov.uk/def/bathing-water-quality/intestinalEnterococciCount |
|(code). intestinalEnterococciQualifier | moreThan, lessThan or actual count qualifier for intestinalEnterococciCount. |(code). http://environment.data.gov.uk/def/bathing-water-quality/intestinalEnterococciQualifier |
|(code). escherichiaColiCount | The number of colonies of escherichia coli grown per 100ml water sample |(code). http://environment.data.gov.uk/def/bathing-water-quality/escherichiaColiCount |
|(code). escherichiaColiQualifier | moreThan, lessThan or actual count qualifier for escherichiaColiCount. |(code). http://environment.data.gov.uk/def/bathing-water-quality/escherichiaColiQualifier |
|(code). followingSuspension | A link to an immediately following suspension-of-monitoring record in the same assessment season, if any. |(code). http://environment.data.gov.uk/def/bwq-som/followingSuspension |
|(code). priorSuspension | A link to an immediately previous suspension-of-monitoring record in the same assessment season, if any. |(code). http://environment.data.gov.uk/def/bwq-som/priorSuspension |
|(code). discountable | A boolean valued flag that indicates whether the sample assessment meets criteria that allow it to be discounted from annual compliance assessments. The absence of a value for this flag indicates that it the sample assessment may yet be judged to be discountable. However, once set as discountable true
, or non-discountable, false
the value of the flag is not expected to be changed. |(code). http://environment.data.gov.uk/def/bathing-water-quality/discountable |
|(code). discounted | A boolean value which if set indicates that a discountable sample assessment has in fact been discounted (true
) from use in annual compliance results or not (false
). It expected that the decision that sets this flag is made at the end of corresponding bathing-water season for all discountable sample assessments during that season. Once the discounted
flag has been set, whether true
or false
it retains that setting with respect to all annual compliance assessments to which it might contribute over the following 4 years. |(code). http://environment.data.gov.uk/def/bathing-water-quality/discounted |
|. Property Short Name |{width:40%}. Description |_{width:40%}. Property URL |
|(code). bwq_bathingWater | Link to the bathing-water for which the assessment is made. |(code). http://environment.data.gov.uk/def/bathing-water-quality/bathingWater |
|(code). bwq_samplingPoint | Link to the sampling-point from which the samples were taken. |(code). http://environment.data.gov.uk/def/bathing-water-quality/samplingPoint |
|(code). sampleYear | The calendar year of the assessment. |(code). http://environment.data.gov.uk/def/bathing-water-quality/sampleYear |
|(code). inYearDetail | Link to the in-season BySamplingPointYearSlice from which the compliance assessment was made.
Under the rBWD regime inYearDetail
may refer to up-to 4 such slices, for the current and previous 3 years. Compliance assessments are computed from the undiscounted
, unwithdrawn
, unreplaced
in-season sample assessments associated with each such slice that were made between the firstSampleDate
and finalSampleDate
associated with the compliance assessment . |(code). http://environment.data.gov.uk/def/bathing-water-quality/inYearDetail |
|(code). dataSet | Link to the Cube DataSet that contains the compliance-assessment |(code). http://purl.org/linked-data/cube#dataSet |
|(code). complianceClassification |
Annual bathing water quality compliance assessment classification:
Pre-2012 classifications
C (closed), G (Higher) formerly G (Excellent), I (Minimum) formerly I (Good), F (Fail) formerly F (Poor), N (Not classified)
2012-2014 rBWD transitional classifications
C (closed), G (Higher), I (Minimum), F (Fail), N (Not classified)
Note that each group of classifications use different URI.
Post 2014 rBWD classifications
Excellent (1), Good (2), Sufficient (3), Poor (4). Insufficiently Sampled (5), New, and Closed
Under the Revised Bathing Water Directive, annual compliance classifications are aggregated over as many as 4 years of in-season sampling. Consequently both a new data-cube and new compliance codes are defined for the rBWD Monitoring regime.
|(code). http://environment.data.gov.uk/def/bathing-water-quality/complianceClassification |
|(code). assessmentRegime | The assessment regime associated an annual compliance assessment. If no value is given then the default is the earlier ’current Bathing Water Directive` (cBWD) from 1976. Regime values are defined for rBWD and cBWD |(code). http://environment.data.gov.uk/def/bathing-water-quality/assessmentRegime |
|(code). assessmentQualifier | A qualifier that indicates whether a given annual compliance assessment is projected or actual. Around the transition to a new monitoring and reporting regime, such as the completion of the rBWD transition in 2015, projected compliance assessment may be prepared using data gather during the transition period where the reported results during that period were made under the previous regime (cBWD in this case). These projected assessments provide for continuity with current and future actual compliance assessments made under the new regime. |(code). http://environment.data.gov.uk/def/bathing-water-quality/assessmentQualifier |
|(code). intestinalEnterococciStats | References summary statistics associated with the intestinal enterococci count determinand over the sampling interval of the assessment. |(code). http://environment.data.gov.uk/def/bathing-water-quality/intestinalEnterococciStats |
|(code). escherichiaColiStats | References summary statistics associated with the escherichia coli (ecoli) count determinand over the sampling interval of the assessment. |(code). http://environment.data.gov.uk/def/bathing-water-quality/escherichiaColiStats |
|(code). firstSampleDate | The date on which the first in-season assessment relevant to the given compliance assessment was made. |(code). http://environment.data.gov.uk/def/bathing-water-quality/firstSampleDate |
|(code). finalSampleDate | The date on which the last in-season assessment relevant to the given compliance assessment was made. |(code). http://environment.data.gov.uk/def/bathing-water-quality/finalSampleDate |
|(code). latestStepChange | A reference to the most recent step-change associated with a bathing-water that affect the given sample assessment. |(code). http://environment.data.gov.uk/def/bathing-water-quality/latestStepChange |
Dataset slices have key properties whose value is the same for all observations (SampleAssessments or ComplianceAssessments) associated with the slice by the qb:observation (shortname observation) property. The key properties for each type of slice are listed by short name in the table below.
Type of Slice | Slice Key Property Short Names |
---|---|
LatestSampleSlice | none |
BySamplingPointSlice | bwq_samplingPoint, bwq_bathingWater |
ByYearSlice | sampleYear |
ByWeekSlice | sampleWeek |
BySamplingPointYearSlice | bwq_samplingPoint, bwq_bathingWater, sampleYear |
ComplianceBySamplingPointSlice | bwq_samplingPoint, bwq_bathingWater |
ComplianceByYearSlice | sampleYear |
The data model around Annual Compliance Assessments has been expanded to include several new entities:
These are illustrated in the following diagram.
:bwq-data-model-rBWD-compliance-assessment.png
rBWD extended Compliance Assessment Data Model
Field | Description |
---|---|
{regime} | An optional token embedded within a URI that indicates monitoring and reporting regime associated with a compliance assessment and related entities, such as summary statistics. |
{bwspid} | A bathing water sampling point code embedded within a URI |
{complianceYear} | The reporting year for a compliance assessment or related artifact. |
{measureStats} | A field that discriminates between the summary statistics for different determinands. Currently values of escherichiaColiStats or intestinalEnterococciStats are operational. |
{changeDate} | A reference date when a step-change is deemed to have occurred. The value is intend solely as a discriminator between multiple step-changes at the same bathing water. |
{complianceCode} | The compliance code associated with a Threshold. |
{measureProperty | The measure property associated with a threshold - intended as a discriminator between multiple thesholds associated with the same complianceCode : currently intestinal-enterococci or escherichia-coli |
{bathingWaterType} | The type of Bathing Water associated with a Threshold: currently inland , coastal , transitional or lake |
Summary statistics provides information about the distribution of colony count values reported by in-season sample assessments used in making a compliance assessemnt.
Property Short Name | Description | Property URL |
---|---|---|
measure | A reference to the measure property obeing summarised by the statistics | http://environment.data.gov.uk/def/bathing-water-quality/measure |
meanValue | The mean value of the property value being summarised | http://environment.data.gov.uk/def/bathing-water-quality/meanValue |
meanLog10Value | The mean of the Log10 of the property value being summarised. | http://environment.data.gov.uk/def/bathing-water-quality/meanLog10Value |
minValue | The munimum value of the property being summarised | http://environment.data.gov.uk/def/bathing-water-quality/minValue |
maxValue | The maximum value of the property being summarised | http://environment.data.gov.uk/def/bathing-water-quality/maxValue |
percentile90 | The value of the summarised property at the 90th percentile. | http://environment.data.gov.uk/def/bathing-water-quality/percentile90 |
percentile95 | The value of the summarised property at the 95th percentile | http://environment.data.gov.uk/def/bathing-water-quality/percentile95 |
sampleCount | The number of sample assessments contributing to the compliance assessment. | http://environment.data.gov.uk/def/bathing-water-quality/sampleCount |
stdDeviation | The standard deviation of the summarised property value | http://environment.data.gov.uk/def/bathing-water-quality/stdDeviation |
stdDeviationLog10 | The standard deviation of Log10 of the summarised property value | http://environment.data.gov.uk/def/bathing-water-quality/stdDeviationLog10 |
complianceAssessment | A reference to the annual compliance assessment to which the statistics pertain | http://environment.data.gov.uk/def/bathing-water-quality/complianceAssessment |
Step Changes record significant changes that have been made in the locale of a bathing-water, generally with the intent of improving bathing-water quality.
Property Short Name | Description | Property URL |
---|---|---|
bathingWater | A reference to the bathing water affected by the change. | http://environment.data.gov.uk/def/bathing-water/bathingWater |
samplingPoint | A reference to the sampling point at the bathing water affected by the change | http://location.data.gov.uk/def/ef/SamplingPoint/samplingPoint |
dateOfChange | The date from which the StepChange is regarded as being effective from the point-of-view of affecting the annual compliance assessment for a bathing water. Following a StepChange, the in-season sample assessments gatherer prior to the Step Change may no longer contribute to the annual compliance assessment. | http://environment.data.gov.uk/def/bathing-water-quality/dateOfChange |
comment | A narrative comment explaining the change that has been made. | http://www.w3.org/2000/01/rdf-schema#comment |
Online version - Threshold
Online version - UpperThreshold
Online version - LowerThreshold
Thresholds provide for the expression of explicit limits used in annually assessing the compliance of a collection of bathing-water samples taken at a bathing water.
Property Short Name | Description | Property URL |
---|---|---|
assessmentRegime | A reference to the corresponding compliance assessment regime, e.g. rBWD | http://environment.data.gov.uk/def/bathing-water-quality/assessmentRegime |
classification | The compliance classification for which this Threshold is a limit. | http://environment.data.gov.uk/def/bathing-water-quality/classification |
limit | The limit associated with a Threshold. In the case of an UpperThreshold limit conveys the maximum value that the measure permitted for the given classification . Similarly, in the case of a LowerThreshold limit conveys the minimum value the measure permitted in order for the given classification to apply. |
http://environment.data.gov.uk/def/bathing-water-quality/limit |
measure | A reference to the ComplianceAssessment measure property to which this Threshold applies. | http://environment.data.gov.uk/def/bathing-water-quality/measure |
percentile | Conveys the percentile, usually 90 or 95, to which the limit of the Threshold applies. |
http://environment.data.gov.uk/def/bathing-water-quality/percentile |
waterType | The specific type of bathing water to which the Threshold applies. A given Compliance classification may have multiple UpperThresholds each for a different type of bathing water. | http://environment.data.gov.uk/def/bathing-water-quality/waterType |
Under the revised Bathing Water directive, during an abnormal situation normal monitoring of a bathing water may be suspended. As of v0.3 of this API such suspension of monitoring records are accessible and relate to the 2012 bathing water season.
Monitoring may be suspended for a variety of abnormal situations, not just abnormal weather conditions.
:bwq-suspension-of-monitoring.png
Suspension of Monitoring
Class | URI Pattern | Example URI |
---|---|---|
SuspensionOfMonitoring | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/suspension/point/{bwspid}/date/{date}/time/{time}/recordDateTime/{recordDateTime} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/suspension/point/12300/date/20120604/time/090000/recordDateTime/201206121700 |
Note at the time of writing there NRW has yet to publish a suspension of monitoring. The example URI above will 404.
For the purposes of creating unique URI for SuspensionOfMonitoring records:
bwspid
embeds a 5 digit bathing water sampling point code;date
embeds the date on which a suspension started in YYYYMMdd
format;time
embeds the time of day (local) at which the suspension started in HHmmss
format; andrecordDateTime
embeds the date and time that the record was itself created or modified in YYYYMMddHHmm
format.Property Short Name | Description | Property URL |
---|---|---|
description | A description of the cause of the suspension-of-monitoring | http://purl.org/dc/term/description |
comment | An additional comment giving narrative details about the suspension-of-monitoring | http://www.w3.org/2000/01/rdf-schema#comment |
som_notation notation |
A coded value which common for all suspension-of-monitoring records related to a particular suspension. | http://environment.data.gov.uk/def/bwq-som/notation http://www.w3.org/2004/02/skos/core#notation |
bathingWater | A property for associating something, in this case a suspension-of-monitoring record, with a bathing-water. | http://environment.data.gov.uk/def/bathing-water/bathingWater |
samplingPoint | A property for associating something, in this case a suspension-of-monitoring record, with a bathing-water sampling point. | http://location.data.gov.uk/def/ef/SamplingPoint/samplingPoint |
sampleYear | The assessment year of a “suspension-of-monitoring”. | http://environment.data.gov.uk/def/bathing-water-quality/sampleYear |
regionalOrganization | The regional organisation responsible for monitoring the water quality at a bathing-water associated with a suspension-of-monitoring record. Typically this will refer to an Environment Agency regional office, however this is likely to vary across the UK. | http://environment.data.gov.uk/def/bathing-water/regionalOrganization |
startOfSuspension | The date and time (xsd:dateTime ) at which the corresponding suspension-of-monitoring started. |
http://environment.data.gov.uk/def/bwq-som/startOfSuspension |
expectedEndOfSuspension | The date (xsd:date ) on which the corresponding “suspension-of-monitoring” is expected to end. |
http://environment.data.gov.uk/def/bwq-som/expectedEndOfSuspension |
endOfSuspension | The date and time (xsd:dateTime ) at which the corresponding “suspension-of-monitoring” actually ended. |
http://environment.data.gov.uk/def/bwq-som/endOfSuspension |
recordDateTime | The creation or modification date and time (xsd:dateTime ) at which the corresponding suspension-of-monitoring record was created/changed. |
http://environment.data.gov.uk/def/bwq-som/recordDateTime |
followingAssessment | An immediately following sample-assessment for the same bathing-water and assessment year, if any. | http://environment.data.gov.uk/def/bwq-som/followingAssessment |
priorAssessment | An immediately prior sample-assessment for the same bathing-water and assessment year, if any. | http://environment.data.gov.uk/def/bwq-som/followingAssessment |
relatedAssessment | Immediately prior or following sample assessments for the same bathing-water and assessment year, if any. | http://environment.data.gov.uk/def/bwq-som/relatedAssessment |
During the summer of 2013 Natural Resources Wales will start to publish daily predictions of short-term pollution risk. Increased risk typically arises from rainfall. Short term RiskPredictions are modelled as illustrated below.
:bwq-short-term-pollution-warning.png
Short Term Pollution Risk Prediction
Class | URI Pattern | Example URI |
---|---|---|
RiskPrediction | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/stp-risk-prediction/point/{bwspid}/date/{date} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/stp-risk-prediction/point/40600/date/20150510-083510 |
For the purposes of creating unique URI for RiskPrediction records:
bwspid
embeds a 5 digit bathing water sampling point code for the sampling point at the bathing-water associated with the prediction;date
embeds the date for which the prediction was made in yyyyMMdd-hhmmss
format;Property Short Name | Description | Property URL |
---|---|---|
stp_bathingWater | The bathing-water associated with a risk-prediction. | http://environment.data.gov.uk/def/bwq-stp/bathingWater |
stp_samplingPoint | The sampling-point associated with a risk-prediction. | http://environment.data.gov.uk/def/bwq-stp/samplingPoint |
predictedOn | The day on which the prediction was made, expressed as an xsd:date . |
http://environment.data.gov.uk/def/bwq-stp/predictedOn |
predictedAt | The date and time when the prediction was made, expressed as an xsd:dateTime . |
http://environment.data.gov.uk/def/bwq-stp/predictedAt |
expiresAt | The date and time when the prediction expires, expressed as an xsd:dateTime . |
http://environment.data.gov.uk/def/bwq-stp/expiresAt |
publishedAt | The date and time when the prediction was published, expressed as an xsd:dateTime . |
http://environment.data.gov.uk/def/bwq-stp/publishedAt |
riskLevel | The predicted level of risk: code>normal, code>increased or code>unknown. | http://environment.data.gov.uk/def/bwq-stp/riskLevel |
<hr />
Features are versioned following the versioningModel. Resources of type Enduring Feature are the enduring resources. Resources of type Feature are their versions.
The following URI patterns is used to designate instances of a class, but bear in mind that whilst they may provide useful ’hint’s URI are in-general considered to be opaque (see cooluris ).
Class | URI Pattern | Example URI |
---|---|---|
Feature | http://environment.data.gov.uk/wales/bathing-waters/so/BathingWaterProfileFeature/{featureId}:{version} | http://environment.data.gov.uk/wales/bathing-waters/so/BathingWaterProfileFeature/FE-AN0316901-1-1:1 |
Enduring Feature | http://environment.data.gov.uk/wales/bathing-waters/so/BathingWaterProfileFeatureEndurant/{featureId} | http://environment.data.gov.uk/wales/bathing-waters/so/BathingWaterProfileFeatureEndurant/FE-AN0316901-1-1 |
Property Short Name | Description | Property URL |
---|---|---|
type | A property for indicating the type of a resource, in this case one of disused outfall ( DO ), emergency or storm overflow ( ESO ), river or stream intersection ( RSI ), surface water outfall ( SWO ) or treated sewage works outfall ( TSO ). | http://www.w3.org/1999/02/22-rdf-syntax-ns#type |
label | A property for associating a human readable label with a resource. | http://www.w3.org/2000/01/rdf-schema#label |
bathingWater | A property for associating something, in this case a feature, with a bathing water | http://environment.data.gov.uk/def/bathing-water/bathingWater |
easting | A property for associating something, in this case a feature, with its UK National Grid easting coordinate. | http://data.ordnancesurvey.co.uk/ontology/spatialrelations/easting |
northing | A property for associating something, in this case a feature, with its UK National Grid northing grid coordinate. | http://data.ordnancesurvey.co.uk/ontology/spatialrelations/northing |
lat | A property for associating something, in this case a feature, with a WGS84 latitude in decimal degrees. | http://www.w3.org/2003/01/geo/wgs84_pos#lat |
long | A property for associating something, in this case a feature, with a WGS84 longitude in decimal degrees. | http://www.w3.org/2003/01/geo/wgs84_pos#lat |
regionalOrganisation | A property used here to associate a feature with its responsible Environment Agency regional organisation. | http://environment.data.gov.uk/def/bathing-water/regionalOrganization |
isVersionOf | A property used here to associate an entity, in this case a feature, with the thing it is a a version of, in this case an EnduringFeature. | http://purl.org/dc/terms/isVersionOf |
versionInterval | A property used here to associate a versioned entity, in this case a feature, with the interval for which it was current. | http://environment.data.gov.uk/def/version/interval |
versionString | A property used here to associate a versioned entity, in this case a feature, with a string label for the version. | http://environment.data.gov.uk/def/version/versionString |
source | A property used here to associate a bathing water profile in linked data form with the data from which it was derived. | http://purl.org/dc/terms/source |
uriSet | The URI Set that a thing, in this case a feature, is a member of. | http://reference.data.gov.uk/def/reference/uriSet |
Property Short Name | Description | Property URL |
---|---|---|
hasVersion | A property used here to associate an enduring entity, in this case an enduring feature, with an entity that represents a version of it, in this case a feature. | http://purl.org/dc/terms/isVersionOf |
uriSet | The URI Set that a thing, in this case an enduring feature, is a member of | http://reference.data.gov.uk/def/reference/uriSet |
<hr />
Bathing water profiles are essentially a collection of natural language statements about bathing waters, published by Natural Resources Wales. A bathing water profile has a year of publication or applicable year. New profiles may be published about a bathing water from time to time, the frequency depending on the assessment of the water quality at the bathing water, but not more than once a year. New profiles are considered to be new publications, not new versions of the same publication. However, once published, a profile may be updated to correct errors. A corrected profile is considered to be a new version of the profile for an applicable year.
Bathing water profiles follow the versioning model. Resources of type EnduringBathingWaterProfile are the enduring profiles. Resources of type BathingWaterProfile are their versions.
Bathing water profiles contain standard language which is common across many profiles. Individual profiles are linked to a standard language collection which has properties describing the standard language.
The following URI patterns is used to designate instances of a class, but bear in mind that whilst they may provide useful ’hint’s URI are in-general considered to be opaque (see cooluris ).
Class | URI Pattern | Example URI |
---|---|---|
BathingWaterProfile | http://environment.data.gov.uk/wales/bathing-waters/id/bathing-water-profile/{eubwid}/{year}:{ver} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-profile/ukl1100-39980/2015:1 |
EnduringBathingWaterProfile | http://environment.data.gov.uk/wales/bathing-waters/id/bathing-water-profile-endurant/{eubwid}/{year} | http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-profile-endurant/ukl1100-39980/2015 |
Standard Language | http://environment.data.gov.uk/wales/bathing-waters/id/bathing-water-profile-standard-language/{year}:{ver} http://environment.data.gov.uk/wales/bathing-waters/id/bathing-water-profile-standard-language/{year}-{bwspid}:{ver} |
http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-profile-standard-language/2015-39980:1 |
Property Short Name | Description | Property URL |
---|---|---|
label | A property for associating a human readable label with a resource. | http://www.w3.org/2000/01/rdf-schema#label |
name | A property for indicating the preferred name of a thing. At most one preferred name per language, english and welsh in the case of this dataset. | http://www.w3.org/2004/02/skos/core#prefLabel |
bathingWater | A property for associating a bathing water with something else. | http://environment.data.gov.uk/def/bathing-water/bathingWater |
applicableYear | A property for associating a bathing water profile with the year it applies to, typically the year it was published. | http://environment.data.gov.uk/def/bathing-water-profile/applicableYear |
standardLanguageCollection | A property for associating a bathing water profile with a collection of standard language that applies to many profiles. See standard language collection properties. | http://environment.data.gov.uk/def/bathing-water-profile/standardLanguageCollection |
localAuthority | A property for associating something with a local authority. This property exists primarily to provide a name for the local authority. See local authority properties. | http://statistics.data.gov.uk/def/administrative-geography/localAuthority |
countyName | A colloquial name for the county containing the bathing water. This is the name of the county used by Natural Resources Wales on its published profiles and may differ from the names provided in reference data such as provided by the Ordinance Survey. | http://environment.data.gov.uk/def/bathing-water-profile/countyName |
bathingWaterDescription | A property used for associating a bathing water profile with a physical description of a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/bathingWaterDescription |
zoiDescription | A property used for associating a bathing water profile with a physical description of the surrounding catchment impacting on a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/zoiDescription |
streamsRiversStatement | A property used for associating a bathing water profile with a statement about details of streams and rivers that impact water quality at the bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/streamsRiversStatement |
investigationsStatement | A property used for associating a bathing water profile with a statement about details of any Environment Agency investigations into water quality which have impacted on the bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/eaInvestigationsStatement |
historyStatement | A property used for associating a bathing water profile with a statement about details of the history of any water company assets which impact a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/historyStatement |
stwOutfallsStatement | A property used for associating a bathing water profile with a statement about details of any sewage treatment outfalls which may impact on a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/stwOutfallsStatement |
esoOutfallsStatement | A property used for associating a bathing water profile with a statement about details of any emergency outfalls and storm overflow outfalls which may impact on a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/esoOutfallsStatement |
localAuthorityStatement | A property used for associating a bathing water profile with a statement about details of any work or improvements to water quality undertaken with the local authority which may impact on a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/localAuthorityStatement |
misconnectionsStatement | A property used for associating a bathing water profile with a brief statement about misconnections and any details specific to a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/misconnectionsStatement |
workingWithFarmersStatement | A property used for associating a bathing water profile with a statement about details of any work or improvements to water quality undertaken with local farmers which may impact on a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/workingWithFarmersStatement |
workingWithIndustryStatement | A property used for associating a bathing water profile with a statement about details of any work or improvements to water quality undertaken with local industry which may impact on a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/workingWithIndustryStatement |
workingWithPrivateOwnersStatement | A property used for associating a bathing water profile with a statement about details of any work or improvements to water quality undertaken with private owners which may impact on a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/workingWithPrivateOwnersStatement |
macroAlgaeStatement | A property used for associating a bathing water profile with a brief statement about Macroalgae (seaweed) at a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/macroAlgaeStatement |
phytoplanktonStatement | A property used for associating a bathing water profile with a brief statement about Phytoplankton at a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/phytoplanktonStatement |
webResImage | A property used for associating a bathing water profile with an image of the bathing water at a resolution suitable for displaying on a web page. | http://environment.data.gov.uk/def/bathing-water-profile/webResImage |
isVersionOf | A property used here to associate an entity with the enduring thing it is a a version of. | http://purl.org/dc/terms/isVersionOf |
versionInterval | A property used here to associate a versioned entity with the interval for which it was current. | http://environment.data.gov.uk/def/version/interval |
versionString | A property used here to associate a versioned entity with a string label for the version. | http://environment.data.gov.uk/def/version/versionString |
source | A property used here to associate a bathing water profile in linked data form with the data from which it was derived. | http://purl.org/dc/terms/source |
otherPollutionSourcesStatement | A property used to relate a bathing water profile to a brief statement about other sources of pollution at a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/otherPollutionSourcesStatement |
pollutionRiskForecastStatement | A property used to relate a bathing water profile to a brief statement the use and occurence of pollution risk forecasts at a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/pollutionRiskForecastStatement |
pollutionRiskForecasting | A property used to indicate when the corresponding bathing-water is part of the Pollution Risk Reporting (PRF) programme during the period covered by the profile. | http://environment.data.gov.uk/def/bathing-water-profile/pollutionRiskForecasting |
seasonStartDate | A property that indicates the first day of the interval during which the associated bathing-water will be monitoring during the season covered by the version of the bathing water profile. | http://environment.data.gov.uk/def/bathing-water-profile/seasonStartDate |
seasonFinishDate | A property that indicates the last day of the interval during which the associated bathing-water will be monitoring during the season covered by the version of the bathing water profile. | http://environment.data.gov.uk/def/bathing-water-profile/seasonFinishDate |
seasonInterval | A property used to relate a bathing water profile to an interval indicating the period of time over which the associated bathing-water will be monitoring during the season covered by the version of the bathing water profile. | http://environment.data.gov.uk/def/bathing-water-profile/seasonInterval |
stepChangeStatement | A property used to relate a bathing water profile to a brief statement summarising step-changes, typically improvements, that affect the water quality at a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/stepChangeStatement |
visiblePollutionStatement | A property used to relate a bathing water profile to a brief statement about visible pollution at a bathing water. | http://environment.data.gov.uk/def/bathing-water-profile/visiblePollutionStatement |
account | A property used to relate a bathing-water profile to a social-media account used by a responsible agency to provide information about the bathing-water by social media channels. | http://xmlns.com/foaf/0.1/account |
Property Short Name | Description | Property URL |
---|---|---|
label | A property for associating a human readable label with a resource, in this case the name of the local authority. | http://www.w3.org/2000/01/rdf-schema#label |
district | A reusable property used here to associate a local authority with the district it administers. | http://statistics.data.gov.uk/def/administrative-geography/district |
Property Short Name | Description | Property URL |
---|---|---|
label | A property for associating a human readable label with a resource. | http://www.w3.org/2000/01/rdf-schema#label |
name | A property for indicating the preferred name of a thing. At most one preferred name per language, english and welsh in the case of this dataset. | http://www.w3.org/2004/02/skos/core#prefLabel |
pollutionManagementGeneralStatement | A property used for associating a bathing water profile with a brief statement of how Natural Resources Wales manages pollution at bathing waters. | http://environment.data.gov.uk/def/bathing-water-profile/pollutionManagementGeneralStatement |
stwOutfallsGeneralStatement | A property used for associating a bathing water profile with a brief general statement of the improvements to sewage treatment outfalls. | http://environment.data.gov.uk/def/bathing-water-profile/stwOutfallsGeneralStatement |
esoOutfallsGeneralStatement | A property used for associating a bathing water profile with a brief statement about Emergency outfalls and Storm overflow outfalls. | http://environment.data.gov.uk/def/bathing-water-profile/esoOutfallsGeneralStatement |
localAuthorityGeneralStatement | A property used for associating a bathing water profile with a brief statement about precipitation run-off from roads and pavements. | http://environment.data.gov.uk/def/bathing-water-profile/localAuthorityGeneralStatement |
algaeGeneralStatement | A property used for associating a bathing water profile with a brief statement about Algae in general at bathing waters | http://environment.data.gov.uk/def/bathing-water-profile/algaeGeneralStatement |
Property Short Name | Description | Property URL |
---|---|---|
hasVersion | A property used here to associate an enduring bathing water profile with a version of that profile. | http://purl.org/dc/terms/isVersionOf |
<hr />
The Bathing Water Quality API is implemented as an LDA (Linked-Data API) configuration.
The LDA framework provides for item and list endpoints.
Item endpoints are typically used as a way of realising linked-data URI for items of interest: vocabulary terms; things in the world - bathing waters, sampling points, zones of influence; and information items (documents, graphs, information objects) that describe those making use of vocabulary terms from one or more linked-data vocabularies.
List endpoints are used to generate pages that contain descriptions of items selected to meet particular criteria built in to the endpoint configuration and which may be augmented by parameters carried in the request URI. Request URI parameters may narrow the range of items presented in a response. A given list endpoint produces a series of pages which together traverse the set if items that meet the filter criteria for the endpoint augmented with filters from the URI.
Both item and list endpoints can be configured with one or more view. A view is a projection of some part of the RDF graph that emanates from the selected item, in the case of an item endpoint, or from each item included in a response page generated by a list endpoint.
Item and List endpoints can be configured with one or more views which can be selected through the use of a common LDA URI parameter _view
. Views are lists of property chains formed through the use of ‘.’ separated property short names. Pre-configured views can also be augmented with additional property chains through the use of the _properties
LDA URI parameter. For example:
&_properties=samplingPoint.easting,samplingPoint.northing
will include the OSGB easting and northings (if any) associated with a sampling point (if any) associated with selected items (typically bathing waters).
&_properties=district.gssCode
will include the GSS (Government Statistical Services) geography code (if any) of a local authority district (if any) associated with selected items (typically bathing waters).
In the API reference below property chains associated with pre-configured API endpoint views are listed. The _properties
provides a way for API users to augment any of the available or built-in views.
Built-in views that are operative for most available item and list endpoints are as follows:
View | Description |
---|---|
basic | Presents item type and label properties |
description | Presents all the properties of selected items, and of b-node objects linked to selected items and so-on following links as far URI node or Literal items. A so-called b-node closure |
all | As description, but including available labels for all objects that are mentioned. |
Note that _view=description
and particularly _view=all
can generate large and time consuming queries when used in conjunction with slice listing endpoints (see below). This is because slices in general carry a large number of observations or assessments resulting in a large number of items to mention and/or to gather labels for presentation. Where possible technical measures are either in place or under development to prevent their use in circumstance where they would be of little utility at best.
For list endpoints, the item selection can be refined through the use of filter terms. For example, given the general bathing water list endpoint detailed below, the following URI will list all bathing water associated with a district whose GSS code is E07000188
, i.e. Sedgemoor District.
http://environment.data.gov.uk/wales/bathing-waters/doc/bathing-water?district.gssCode=E07000188
Similarly, the following URI will list all in-season sample assessments that have been withdrawn:
http://environment.data.gov.uk/wales/bathing-waters/doc/bathing-water-quality/in-season/sample?recordStatus=withdrawal
or the following URI will list all in-season sample assessments that have sample assessment classification of Excellent.
http://environment.data.gov.uk/wales/bathing-waters/doc/bathing-water-quality/in-season/sample?sampleAssessment.name=Excellent
LDA also provides mechanisms that enable value ranges to be expressed, so for example in order to list all the latest in-season sample assessments for bathing water sampling points that fall within a given northing and eastings bounding box, URI such as the following can be used.
http://environment.data.gov.uk/wales/bathing-waters/doc/bathing-water-quality/in-season/latest?min-bwq_samplingPoint.easting=240209&max-bwq_samplingPoint.easting=293209&min-bwq_samplingPoint.northing=155718&max-bwq_samplingPoint.northing=212718
note the use of min-{P}
and max-{P}
to establish minimum and maximum filter range values for {P}
. In this case {P}
stands for the property chains bwq_samplingPoint.northing
and bwq_samplingPoint.easting
.
It is also possible to filter selected items based on the presence or absence of a property using the exists-{P}=
URI parameter. For example the following URI will list in-season SampleAssessment
that have been replaced:
http://environment.data.gov.uk/wales/bathing-waters/doc/bathing-water-quality/in-season/sample?exists-isReplacedBy=true
Similarly, the following URI lists SampleAssessments
that have not been replaced:
http://environment.data.gov.uk/wales/bathing-waters/doc/bathing-water-quality/in-season/sample?exists-isReplacedBy=false
Each LDA endpoint is also capable of delivering its responses in several formats which can be triggered through the use of HTTP content-negotiation or the use of an explicit .ext
mechanism were the .ext
is inserted at the end of the URI path and prior to any URI query component. e.g. reusing an earlier example, a JSON response can be generated using the following URI:
http://environment.data.gov.uk/wales/bathing-waters/doc/bathing-water.json?district.gssCode=E07000188
Extension | Media Type | Description |
---|---|---|
.rdf | application/rdf+xml | RDF/XML formatted data |
.ttl | text/turtle | Terse RDF Triple Language formatted data |
.xml | text/xml | LDA XML formatted data |
.json | application/json and text/javascript |
LDA JSON formatted data. Available both as JSON objects and JSONP callback scripts. |
.html | text/html | HTML formatted data. |
.text | text/plain | JSON formatted output presented with a text/plain media type. |
.csv | text/csv | Comma separated value formatted data. |
LDA provides both configuration and URI parameter based mechanisms for setting the default language choices for information presented via a view and for information selected via a filter. The bathing-water quality API is configured to default to filter-on and present text literals tagged with as English or that are untaggged.
This configuration can be overridden using _lang
and lang-{P}
URI parameters - where {P}
is a shortname for a property or a property chain. The value of the parameter is a comma separated list of language tag values. For this API, relevant language tag values are: en
for English, cy
for Welsh and none
for untagged values.
lang-{P}
affects the languages used in filter matches that involve the property whose short-name is {P}
.
URI Parameter Setting | Description |
---|---|
lang-name=en,none | Filters that involve the property whose short-name is name match values tagged as English or that are untagged. |
lang-mbox=none | Filters that involve the property whose short-name is mbox match only untagged values. |
_lang=en,cy,none | Sets the default languages for all filter properties and view projected values as English, Welsh or untagged. |
_lang=cy,none | Sets the default languages for all filter properties and view projected values as Welsh or untagged. |
In the case where there is are no values tagged with at least one of the configured languages, any available untagged values are presented instead.
The most useful values to use for the these parameters are en,none
, the configured default, and en,cy,none
which includes any text tagged as being Welsh in the output.
URI Parameter | Value Description |
---|---|
exists-{P} | A boolean value parameter that filters items based on whether the given property chain, &{P} , can be bound. |
min-{P} | Sets an inclusive lower-bound filter on the value of the given property chain, {P} . Selected items must have a value for {P} that is greater than or equal to that given in the parameters value |
max-{P} | Sets an inclusive upper-bound filter on the value of the given property chain, {P} . Selected items must have a value for {P} that is less than or equal to that given in the parameter’s value |
minEx-{P} | Sets an exclusive lower-bound filter on the value of the given property chain, {P} . Selected items must have a value for {P} that is greater than that given in the parameter’s value |
maxEx-{P} | Sets an exclusive upper-bound filter on the value of the given property chain, {P} . Selected items must have a value for {P} that is less than that given in the parameter’s value |
_lang | A comma separated list of languages used for both filter based selection and value projection in response data. Default: en,none |
_pageSize | The requested maximum number of items to be on a requested list endpoint page. |
_page | The page number of a requested list endpoint page. |
_properties | A comma separated list of properties or property chains that are added to any default or selected views. |
_sort | A comma separated list of property shortnames or property chains which are used to order the items returned by a list endpoint. A leading ‘-’ character on any property or property chain selects a descending rather than ascending order. |
_view | A view name that selects a pre-configured view that moderates the amount of detail presented about a given item in a resultset. |
callback | A javascript function named used when generating a JSONP response. |
More details about common LDA URI parameters can be found in the LDA Specification
It should be evident from this simple introduction that the LDA framework provides a powerful URI based mechanism for selecting and projecting information held with in an RDF store for use in implementing linked data URI pages and for building data consuming web applications.
<hr />
This reference is divided into three sections, one each for API endpoint collected at environment.data.gov.uk
and location.data.gov.uk
respectively and a final section that acts as a cross reference for shortnames that can be use to build property-chains for both views (&_properties=
) and filters (&{P}={V}
) as part of a URI based API call. Property chains can only be followed through items that have the corresponding properties. The Datamodel section earlier listed the properties that may be used from each of the available entry types.
Within each of the first two sub sections below, API endpoints are organised by the item type that they return and that share configured views. Each section lists:
Item Types: various: Ontology, OWL Class, RDFS Class, RDF Property, Datatype Property, Object Property, Datatype, ConceptScheme, Concept, Cube Data Structure Definition, Cube Slice Key
Endpoint URI Template http://environment.data.gov.uk |
List or Item | Description | Views |
---|---|---|---|
/def | List | Lists vocabularies whose URI names begin http://environment.data.gov.uk/def/ | description, scheme |
/def/{vocabulary} | List | Lists vocabulary terms defined within http://environment.data.gov.uk/def/{vocabulary}/. Currently, {vocabulary} = “bathing-water” or “bathing-water-quality” or “bathing-water-profile” or “bwq-som” or “bwq-stp” or “bwq-cc-2012” or “bwq-cc-2015” . |
description, scheme |
/def/{vocabulary}/ | Item | Returns data about a given vocabulary. | description, scheme |
/def/{vocabulary}/{term} | Item | Returns the definition of an individual vocabulary term. | description, definition |
/def/{vocabulary}/{term}/instance | List | For a given {term} where http://environment.data.gov.uk/def/{vocabulary}/{term} is a class, returns a list of instances of that class. |
description, definition |
/def/{vocabulary}/{term}/property | List | For a given {term} where http://environment.data.gov.uk/def/{vocabulary}/{term} is a class, returns a list of properties used within the data by instances of that class. |
description, definition |
/def/{vocabulary}/{term}/subclass | List | For a given {term} where http://environment.data.gov.uk/def/{vocabulary}/{term} is a class, returns a list of defined subclasses of that class. |
description, definition |
View | Properties |
---|---|
description | Built-in |
definition | name, type, definition, alias, label, note, scopeNote, topConcept, topConceptOf, broader.name, narrower.name, comment, range, domain, type.label, isDefinedBy.label, subClassOf.label, subPropertyOf.label |
scheme | name, type, alias, label, note, scopeNote, contributor.who, contributor.mbox, topConcept.name, comment, isDefinedBy.label |
BathingWater
class from the bathing-water
vocabulary presented through the endpoint’s default view.BathingWater
class whose name
property has a value of “Spittal” presented through the endpoint’s default view.BathingWater
.SampleAssessment
from the bathing-water-quality
vocabulary.New as of bwq-api v0.5
Item Types: Threshold UpperThreshold LowerThreshold
|. Endpoint URI Template
http://environment.data.gov.uk |{width:5%}. List or Item |. Description |{width:15%}. Views |
|(code). /def/{codeset}/{code}/threshold/measure/{measure}/water/{water} | Item | Returns informations about a particular compliance assessment threshold. |(code). description, basic, all |
|(code). /def/{codeset}/{code}/threshold/measure/{measure} | List | Lists compliance assessment thresholds for a given compliance classification, {code}
, and measure property, {measure}
.
This will return thresholds that vary by water type, {water}
. |(code). description, basic, all |
|(code). /def/{codeset}/{code}/threshold | List | Lists compliance thresholds for a given compliance classification, {code}
.
This will return thresholds that vary by water type, {water}
and measure propery, {measure}
. |(code). description, basic, all |
|. View |{width:85%}. Properties |
|(code). basic | Built-in |
|(code). description | Built-in |
|(code). all | Built-in |
{water}=coastal
) Esherchia-Coli colony count ({measure}=escherichia-coli
) threshold (upper) for a “Good” classification ({code}=2
) using the endpoints default view (description
).{water}=inland
) Intestinal-Enterococci colony count ({measure}=intestinal-enterococci
) threshold (upper) for a “Sufficient” classification ({code}=3
) using the endpoints default view.{measure}=escherichia-coli
) thresholds (upper) across all bathing water types to achieve a “Good” ({code}=2
) classification using the built-in all
viewer.{code}=3
) classification across all water types and measures using the endpoints default view.As of the start of the 2015 bathing-water season the dataset structure described here has been rendered largely irrelevant. Natural Resources Wales have resposnibility for monitoring and reporting on bathing-water quality for Welsh bathing waters. Welsh bathing water quality information is now published separately at: http://environment.data.gov.uk/wales/bathing-waters. The structure anticipated below remains in place however its is now populated solely by the Environment Agency and as of 2015 will only be updated with new information about bathing-water quality in England. Existing information about bathing-water quality in England and Wales prior to 2015 remains in place.
The previous dataset organisation has been extended in preparation for bathing-water quality data and reference information being published by multiple monitoring bodies within the UK, for example SEPA in Scotland and a future Single Environmental Body for Wales.
The top level in-season sample assessment and annual compliance assessment cube datasets are retained however, they are each formulated as an aggregation of underlying subsets with an in-season assessment subset and an annual compliance subset per monitoring body. Dataset slices remain formulated over the entire aggregation as before, however individual observations (SampleAssessments and ComplianceAssessments are linked to the per monitoring body subset. Baseline and incremental updates of per monitoring body in-season and annual compliance dataset are formulated as distinct subsets of the corresponding per monitoring body cubes.
SuspensionOfMonitoring are organised similarly as a hierarchy of VoID datasets rooted in the top-level bathing-water-quality dataset with an over all suspension-of-monitoring with per monitoring body aggregation subsets eg. http://environment.data.gov.uk/wales/bathing-waters/data/bathing-water-quality/eaew/suspension which collects subordinate baseline and incremental suspension of monitoring datasets.
This is illustrated in the diagram below:
:EA-3-DatasetOrganisation.png
In-Season, Annual Compliance and Suspension-of-Monitoring Dataset Organisation
Item type: VoID Dataset, Cube Dataset
|. Endpoint URI Template
http://environment.data.gov.uk/wales/bathing-waters |{width:5%}. List or Item |. Description |{width:15%}. Views |
|(code). /data | List | Lists VoID and Cube datasets within the environment.data.gov.uk |(code). dataset, basic, description |
|(code). /data/bathing-water-quality | Item | Top-level Bathing Water Quality dataset |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{dataset} | Item | Top-level in-season or annual compliance data assessment datasets {dataset} = “in-season” or “compliance” or “suspension”
|(code). dataset, basic, description |
|(code). /data/bathing-water-quality/in-season/dataset-increment | List | List available in-season dataset subsets corresponding to baseline and incremental update data |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{dataset}/dataset-increment/{increment} | Item | Describes a particular dataset subset |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/in-season | Item | Returns information about a particular publisher’s or monitoring body’s in-season sample assessment cube dataset (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/in-season/ | List | Lists baseline and incremental update (void) datasets that contribute to a particular publisher’s or monitoring body’s in-season sample assessment (cube) dataset (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/in-season/dataset-increment/{release} | Item | Return information about a particular publisher’s or monitoring body’s baseline or incremental release of in-season sample assessment data (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/compliance | Item | Returns information about a particular publisher’s or monitoring body’s annual compliance assessment cube dataset (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/compliance/ | List | Lists baseline and incremental update (void) datasets that contribute to a particular publisher’s or monitoring body’s annual compliance assessment (cube) dataset (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/compliance/dataset-increment/{release} | Item | Return information about a particular publisher’s or monitoring body’s baseline or incremental release of annual compliance assessment data (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/suspension | Item | Returns information about a particular publisher’s or monitoring body’s suspension of monitoring dataset (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/suspension/ | List | Lists baseline and incremental update (void) datasets that contribute to a particular publisher’s or monitoring body’s suspension-of-monitoring dataset (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/suspension/dataset-increment/{release} | Item | Return information about a particular publisher’s or monitoring body’s baseline or incremental release of suspension-of-monitoring data (see dataset organisation ). |(code). dataset, basic, description |
|(code) /data/bathing-water-quality/{publisher}/compliance-{regime}/ | List | For a particular compliance assessment regime ,{regime}
, lists baseline and incremental update (void) datasets that contribute to a particular publisher’s or monitoring body’s annual compliance assessment (cube) dataset. (see dataset organisation ). |(code). dataset, basic, description |
|(code). /data/bathing-water-quality/{publisher}/compliance-{regime}/dataset-increment/{release} | Item | For a particular compliance assessment regime ,{regime}
, return information about a particular publisher’s or monitoring body’s baseline or incremental release of annual compliance assessment data (see dataset organisation ). |(code). dataset, basic, description |
View | Properties |
---|---|
basic | Built-in |
description | Built-in |
dataset | name, label, type, comment, description, created, modified, subset, subset.label, subset.name, dataDump, vocabulary, vocabulary.label, license, source, structure, uriRegexPattern |
Item Type: BathingWater
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/id/bathing-water/ /doc/bathing-water/ |
Item | Describes Natural Resources Wales bathing-water URIset. | all, description |
/id/bathing-water /doc/bathing-water |
List | Lists designated bathing waters that are members of the bathing-water URI set. In particular, the list omits formerly designated bathing waters that have been de-designated. | all, desciption, bathing-water |
/id/bathing-water/{eubwid} /doc/bathing-water/{eubwid} |
Item | Describes a particular bathing-water. | all, desciption, bathing-water |
/doc/nearest-bathing-water/easting/{easting}/northing/{northing} | List | Lists designated bathing waters that are nearest to a location given by an OSGB easting and northing. In particular, the list omits formerly designated bathing waters that have been de-designated. | all, desciption, bathing-water |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
bathing-water | name, type, envelope.label, sedimentTypesPresent, yearDesignated, yearDedesignated, district.name, zoneOfInfluence.name, county.name, country.name, regionalOrganization.name, waterQualityImpactedByHeavyRain, eubwidNotation, uriSet.name, uriSet.label, seeAlso, sameAs, samplingPoint.name, samplingPoint.lat, samplingPoint.long, samplingPoint.easting, samplingPoint.northing, latestSampleAssessment, latestSampleAssessment.sampleClassification.name, latestComplianceAssessment, latestComplianceAssessment.complianceClassification.name |
district
properties associated with the returned bathing-water descriptions. The list page is rendered in a default or content-negotiated format.90000<=easting<=240000
and 0<=northing<=70000
, viewed through the default view for the endpoint.Item type: SampleAssessment
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/doc/bathing-water-quality/in-season/sample | List | General listing endpoint for listing in-season sample assessment. Beware of the use of the _sort URI parameter without further qualifying the sample assessment being sought. There are in-excess of 210k in-season sample assessments in the dataset. |
location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
/data/bathing-water-quality/in-season/sample/point/{bwspid}/date/{date}/time/{time}/recordDate | List | List sample assessments for a given bathing-water or sampling-point with the same sampling date and time. This lists new, replacement and withdrawal sample assessment records for the same sample. | location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
/data/bathing-water-quality/in-season/sample/point/{bwspid}/date/{date}/time/{time}/recordDate/{recDate} | Item | Describes a particular in-season sample assessment | location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
/doc/bathing-water-quality/in-season/latest | List | List the latest, un-replaced, un-withdrawn in-season sample assessments. At most one per bathing-water. | location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
/doc/bathing-water-quality/in-season/bathing-water/{eubwid} | List | Lists un-replaced, un-withdrawn in-season sample assessments for a given bathing-water | location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
/doc/bathing-water-quality/in-season/bathing-water/{eubwid}/latest | List | Lists the (single) latest, un-withdrawn, un-replaced in-season sample assessment for a given bathing-water. | location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
/doc/bathing-water-quality/in-season/point/{bwspid} | List | Lists un-replaced, un-withdrawn in-season sample assessments taken at a given sampling-point. | location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
/doc/bathing-water-quality/in-season/point/{bwspid}/latest | List | Lists the (single) latest, un-withdrawn, un-replaced in-season sample assessment taken at a given sampling-point. | location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
/doc/bathing-water-quality/in-season/latest-nearest/easting/{easting}/northing/{northing} | List | List the latest in-season sample assessments taken at sampling-points closest to a location given by OSGB easting and northing. By default list the nearest 5 sample assessments in order of increasing distance. _pageSize can be used to vary the number of results and further results can be obtained on successive pages using the _page |
location, assessment, assessment-csv, classification, coliforms, streptococci, entrovirus, salmonella, description |
View | Properties |
---|---|
description | Built-in |
location | label, type, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_samplingPoint.easting, bwq_samplingPoint.northing, bwq_samplingPoint.lat, bwq_samplingPoint.long, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, sampleClassification.complianceCodeNotation, sampleClassification.name, totalColiformQualifier.countQualifierNotation, totalColiformCount, faecalColiformQualifier.countQualifierNotation, faecalColiformCount, faecalStreptococciQualifier.countQualifierNotation, faecalStreptococciCount, entrovirusQualifier.countQualifierNotation, entrovirusCount, escherichiaColiCount, escherichiaColiQualifier.countQualifierNotation, intestinalEnterococciCount, intestinalEnterococciQualifier.countQualifierNotation, salmonellaPresent.name, salmonellaPresent.presenceNotation, abnormalWeatherException |
assessment | label, type, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, sampleClassification.complianceCodeNotation, sampleClassification.name, totalColiformQualifier.countQualifierNotation, totalColiformCount, faecalColiformQualifier.countQualifierNotation, faecalColiformCount, faecalStreptococciQualifier.countQualifierNotation, faecalStreptococciCount, entrovirusQualifier.countQualifierNotation, entrovirusCount, escherichiaColiCount, escherichiaColiQualifier.countQualifierNotation, intestinalEnterococciCount, intestinalEnterococciQualifier.countQualifierNotation, salmonellaPresent.name, salmonellaPresent.presenceNotation, abnormalWeatherException |
assessment-csv | type, bwq_samplingPoint.samplePointNotation, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, sampleClassification.complianceCodeNotation, totalColiformQualifier.countQualifierNotation, totalColiformCount, faecalColiformQualifier.countQualifierNotation, faecalColiformCount, faecalStreptococciQualifier.countQualifierNotation, faecalStreptococciCount, entrovirusQualifier.countQualifierNotation, entrovirusCount, escherichiaColiCount, escherichiaColiQualifier.countQualifierNotation, intestinalEnterococciCount, intestinalEnterococciQualifier.countQualifierNotation, salmonellaPresent.presenceNotation, abnormalWeatherException |
classification | type, label, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, sampleClassification.complianceCodeNotation, sampleClassification.name, abnormalWeatherException |
coliforms | type, label, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, totalColiformQualifier.countQualifierNotation, totalColiformCount, faecalColiformQualifier.countQualifierNotation, faecalColiformCount, abnormalWeatherException |
streptococci | type, label, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, faecalStreptococciQualifier.countQualifierNotation, faecalStreptococciCount, abnormalWeatherException |
entrovirus | type, label, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, entrovirusQualifier.countQualifierNotation, entrovirusCount, abnormalWeatherException |
salmonella | type, label, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, salmonellaPresent.name, salmonellaPresent.presenceNotation, abnormalWeatherException |
intestinalEnterococci | type, label, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, intestinalEnterococciQualifier.countQualifierNotation, intestinalEnterococciCount, abnormalWeatherException |
escherichiaColi | type, label, source, dataset, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.name, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleDateTime.inXSDDateTime, sampleWeek.label, escherichiaColiQualifier.countQualifierNotation, escherichiaColiCount, abnormalWeatherException |
SampleAssessment
whose recordStatus
is replacement
meaning that they are a replacement for an earlier SampleAssessment
.SampleAssessments
whose sampleClassification
have a name
of Excellent
and whose sampleDateTime
lies between midnight on 20th June 2011 and midnight on 30th June 2011. The page is rendered in a content-negotiated format viewed through the endpoints default view.SampleAssessment
taken at a SamplingPoint
that lies within a box bounded by 280000<=easting<=360000
and 150000<=northing<=190000
. The page is viewed with the endpoints default view.SampleAssessment
nearest to a point-of-interest easting=329114
, northing=154114
that have a sampleClassification
with a name
of Good
. The list entries are ordered by increasing straight-line distance from the point of interest. The page is rendered in a content-negotiated format viewed using the endpoints default view.SampleAssessments
that have been superceeded by a subsequent SampleAssessment
. The page is rendered in a content-negotiated format viewed using the endpoints default view.Item type: Slice, ByYearSlice, BySamplingPointSlice, BySamplingPointYearSlice, ByWeekSlice
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/data/bathing-water-quality/in-season/slice | List | List all in-season dataset slices | basic |
/data/bathing-water-quality/in-season/slice/latest | Item | Describes the (singleton) latest in-season assessment slice | basic, description |
/data/bathing-water-quality/in-season/slice/point | List | List all in-season BySamplingPointSlice slices. | slice-by-point, basic |
/data/bathing-water-quality/in-season/slice/point/{point} | Item | Describes an in-season BySamplingPointSlice for a given sampling-point. | slice-by-point, description |
/data/bathing-water-quality/in-season/slice/point-year | List | List all in-season BySamplingPointYearSlice slices. | slice-by-point-year, basic |
/data/bathing-water-quality/in-season/slice/point/{point}/year/{year} | Item | Describes an in-season BySamplingPointYearSlice slice for a given sampling-point and year | slice-by-point-year, description, basic |
/data/bathing-water-quality/in-season/slice/week | List | List all in-season ByWeekSlice slices. | slice-by-week, basic |
/data/bathing-water-quality/in-season/slice/week/{week} | Item | Describes an in-season ByWeekSlice for a given week. | slice-by-week, description |
/data/bathing-water-quality/in-season/slice/year | List | List all in-season ByYearSlice slices. | slice-by-year, basic |
/data/bathing-water-quality/in-season/slice/year/{year} | Item | Describes an in-season ByYearSlice for a given year. | slice-by-year, description |
View | Properties |
---|---|
basic | Built-in |
description | Built-in |
slice-by-point (list) | name, label, bwq_samplingPoint.name, bwq_samplingPoint.easting, bwq_samplingPoint.northing, bwq_samplingPoint.lat, bwq_samplingPoint.long |
slice-by-point (item) | name, label, bwq_samplingPoint.name, bwq_samplingPoint.easting, bwq_samplingPoint.northing, bwq_samplingPoint.lat, bwq_samplingPoint.long, observation.sampleWeek.label |
slice-by-point-year (list) | name, label, sampleYear.ordinalYear, bwq_samplingPoint.name, bwq_samplingPoint.easting, bwq_samplingPoint.northing, bwq_samplingPoint.lat, bwq_samplingPoint.long |
slice-by-point-year (item) | name, label, sampleYear.ordinalYear, bwq_samplingPoint.name, bwq_samplingPoint.easting, bwq_samplingPoint.northing, bwq_samplingPoint.lat, bwq_samplingPoint.long, observation.sampleWeek.label |
slice-by-week (list) | name, label, sampleWeek.ordinalWeekOfYear, sampleWeek.ordinalWeekOfYearYear |
slice-by-week (item) | name, label, sampleWeek.ordinalWeekOfYear, sampleWeek.ordinalWeekOfYearYear, observation.bwq_samplingPoint.name |
slice-by-year (list) | name, label, sampleYear.ordinalYear |
slice-by-year (item) | name, label, sampleYear.ordinalYear, observation.bwq_samplingPoint.name, observation.sampleWeek.label |
Caution: given the large number of SampleAssessments
associated with many slices, it is unwise to use the built-in views, _view=all
or _view=description
, in conjuction with slice listing endpoints.
ByWeekSlice
slice for all SampleAssessment
taken in week 20 of 2010. The page is rendered in a content-negotiated format viewed using the endpoints default view.ByWeekSlice
slices for week 20 of any year, ordered by year. The page is rendered in a content-negotiated format viewed using the endpoint’s default view.Item Type: Annual ComplianceAssessment
In order to accomodate a the transition to the monitoring and reporting regime of the Revised Bathing Water Directive (rBWD), new per-regime compliance assessment datasets have been created. As of the start of the 2015 bathing water season, annual compliance assessments are reported under the rBWD regime. In addtion, projected rBWD compliance assessments for earlier years (2014 and earlier) are also available. rBWD compliance assessments include and assessmentQualifier property that indicates whether they are actual-assessment or a projected-assessment rBWD compliance assessments are accessed using the URI patterns that include a -{regime}
component. Pre-BWD compliance assessments, under the earlier 1976 bathing-water directive, are accessed using the URI patterns without the -{regime}
component. The -[regime}
component in the URI patterns below is intended to anticipate future changes in monitoring and assessment regimes.
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/doc/bathing-water-quality/compliance /doc/bathing-water-quality/compliance-{regime} |
List | General listing endpoint for listing annual compliance assessments | compliance, description, compliance-csv, with-stats |
/data/bathing-water-quality/compliance/point/{bwspid}/year/{year} /data/bathing-water-quality/compliance-{regime}/point/{bwspid}/year/{year} |
Item | Describes an annual compliance assessment for samples taken at a given sampling point for a given year. | compliance, description, compliance-csv, with-stats |
/doc/bathing-water-quality/compliance/latest /doc/bathing-water-quality/compliance-{regime}/latest |
List | List the most recent annual compliance assessment for each bathing water. | compliance, description, compliance-csv, with-stats |
/doc/bathing-water-quality/compliance/latest-nearest/easting/{easting}/northing/{northing} /doc/bathing-water-quality/compliance-{regime}/latest-nearest/easting/{easting}/northing/{northing} |
List | List the most recent annual compliance assessment taking at sampling points that are closest to a location given by an OSGB easting and northing. By default list the nearest 5 compliance assessments in order of increasing distance. _pageSize can be used to vary the number of results and further results can be obtained on successive pages using the _page . |
compliance, description, compliance-csv, with-stats |
/doc/bathing-water-quality/compliance/bathing-water/{eubwid} /doc/bathing-water-quality/compliance-{regime}/bathing-water/{eubwid} |
List | Lists annual compliance assessments for a given bathing-water. | compliance, description, compliance-csv, with-stats |
/doc/bathing-water-quality/compliance/bathing-water/{eubwid}/latest /doc/bathing-water-quality/compliance-{regime}/bathing-water/{eubwid}/latest |
List | Lists the single latest compliance assessment for a given bathing-water. | compliance, description, compliance-csv, with-stats |
/doc/bathing-water-quality/compliance/point/{bwspid} /doc/bathing-water-quality/compliance-{regime}/point/{bwspid} |
List | Lists annual compliance assessments taken at a given sampling point. | compliance, description, compliance-csv, with-stats |
/doc/bathing-water-quality/compliance/point/{bwspid}/latest /doc/bathing-water-quality/compliance-{regime}/point/{bwspid}/latest |
List | Lists the single latest compliance assessment taken at a given sampling point. | compliance, description, compliance-csv, with-stats |
View | Properties |
---|---|
description | Built-in |
compliance | type, label, source, bwq_samplingPoint.name, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.easting, bwq_samplingPoint.northing, bwq_samplingPoint.lat, bwq_samplingPoint.long, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleYear.ordinalYear, complianceClassification.complianceCodeNotation, complianceClassification.name Added as of bwq-api v0.5 assessmentRegime.name, assessmentQualifier.name, intestinalEnterococciStats, escherichiaColiStats |
compliance-csv | label, source, bwq_samplingPoint.name, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.easting, bwq_samplingPoint.northing, bwq_samplingPoint.lat, bwq_samplingPoint.long, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleYear.ordinalYear, complianceClassification.complianceCodeNotation, complianceClassification.name, assessmentRegime.name, assessmentQualifier.name, intestinalEnterococciStats.*, escherichiaColiStats.* |
with stats | type, label, source, bwq_samplingPoint.name, bwq_samplingPoint.samplePointNotation, bwq_samplingPoint.easting, bwq_samplingPoint.northing, bwq_samplingPoint.lat, bwq_samplingPoint.long, bwq_bathingWater.name, bwq_bathingWater.eubwidNotation, sampleYear.ordinalYear, complianceClassification.complianceCodeNotation, complianceClassification.name, assessmentRegime.name, assessmentQualifier.name, intestinalEnterococciStats.*, escherichiaColiStats.* |
ComplianceAssessment
whose complianceClassification
has a name of Poor
. The page is rendered in a content-negotiated format viewed using the endpoints default view.ComplianceAssessment
for bathing-waters whose SamplingPoint
is nearest to a point-of-interest at easting=329114
, northing=154114
, ordered by increasing straight-line distance from that point. The page is rendered in a content-negotiated format viewed using the endpoints default view.ComplianceAssessment
recorded under the rBWD annual compliance regime whose complianceClassification
have a name of Poor
. The page is rendered in a content-negotiated format viewed using the endpoints default view.Item type: Annual ComplianceByYearSlice, Annual ComplianceBySamplingPointSlice
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/data/bathing-water-quality/compliance/slice /data/bathing-water-quality/compliance-{regime}/slice |
List | List all annual compliance dataset slices | basic |
/data/bathing-water-quality/compliance/slice/point /data/bathing-water-quality/compliance-{regime}/slice/point |
List | List all annual compliance ComplianceBySamplingPointSlice slices. | slice-by-point |
/data/bathing-water-quality/compliance/slice/point/{point} /data/bathing-water-quality/compliance-{regime}/slice/point/{point} |
Item | Describe an annual compliance ComplianceBySamplingPointSlice for a given sampling-point. | slice-by-point, description |
/data/bathing-water-quality/compliance/slice/year /data/bathing-water-quality/compliance-{regime}/slice/year |
List | List all annual compliance ComplianceByYearSlice slices. | slice-by-year |
/data/bathing-water-quality/compliance/slice/year/{year} /data/bathing-water-quality/compliance-{regime}/slice/year/{year} |
Item | Describe an annual compliance ComplianceByYearSlice slice for a given year. | slice-by-year, description |
View | Properties |
---|---|
basic | Built-in |
description | Built-in |
slice-by-point (list) | name, label, bwq_bathingWater.name |
slice-by-point (item) | name, label, bwq_bathingWater.name, observation.sampleYear.ordinalYear, observation.complianceClassification.name |
slice-by-year (list) | name,label,sampleYear.ordinalYear |
slice-by-year (item) | name, label, sampleYear.ordinalYear, observation.bwq_bathingWater.name, observation.complianceClassification.name |
ComplianceByYearSlice
for the year 2010. This slice lists the annual ComplianceAssessments
for the calendar year 2010. The page is rendered in a content-negotiated format viewed using the endpoints default view.Item Type: SuspensionOfMonitoring
These API endpoints are organises such that succcessive truncations of the URI for a SuspensionOfMonitoring record yield lists of records that are progressively less constrained by the parameters truncated from the URI. The table below is organised to emphasise this effects of such truncation.
For endpoints that have two similar URI patterns starting /doc/…
and /data/…
, the /data/…
URI will 303 redirect to the corresponding /doc/…
URI. The /doc/…
pages are constructed by the API framework whereas any for /data/…
URI that respond directly (without redirection) correspond to an item in the datastore. Using /data/…
URI to access the listed of endpoints below will incur an extra network round trip that can be avoided by using the corresponding /doc/…
URI by preference.
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/data/bathing-water-quality/suspension | Item | Returns information about the top-level Suspension of Monitoring Dataset | basic, description, all |
/doc/bathing-water-quality/suspension | List | Lists the most recent SuspensionOfMonitoring record for each recorded suspension of monitoring. | basic, description, all |
/doc/bathing-water-quality/suspension/active-on/{YYYYMMdd} /data/bathing-water-quality/suspension/point/{point}/active-on/{YYYYMMdd} |
List | Lists the most recent SuspensionOfMonitoring record for any suspension-of-monitoring which starts on or before the indicated date, YYYYMMdd , and either has no recorded endOfSuspension or ends on or after the indicated date. |
basic, description, all |
/doc/bathing-water-quality/suspension/completed-by/{YYYYMMdd} /data/bathing-water-quality/suspension/point/{point}/completed-by/{YYYYMMdd} |
List | Lists the most recent SuspensionOfMonitoring record for any suspension-of-monitoring which ends on or before the indicated date, YYYYMMdd . |
basic, description, all |
/data/bathing-water-quality/suspension/point/{point}/date/{YYYYMMdd}/time/{HHmmss}/recordDateTime/{YYYYMMssHHmm} | Item | Returns information about an individual SuspensionOfMonitoring record. | basic, description, all |
/doc/bathing-water-quality/suspension/point/{point}/date/{YYYYMMdd}/time/{HHmmss} /data/bathing-water-quality/suspension/point/{point}/date/{YYYYMMdd}/time/{HHmmss} |
List | Lists of all (including updated records) SuspensionOfMonitoring records for the SamplingPoint indicated by point for a suspension-of-monitoring that starts at a given date, YYYYMMdd , and time, HHmmss . |
basic, description, all |
/doc/bathing-water-quality/suspension/point/{point}/date/{YYYYMMdd}/time/{HHmmss}/latest /doc/bathing-water-quality/suspension/point/{point}/date/{YYYYMMdd}/time/{HHmmss}/latest |
List | Lists the single most recent SuspensionOfMonitoring record for the SamplingPoint indicated by point for a suspension-of-monitoring that starts at a given date, YYYYMMdd , and time, HHmmss . |
basic, description, all |
/doc/bathing-water-quality/suspension/point/{point}/date/{YYYYMMdd} /data/bathing-water-quality/suspension/point/{point}/date/{YYYYMMdd} |
List | Lists of all (including updated records) SuspensionOfMonitoring records for the SamplingPoint indicated by point for suspensions-of-monitoring that start on a given date, YYYYMMdd . |
basic, description, all |
/doc/bathing-water-quality/suspension/point/{point}/latest /data/bathing-water-quality/suspension/point/{point}/latest |
List | Lists the one most recent SuspensionOfMonitoring record for the SamplingPoint indicated by point . |
basic, description, all |
/doc/bathing-water-quality/suspension/point/{point} /data/bathing-water-quality/suspension/point/{point} |
List | Lists the most recent SuspensionOfMonitoring record for each recorded suspension associated with the SamplingPoint indicated by point . |
basic, description, all |
/doc/bathing-water-quality/suspension/point/{point}/active-on/{YYYYMMdd} /data/bathing-water-quality/suspension/point/{point}/active-on/{YYYYMMdd} |
List | Lists the most recent SuspensionOfMonitoring record for any suspension-of-monitoring at the SamplingPoint indicated by point which starts on or before the indicated date, YYYYMMdd , and either has no recorded endOfSuspension or ends on or after the indicated date. |
basic, description, all |
/doc/bathing-water-quality/suspension/point/{point}/completed-by/{YYYYMMdd} /data/bathing-water-quality/suspension/point/{point}/completed-by/{YYYYMMdd} |
List | Lists the most recent SuspensionOfMonitoring record for any suspension-of-monitoring at the SamplingPoint indicated by point which ends on or before the indicated date, YYYYMMdd . |
basic, description, all |
/doc/bathing-water-quality/suspension/bathing-water/{eubwid} /data/bathing-water-quality/suspension/bathing-water/{eubwid} |
List | Lists the most recent SuspensionOfMonitoring record for each recorded suspension associated with the BathingWater indicated by eubwid . |
basic, description, all |
/doc/bathing-water-quality/suspension/bathing-water/{eubwid}/date/{YYYYMMdd}/time/{HHmmss} /data/bathing-water-quality/suspension/bathing-water/{eubwid}/date/{YYYYMMdd}/time/{HHmmss} |
List | Lists of all (including updated records) SuspensionOfMonitoring records for the BathingWater indicated by eubwid for a suspension-of-monitoring that starts at a given date, YYYYMMdd , and time, HHmmss . |
basic, description, all |
/doc/bathing-water-quality/suspension/bathing-water/{eubwid}/date/{YYYYMMdd}/time/{HHmmss}/latest /data/bathing-water-quality/suspension/bathing-water/{eubwid}/date/{YYYYMMdd}/time/{HHmmss}/latest |
List | Lists the single most recent SuspensionOfMonitoring record for the BathingWater indicated by eubwid for a suspension-of-monitoring that starts at a given date, YYYYMMdd , and time, HHmmss . |
basic, description, all |
/doc/bathing-water-quality/suspension/bathing-water/{eubwid}/date/{YYYYMMdd} /data/bathing-water-quality/suspension/bathing-water/{eubwid}/date/{YYYYMMdd} |
List | Lists of all (including updated records) SuspensionOfMonitoring records for the BathingWater indicated by eubwid for suspensions-of-monitoring that start on a given date, YYYYMMdd . |
basic, description, all |
/doc/bathing-water-quality/suspension/bathing-water/{eubwid}/latest /data/bathing-water-quality/suspension/bathing-water/{eubwid}/latest |
List | Lists the one most recent SuspensionOfMonitoring record for the BathingWater indicated by eubwid . |
basic, description, all |
/doc/bathing-water-quality/suspension/bathing-water/{eubwid}/active-on/{YYYYMMdd} /data/bathing-water-quality/suspension/bathing-water/{eubwid}/active-on/{YYYYMMdd} |
List | Lists the most recent SuspensionOfMonitoring record for any suspension-of-monitoring at the BathingWater indicated by eubwid which starts on or before the indicated date, YYYYMMdd , and either has no recorded endOfSuspension or ends on or after the indicated date. |
basic, description, all |
/doc/bathing-water-quality/suspension/bathing-water/{eubwid}/completed-by/{YYYYMMdd} /data/bathing-water-quality/suspension/bathing-water/{eubwid}/completed-by/{YYYYMMdd} |
List | Lists the most recent SuspensionOfMonitoring record for any suspension-of-monitoring at the BathingWater indicated by eubwid which ends the indicated date, YYYYMMdd . |
basic, description, all |
View | Properties |
---|---|
basic | Built-in |
description | Built-in |
all | Built-in |
ukj4210-12350
).Item Type: RiskPrediction
These API endpoints are organised such that succcessive truncations of the URI for a RiskPrediction yield lists that are progressively less constrained by the parameters truncated from the URI. The table below is organised to emphasise this effects of such truncation.
For endpoints that have two similar URI patterns starting /doc/…
and /data/…
, the /data/…
URI will 303 redirect to the corresponding /doc/…
URI. The /doc/…
pages are constructed by the API framework whereas any for /data/…
URI that respond directly (without redirection) correspond to an item in the datastore. Using /data/…
URI to access the listed of endpoints below will incur an extra network round trip that can be avoided by using the corresponding /doc/…
URI by preference.
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/doc/bathing-water-quality/stp-risk-prediction | List | Lists available RiskPredictions | basic, description, all |
/doc/bathing-water-quality/stp-risk-prediction/latestOn/{yyyymmdd} | List | A list of the most recent RiskPrediction associated each bathing-water for which predictions are being made, that occurred on or before the date indicated by yyyymmdd . |
basic, description, all |
/doc/bathing-water-quality/stp-risk-prediction/point/{bwspid} | List | Lists available RiskPredictions associated with a given bathing-water sampling point indicated by bwspid |
basic, description, all |
/doc/bathing-water-quality/stp-risk-prediction/point/{bwspid}/latestOn/{yyyymmdd} | Item | Returns the single, most recent RiskPredictions associated with a given bathing-water sampling point indicated by bwspid which occurred on or before the date indicated by yyyymmdd . |
basic, description, all |
/doc/bathing-water-quality/stp-risk-prediction/bathing-water/{eubwid} | List | Lists available RiskPredictions associated with a given bathing-water indicated by eubwid |
basic, description, all |
/doc/bathing-water-quality/stp-risk-prediction/bathing-water/{eubwid}/latestOn/{yyyymmdd} | Item | Returns the single, most recent RiskPredictions associated with a given bathing-waterindicated by eubwid which occurred on or before the date indicated by yyyymmdd . |
basic, description, all |
View | Properties |
---|---|
basic | Built-in |
description | Built-in |
all | Built-in |
Item Type: StepChange
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/data/bathing-water-quality/step-change/point/{bwspid}/date/{date} | Item | Describes a particular step-change | description, basic, all |
/doc/bathing-water-quality/step-change | List | Returns a list of all step changes | description, basic, all |
/doc/bathing-water-quality/step-change/bathing-water/{eubwid} | List | Returns a list of all step-changes for a particular bathing-water | description, basic, all |
/doc/bathing-water-quality/step-change/point/{bwspid} | List | Returns a list of all step-changes for a particular sampling-point | description, basic, all |
View | Properties |
---|---|
basic | Built-in |
description | Built-in |
all | Built-in |
Item type: BathingWaterProfile
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/data/bathing-water-profile-dataset | Item | Describes the Bathing Water Profile dataset. | dataset, description, all |
/data/bathing-water-profile-dataset/nrw | Item | Describes the Natural Resources Wales Bathing Water Profile dataset. | dataset, description, all |
/data/bathing-water-profile-dataset/nrw/{year} | Item | Describes the atural Resources Wales Bathing Water Profile dataset for a year. | dataset, description, all |
/doc/bathing-water-profile | List | Lists all bathing water profiles. | short-profile, description, all |
/doc/bathing-water-profile:latest | List | Lists the latest profile for all bathing waters. | short-profile, description, all |
/doc/bathing-water-profile/{eubwid} | List | Lists all the bathing water profile versions for the specified bathing water. | short-profile, description, all |
/doc/bathing-water-profile/{eubwid}:latest | Item | Describes latest bathing water profile for the specified bathing water. | profile, full-profile, description, all |
/doc/bathing-water-profile/{eubwid}/{year} | List | Lists all the bathing water profile versions for the specified bathing water and year. | short-profile, description, all |
/doc/bathing-water-profile/{eubwid}/{year}:latest | Item | Describes the latest version of a bathing-water profile for the specified bathing water and year. | profile, full-profile, description, all |
/data/bathing-water-profile/{eubwid}/{year}:{ver} | Item | Describes a specific version of a bathing-water profile for the specified bathing water and year. | profile, full-profile, description, all |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
short profile | name, bathingWater, bathingWaterDescription, applicableYear, versionString |
profile | bathingWater.prefLabel, bathingWater.samplingPoint.name, bathingWater.samplingPoint.easting, bathingWater.samplingPoint.northing, bathingWater.samplingPoint.lat, bathingWater.samplingPoint.long, bathingWater.country.prefLabel, countyName, localAuthority.label, standardLanguageCollection.pollutionManagementGeneralStatement, standardLanguageCollection.stwOutfallsGeneralStatement, standardLanguageCollection.esoOutfallsGeneralStatement, standardLanguageCollection.localAuthorityGeneralStatement, standardLanguageCollection.algaeGeneralStatement, bathingWaterDescription, zoiDescription, streamsRiversStatement, investigationsStatement, historyStatement, stwOutfallsStatement, esoOutfallsStatement, localAuthorityStatement, misconnectionsStatement, workingWithFarmersStatement, workingWithIndustryStatement, workingWithPrivateOwnersStatement, macroAlgaeStatement, phytoplanktonStatement, webResImage, source, versionString, seasonStartDate, seasonFinishDate, seasonInterval, seasonInterval.hasBeginning.inXSDDateTime, seasonInterval.hasEnd.inXSDDateTime, visiblePollutionStatemement, pollutionRiskForecastStatement, pollutionRiskForecasting, stepChangeStatement, otherPollutionSourcesStatement, account |
fullBathingWaterProfile | bathingWater.prefLabel, bathingWater.samplingPoint.name, bathingWater.samplingPoint.easting, bathingWater.samplingPoint.northing, bathingWater.samplingPoint.lat, bathingWater.samplingPoint.long, bathingWater.envelope.asGML, bathingWater.envelope.lowerCorner.easting, bathingWater.envelope.lowerCorner.northing, bathingWater.envelope.lowerCorner.x, bathingWate.envelope.lowerCorner.y, bathingWater.envelope.upperCorner.easting, bathingWater.envelope.upperCorner.northing, bathingWater.envelope.upperCorner.x, bathingWater.envelope.upperCorner.y, bathingWater.zoneOfInfluence.extent.asGML, bathingWater.country.prefLabel, countyName, localAuthority.label, standardLanguageCollection.pollutionManagementGeneralStatement, standardLanguageCollection.stwOutfallsGeneralStatement, standardLanguageCollection.esoOutfallsGeneralStatement, standardLanguageCollection.localAuthorityGeneralStatement, standardLanguageCollection.algaeGeneralStatement, bathingWaterDescription, zoiDescription, streamsRiversStatement, investigationsStatement, historyStatement, stwOutfallsStatement, esoOutfallsStatement, localAuthorityStatement, misconnectionsStatement, workingWithFarmersStatement, workingWithIndustryStatement, workingWithPrivateOwnersStatement, macroAlgaeStatement, phytoplanktonStatement, webResImage, source, versionString, seasonStartDate, seasonFinishDate, seasonInterval, seasonInterval.hasBeginning.inXSDDateTime, seasonInterval.hasEnd.inXSDDateTime, visiblePollutionStatemement, pollutionRiskForecastStatement, pollutionRiskForecasting, stepChangeStatement, otherPollutionSourcesStatement, account, account.accountName, account.accountProfile, account.accountServiceHomePage |
dataset | name, label, type, comment, description, created, modified, subset, subset.label, subset.name, dataDump, vocabulary, vocabulary.label, license, source, uriRegexPattern |
Item type: StandardLanguageCollection
Standard Language Collections were originally intended to carry the common ‘boiler-plate’ statements common to a collection bathing water profiles typically published together in the same year. However, there was an evolving need to vary the standat language collections or a regional basis or even on a per bathing water basis. The URI patterns for standard language collections have been revised from embedding {year}:{ver}
to additionally include a sampling point identifier, {year}-{bwspid}:{ver}
so that different bathing waters can provide different standard language collections.
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/data/bathing-water-profile-standard-language/{year}:{ver} /data/bathing-water-profile-standard-language/{year}-{bwspid}:{ver} |
Item | Describes a collection of standard language statements. | description, all |
/doc/bathing-water-profile-standard-language | List | Lists all bathing water profile standard language collections. | description, all |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
Item type: BathingWaterProfileEndurant
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/data/bathing-water-profile-endurant/{eubwid}/{year} | Item | Describes the enduring bathing water profile for a bathing water for the specified year which is essentially a list of the versions of the bathing water profiles for that year. | endurant, all |
/doc/bathing-water-profile-endurant/{eubwid} | List | Lists all the enduring bathing water profiles for a bathing water. | endurant, description, all |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
endurant | hasVersion, hasVersion.label |
<hr />
Item Types: various: Ontology, OWL Class, RDFS Class, RDF Property, Datatype Property, Object Property, Datatype
Endpoint URI Template http://location.data.gov.uk |
List or Item | Description | Views |
---|---|---|---|
(code) /def/{theme} | List | List the known feature type vocabularies for a given INSPIRE theme {theme} = “ef” or “common” corresponding to environmental facilities (ef) and common cross theme (common) feature types. |
definition, description, all |
/def/{theme}/{featureType} | List | List the terms defined in a given feature type vocabulary. | definition, description, all |
/def/{theme}/{featureType}/ | Item | Describe a given feature type vocabulary. | scheme, description, all |
/def/{theme}/{featureType}/{term} | Item | Describe a given {term} within a given feature type vocabulary |
definition, description, all |
/def/{theme}/{featureType}/{term}/subclass | List | For a given {term} where http://location.data.gov.uk/def/{theme}/{featureType}/{term} is a class, returns a list of subclasses of that class. |
definition, description, all |
/def/{theme}/{featureType}/{term}/instance | List | For a given {term} where http://location.data.gov.uk/def/{theme}/{featureType}/{term} is a class, returns a list of instances of that class. |
description |
/def/{theme}/{featureType}/{term}/property | List | For a given {term} where http://location.data.gov.uk/def/{theme}/{featureType}/{term} is a class, returns a list of properties used by instances of that class. |
basic, description |
View | Properties |
---|---|
all | Built-in |
basic | Built-in |
description | Built-in |
scheme | name, type, seeAlso, alias, label, note, scopeNote, contributor.who, contributor.mbox, topConcept.name, comment, isDefinedBy.label |
definition | name, type, seeAlso, definition, alias, label, note, scopeNote, topConceptOf, broader.name, narrower.name, comment, range, domain, type.label, isDefinedBy.label, subClassOf.label, subPropertyOf.label |
SamplingPoint
spatial-object feature-type. This includes class and property definitions.ZoneOfInfluence
spatial-object feature-type. This includes class and property definitions.Item type: SamplingPoint
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/so/SamplingPoint/ /doc/SamplingPoint/ |
Item | Describes the Natural Resources Wales Bathing Water Sampling Point Spatial-Object URI Set. | description, all |
/so/SamplingPoint /doc/SamplingPoint |
List | Lists the sampling point spatial objects that are members ofthe Natural Resources Wales Bathing Water Sampling Point Spatial-Object URI Set. The list omits sampling point spatial objects for bathing waters that have been de-designated. | sampling-point, description |
/so/SamplingPoint/{bwspid} /doc/SamplingPoint/{bwspid} |
Item | Describes a given bathing-water sampling point. | sampling-point, description |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
sampling-point | name, type, samplePointNotation, district, uriSet.name, uriSet.label, seeAlso, lat, long, easting, northing, bathingWater.name |
SamplingPoint
, designated by Natural Resources Wales in Wales. The page is rendered in a content-negotiated format viewed using the built-in view, all
.extent
of the ZoneOfInfluence
associated with the corresponding BathingWater
using _properties=bathingWater.zoneOfInfluence.extent.asGML
to extend the default view.Item type: ZoneOfInfluence, AbstractGeometry
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/so/ZoneOfInfluence/ /doc/ZoneOfInfluence/ |
Item | Describes a Natural Resources Wales bathing-water zone-of-influence spatial-object URI Set. | description, all |
/so/ZoneOfInfluence /doc/ZoneOfInfluence |
List | Lists the zone of influence spatial-objects that are members of the Natural Resources Wales bathing-water zone-of-influence spatial-object URI set. The list omits zone-of-influence spatial objects for bathing waters that have been de-designated. | zone-of-influence, description |
/so/ZoneOfInfluence/{localId}:{version} /doc/ZoneOfInfluence/{localId}:{version} |
Item | Describes a particular zone of influence spatial object. | zone-of-influence, description |
/so/ZoneOfInfluence/{localId}:{version}/{part} /doc/ZoneOfInfluence/{localId}:{version}/{part} |
Item | Describes a sub-part of a zone-of-influence spatial object. Typically {part} = “extent” which will be an AbstractGeometry that conveys the extent of the zone of influence for a given bathing-water. |
description |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
zone-of-influence | name, type, zoiNotation, uriSet, seeAlso, extent, bathingWater.name, bathingWater.samplingPoint.lat, bathingWater.samplingPoint.long, bathingWater.samplingPoint.easting, bathingWater.samplingPoint.northing |
ZoneOfInfluence
spatial-objects associated with designated BathingWater
in Wales. The page is rendered in a content-negotiated format viewed using the endpoint’s default view.extent
of the ZoneOfInfluence
using _properties=extent.asGML
to extend the default view. The page is rendered in a content-negotiated format.AbstractGeometry
" representing the spatial extent of the ZoneOfInfluence
at Rhosneigr. The page is rendered in in JSON.Item type: Envelope
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/so/common/Envelope/{ns}/ /doc/common/Envelope/{ns}/ |
Item | Describes an envelope (bounding box) spatial-object URI Set. Currently {ns} = bwpf.eaew for Natural Resources Wales URI set of envelope spatial objects that represent the map extents for use in bathing-water profiles. |
description, all |
/so/common/Envelope/{ns} /doc/common/Envelope/{ns} |
List | Lists the envelope spatial-objects that are members of an envelope (bounding box) spatial-object URI Set. The list omits envelope spatial objects for bathing waters that have been de-designated. Currently {ns} = bwpf.eaew for Natural Resources Wales URI set of envelope spatial objects that represent the map extents for use in bathing-water profiles. |
bounds, description |
/so/common/Envelope/{ns}/{localId}:{version} /doc/common/Envelope/{ns}/{localId}:{version} |
Item | Describes a particular envelope spatial object. | bounds, description |
/so/common/Envelope/{ns}/{localId}:{version}/{part} /doc/common/Envelope/{ns}/{localId}:{version}/{part} |
Item | Describes a sub-part of a envelope spatial object. Typically {part} = “lowerCorner” or “upperCorner” each of which will be a Point. |
description |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
bounds | *, lowerCorner.*, upperCorner.* |
Envelope
spatial-objects associated with the BathingWater
at Whitesands. The page is rendered in a content-negotiated format viewed using the endpoint’s default view.lowerCorner
of the map bounds Envelope
spatial-objects associated with the BathingWater
at Whitesands. The page is rendered in a content-negotiated format viewed using the endpoint’s default view.Envelope
spatial-objects (map bounds) associated with designated BathingWater
in Wales. The page is rendered in a content-negotiated format viewed using the endpoint’s default view.Item type: Feature
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/so/BathingWaterProfileFeature/ /doc/BathingWaterProfileFeature/ |
Item | Describes the Natural Resources Wales Bathing Water Profile Feature Spatial-Object URI Set | description, all |
/so/BathingWaterProfileFeature /doc/BathingWaterProfileFeature |
List | Lists all bathing-water profile features. | feature, description |
/so/BathingWaterProfileFeature:latest /doc/BathingWaterProfileFeature:latest |
List | Lists all latest bathing-water profile features. | feature, description |
/so/BathingWaterProfileFeature/{featureId} /doc/BathingWaterProfileFeature/{featureId} |
List | Lists all versions of a bathing-water profile feature. | feature, description |
/so/BathingWaterProfileFeature/{featureId}:latest /doc/BathingWaterProfileFeature/{featureId}:latest |
Item | Lists the latest version of a bathing-water profile feature. | feature, description |
/so/BathingWaterProfileFeature/{featureId}:{ver} /doc/BathingWaterProfileFeature/{featureId}:{ver} |
Item | Describes a specific version of a bathing-water profile feature. | feature, description |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
feature | type,type.label,label,bathingWater,bathingWater.name,lat,long,easting,northing,regionalOrganization,regionalOrganization.name |
all
.Item type: BathingWaterProfileEndurant
Endpoint URI Template http://environment.data.gov.uk/wales/bathing-waters |
List or Item | Description | Views |
---|---|---|---|
/so/BathingWaterProfileFeatureEndurant/{id} /doc/BathingWaterProfileFeatureEndurant/{id} |
Item | Describes an enduring bathing water profile feature. | endurant, description, all |
/so/BathingWaterProfileFeatureEndurant /doc/BathingWaterProfileFeatureEndurant |
List | Lists all the enduring bathing water profile features. | endurant, description, all |
View | Properties |
---|---|
all | Built-in |
description | Built-in |
endurant | hasVersion, hasVersion.label |
FE-AN0316901-1-1
, i.e. at Jackson’s Bay Barry Island . This effectively returns a list of the versions of this feature.<hr />
The Natural Resources Wales and Environment Agency Bathing Water data models are identical. Vocabulary terms that make up the data model are all served under http://environment.data.gov.uk/def The only significant difference in the data model section of this document are the URIs used for example instances.
The main difference in the API are the entity access URI patterns.
Environment Agency Entity URI Pattern | Natural Resources Wales Entity URI Pattern |
---|---|
http://environment.data.gov.uk/{id,doc,data}/* | http://environment.data.gov.uk/wales/bathing-waters/{id,doc,data}/* |
http://location.data.gov.uk/{so,id,doc}/{theme}/{featureType}/{inspire-namespace}[/*] | http://environment.data.gov.uk/wales/bathing-waters/{so,doc,id}/{featureType}[/*] |
In partciular all Natural Resources Wales entities, including spatial-object, have been relocated under http://environment.data.gov.uk/wales/bathing-waters/. Previously spatial-objects would have been located under http://location.data.gov.uk
which enabled the embedding of INSPIRE namespaces with URI. INSPIRE has moved to a position where URI can be used as INSPIRE namespaces. In addition data.gov.uk URI guidance and evolved to encompass the notion of a collection, in this case rooted http://environment.data.gov.uk/wales/bathing-waters which make it much easier to managed multi-tenanted URI spaces such as http://environment.data.gov.uk