Digital Delta API Specification Version 2.0
This specification describes the Digital Delta API Version 2.0 (DD-API 2.0). It is meant for both implementers and consumers of the Digital Delta API specifications.
About the Digital Delta 2.0 specification
Version 2.0 of the Digital Delta API builds on the foundation as specified in version 1.0.
See the Digital Delta project for some background information.
The changes in version 2.0 compared to 1.0 can be summarized as:
- Renaming of some attributes, e.g. for consistency reasons, or to clarify the content of the attribute
- Adjusting some resource object types in the response in order to let them adhere better to standards. For instance, the Location objects now is a GeoJSON object) and the paging information has been re-arranged according the DSO API guidelines.
- Adding attributes to the Timeseries object that facilitate the definition of computation results and ensemble runs.
- Adding interval information to the values in a Timeseries
- Adding the concept of aspect sets, a mechanism to group related time series, e.g. the minimum, maximum and average of a measured quantity, or the direction and amplitude of wave field.
Due to the nature of the changes, version 2.0 is not backwards compatible with version 1.0.
The status of this specification is pre-production.
Getting started
The specification is written in RAML 1.0, a ‘language’ to define REST (REpresentational State Transfer) service.
It is a specification. This means that there is no full implementation of this specification available in this repository. There are, however, result samples available. Some helper classes in the C# programming language are available in the Wiki.
To read the RAML specification, some tools are recommended. Some tools are also capable of generating documentation, or code skeletons for both consumers and implementers.
The HTML specifications can also be used and may be easier to read.
Prerequisites
The easiest way to get the specification is to download the generated HTML files. To be able to use the RAML files, please consult the tools section. Knowledge of the RAML language is then recommended.
The specification
Version 2.0 includes two specifications. The generic DD-API version 2.0 of the specification is the ‘general purpose’ specification, with url’s that facilitate both searching for and retrieving data. Hence it both for discovery and for getting data.
The Operational extension “dd-oper” is an extension developed for/by Rijkswaterstaat, designed to retrieve data using a fixed strict url-path. It only differs from the generic version in the url-syntax. The dd-oper-url does not support discovery.
The changes between version 1.0 and 2.0 are described here.
Implementations
The Current Implementations contains the most recent list of implementations of the Digital Delta Specifications.