Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Used to obtain information about the capabilities of participants in the DSGO from the trust framework catalogue (provided by the DSGO Trust framework authority). The /capabilities endpoint is used by all parties providing services within the context of the DSGO (data service providers, market facilities and the trust framework catalogue) to provide information about features provided. In the DSGO, a data service can be considered as a specific feature.

...

Parameters

Type

Description

party_id

Required

String

Unique identifier of the party, MUST be a valid Organisation ID, containing an EORI or KvK number.

roles

Required

Array of objects

MUST be an object containing an array of role objects hat provide the information about the roles of the party in the DSGO

role

Required

String in roles object

MUST be the party role. Available values are Data Service Provider, Data Service Consumer, Data entitled Party,Authorisation Registry, Identity Provider, Data Service Broker or Scheme Owner

supported_versions

Array of objects

Contains information about supported version endpoints for each version. MUST contains version and supported_features

version

Required

String in supported_versions object

MUST be the version of the system which is under support

supported_features

Required

Array of objects in supported_versions object

Contains a list of supported features. MUST contains public and restricted objects.

public

Optional

Array of objects in supported_features object

MUST Contain a list of public features (id, feature, description, url and token_endpoint)

id

Required

String in public object

Unique identifier of the data service, MUST be a unique identifier distributed by the DSGO Trust framework authority, when no identifier is received yet, field MUST be To be received

feature

Required

String in public object

Friendly name of the data service, MUST be limited to a maximum of 100 characters

description

Required

String in public object

Short description of the data service, MUST be limited to a maximum of 1000 characters

url

Required

String in public object

URL to the data service, MUST be according to RFC3986

token_endpoint

Optional

String in public object

URL where access token for the feature could be retrieved, MUST be according to RFC3986. This is optional because if feature is access token, it is not needed to mention it twice, or if the data service does not require an access token.

data_service_info*

Required

object in public object

Data service specification, MUST contain a valid data_service_info object. See Data service specification for more information.

restricted

Optional

Array of objects in supported_features object

MUST contain supported restricted features. The structure and parameters are exactly the same as defined in public above (id, feature, description, url and token_endpoint). It should only be provided to the parties which provided a valid access token. If an access token was not provided or restricted endpoints does not exist, this value can be not returned and must be empty or null.

...

the /parties endpoint follows the generic technical requirements, as well as the requirements specified for specific methods. The figure below gives an overview of the HTTP methods that are supported by the /parties endpoint. These methods are further detailed and specified in the pages below:

Page Tree
rootDSGO:AD:@self
startDepth1

Swagger open api macro
displayOperationIdfalse
methodsnone,get,put,post,delete,options,head,patch,trace
validator
defaultModelsExpandDepth0
urlhttps://api.swaggerhub.com/apis/DSGO/developer-portal/0.7.0
tokend51a8d42-88d4-4747-82dc-76dfeed3121d
defaultModelRenderingexample
filterCapabilites
passwordZ@&&BYe27jt^e*9^3B$jryXgxE^^8Qwh
expandlist
showCommonExtensionsfalse
filename
operations
maxDisplayedTags
attachfalse
showExtensionsfalse
displayRequestDurationfalse
usernamebauke.rietveld@digigo.nu
order