Info |
---|
Deze pagina is in het engels ten behoeve van mogelijk internationale ontwikkelaars |
To describe data services uniformly, the trust framework specifies a data_service_info
object containing all the relevant elements of the data service specification. The data_service_info
object is used in the /capabilities endpoint and in the trust framework catalogue to provide an overview of the data services available in the DSGO and their detailed specifications. The data service specification is inspired by and based on the Data Catalog Vocabulary (DCAT), an open standard for the description of datasets recommended by Forum voor Standaardisatie, and the Data Sharing Canvas.
...
Parameters | Type | Description | ||||
| Required | String | MUST contain a description of the access policy of the data service which is not covered by the | |||
| Optional | String | MUST contain a description of authentication means in case authentication is needed on human level. | |||
| 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 URIs (according to RFC3986)URLs, if this is not possible, it MAY contain a human-readable description of the standard. | |||
| 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 URI (according to RFC3986) URL to existing models, if this is not possible, it MAY contain a human-readable description of associated costs. | |||
| Required | String | MUST contain a description of what type of data service consumers are supported. Allowed values are | |||
| Required | Array | MUST contain a URI (according to RFC3986) to 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 URI URL to a human-readable description of the endpoint, for example a developer portal. | |||
| Required | String | MUST contain a description regarding the policies related to the execution of the data service. In order to be machine-readable, this MUST SHOULD contain a XCAML description, if this is not possible, it MAY contain a human-readable description of the policies. | |||
| RequiredOptional | 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 eIDAS regulation eHerkenning levels of assurance and be the string value of | |||
| 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 “ | |||
| 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. | |||
| RequiredObject | Array of objects | Service levels which data service consumers can expect regarding the data service. MUST contain an object including the | |||
| Required | Array of objects in | 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.
| |||
| Required | string in | Performance indicators of the data service. MUST contain a string describing the performance, limited to a maximum of 500 characters. | |||
| Required | String | Version indicator of the data service, MUST be formatted as a.b.c. inline with the versioning guidelines for the trust framework |
...
Code Block | ||||
---|---|---|---|---|
| ||||
{ "accessRights" : "must have an access token to access", "conformsTo" : ["https://www.digigo.nu/standaarden"], "costs" : "Not Applicable", "dataServiceConsumerType" : "M2M", "endpointDescription" : "https://dsgo-demo.dsgo.app/docs", "hasPolicy" : "None", "levelOfAssurance" : "Not Applicable", "licence" : "DSGO.0001", "securityLevel" : "Not Applicable", "serviceLevelAgreements" : [ { "availability": [ {"monday": {"start": "09:00", "end": "17:00"}}, {"tuesday": {"start": "09:00", "end": "17:00"}}, // ... other days ... {"sunday": {"start": "00:00", "end": "00:00"}} ] }, { "performance": "responds to 95% of requests within 2 seconds" } ], "version":"v0.1.0" } |
...