GET /subscriptions/{id}

Owned by Bauke Rietveld
Last updated: 17 Jun 2024Version comment
1 min read

Retrieves the information of a specific subscription with the given ID at a data service provider.

DSGO.Basis: Data service providers MUST support a GET call to a /subscriptions/{id} endpoint to get information about a specific subscription

Request

Authorisation

The data service provider is responsible for determining a suitable authorisation policy for their subscriptions resources. See Autorisatie for more information.

Parameters

For information about the parameters that are common to trust framework’s API’s see Generic API Requirements, and for parameters common to all subscriptions methods, see /subscriptions.

DSGO.Basis: Data service providers MUST validate that the {id} of a GET request to a /subscriptions/{id} is valid, exists and is available to the data service consumer

Responses

200 OK

Successful, the response body contains data of the specific subscription requested. The data has to be structured as a subscription object, as indicated in the example below.

DSGO.Basis: Data service providers MUST respond with a 200 OK to a successful GET call to a /subscriptions/{id} endpoint

{ "id": "sub_123", "resource_type": "subscription", "href": "/subscriptions/sub_123", "created_date": "1663752217", "start_date": "1663801199", "end_date": "1663801199", "consumer_id": "EU.EORI.NL000123456", "provider_id": "EU.EORI.NL000345678", "description": "detailed description of the subscription", "event_type": ["Modified"], "status": "active", "webhook_url": "https://example.com/notifications" }

404 Not found