POST /subscriptions/{id}/test

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

Triggers the sending of a test notification by a data service provider to a data service consumer for an existing subscription with the given ID. This method is only possible on subscriptions with status equal to active (see Lifecycle of a Subscription for more information)

DSGO.Basis: Data service providers MUST support a POST call to a /subscriptions/{id}/test endpoint to send a test notification to the data service consumers supplied /notifications endpoint

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 the 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 HTTP body of a POST request to a /subscriptions/{id}/test endpoint is empty

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

Responses

202 Accepted

Successful, triggers the sending of a test notification to the data service consumer

404 Not found

Â