Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Kleine wijzigingen: Aanpassingen t.b.v. leesbaarheid

...

Excerpt
nameget subs/id
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

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

...

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.

Excerpt
nameget subs/id req
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

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

...

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

Excerpt
nameget subs/id res
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

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

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST include the requested subscription resource object in the HTTP body of the response to a successful GET call to the /subscriptions/{id} endpoint

Expand
titleExample response body for a succesful GET /subscriptions/sub_123 call
Code Block
languagejson
{
  "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"
}

...

Excerpt
nameget subs/id res 2
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST respond with a 404 Not found to a GET call to a /subscriptions/{id} endpoint when the {id} is not valid or available to a data service consumer