Versions Compared

Key

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

Removes a specific subscription with the given ID at a data service provider. This method is possible on all subscriptions with status equal to active and results in their status being set to inactive such that they cannot be used. (see Lifecycle of a Subscription for more information)

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

DSGO.Basis: Data service providers MUST support a DELETE call to a /subscriptions/{id} endpoint to remove a specific subscription

...

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

...

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.

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

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

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST validate that the subscription resource being deleted complies with their data service specific subscription requirements

...

Excerpt
namedelete 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 DELETE call to a /subscriptions/{id} endpoint

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST NOT include an HTTP body in the response to a successful DELETE call to the /subscriptions/{id} endpoint

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST set the “status" of subscription/{id} to "inactive" in response to a successful DELETE call to the /subscriptions/{id} endpoint

...

Excerpt
namedelete 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 DELETE call to a /subscriptions/{id} endpoint when the {id} is not a valid or available to the data service consumer