Page Comparison

Parameters

Type

Description

accessRights

Required

String

MUST contain a description of the access policy of the data service which is not covered by the level_of_assurance or security_level, MUST be limited to a maximum of 1500 characters.

authenticationMeans*

Optional

String

MUST contain a description of authentication means in case authentication is needed on human level.

conformsTo

Required

Array

MUST contain a (reference to) (one or more) recognised standard to indicate ontologies, semantics, schemes to which the resource in the data service conforms. In order to be machine-readable, this MUST contain an array of URLs, if this is not possible, it MAY contain a human-readable description of the standard.

costs*

Required

String

MUST contain a description of the costs that a data service provider charges a data service consumer for using the data service. In order to be machine-readable, this MUST contain a URL to existing models, if this is not possible, it MAY contain a human-readable description of associated costs.

dataServiceConsumerType*

Required

String

MUST contain a description of what type of data service consumers are supported. Allowed values are "H2M" or "M2M"

endpointDescription

Required

Array

MUST contain a URL to a machine-readable description of the endpoint and possible operations related to the endpoint(s) of the data service. Examples include an OpenAPI (Swagger) description, or YAML file. Additionally, this array MAY include a URL to a human-readable description of the endpoint, for example a developer portal.

hasPolicy

Required

String

MUST contain a description regarding the policies related to the execution of the data service. In order to be machine-readable, this SHOULD contain a XCAML description, if this is not possible, it MAY contain a human-readable description of the policies.

levelOfAssurance*

Optional

String

MUST contain the level of assurance that a data service consumer must achieve in order to make use of the data service, MUST be indicated in accordance with the eHerkenning levels of assurance and be the string value of Not Applicable, eH2+, eH3 or eH4. Only applicable for type of data service consumers involving a human.

license

Required

Array

MUST contain a reference to the legal document under which the data service is made available. MUST be equal to one or more of the licence codes, prepended with a “DSGO." prefix.

securityLevel*

Required

String

MUST contain the level of security that a data service consumer must achieve in order to make use of the data service.

Note, this is not yet defined in the DSGO, but will be further expanded in the development of the DSGO.

serviceLevelAgreements*

Required

Array of objects

Service levels which data service consumers can expect regarding the data service. MUST contain an object including the availability and performance objects.

availability*

Required

Array of objects in service_level_agreements object

MUST contain a range of timestamps indicating the weekly availability window of the data service. In order to be machine-readable, this MUST contain a JSON structure as presented below, if this is not possible, it MAY contain a human-readable description of the availability window.

[
  {"monday": {"start": "09:00", "end": "17:00"}},
  {"tuesday": {"start": "09:00", "end": "17:00"}},
  // ... other days ...
  {"sunday": {"start": "00:00", "end": "00:00"}}
]

performance*

Required

string in service_level_agreements object

Performance indicators of the data service. MUST contain a string describing the performance, limited to a maximum of 500 characters.

version

Required

String

Version indicator of the data service, MUST be formatted as a.b.c. inline with the versioning guidelines for the trust framework