(GET) Subscriptions
Description
Stage (test): https://openadr-vtn-stage.gridx.com/v1/subscriptions
Production: https://openadr-vtn.gridx.com/v1/subscriptions
To subscribe to receive price data each time it’s published, you must first enroll for the service with the POST Subscription endpoint.
The GET Subscriptions endpoint allows participants to confirm that subscription requests have been received by the OpenADR server. The response looks very similar to the POST subscription request.
Note
Response | Definition |
---|---|
For questions on specific terminology in OpenADR protocol, please refer to information model section of OpenADR documentation |
Headers
Header | Description |
---|---|
authorization | JWT token received from /token endpoint, more information here: https://api-calculate-docs.gridx.com/acgd/post-token-authentication |
Query Parameters
Parameter | Description |
---|---|
programID | filter on the “id” from (GET) Programs response you subscribed to in the POST Subscriptions request |
clientName | filter subscriptions based on the clientName you configured in the POST Subscription request |
targetType | filter subscriptions based on TargetType (aka CIRCUIT_IDS) you configured in the POST subscription request |
targetValues | filter subscriptions based on TargetValue (aka specific circuit ID values) you configured in the POST subscription request |
objects | filter subscriptions based on the objects configured in the POST subscription request (aka EVENT) |