alpha This is a trial service – your feedback will help us to improve it.

Asset Management API Documentation

For developers only

The information on this page is provided for developers who wish to access the asset management data.

If you are not a developer and simply wish to view information on some asset then please use the web application at Home.

Introduction

The Environment Agency maintains records on assets of many types related to environmental activities particularly flood defences, including some assets owned or managed by other bodies. The API provides access to these asset description records along with information on maintenance activities planned for the assets. Only some assets have an associated maintenance schedule.

In the API the maintenance information is split in to three different types. Maintenance activities represent funded and scheduled work. A single activity may involve several maintenance actions on several different assets. We divide the activities into separate tasks, where each task represents a specific maintenance action on a single asset. Finally maintenance plans represent intended maintenance activities for future financial years but which have not necessarily been scheduled or funded at this stage. The API allows all activities, tasks and plans to be listed for a particular asset, set of assets or across all assets.

API summary

This is a brief summary of the APIs available, see below for details. In the tables the API links are live examples and offer both JSON and HTML views of the data. Note that the HTML views are offered as an aid to debugging and development, they are not intended for presentation to consumers. All URIs are relative to the service base URI of http://environment.data.gov.uk/asset-management.

Assets

WhatAPIParameters
List assets id/asset
[json] [html]
assetType={type} assetSubType={type} primaryPurpose={value} protection-type={value} _view=default|full
Details on a single asset id/asset/{id}
[json] [html]

Asset Types

WhatAPIParameters
List asset types def/asset-types
[json] [html]
superType={type} subType={type} _view=default|full
Filtered view of asset super types def/asset-types
[json] [html]
_view=asset-super-type
Filtered view of asset sub types def/asset-types
[json] [html]
superType={type} _view=asset-sub-type

Maintenance activities

WhatAPIParameters
List maintenance activities id/maintenance-activity
[json] [html]
maintainedAsset={asset}
List maintenance activities related to a particular asset id/asset/{id}/maintenance-activity
[json] [html]
Details on a single activity id/maintenance-activity/{id}
[json] [html]

Maintenance tasks

WhatAPIParameters
List maintenance tasks id/maintenance-task
[json] [html]
maintainedAsset={asset} activityType={type} activitySubType={type} westminsterConstituency={oscode}
List maintenance tasks related to a particular asset id/asset/{id}/maintenance-task
[json] [html]
Details on a single task id/maintenance-task/{id}
[json] [html]

Maintenance plans

WhatAPIParameters
List maintenance plans id/maintenance-plan
[json] [html]
maintainedAsset={asset} activityType={type} activitySubType={type} planStatus={status} programYear={year} mineq-programYear={year}&max-programYear={year}
List maintenance plans related to a particular asset id/asset/{id}/maintenance-plan
[json] [html]
Details on a single planned maintenance id/maintenance-plan/{id}
[json] [html]

Capital Projects

WhatAPIParameters
List capital projects /id/capital-project
[json] [html]
_view=default|full
Details on a single project /id/capital-project/{id}
[json] [html]

Completed Capital Projects

WhatAPIParameters
List completed capital projects /id/completed-capital-project
[json] [html]
_view=default|full
Details on a single project /id/completed-capital-project/{id}
[json] [html]

There are also API calls available for enumerating the reference used in the asset and activity descriptions:

WhatAPI
List asset types def/asset-types
[json] [html]
List activity types def/maintenance/activity-type
[json] [html]
List EA Areas def/ea-areas
[json] [html]
List Westminster Constituencies def/westminster-constituencies
[json] [html]

API structure

The APIs provide a REST style access to the data via simple HTTP GET requests. Data can be returned in a range of formats including JSON, CSV and web pages.

Simple requests

For example fetching a list of assets from: id/asset.json?_limit=10

will return a JSON data packet similar to the following:

{
  "meta": {
    "@id": "http://environment.data.gov.uk/asset-management/id/asset.json?_limit=10",
    "comment": "Asset Management API, alpha",
    "license": "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
    "licenseName": "OGL 3",
    "publisher": "Environment Agency",
    "version": "0.1",
    "limit": 10
  },
  "items": [
    {
      "@id": "http://environment.data.gov.uk/asset-management/id/asset/382266",
      "area": {
        "@id": "http://environment.data.gov.uk/registry/def/ea-organization/ea_areas/6-28",
        "label": "Wessex"
      },
      ...
    }
  ]
}

The returned JSON data from all API endpoints follows the same structure of elements: metadata and items.

Metadata and versioning

The metadata block provides information on the publisher and applicable licence as well as a link to this, or other, documentation. If the resource is also available in other formats then hasFormat will supply list of URLs for those alternative formats (the media type is implied by a suffix, see content types).

"meta": {
    "comment": "Asset Management API, alpha",
    "license": "http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3/",
    "licenseName": "OGL 3",
    "publisher": "Environment Agency",
    "version": "0.1",
    "limit": 10
  }

The metadata block also includes version number information. The intention is that, after initial release, updates to the API should maintain backward compatibility. If an incompatible change to the API is required then we will attempt to provide access to the prior version for a transitional period. In that case the meta block will also provide replaces and isReplacedBy links between the new and the old versions of the affected API endpoints.

Finally, in the case of calls which provide lists of results any applied limit to the length of the list and offset from the start of the list will be shown in the metadata as limit and offset values, as in the example above.

Items

The items element in the JSON response will be an array containing objects describing items in the data. If requesting a description of a single item the items element will still be an array (just with one element). If a list search returns no results then the items array will be empty.

Each item will normally be identified by a URI given in the @id field. Thus, for example in the more complete version of the earlier example we can see the asset has a URI, the last element of which matches the notation field (382266). This is a common pattern and when referencing items in API calls then it is often possible to just use this last element in place of the full URI.

"items": [
    {
      "@id": "http://environment.data.gov.uk/asset-management/id/asset/382266",
      "area": {
        "@id": "http://environment.data.gov.uk/registry/def/ea-organization/ea_areas/6-28",
        "label": "Wessex"
      },
      "assetLength": 51.52,
      "assetSubType": {
        "@id": "http://environment.data.gov.uk/asset-management/def/core/OpenChannel",
        "prefLabel": "Open Channel"
      },
      "assetType": {
        "@id": "http://environment.data.gov.uk/asset-management/def/core/Channel",
        "prefLabel": "Channel"
      },
      "label": "Channel Open Channel: 382266",
      "managementUnit": { ... },
      "notation": "382266",
      "primaryPurpose": { ... },
      "protectionType": { ... },
      "targetCondition": { ... }
    },
    ....
  ]

When one item references another, such as in this case, the API will typically include key attributes of the referenced item in-line for convenience (e.g. the prefLabel field on the asset types). However, we can always fetch (i.e. HTTP GET) data from the URI of the referenced item to obtain a full description.

Content Types

The descriptions of individual items can be obtained in multiple formats. The default format is HTML, but all item descriptions can also return information in JSON and RDF formats (RDF/XML and Turtle). The HTML rendering is intended as an aid to help developers understand the data, it is not an end-user application.

Similarly lists of items can be obtained in JSON, CSV and HTML as well as RDF formats.

To select the desired format use standard HTTP content negation. E.g.:

curl -i -H "Accept: text/csv" http://environment.data.gov.uk/asset-management/id/asset?_limit=5

All endpoints also support a shortcut of appending a type suffix to the URI to force a particular content type. The supported suffixes are:

SuffixType
.jsonapplication/json
.htmltext/html
.csvtext/csv
.ttltext/turtle
.rdfapplication/rdf+xml

So the earlier example is equivalent to simply fetching the URL:

By default the CSV content returns will use column names matching the property paths in the corresponding JSON format.

Lists: filtering and paging

Some endpoints return information describing a single identified item but many return information on a list of items. Such list endpoints support query parameters to filter the list to only include some items. In most cases these filters take the form:

prop1.prop2...propn=value

Here, the props are the short property names that appear in the JSON format and the value is the value that the property is required to have. The value might be a number, a string, a date or a URI. In the case of the URI then you can often use the last segment of the URI on its own. For example, to list just assets of type Outfall we can use:

To get a list of the types and subtypes showing the full URI and the shortform then you can use the reference data endpoint

If the same filter is used twice with different values then the API will return results for both values (i.e. it acts as a disjunction).

List endpoints also support view modification parameters. These are distinguished by starting with an underscore character. The commonly supported modifiers are:

QueryMeaning
_view=full|..An alternative view of the items. The default view includes just summary properties. The full view includes everything.
_limit=xReturn only x items from the list, some endpoints may impose a default limit and/or a maximum to which the limit can be set.
_offset=xReturn the list of items starting with the xth item, together with _limit this enables paging through a long set of results.

If a limit or offset is applicable, whether explicit in the query or implicitly imposed by the API, then the metadata object will include a limit or offset field to show what limits were applied.

Assets

The assets endpoint provides a list all assets, this can be filtered by any attribute as described above. See below for examples of useful filters.

WhatAPIParameters
List assets id/asset
[json] [html]
assetType={type} assetSubType={type} primaryPurpose={value} protection-type={value} _view=default|full
Details on a single asset id/asset/{id}
[json] [html]

The data returned for each asset is shown below. When list assets then the default view limits the view to show only the main attributes of the asset as shown in the table. However, individual asset descriptions show everything and it is possible to show everything in the list view by using _view=full.

The Westminster Constinuency containing the asset. This information will only be present on maintained assets.
FieldMeaningTypeOccursViews
actualConditionThe actual condition of the Assetskos:Conceptoptionalfull, default
actualCondition.prefLabeloptionalfull, default
actualDclThe actual downstream crest levelxsd:decimaloptionalfull, default
actualDclDqfThe data quality flag for the actual downstream crest level. Refer to OI 57_06skos:Conceptoptionalfull
actualUclThe actual upstream crest levelxsd:decimaloptionalfull, default
actualUclDqfThe data quality flag for the actual upstream crest level. Refer to OI 57_06skos:Conceptoptionalfull
areaThe EA Management areaskos:Conceptoptionalfull, default
area.labeloptionalfull, default
assetLengthThe length of the asset calculated from its geometryxsd:decimaloptionalfull, default
assetStartDateThe date the asset became operationalxsd:dateoptionalfull, default
assetSubTypeThe specific sub type of assetskos:Conceptoptionalfull, default
assetSubType.prefLabeloptionalfull, default
assetTypeThe generic type of Assetskos:Conceptoptionalfull, default
assetType.prefLabeloptionalfull, default
bankThe bank that the asset is on when looking downstream for fluvial assets. For coastal assets use coastalskos:Conceptoptionalfull, default
bank.prefLabeloptionalfull, default
calculatedConditionThe condition of the asset calculated from the element weightings and conditions configurationskos:Conceptoptionalfull, default
calculatedCondition.prefLabeloptionalfull, default
currentSopThe Standard of Protection (1:n) that the asset currently provides, if knownxsd:decimaloptionalfull, default
currentSopDateThe date the Current Standard of Protection was appraisedxsd:dateoptionalfull
dataOwnerAssetRefAsset reference used by the management group, for example: EA NFCDD Referencexsd:stringoptionalfull
designDclThe designed downstream crest levelxsd:decimaloptionalfull, default
designSopThe Standard of Protection (1:n) that the asset was designed to providexsd:decimaloptionalfull, default
designSopDqfThe data quality flag for the design Standard of Protection. Refer to OI 57_06skos:Conceptoptionalfull
designUclThe designed upstream crest levelxsd:decimaloptionalfull, default
effectiveClThe lowest crest level along a coastal defencexsd:decimaloptionalfull, default
effectiveClDqfThe data quality flag for the effective crest level. Refer to OI 57_06skos:Conceptoptionalfull
geometryfull, default
includeInFloodMapThe Floodmap inclusion assessment. Refer to Floodmap Guidanceskos:Conceptoptionalfull
inspectionDataQualityFlagThe inspection data quality. Refer to OI 57_06skos:Conceptoptionalfull
invertLevelThe invert level of the culvert or pipexsd:decimaloptionalfull, default
labelOptional name for the assetoptionalfull, default
lastInspectionDateThe date of the most recent inspectionxsd:dateoptionalfull, default
maintenanceActivityAn open domained property that can be used to make reference to a maintenance activity.local:SimplifiedActivitymulti-valuedfull, default
maintenanceActivity.activitySubTypeMaintentance activity sub-typeskos:Conceptoptionalfull, default
maintenanceActivity.activityTypeMaintenance activity typeskos:Conceptfull, default
maintenanceActivity.actualFinishMonthThe month in which an activity actually finished.xsd:gYearMonthoptionalfull
maintenanceActivity.actualStartMonthThe actual month in which a maintenance activity startedxsd:gYearMonthoptionalfull
maintenanceActivity.plannedFinishMonthThe month in which a maintenance activity is planned to finsih.xsd:gYearMonthoptionalfull
maintenanceActivity.plannedStartMonthThe month in which a maintenance activity is planned to startxsd:gYearMonthoptionalfull
managementGroupGroup who has the responsibility to maintain the data associated with the Aset in the systemam-core:ManagementGroupoptionalfull
managementUnitManagement Unit associated with an Assetam-core:ManagementUnitoptionalfull, default
managementUnit.labelfull, default
manualOverrideConditionHas the calculated condition been overridden?skos:Conceptoptionalfull, default
manualOverrideCondition.prefLabeloptionalfull, default
notationIdentifier code for the assetoptionalfull, default
primaryPurposeThe main purpose of the asset, i.e.: the reason it was constructed (a natural asset may have an asset management purpose)skos:Conceptoptionalfull, default
primaryPurpose.prefLabeloptionalfull, default
protectionTypeThe type of protection the asset givesskos:Conceptoptionalfull, default
protectionType.labeloptionalfull, default
recommendationThe inspectors recommendations from the asset inspectionxsd:stringoptionalfull, default
secondaryPurposeThe secondary purpose of the asset if it has one, i.e.: an incidental purposeskos:Conceptmulti-valuedfull, default
secondaryPurpose.prefLabeloptionalfull, default
spatialQualityFlagThe data quality flag for the spatial position of the asset. Refer to OI 57_06skos:Conceptoptionalfull
structureHeightThe total height of the structure, taken from ground level to its highest tangible pointxsd:decimaloptionalfull, default
targetConditionThe target condition of the asset – Refer to OI 026_08skos:Conceptoptionalfull, default
targetCondition.prefLabeloptionalfull, default
toeLevelThe toe level at the exposed face. Refer to OI 144_07xsd:decimaloptionalfull, default
urgencyThe urgency of the action required following the asset inspectionskos:Conceptoptionalfull, default
urgency.prefLabeloptionalfull, default
westminsterConstituencyoptionalfull
westminsterConstituency.labelfull
worstConditionThe worst condition taken from the list of element conditions of the assetskos:Conceptoptionalfull, default
worstCondition.prefLabeloptionalfull, default
yearLastRefurbishedThe year the asset was last refurbishedxsd:yearoptionalfull, default

Example Asset API calls

List just outfalls, show first 50 results:

List outfalls that relate to fluvial-tidal protection:

Return those as a CSV file:

List 50 Open Channels within the EA Area Wessex:

Get summary data, including geometry as geojson, for a specific asset:

Asset Types

The asset types endpoints provides a list of assets for use as a list of assets (described here), or as a codelist (described below). This data is served directly from the DRL application and provides two separate addresses for groups and subtype both with their own default views without the need for a view parameter.

Asset Type Groups

WhatAPIParameters
List asset type groups drl-app/asset-types [json] [csv] None
FieldMeaningTypeOccurs
@idxsd:stringrequired
labelName of the asset typexsd:stringrequired
commentText comment on the asset typexsd:stringrequired
notationSkos notation of the asset typexsd:stringrequired

Example Asset Types Groups API calls

All Asset Type Groups

Asset Sub Types

The Asset Sub Types api returns all asset sub types of a specified asset type group.

WhatAPIParameters
List asset sub types drl-app/asset-types/{assetType}.json [json] [csv]
FieldMeaningTypeOccurs
@idxsd:stringrequired
labelName of the asset typexsd:stringrequired
commentText comment on the asset typexsd:stringrequired
notationSkos notation of the asset typexsd:stringrequired
superTypeThe parent asset typeam-core:AssetTyperequired
subTypeCodeThe Asset Codexsd:stringrequired
originalCodexsd:stringoptional
markdownA description of the asset sub type in raw markdown, may contain links to images.xsd:stringoptional

Example Asset Sub Types API calls

All Asset Sub Types For Aid To Navigation

All Asset Sub Types For Beach Structure

Attributes

This endpoint provides a list of asset subtype and element attributes. The list can be filtered down based on an asset subtype or an element as desired.

WhatAPIParameters
List Subtype Attributes /asset-management/drl-app/asset-types/{assetType}/asset-sub-types/{assetSubType}/attributes.json
/asset-management/drl-app/asset-types/{assetType}/asset-sub-types/{assetSubType}/attributes.csv
{assetType} Id of the parent asset type
{assetSubType} Id of the asset subtype
List Element Attributes /asset-management/drl-app/asset-types/{assetType}/asset-sub-types/{assetSubType}/elements/{element}/attributes.json
/asset-management/drl-app/asset-types/{assetType}/asset-sub-types/{assetSubType}/elements/{element}/attributes.csv
{assetType}Id of the parent asset type
{assetSubType} Id of the asset subtype
{element}Id of the element
FieldMeaningTypeOccursViews
label Name of the attribute xsd:string required default,full
description xsd:string required default, full
delivery A Delivery Code xsd:string required default, full
mapping Dot separated mapping string xsd:string required default, full
attributeOfAssetType The Asset Sub Type that the attribute belongs to am-core:AssetType optional default, full
attributeOfElement The Element that the attribute belongs to am-drl:ElementType optional default, full
format The format of the attribute am-drl:Format required default, full
format.type The format type of the attribute's format. required default, full

Example Attribute API calls

All attributes of Sub Asset Type "AmenitySite"

Attributes of Element Type "Abutment-front-face"

Element Types

This endpoint provides a list of elements types. The list can be filtered down based on an asset subtype that the element types belong to.

WhatAPIParameters
List SubType Elements /asset-management/drl-app/asset-types/{assetType}/asset-sub-types/{assetSubType}/elements.json
/asset-management/drl-app/asset-types/{assetType}/asset-sub-types/{assetSubType}/elements.csv
{assetType} Id of the asset type
{assetSubType} Id of the asset subtype
FieldMeaningTypeOccursViews
label Name of the element type xsd:string required default
notation Element type skos notation xsd:string required default
description Description of the element type xsd:string required default
elementOf The Asset Sub Type that this element belongs to am-core:AssetType required default
elementCode The element code xsd:string required default

Example Attribute API calls

All elements of Sub Asset Type "Beacon"

Maintenance activities

Maintenance activities represent funded and scheduled work for the next financial year. A single actitivity may involve several maintenance actions on several different assets. We call an individual action to be carred out on a single asset a task so activities are treated as groups of tasks. The maintenance-activity endpoint provides a list of all maintenance activities, this can be filtered by any attribute as described above. See below for examples of useful filters.

WhatAPIParameters
List maintenance activities id/maintenance-activity
[json] [html]
maintainedAsset={asset}
List maintenance activities related to a particular asset id/asset/{id}/maintenance-activity
[json] [html]
Details on a single activity id/maintenance-activity/{id}
[json] [html]

The data returned for each activity is shown below.

FieldMeaningTypeOccursViews
areaNo definition foundskos:Conceptoptionaldefault
area.labelNo definition foundoptionaldefault
hasRfccNo definition foundskos:Conceptoptionaldefault
hasRfcc.prefLabelNo definition foundoptionaldefault
maintainedAssetThe asset(s) maintained by a maintenance activityam-core:Assetmulti-valueddefault
maintainedAsset.assetSubTypeThe specific sub type of assetskos:Conceptoptionaldefault
maintainedAsset.assetTypeThe generic type of Assetskos:Conceptoptionaldefault
maintainedAsset.labelNo definition foundoptionaldefault
maintenanceTaskNo definition foundlocal:SimplifiedTaskmulti-valueddefault
maintenanceTask.activitySubTypeMaintentance activity sub-typeskos:Conceptoptionaldefault
maintenanceTask.activitySubType.prefLabelNo definition foundoptionaldefault
maintenanceTask.activityTypeMaintenance activity typeskos:Conceptdefault
maintenanceTask.activityType.prefLabelNo definition foundoptionaldefault
maintenanceTask.statusA subclass of skos:Concept for maintenance activity status codesskos:Conceptoptionaldefault
maintenanceTask.status.prefLabelNo definition foundoptionaldefault
notationNo definition foundoptionaldefault
programmeThe maintenance programme associated with an maintenance activityam-maint:Programmeoptionaldefault
programme.labelNo definition founddefault
westminsterConstituencyNo definition foundoptionaldefault
westminsterConstituency.labelNo definition founddefault

Example Activity API calls

Maintenance activities for a particular asset:

Shorter alternatives to above:

or

List activities which include a task of maintain raised defences:

Maintenance tasks

A Maintenace Task is a single planned action on a single asset. Tasks are grouped into activities. The maintenance-task endpoint provides a list of all maintenance tasks, this can be filtered by any attribute as described above. See below for examples of useful filters.

Maintenance tasks

WhatAPIParameters
List maintenance tasks id/maintenance-task
[json] [html]
maintainedAsset={asset} activityType={type} activitySubType={type} westminsterConstituency={oscode}
List maintenance tasks related to a particular asset id/asset/{id}/maintenance-task
[json] [html]
Details on a single task id/maintenance-task/{id}
[json] [html]

The data returned for each activity is shown below.

FieldMeaningTypeOccursViews
activitySubTypeMaintentance activity sub-typeskos:Conceptoptionaldefault
activitySubType.prefLabelNo definition foundoptionaldefault
activityTypeMaintenance activity typeskos:Conceptdefault
activityType.prefLabelNo definition foundoptionaldefault
actualFinishMonthThe month in which an activity actually finished.xsd:gYearMonthoptionaldefault
actualFinishQuarterThe calendar quarter in which an activity actually finished.xsd:stringoptionaldefault
actualStartMonthThe actual month in which a maintenance activity startedxsd:gYearMonthoptionaldefault
actualStartQuarterThe quarter in which a maintenance activity was actually startedxsd:stringoptionaldefault
areaNo definition foundskos:Conceptoptionaldefault
area.labelNo definition foundoptionaldefault
hasRfccNo definition foundskos:Conceptoptionaldefault
hasRfcc.prefLabelNo definition foundoptionaldefault
maintainedAssetThe asset(s) maintained by a maintenance activityam-core:Assetmulti-valueddefault
maintainedAsset.assetSubTypeThe specific sub type of assetskos:Conceptoptionaldefault
maintainedAsset.assetTypeThe generic type of Assetskos:Conceptoptionaldefault
maintainedAsset.labelNo definition foundoptionaldefault
maintenanceActivityAn open domained property that can be used to make reference to a maintenance activity.am-maint:Activitydefault
maintenanceActivity.programmeThe maintenance programme associated with an maintenance activityam-maint:Programmeoptionaldefault
maintenanceActivity.programme.labelNo definition founddefault
notationNo definition foundoptionaldefault
plannedFinishMonthThe month in which a maintenance activity is planned to finsih.xsd:gYearMonthoptionaldefault
plannedFinishQuarterThe quarter in which a maintenance activity is planned to finishxsd:stringoptionaldefault
plannedStartMonthThe month in which a maintenance activity is planned to startxsd:gYearMonthoptionaldefault
plannedStartQuarterThe quarter in which a maintenance activity is planned to start.xsd:stringoptionaldefault
statusA subclass of skos:Concept for maintenance activity status codesskos:Conceptoptionaldefault
status.prefLabelNo definition foundoptionaldefault
westminsterConstituencyNo definition foundoptionaldefault
westminsterConstituency.labelNo definition founddefault

Example Task API calls

Maintenance tasks for a particular asset:

or

List maintain raised defences tasks:

List tasks within the Forest of Dean constituency:

List all tasks which make up a single activity:

Maintenance plans

Maintenance plans represent intended maintenance activities for future financial years but which have not necessarily been scheduled or funded at this stage. The maintenance-plan endpoint provides a list of all maintenance plans, this can be filtered by any attribute as described above. See below for examples of useful filters.

Maintenance plans

WhatAPIParameters
List maintenance plans id/maintenance-plan
[json] [html]
maintainedAsset={asset} activityType={type} activitySubType={type} planStatus={status} programYear={year} mineq-programYear={year}&max-programYear={year}
List maintenance plans related to a particular asset id/asset/{id}/maintenance-plan
[json] [html]
Details on a single planned maintenance id/maintenance-plan/{id}
[json] [html]

The data returned for each activity is shown below.

FieldMeaningTypeOccursViews
activitySubTypeMaintentance activity sub-typeskos:Conceptoptionaldefault
activitySubType.prefLabelNo definition foundoptionaldefault
activityTypeMaintenance activity typeskos:Conceptdefault
activityType.prefLabelNo definition foundoptionaldefault
areaNo definition foundskos:Conceptoptionaldefault
area.labelNo definition foundoptionaldefault
assetPerformanceTeamNo definition foundam-maint:FieldTeamoptionaldefault
assetPerformanceTeam.labelNo definition founddefault
hasRfccNo definition foundskos:Conceptoptionaldefault
hasRfcc.prefLabelNo definition foundoptionaldefault
maintainedAssetThe asset(s) maintained by a maintenance activityam-core:Assetmulti-valueddefault
maintainedAsset.assetSubTypeThe specific sub type of assetskos:Conceptoptionaldefault
maintainedAsset.assetTypeThe generic type of Assetskos:Conceptoptionaldefault
maintainedAsset.labelNo definition foundoptionaldefault
notationNo definition founddefault
planStatusNo definition foundskos:Conceptoptionaldefault
planStatus.prefLabelNo definition foundoptionaldefault
plannedFinishMonthThe month in which a maintenance activity is planned to finsih.xsd:gYearMonthoptionaldefault
plannedFinishQuarterThe quarter in which a maintenance activity is planned to finishxsd:stringoptionaldefault
plannedFinishYearNo definition foundxsd:gYearoptionaldefault
programmeMonthNo definition foundxsd:intoptionaldefault
programmeYearNo definition foundxsd:intoptionaldefault

Example Maintenance Plan API calls

Maintenance plans for a particular asset:

or

Plans for a particular asset for FY2020:

Plans for a particular asset for FY2021 or beyond:

List maintain raised defences plans:

Capital Projects

The capital projects endpoint provides a list all capital projects, this can be filtered by any attribute as described above. See below for examples of useful filters.

WhatAPIParameters
List capital projects /id/capital-project
[json] [html]
_view=default|full
Details on a single project /id/capital-project/{id}
[json] [html]

The data returned for each project is shown below.

FieldMeaningTypeOccursViews
labelLabel for the Capital Projectxsd:stringrequireddefault, full
notationUnique Project IDxsd:stringrequireddefault, full
typeThe type of resourcerequireddefault, full
eastingThe Easting coordinate for this projectxsd:integerrequireddefault, full
northingThe Northing coordinate for this projectxsd:integerrequireddefault, full
areaThe identifier for the EA area in which this project liesoptionalfull
area.labelThe label for the EA area in which this project liesxsd:stringoptionalfull
forecastConstructionCompletionDate the project is forecast to completexsd:stringoptionalfull
forecastConstructionStartDate the project is forecast to startxsd:stringoptionalfull
grantInAid2019_20Grant in aid 2019/2020 (£k)xsd:integer, filterableoptionalfull
grantInAid2019_21Grant in aid 2019-2021 (£k)xsd:integer, filterableoptionalfull
hasRfccThe identifier for the Regional Flood and Coastal Committee for this projectoptionalfull
hasRfcc.labelThe label for the Regional Flood and Coastal Committee for this projectoptionalfull
homesProtected2020_21Number of homes protected 2020/21xsd:integer, filterableoptionalfull
homesProtectedOnCompletionNumber of homes projected on project completionxsd:integer, filterableoptionalfull
inRegionThe idenfifier for the ONS region in which this capital project liesoptionalfull
inRegion.officialnameThe official name of the ONS region in which this capital project liesxsd:stringoptionalfull
leadRiskManagementAuthorityThe identifier for the Lead Risk Management Authority for this projectoptionalfull
leadRiskManagementAuthority.labelThe label for the Lead Risk Management Authority for this projectxsd:stringoptionalfull
partnershipFundingPartnership funding (£k)xsd:integer, filterableoptionalfull
projectStageStage that the project is inxsd:stringoptionalfull
westminsterConstituencyThe Identifier for the Westminster Constituency in which this project liesrequiredfull
westminsterConstituency.labelThe label for the Westminster Constituency in which this project liesxsd:stringrequiredfull

Example Capital Projects API Calls

List all capital projects in Solent and South Downs EA Area

List all capital projects in Southern RFCC

List all capital projects in Adur and Worthing Councils Lead Risk Management Authority

List all capital projects with more than £2M partnership funding.

Get summary data, including geometry as geojson, for a specific capital project:

Completed Capital Projects

The completed capital projects endpoint provides a list all completed capital projects, this can be filtered by any attribute as described above. See below for examples of useful filters.

Completed Capital Projects

WhatAPIParameters
List completed capital projects /id/completed-capital-project
[json] [html]
_view=default|full
Details on a single project /id/completed-capital-project/{id}
[json] [html]

The data returned for each completed project is shown below.

FieldMeaningTypeOccursViews
labelLabel for the Capital Projectxsd:stringrequireddefault, full
notationUnique Project IDxsd:stringrequireddefault, full
typeThe type of resourcerequireddefault, full
eastingThe Easting coordinate for this projectxsd:integerrequireddefault, full
northingThe Northing coordinate for this projectxsd:integerrequireddefault, full
authorityTypexsd:stringoptionalfull
inRegionThe idenfifier for the ONS region in which this capital project liesoptionalfull
inRegion.officialnameThe official name of the ONS region in which this capital project liesxsd:stringoptionalfull
hasRfccThe identifier for the Regional Flood and Coastal Committee for this projectoptionalfull
hasRfcc.labelThe label for the Regional Flood and Coastal Committee for this projectxsd:stringoptionalfull
homesBetterProtected2019Number of homes better proected in 2019xsd:integer, filterableoptionalfull

Example Completed Capital Projects API Calls

List all completed capital projects in East Midlands region

List all completed capital projects with EA authority type

List all completed capital projects with more than 1000 homes better protected in 2018.

List all completed capital projects with at least 150 homes better protected in 2018.

List all completed capital projects with less than 5 homes better protected in 2018.

Get summary data, including geometry as geojson, for a specific completed capital project:

Code lists

These API endpoints provide lists of controlled terms used in describing assets and maintenance activities.

WhatAPI
List asset types def/asset-types
[json] [html]
List activity types def/maintenance/activity-type
[json] [html]
List EA Areas def/ea-areas
[json] [html]
List Westminster Constituencies def/westminster-constituencies
[json] [html]