Retrieves a list of all subscriptions have been made accessible to a data service consumer by a data service provider. This may include subscriptions at any phase in their lifecycle.
Excerpt |
---|
|
Panel |
---|
panelIconId | 2705 |
---|
panelIcon | :white_check_mark: |
---|
panelIconText | ✅ |
---|
bgColor | #FFF0B3 |
---|
| DSGO.Basis : Data service providers MUST support a GET call to a /subscriptions endpoint to retrieve a list of available subscriptions
|
|
...
For information about the parameters that are common to the trust framework’s API’s see Generic API Requirements, and for parameters common to all subscriptions methods, see /subscriptions.
...
Successful, the response body contains data providing a list of subscriptions available to the data service consumer. The data is structured as an array of subscription resources objects as indicated in the example below:
Excerpt |
---|
|
Panel |
---|
panelIconId | 2705 |
---|
panelIcon | :white_check_mark: |
---|
panelIconText | ✅ |
---|
bgColor | #FFF0B3 |
---|
| DSGO.Basis : Data service providers MUST include a list of subscription resources available for the data service consumer in a response to a successful GET calls to the /subscriptions endpoint
|
Panel |
---|
panelIconId | 2705 |
---|
panelIcon | :white_check_mark: |
---|
panelIconText | ✅ |
---|
bgColor | #FFF0B3 |
---|
| DSGO.Basis : Data service providers MUST provide a count of the number of subscriptions included, in the count parameter, in the response to a successful GET calls to the /subscriptions endpoint
|
|
Expand |
---|
title | Example response body for a succesful GET /subscriptions call |
---|
|
Code Block |
---|
| {
"count": 4,
"subscriptions": [
{
"id": "sub_123",
"resource_type": "subscription",
"href": "/subscriptions/sub_123",
"created_date": "2022-09-21T10:23:37Z1663752217",
"start_date": "2022-09-21T23:59:59Z1663801199",
"end_date": "2023-09-21T23:59:59Z1663801199",
"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"
},
{
"id": "sub_345",
"resource_type": "subscription",
"href": "/subscriptions/sub_345",
"created_date": null,
"start_date": null,
"end_date": null,
"consumer_id": null,
"provider_id": "EU.EORI.NL000345678",
"description": "detailed description of the subscription",
"event_type": ["Modified","Deleted"]
"status": "inactive",
"webhook_url": null
},
{...},
{...},
]
} |
|