Digital Delta API API documentation version 1.0

http://digitaldeltatest.aquadesk.nl

Digital Delta API

Introduction

The Digital Delta is a distributed network in which various datasources exchange information using a standard interface. This specification outlines the mechanics of the Digital Delta as a distributed network of nodes and masternodes and describes the technical specification of the Digital Delta web API.
This document uses the RAML standard as the definition language.

The API specification

The API specification consists of two parts.

  1. The Types section describes the data types that are available for the resources. Please refer to figure 1 below for the resource object diagram.
    Note: Currently, the generated HTML documentation does not contain tables that describe the data types. However, their content can be seen in the response tabs of the requests. If you want to have a detailed look at the type definitions, open the RAML file and go to the “# Base types.” section.
  2. The Resources section describes the available end-points.

Figure 1

The Digital Delta uses uuids (universally unique identifier, version 4) for identification of resource objects.
The use of uuids guarantees a unique identifier for an instance over all nodes in the Digital Delta without the need for individual nodes to have a knowledge about data in other nodes.
There is a code attribute as well that can be used by suppliers for their internal identifiers.
The Digital Delta supports timeseries data, defined as a measurement series with a begin and end time, a fixed location and a parameter.
The list of objects is setup to be extendable to other data types, such as raster or vector data.
The protocols provides by the services are HTTP and HTTPS. Currently authentication is Anonymous.
The Digital Delta only supports JSON as the output format and for POST request bodies.

The RAML standard and Universal unique identifiers

The RAML specification currently doesn't know the type uuid (Universal unique identifiers). To have a structure in the definition to allow working with uuids, the Digital Delta specification uses a strong with a specific regular expression pattern. The base pattern is: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12}.

About the examples in this document

The examples in the requests are based on based on the AquaDesk implementation of the Digital Delta specifications. The structure, however, for all gets, posts and responses will be the same for all providers.

Future enhancements

The following future enhancements are under consideration.

  • Search endpoint (full-text search)
  • Authentication/Authorisation
  • Error and warning codes
  • OPTION request, explaining how the service works

Future research

The following topics are considered Future research

  • Attributes for different standards
  • Support for multiple data types
  • Additional output formats
  • Basic calculations on timeseries data

Document history

DateAuthorChanges
2017-05-06Geri Wolters
  • Texts from the original document added. Texts corrected and updated.
  • Introduction of samples.
  • Changed properties previous and next to return string? instead of string.
  • Changed properties events from timeseries to return an array or nil, as the values can be null.
2017-05-30Geri Wolters
  • Added resource object diagram.
2017-06-13Geri Wolters
  • Unified naming of fields and parameters.
  • TimeSeries field 'code' is replaced by 'qualifier'. 'qualifier' is optional and filterable.
  • HTTP Status code 204 (NoContent) is introduced for list-requests. This value should be returned instead of an empty list.
2017-06-26Geri Wolters
  • Changed error responses from 404 to 400.
2017-12-14Geri Wolters
  • Changed Extras to required:false.
  • Fixed small bugs.

/datasources

The Datasources endpoint can return the datasources that the provider offers. Filtering: uuid and name.

About Datasource

DataSource (“bronhouder” in Dutch) objects describe the source of the data. A node can have multiple data sources.

get

get

get

Request a specific datasource by its uuid.

get

URI Parameters

  • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

    Unique identifier for the datasource. Version 4.

    Example:

    978fdf5c-95c8-43a5-82ff-d27d9e6d685f

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

    The unique identifier for the datasource. UUID Version 4
    Qualifiers:Nullable,Filterable.

  • name: required (string)

    The name of the datasource..
    Qualifiers:Nullable,Filterable.

  • node: required (object)

    The node of the datasource.

    • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

      The unique identifier of the node. UUID Version 4.
      Qualifiers:Nullable,Filterable.

    • name: required (string)

      The name of the node.
      Qualifiers:Nullable,Filterable.

    • description: required (string)

      The description of the node.
      Qualifiers:Nullable,Filterable.

    • baseUrl: required (string)

      The base URL of the node.

Example:

{
  "uuid": "978fdf5c-95c8-43a5-82ff-d27d9e6d685f",
  "name": "AquaDesk DD Primary",
  "node": {
    "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
    "name": "AquaDesk Primary",
    "description": "AquaDesk Primary Node",
    "baseUrl": "https://digitaldeltatest.aquadesk.nl"
  }
}

HTTP status code 404

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid data source"
}

/nodes

The Nodes endpoint can return the nodes that the provider offers. Filtering: uuid and name.

About Node

Node objects contain the properties of the data node. A node is an operational implementation of the Digital Delta specification.

get

get

get

Request a specific node by its uuid.

get

URI Parameters

  • uuid: required (string)

    Unique identifier for the node. Version 4.

    Example:

    f4af47f5-f087-494c-9b2d-ba129bddd545

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

    The unique identifier of the node. UUID Version 4.
    Qualifiers:Nullable,Filterable.

    Example:

    978fdf5c-95c8-43a5-82ff-d27d9e6d685f
  • name: required (string)

    The name of the node.
    Qualifiers:Nullable,Filterable.

  • description: required (string)

    The description of the node.
    Qualifiers:Nullable,Filterable.

  • baseUrl: required (string)

    The base URL of the node.

Example:

{
  "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
  "name": "AquaDeskPrimaryNode",
  "description": "Primary node for the AquaDesk RWS service.",
  "baseUrl": "https://digitaldeltatest.aquadesk.nl"
}

HTTP status code 404

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid node source"
}

/observationtypes

The ObservationTypes endpoint can return the observationtypes that the provider offers. Filtering: list of parameters.

About ObservationType

The ObservationType objects describe all attributes to correctly interpret what has been measured, and in what way. It is essential to have the quantity field.

get

get

get

Request a specific observation type by its qualifier.
Since almost no specific ObservationTypes for biological entities exist in Aquo, AquaDesk is using uuids instead of the code. The type 'String' is used in both circumstances.

get

URI Parameters

  • qualifier: required (string)

    The qualifier (or uuid for AquaDesk) identifying the observation type.

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

    The unique identifier for the observationtype. UUID Version 4.

  • quantity: required (string)

    Defines what was measured.
    Qualifiers:Nullable,Filterable.

    Examples:

    ZICHT
    MONSTER
    CONCTTE
    AANTL
  • unit: required (string)

    Unit of measurement. Follows the Aquo standards.

    Examples:

    cm2
    n
    n/m3
    %
    DIMSLS
    C
  • parameterCode: (string)

    Parameter code specifying the observationtype. Non-biological observation types follow the Aquo standards.
    Qualifiers:Nullable,Filterable.

    Examples:

    Pediastrum
    Ca
    1112T4ClC2a
    HYBDVS
  • compartment: (string)

    The compartment in which the measurement took place. Standardised Aquo compartments.
    Qualifiers:Nullable,Filterable.

    Examples:

    OW
    DL
    GW
    LW
  • qualifier: (string)

    Dutch: 'Hoedanigheid'. Additional qualities of the measurement.
    Qualifiers:Nullable,Filterable.

    Examples:

    AD
    JU
    T20C
    KO
    BraunBS
    WATSGL
    WATKLM
  • extra: (array of KeyValuePair)

    Extra information about the measurement. Can be used to provide specific details concerning the circumstances or the object measured, etc.

    Items: KeyValuePair

    • key: required (string)

      The key of the key/value pair.

      Example:

      taxontype
    • value: required (string)

      The value of the key/value pair.

    Example:

    [
  {
    "key": "taxongroup",
    "value": "DIATM"
  },
  {
    "key": "type",
    "value": "Biotaxon"
  }
]

Example:

{
  "uuid": "1f9f13c0-d45a-4031-9231-09235d81481e",
  "quantity": "AANTL",
  "unit": "n/ml",
  "parameterCode": "Acanthoceras zachariasii",
  "compartment": "OW",
  "qualifier": "CE",
  "extra": [
    {
      "key": "taxongroup",
      "value": "DIATM"
    },
    {
      "key": "type",
      "value": "Biotaxon"
    }
  ]
}

HTTP status code 404

Body

Media type: application/json

Type: object

Example:

{
  "message": "Invalid observation type source"
}

/locations

The Locations endpoint can return the locations that the provider offers. Filtering: bounding box, uuid, code, name and node.

About Locations

A location object contains all information required to describe a location. This version contains a node.

get post

get
post

Body

Media type: application/json

Type: object

Properties
  • code: required (array of )

Example:

{
  "code": [
    "NLWATB-RWTS_AFGDM_0001",
    "NLWATB-RWTS_AFGDM_0002"
  ]
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • results: required (array of Location)

    List of Locations.

    Items: Location

    • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

      The unique identifier for the location. UUID Version 4.
      Qualifiers:Nullable,Filterable.

    • url: required (string)

      The URL of the location.

    • code: required (string)

      The code of the location.
      Qualifiers:Nullable,Filterable.

    • name: required (string)

      The name of the location..
      Qualifiers:Nullable,Filterable.

    • geometry: required (object)

      The GeoJSON geometry definition of the location..
      Qualifiers:Nullable,Filterable.

      • type: required (string)

        The geometry type. Must have the value "Point".

        Example:

        Point
      • coordinates: required (array of Double)

        An array of doubles, representing a coordinate.

        Example:

        [
  4.234,
  52.3423
]
    • node: required (object)

      The node of the location..
      Qualifiers:Nullable,Filterable.

      • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

        The unique identifier of the node. UUID Version 4.
        Qualifiers:Nullable,Filterable.

        Example:

        978fdf5c-95c8-43a5-82ff-d27d9e6d685f
      • name: required (string)

        The name of the node.
        Qualifiers:Nullable,Filterable.

      • description: required (string)

        The description of the node.
        Qualifiers:Nullable,Filterable.

      • baseUrl: required (string)

        The base URL of the node.

  • count: required (integer)

    Number of records satisfying the query parameters.

    Example:

    1123
  • previous: required (string?)

    Url to the API holding the previous page. null if the requested page is the first page.

  • next: required (string?)

    Url to the API holding the next page. null if the requested page is the last page.

  • maxPageSize: required (integer)

    Maximum page size, as allowed by the service.

Example:

{
  "count": 795,
  "previous": null,
  "next": "https://digitaldeltatest.aquadesk.nl/locations?page=2&pageSize=10",
  "maxPageSize": 100000,
  "results": [
    {
      "uuid": "ed0655e7-ced5-42ad-ac42-b9b96639307c",
      "url": "https://digitaldeltatest.aquadesk.nl/locations/ed0655e7-ced5-42ad-ac42-b9b96639307c",
      "code": "NLWATB-RWTS_AFGDM_0001",
      "name": "NEDHMT",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.15835627200311,
          51.7581204207227,
          0
        ]
      },
      "node": {
        "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
        "name": "AquaDesk Primary",
        "description": "AquaDesk Primary Node",
        "baseUrl": "https://digitaldeltatest.aquadesk.nl"
      }
    },
    {
      "uuid": "4d58d630-ac4e-4eb3-bff4-1b17c7b77630",
      "url": "https://digitaldeltatest.aquadesk.nl/locations/4d58d630-ac4e-4eb3-bff4-1b17c7b77630",
      "code": "NLWATB-RWTS_AFGDM_0002",
      "name": "VEEN",
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.11187400090377,
          51.7800422641779,
          0
        ]
      },
      "node": {
        "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
        "name": "AquaDesk Primary",
        "description": "AquaDesk Primary Node",
        "baseUrl": "https://digitaldeltatest.aquadesk.nl"
      }
    }
  ]
}

HTTP status code 204

Body

Media type: application/json

Type: object

HTTP status code 404

Body

Media type: application/json

Type: object

Example:

{"message": "Invalid filters"}

get

Request a specific location by its uuid.

get

URI Parameters

  • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

    Unique identifier for the location. Version 4.

    Example:

    ed0655e7-ced5-42ad-ac42-b9b96639307c

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

    The unique identifier for the location. UUID Version 4.
    Qualifiers:Nullable,Filterable.

  • url: required (string)

    The URL of the location.

  • code: required (string)

    The code of the location.
    Qualifiers:Nullable,Filterable.

  • name: required (string)

    The name of the location..
    Qualifiers:Nullable,Filterable.

  • geometry: required (object)

    The GeoJSON geometry definition of the location..
    Qualifiers:Nullable,Filterable.

    • type: required (string)

      The geometry type. Must have the value "Point".

      Example:

      Point
    • coordinates: required (array of Double)

      An array of doubles, representing a coordinate.

      Example:

      [
  4.234,
  52.3423
]
  • node: required (object)

    The node of the location..
    Qualifiers:Nullable,Filterable.

    • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

      The unique identifier of the node. UUID Version 4.
      Qualifiers:Nullable,Filterable.

      Example:

      978fdf5c-95c8-43a5-82ff-d27d9e6d685f
    • name: required (string)

      The name of the node.
      Qualifiers:Nullable,Filterable.

    • description: required (string)

      The description of the node.
      Qualifiers:Nullable,Filterable.

    • baseUrl: required (string)

      The base URL of the node.

Example:

{
  "uuid": "ed0655e7-ced5-42ad-ac42-b9b96639307c",
  "url": "https://digitaldeltatest.aquadesk.nl/locations/ed0655e7-ced5-42ad-ac42-b9b96639307c",
  "code": "NLWATB-RWTS_AFGDM_0001",
  "name": "NEDHMT",
  "geometry": {
    "type": "Point",
    "coordinates": [
      5.15835627200311,
      51.7581204207227,
      0
    ]
  },
  "node": {
    "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
    "name": "AquaDesk Primary",
    "description": "AquaDesk Primary Node",
    "baseUrl": "https://digitaldeltatest.aquadesk.nl"
  }
}

HTTP status code 404

Body

Media type: application/json

Type: object

Example:

{"message": "Invalid location code"}

/timeseries

The timeseries endpoint can return both the metadata and the data itself. If a start‐ and endtime is given in the request, the data is added to the response, for both the List and the Detail requests. Furthermore, it is possible to only retrieve the data (without the metadata) by querying the data endpoint: /timeseries/{uuid}/data/.
Optional: add start and end filter, returns metadata and data (values)
Filtering: value type, uuid, code, node, timeseries type, observation type, location name, start- and enddate.

About Timeseries

Timeseries objects contain all information needed to interpret timeseries.
There are references to other objects, such as Node, Location, DataSource, ObservationType and TimeseriesType.
The TimeseriesType should be added as a reference because it can indicate if a timeseries containts a RAW dataset or makes use of the current measurements. The Digital Delta specification of timeseries makes no assumptions on the nature of the series, timeseries may describe any series of data points of the same observation type and datasource in time on one location.
This includes both equidistant series (fixed time interval between data points) and non-equidistant series (with varying time interval).

Use case:

Imagine a data-source is providing several timeseries for a specific location and observation. For example:
Waterlevel is measured every 5 minutes for the location Lobith. This is the original timeseries from the datasource and we can call it the RAW timeseries or the original timeseries.
Within the same data-souce, again, waterlevel is measured every 5 minutes for the same location, but this timeseries is a manually or automatically validated timeseries. So in this case we have an original timeseries which is providing the raw data and another timeseries which has been validated. Both timeseries can be required for different purposes.
Now imagine that someone requires the validated timeseries instead of the original.
The users should be able to filter them based on this information and retreve data only for this type of timeseries. There are several more uses cases where more than two types are used. Think of timeseries that are recalculated based on validation, interval, aggregation, etc.

Using TimeseriesType is providing more flexibility in providing multiple timeseries for the same location and observation type provided by a single data-source.

get post

get
post

Body

Media type: application/json

Type: object

Properties
  • code: required (array of )

    Array of codes or uuids of timeseries to return. AquaDesk uses uuids.

  • start: required (date-only)

    First date of the requested measurements. Format: yyyy-MM-dd.

  • end: required (date-only)

    Last date of the requested measurements. Format: yyyy-MM-dd.

Example:

{
  "code": [
    "H.Meting"
  ],
  "start": "2012-01-01",
  "end": "2013-01-01"
}

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • results: required (array of Timeseries)

    List of timeseries types.

    Items: Timeseries

    • url: required (string)
    • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

      The unique identifier for the timeseries. UUID Version 4.
      Qualifiers:Nullable,Filterable.

      Example:

      f4af47f5-f087-494c-9b2d-ba129bddd545
    • qualifier: (string)

      The qualifier of the timeseries. AquaDesk uses the uuid for this.
      Qualifiers:Nullable,Filterable.

      Example:

      H.Meting
    • location: required (object)

      The location that the timeseries uses.
      Qualifiers:Nullable,Filterable.

      • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

        The unique identifier for the location. UUID Version 4.
        Qualifiers:Nullable,Filterable.

      • url: required (string)

        The URL of the location.

      • code: required (string)

        The code of the location.
        Qualifiers:Nullable,Filterable.

      • name: required (string)

        The name of the location..
        Qualifiers:Nullable,Filterable.

      • geometry: required (object)

        The GeoJSON geometry definition of the location..
        Qualifiers:Nullable,Filterable.

        • type: required (string)

          The geometry type. Must have the value "Point".

          Example:

          Point
        • coordinates: required (array of Double)

          An array of doubles, representing a coordinate.

          Example:

          [
  4.234,
  52.3423
]
      • node: required (object)

        The node of the location..
        Qualifiers:Nullable,Filterable.

        • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

          The unique identifier of the node. UUID Version 4.
          Qualifiers:Nullable,Filterable.

          Example:

          978fdf5c-95c8-43a5-82ff-d27d9e6d685f
        • name: required (string)

          The name of the node.
          Qualifiers:Nullable,Filterable.

        • description: required (string)

          The description of the node.
          Qualifiers:Nullable,Filterable.

        • baseUrl: required (string)

          The base URL of the node.

    • observationType: required (object)

      The observationtype that the timeseries uses.
      Qualifiers:Nullable,Filterable.

      • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

        The unique identifier for the observationtype. UUID Version 4.

      • quantity: required (string)

        Defines what was measured.
        Qualifiers:Nullable,Filterable.

        Examples:

        ZICHT
        MONSTER
        CONCTTE
        AANTL
      • unit: required (string)

        Unit of measurement. Follows the Aquo standards.

        Examples:

        cm2
        n
        n/m3
        %
        DIMSLS
        C
      • parameterCode: (string)

        Parameter code specifying the observationtype. Non-biological observation types follow the Aquo standards.
        Qualifiers:Nullable,Filterable.

        Examples:

        Pediastrum
        Ca
        1112T4ClC2a
        HYBDVS
      • compartment: (string)

        The compartment in which the measurement took place. Standardised Aquo compartments.
        Qualifiers:Nullable,Filterable.

        Examples:

        OW
        DL
        GW
        LW
      • qualifier: (string)

        Dutch: 'Hoedanigheid'. Additional qualities of the measurement.
        Qualifiers:Nullable,Filterable.

        Examples:

        AD
        JU
        T20C
        KO
        BraunBS
        WATSGL
        WATKLM
      • extra: (array of KeyValuePair)

        Extra information about the measurement. Can be used to provide specific details concerning the circumstances or the object measured, etc.

        Items: KeyValuePair

        • key: required (string)

          The key of the key/value pair.

          Example:

          taxontype
        • value: required (string)

          The value of the key/value pair.

        Example:

        [
  {
    "key": "taxongroup",
    "value": "DIATM"
  },
  {
    "key": "type",
    "value": "Biotaxon"
  }
]
    • node: required (object)

      The node responsible for hosting the data for the timeseries.
      Qualifiers:Nullable,Filterable.

      • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

        The unique identifier of the node. UUID Version 4.
        Qualifiers:Nullable,Filterable.

        Example:

        978fdf5c-95c8-43a5-82ff-d27d9e6d685f
      • name: required (string)

        The name of the node.
        Qualifiers:Nullable,Filterable.

      • description: required (string)

        The description of the node.
        Qualifiers:Nullable,Filterable.

      • baseUrl: required (string)

        The base URL of the node.

    • datasource: required (object)

      The datasource providing the data for the timeseries..
      Qualifiers:Nullable,Filterable.

      • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

        The unique identifier for the datasource. UUID Version 4
        Qualifiers:Nullable,Filterable.

      • name: required (string)

        The name of the datasource..
        Qualifiers:Nullable,Filterable.

      • node: required (object)

        The node of the datasource.

        • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

          The unique identifier of the node. UUID Version 4.
          Qualifiers:Nullable,Filterable.

        • name: required (string)

          The name of the node.
          Qualifiers:Nullable,Filterable.

        • description: required (string)

          The description of the node.
          Qualifiers:Nullable,Filterable.

        • baseUrl: required (string)

          The base URL of the node.

    • timeseriesType: required (object)

      The type of the timeseries..
      Qualifiers:Nullable,Filterable.

      • code: required (string)

        The code of the timeseries type.

        Example:

        MEAS
      • name: required (string)

        The name of the timeseries type.

        Example:

        Measurement
    • interval: (number)

      Specifies the interval between measurements for the timeseries.
      Qualifiers:Nullable,Filterable.

    • valueType: (string)

      The data type of the measured data.
      Qualifiers:Nullable,Filterable.

    • start: required (datetime)

      Start date/time of the measurement. Uses the Zulu notation
      Qualifiers:Nullable,Filterable.

      Example:

      2016-01-01T12:45:00Z
    • end: required (datetime)

      End date/time of the measurement. Uses the Zulu notation
      Qualifiers:Nullable,Filterable.

      Example:

      2016-01-01T12:45:00Z
    • events: (array of Event (minimal))

      Defines a minimal event.

      Items: Event (minimal)

      • value: required (number)

        The value of the measured data.
        Qualifiers:Nullable,Filterable.

        Example:

        37
      • timeStamp: (datetime)

        The date/time when the measurement took place. Uses the Zulu notation.

        Example:

        2016-12-31T12:45:00Z
  • count: required (integer)

    Number of records satisfying the query parameters.

    Example:

    1123
  • previous: required (string?)

    Url to the API holding the previous page. null if the requested page is the first page.

  • next: required (string?)

    Url to the API holding the next page. null if the requested page is the last page.

  • maxPageSize: required (integer)

    Maximum page size, as allowed by the service.

Example:

{
  "count": 48751,
  "previous": null,
  "next": "https://digitaldeltatest.aquadesk.nl/timeseries?page=2&pagesize=2",
  "maxPageSize": 100000,
  "results": [
    {
      "url": "https://digitaldeltatest.aquadesk.nl/timeseries/e9ede034-f254-4855-b1ea-fe715c382935",
      "uuid": "e9ede034-f254-4855-b1ea-fe715c382935",
      "location": {
        "uuid": "6fba498f-0b59-462b-8c34-bd456d8e7d31",
        "url": "https://digitaldeltatest.aquadesk.nl/locations/6fba498f-0b59-462b-8c34-bd456d8e7d31",
        "code": "NLWATB-RWTS_BERMS_0002",
        "name": "KEIZVR",
        "geometry": {
          "type": "Point",
          "coordinates": [
            4.89443671141974,
            51.7201856231622,
            0
          ]
        },
        "node": {
          "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
          "name": "AquaDesk Primary",
          "description": "AquaDesk Primary Node",
          "baseUrl": "https://digitaldeltatest.aquadesk.nl"
        }
      },
      "observationType": {
        "uuid": "297d7ba6-d5e0-4683-849a-5246a3aa83c4",
        "quantity": "AANTL",
        "unit": "n/ml",
        "parameterCode": "Achnanthidium",
        "compartment": "OW",
        "qualifier": "CE",
        "extra": [
          {
            "key": "taxongroup",
            "value": "DIATM"
          },
          {
            "key": "type",
            "value": "Biotaxon"
          }
        ]
      },
      "node": {
        "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
        "name": "AquaDesk Primary",
        "description": "AquaDesk Primary Node",
        "baseUrl": "https://digitaldeltatest.aquadesk.nl"
      },
      "datasource": {
        "uuid": "978fdf5c-95c8-43a5-82ff-d27d9e6d685f",
        "name": "AquaDesk Primary",
        "node": {
          "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
          "name": "AquaDesk Primary",
          "description": "AquaDesk Primary Node",
          "baseUrl": "https://digitaldeltatest.aquadesk.nl"
        }
      },
      "timeseriesType": {
        "code": "MEAS",
        "name": "Measurements"
      },
      "interval": null,
      "valueType": "float",
      "start": "2005-02-14T23:00:00Z",
      "end": "2005-02-14T23:00:00Z",
      "events": null
    },
    {
      "url": "https://digitaldeltatest.aquadesk.nl/timeseries/db9544e4-1eb3-4f99-ac6e-b9c02a7cca88",
      "uuid": "db9544e4-1eb3-4f99-ac6e-b9c02a7cca88",
      "location": {
        "uuid": "6fba498f-0b59-462b-8c34-bd456d8e7d31",
        "url": "\\null\\",
        "code": "NLWATB-RWTS_BERMS_0002",
        "name": "KEIZVR",
        "geometry": {
          "type": "Point",
          "coordinates": [
            4.89443671141974,
            51.7201856231622,
            0
          ]
        },
        "node": {
          "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
          "name": "AquaDesk Primary",
          "description": "AquaDesk Primary Node",
          "baseUrl": "https://digitaldeltatest.aquadesk.nl"
        }
      },
      "observationType": {
        "uuid": "5cd9726e-7985-4789-9674-22bec8bef325",
        "quantity": "AANTL",
        "unit": "n/ml",
        "parameterCode": "Actinocyclus normanii",
        "compartment": "OW",
        "qualifier": "CE",
        "extra": [
          {
            "key": "taxongroup",
            "value": "DIATM"
          },
          {
            "key": "type",
            "value": "Biotaxon"
          }
        ]
      },
      "node": {
        "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
        "name": "AquaDesk Primary",
        "description": "AquaDesk Primary Node",
        "baseUrl": "https://digitaldeltatest.aquadesk.nl"
      },
      "datasource": {
        "uuid": "978fdf5c-95c8-43a5-82ff-d27d9e6d685f",
        "name": "AquaDesk Primary",
        "node": {
          "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
          "name": "AquaDesk Primary",
          "description": "AquaDesk Primary Node",
          "baseUrl": "https://digitaldeltatest.aquadesk.nl"
        }
      },
      "timeseriesType": {
        "code": "MEAS",
        "name": "Measurements"
      },
      "interval": null,
      "valueType": "float",
      "start": "2004-08-30T22:00:00Z",
      "end": "2004-08-30T22:00:00Z",
      "events": null
    }
  ]
}

HTTP status code 204

Body

Media type: application/json

Type: object

HTTP status code 400

Body

Media type: application/json

Type: object

Example:

{"message": "Invalid filters"}

get

Get the data of one timeseries, including metadata.

get

URI Parameters

  • uuid: required (string)

    Unique identifier for the timeseries. Version 4.

    Example:

    db9544e4-1eb3-4f99-ac6e-b9c02a7cca88

HTTP status code 200

Body

Media type: application/json

Type: object

Properties
  • url: required (string)
  • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

    The unique identifier for the timeseries. UUID Version 4.
    Qualifiers:Nullable,Filterable.

    Example:

    f4af47f5-f087-494c-9b2d-ba129bddd545
  • qualifier: (string)

    The qualifier of the timeseries. AquaDesk uses the uuid for this.
    Qualifiers:Nullable,Filterable.

    Example:

    H.Meting
  • location: required (object)

    The location that the timeseries uses.
    Qualifiers:Nullable,Filterable.

    • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

      The unique identifier for the location. UUID Version 4.
      Qualifiers:Nullable,Filterable.

    • url: required (string)

      The URL of the location.

    • code: required (string)

      The code of the location.
      Qualifiers:Nullable,Filterable.

    • name: required (string)

      The name of the location..
      Qualifiers:Nullable,Filterable.

    • geometry: required (object)

      The GeoJSON geometry definition of the location..
      Qualifiers:Nullable,Filterable.

      • type: required (string)

        The geometry type. Must have the value "Point".

        Example:

        Point
      • coordinates: required (array of Double)

        An array of doubles, representing a coordinate.

        Example:

        [
  4.234,
  52.3423
]
    • node: required (object)

      The node of the location..
      Qualifiers:Nullable,Filterable.

      • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

        The unique identifier of the node. UUID Version 4.
        Qualifiers:Nullable,Filterable.

        Example:

        978fdf5c-95c8-43a5-82ff-d27d9e6d685f
      • name: required (string)

        The name of the node.
        Qualifiers:Nullable,Filterable.

      • description: required (string)

        The description of the node.
        Qualifiers:Nullable,Filterable.

      • baseUrl: required (string)

        The base URL of the node.

  • observationType: required (object)

    The observationtype that the timeseries uses.
    Qualifiers:Nullable,Filterable.

    • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

      The unique identifier for the observationtype. UUID Version 4.

    • quantity: required (string)

      Defines what was measured.
      Qualifiers:Nullable,Filterable.

      Examples:

      ZICHT
      MONSTER
      CONCTTE
      AANTL
    • unit: required (string)

      Unit of measurement. Follows the Aquo standards.

      Examples:

      cm2
      n
      n/m3
      %
      DIMSLS
      C
    • parameterCode: (string)

      Parameter code specifying the observationtype. Non-biological observation types follow the Aquo standards.
      Qualifiers:Nullable,Filterable.

      Examples:

      Pediastrum
      Ca
      1112T4ClC2a
      HYBDVS
    • compartment: (string)

      The compartment in which the measurement took place. Standardised Aquo compartments.
      Qualifiers:Nullable,Filterable.

      Examples:

      OW
      DL
      GW
      LW
    • qualifier: (string)

      Dutch: 'Hoedanigheid'. Additional qualities of the measurement.
      Qualifiers:Nullable,Filterable.

      Examples:

      AD
      JU
      T20C
      KO
      BraunBS
      WATSGL
      WATKLM
    • extra: (array of KeyValuePair)

      Extra information about the measurement. Can be used to provide specific details concerning the circumstances or the object measured, etc.

      Items: KeyValuePair

      • key: required (string)

        The key of the key/value pair.

        Example:

        taxontype
      • value: required (string)

        The value of the key/value pair.

      Example:

      [
  {
    "key": "taxongroup",
    "value": "DIATM"
  },
  {
    "key": "type",
    "value": "Biotaxon"
  }
]
  • node: required (object)

    The node responsible for hosting the data for the timeseries.
    Qualifiers:Nullable,Filterable.

    • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

      The unique identifier of the node. UUID Version 4.
      Qualifiers:Nullable,Filterable.

      Example:

      978fdf5c-95c8-43a5-82ff-d27d9e6d685f
    • name: required (string)

      The name of the node.
      Qualifiers:Nullable,Filterable.

    • description: required (string)

      The description of the node.
      Qualifiers:Nullable,Filterable.

    • baseUrl: required (string)

      The base URL of the node.

  • datasource: required (object)

    The datasource providing the data for the timeseries..
    Qualifiers:Nullable,Filterable.

    • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

      The unique identifier for the datasource. UUID Version 4
      Qualifiers:Nullable,Filterable.

    • name: required (string)

      The name of the datasource..
      Qualifiers:Nullable,Filterable.

    • node: required (object)

      The node of the datasource.

      • uuid: required (string - pattern: [0-9a-f]{8}-([0-9a-f]{4}-){3}[0-9a-f]{12})

        The unique identifier of the node. UUID Version 4.
        Qualifiers:Nullable,Filterable.

      • name: required (string)

        The name of the node.
        Qualifiers:Nullable,Filterable.

      • description: required (string)

        The description of the node.
        Qualifiers:Nullable,Filterable.

      • baseUrl: required (string)

        The base URL of the node.

  • timeseriesType: required (object)

    The type of the timeseries..
    Qualifiers:Nullable,Filterable.

    • code: required (string)

      The code of the timeseries type.

      Example:

      MEAS
    • name: required (string)

      The name of the timeseries type.

      Example:

      Measurement
  • interval: (number)

    Specifies the interval between measurements for the timeseries.
    Qualifiers:Nullable,Filterable.

  • valueType: (string)

    The data type of the measured data.
    Qualifiers:Nullable,Filterable.

  • start: required (datetime)

    Start date/time of the measurement. Uses the Zulu notation
    Qualifiers:Nullable,Filterable.

    Example:

    2016-01-01T12:45:00Z
  • end: required (datetime)

    End date/time of the measurement. Uses the Zulu notation
    Qualifiers:Nullable,Filterable.

    Example:

    2016-01-01T12:45:00Z
  • events: (array of Event (minimal))

    Defines a minimal event.

    Items: Event (minimal)

    • value: required (number)

      The value of the measured data.
      Qualifiers:Nullable,Filterable.

      Example:

      37
    • timeStamp: (datetime)

      The date/time when the measurement took place. Uses the Zulu notation.

      Example:

      2016-12-31T12:45:00Z

Example:

{
  "url": "https://digitaldeltatest.aquadesk.nl/timeseries/db9544e4-1eb3-4f99-ac6e-b9c02a7cca88",
  "uuid": "db9544e4-1eb3-4f99-ac6e-b9c02a7cca88",
  "location": {
    "uuid": "6fba498f-0b59-462b-8c34-bd456d8e7d31",
    "url": "https://digitaldeltatest.aquadesk.nl/locations/6fba498f-0b59-462b-8c34-bd456d8e7d31",
    "code": "NLWATB-RWTS_BERMS_0002",
    "name": "KEIZVR",
    "geometry": {
      "type": "Point",
      "coordinates": [
        4.89443671141974,
        51.7201856231622,
        0
      ]
    },
    "node": {
      "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
      "name": "AquaDesk Primary",
      "description": "AquaDesk Primary Node",
      "baseUrl": "https://digitaldeltatest.aquadesk.nl"
    }
  },
  "observationType": {
    "uuid": "5cd9726e-7985-4789-9674-22bec8bef325",
    "quantity": "AANTL",
    "unit": "n/ml",
    "parameterCode": "Actinocyclus normanii",
    "compartment": "OW",
    "qualifier": "CE",
    "extra": [
      {
        "key": "taxongroup",
        "value": "DIATM"
      },
      {
        "key": "type",
        "value": "Biotaxon"
      }
    ]
  },
  "node": {
    "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
    "name": "AquaDesk Primary",
    "description": "AquaDesk Primary Node",
    "baseUrl": "https://digitaldeltatest.aquadesk.nl"
  },
  "datasource": {
    "uuid": "978fdf5c-95c8-43a5-82ff-d27d9e6d685f",
    "name": "AquaDesk Primary",
    "node": {
      "uuid": "f4af47f5-f087-494c-9b2d-ba129bddd545",
      "name": "AquaDesk Primary",
      "description": "AquaDesk Primary Node",
      "baseUrl": "https://digitaldeltatest.aquadesk.nl"
    }
  },
  "timeseriesType": {
    "code": "MEAS",
    "name": "Measurements"
  },
  "interval": null,
  "valueType": "float",
  "start": "2004-08-30T22:00:00Z",
  "end": "2004-08-30T22:00:00Z",
  "events": [
    {
      "value": 13.81,
      "timeStamp": "2004-08-30T22:00:00Z"
    }
  ]
}

HTTP status code 204

Body

Media type: application/json

Type: object

HTTP status code 400

Body

Media type: application/json

Type: object

Example:

{"message": "Invalid time series"}

get

Get the detail data for the specified timeseries, excluding metadata.

get

URI Parameters

  • uuid: required (string)

    Unique identifier for the timeseries. Version 4.

    Example:

    db9544e4-1eb3-4f99-ac6e-b9c02a7cca88

Query Parameters

  • start: (date-only)

    Format: yyyy-MM-dd.

    Example:

    2016-01-01
  • end: (date-only)

    Format: yyyy-MM-dd.

    Example:

    2016-12-31

HTTP status code 200

Body

Media type: application/json

Type: array of Event (detailed)

Items: Event (detailed)

  • value: required (number)

    The value of the measured data.
    Qualifiers:Nullable,Filterable.

  • timeStamp: (datetime)

    The date/time when the measurement took place. Uses the Zulu notation.

  • quality: (string)

    As specified in Aquo Domain Table 'Kwaliteitsoordeel'. Specifies whether the value is considered normal, abberent, interpolated, etc. and for what reason. .
    Qualifiers:Nullable,Filterable.

    Example:

    99
  • limitSymbol: (string)

    The limit symbol supplements the measured value.
    Qualifiers:Nullable,Filterable.

    Examples:

    <
    >
    =

Example:

[
  {
    "value": 13.81,
    "timeStamp": "2004-08-30T22:00:00Z",
    "quality": "",
    "limitSymbol": null
  }
]

HTTP status code 400

Body

Media type: application/json

Type: object

Example:

{"message": "Invalid time series"}