(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

OpenADR 3.0 Definition v3.0.0.pdf

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)

Example

Sample JSON Request

JSON

curl --location 'https://openadr-vtn-stage.gridx.com/v1/subscriptions?programID=1234567890&clientName=clientA' \
--header 'Authorization: Bearer eyJraWQiOiJjMFVubE52MHdoRGUwdEY0Ujlndk1PSks4QURkZ3RuUjY0S0VENisxZDhBPSIsImFsZyI6IlJTMjU2In0.eyJzdWIiOiIyNXBmZzVpYTBqMnE2cG5qbm9tYmVpMGkzbCIsInRva2VuX3VzZSI6ImFjY2VzcyIsInNjb3BlIjoiUHJpY2luZ0VuZ2luZVwvQkwiLCJhdXRoX3RpbWUiOjE3MzM5NDA3MTcsImlzcyI6Imh0dHBzOlwvXC9jb2duaXRvLWlkcC51cy13ZXN0LTIuYW1hem9uYXdzLmNvbVwvdXMtd2VzdC0yX0NyVENlc0pYNSIsImV4cCI6MTczMzk0NDMxNywiaWF0IjoxNzMzOTQwNzE3LCJ2ZXJzaW9uIjoyLCJqdGkiOiIwNTc0YzMzYi00NjI1LTQ1NWYtYjg0Yy1hZTk5N2UyN2U2ZGEiLCJjbGllbnRfaWQiOiIyNXBmZzVpYTBqMnE2cG5qbm9tYmVpMGkzbCJ9.UhwVfOtW01uUAMWDhGA2Mq0d20gz4ScJMDkLZ-IXt_DJhh5kn5V73n4Dngq7tAqNx7AvcZII6zqP8EtRLjI5kNVb25d4Uo2NoHw53m8xP--yyeJlFOS06aKbhzjSmt-xQyBA3boFfbhO87Ku7_tDj1FzTtO9Tq1MgXS3ItaLwRZ-IVKrY_-pPQtDqZZEpXWpKlq5U-Q3XUnZbpa4gjJKv1QINoqT9ydI9GaX2ncx0DdiOg0h3v2Y4jF0Tmlsafa2HveTBtK8TqiHQPSgncp7YTY7LENPleFsAArKu_g4POETv_rNu6PwCi6QlcQpOrShLf8J05s0P5Ijwqb8OhGuKg'

Sample JSON Response

BASH

{
"objectType": "SUBSCRIPTION",   
"clientName": "clientA",        
"programID": "1234567890"       
"objectOperations": [           
    {
      "operations": [
        "POST"  
      ],
      "objects": [
        "EVENT"   
      ],
      "callbackUrl": "https://myserver.com/send/callback/here"  
      "bearerToken": "NCEJGI9E8ER9802UT9HUG"    
    }
  ],
  "targets": [        
    {
      "type": "CIRCUIT_IDS",
      "values": [
        "12345",
        "67890"
      ]
    }
  ]
}