Versions Compared

Key

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

Creates a new subscription for a data service consumer at a data service provider. This method results in a subscription with status set to active. (see Lifecycle of a Subscription for more information)

Excerpt
namepost subs
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST support a POST call to a /subscriptions endpoint to create a new 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. The HTTP body must contain a subscription resourceobject, in accordance to the subscription as defined by the data service provider.

Excerpt
namepost subs req
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST validate that the HTTP body of a POST request to a /subscriptions endpoint contains the following parameters, with content as defined in the subscription resource object:

  • resource_type

  • start_date (optional)

  • end_date (optional)

  • event_type

  • webhook_url

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST validate that a POST request to /subscriptions endpoint complies with their data service specific subscription requirements

...

Successful, the new subscription is created. The response body contains the data of the created subscription as a subscription resource object, as indicated in the example below:

Excerpt
namepost subs res
Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST respond with a 201 Created to a successful POST call to a /subscriptions endpoint

Panel
panelIconId2705
panelIcon:white_check_mark:
panelIconText
bgColor#FFF0B3

DSGO.Basis: Data service providers MUST include the created subscription resource object in the HTTP body of the response to a successful POST call to the /subscriptions endpoint

...