Retrieves a list of all data services to the requesting party from the trust framework catalogue.

The trust framework catalogue MUST support a GET call to a /data_services endpoint to retrieve a list of DSGO data services (in an array of capabilities_info objects).

Request

Authorization

An access token is used in GET calls to the /data_services endpoint. For more information, see Access Token.

The trust framework catalogue MUST validate that a GET call to a /data_services endpoint includes the “Authorization" header according to RFC 6750 and includes a valid access token

Parameters

For information about the parameters that are common to the trust framework’s API’s see Generic API Requirements.

The trust framework catalogue MUST validate that the HTTP body of a GET request to the /data_services endpoint contains the parameters as defined in the table below

The trust framework catalogue MUST validate that the HTTP body of a GET request to the /data_services endpoint contains at least a single parameter.

Parameter		Type	Description

Parameter		Type	Description
`party_id`	Optional	String	Used to search by a party’s identifier. MUST contain a valid Organisation ID
`certified_only`	Optional	Boolean	Used to search all certified parties. MUST be equal to `null`, `false` or `true`. If `null` is provided, then it will not affect the query and will return both services from certified and non-certified parties. If `false` is provided, then the query will return services from non-certified parties. If `true` is provided, the query will return services of certified parties.
`active_only`	Optional	Boolean	Used to search services of all active parties. MUST be equal to `null`, `false` or `true`. If `null` is provided, then it will not affect the query and will return both services from active and inactive parties. If `false` is provided, then the query will return services from inactive parties. If `true` is provided, then the query will return services from active parties.
`page`	Optional	Integer	Used for navigation in case the result contains more than 10 objects, MUST contain an integer.
`date_time`	Optional	String	Date and time for which the information is requested. MUST be according to ISO 8601. If provided, the result becomes final and therefore MUST be cacheable.

> Authorization: Bearer IIeDIrdnYo2ngwDQYJKoZIhvcNAQELBQAwSDEZMBcGA1UEAwwQaVNIQ

GET /data_services?
    party_id=did:ishare:EU.NL.NTRNL-63202158&

Responses

200 OK

Successful, the response contains data providing the requested parties information in an array of capabilities_info objects as defined here. The response is signed using the onweerlegbaarheid JWT for non-repudation.

The trust framework catalogue MUST include an array of capabilities_info objects in a response to a successful GET calls to the /data_services endpoint

< Content-Type: application/json

{
    "data_services": [
        "capabilities_info": {
            "publicServices": [
              {
                "identifier": "/capabilities",
                "title": "Capabilities",
                "description": "digiGO Capabilities",
                "endpointDescription": "https://api.digigo.nu/capabilities",
                "endpointURL": "https://api.digigo.nu/capabilities",
                "tokenEndpoint": "https://api.digigo.nu/token",
                "status": "active",
                "serviceType": "framework-defined",
                "version": {
                  "compliesWithFrameworkVersions": [
                    "2.1"
                  ],
                  "compliesWithDataspaceVersions": [
                    "1.2"
                  ],
                  "capabilityVersion": "1.0"
                },
                "methods": [
                  "GET"
                ],
                "aal": [
                  "QSeal",
                  "AdSeal",
                  "ClientPassword"
                ],
                "conformsTo": [
                  "https://afsprakenstelseldsgo.atlassian.net/wiki/spaces/DSGO/pages/316968962/capabilities",
                ]
              }
            ]
        } 
    ]
}

400 Bad Request

When Authorization header is provided, but the token format is invalid (for example, not Bearer). Additionally, a 400 should be returned when the provided access token is valid, but query parameters are either invalid or none of them were provided.

401 Unauthorized

When Authorization header is either missing, invalid or the access token has already expired.