Green Button ESPI API (1.1.0)

Download OpenAPI specification:

URL: https://www.greenbuttonalliance.org License: Apache 2.0

The Green Button Energy Services Provider Interface (ESPI) API provides RESTful access to energy usage data and retail customer information following the NAESB REQ.21 ESPI standard. This API enables Data Custodians and Third Party Applications to exchange both energy usage information and customer/billing data using Atom-formatted XML feeds.

Interactive API Explorer: Try out the API using Swagger UI

All resources are returned as Atom feeds (collections) or Atom entries (individual resources) using the application/atom+xml content type. The ESPI data elements are embedded within the Atom <content> element using either the http://naesb.org/espi XML namespace (energy data) or the http://naesb.org/espi/customer XML namespace (customer/billing data).

Note: Customer resources contain Personally Identifiable Information (PII) and use a separate namespace (http://naesb.org/espi/customer). They cannot be retrieved in the same request as energy usage data.

Green Button Alliance Developer Resources

Authentication

This API uses OAuth 2.0 for authentication and authorization. Access tokens are obtained through the standard OAuth 2.0 authorization code flow or client credentials flow. The Bearer token must be provided in the HTTP Authorization header for all API requests.

Resource Hierarchy

The ESPI data model follows this hierarchy:

Subscription > UsagePoint > MeterReading > IntervalBlock
UsagePoint > ElectricPowerQualitySummary
UsagePoint > UsageSummary
MeterReading > ReadingType (referenced)
LocalTimeParameters (standalone)

Data Custodian vs Subscription Endpoints

Resources can be accessed through two patterns:

Data Custodian endpoints (/espi/1_1/resource/{Resource}) - Used with a data_custodian_access_token for administrative access to all resources.
Subscription endpoints (/espi/1_1/resource/Subscription/{subscriptionId}/...) - Used with a customer access_token for scoped access to authorized resources.

ApplicationInformation

Operations for managing Third Party Application registration information with the Data Custodian.

Retrieve all Application Information resources [FB_33]

Returns an Atom feed containing all Application Information resources registered with the Data Custodian. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:7c9a4e82-3b57-5a01-9c4f-2d8e6b3a1f04</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ApplicationInformation" type="espi-feed/ApplicationInformation"/>
  <title>ApplicationInformation</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:af6e8b01-3c52-5d19-84a3-7f2e9d4b6c08</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ApplicationInformation/247931" type="espi-entry/ApplicationInformation"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ApplicationInformation" type="espi-feed/ApplicationInformation"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>ApplicationInformation</title>
    <content>
      <ApplicationInformation xmlns="http://naesb.org/espi">
        <dataCustodianId>DATA_CUSTODIAN_001</dataCustodianId>
        <dataCustodianApplicationStatus>3</dataCustodianApplicationStatus>
        <thirdPartyApplicationDescription>Energy analytics platform for residential customers</thirdPartyApplicationDescription>
        <thirdPartyApplicationStatus>3</thirdPartyApplicationStatus>
        <thirdPartyApplicationType>1</thirdPartyApplicationType>
        <thirdPartyApplicationUse>1</thirdPartyApplicationUse>
        <thirdPartyPhone>555-123-4567</thirdPartyPhone>
        <authorizationServerUri>https://data.greenbuttonconnect.org/DataCustodian</authorizationServerUri>
        <thirdPartyNotifyUri>https://thirdparty.example.com/espi/1_1/Notification</thirdPartyNotifyUri>
        <authorizationServerAuthorizationEndpoint>https://data.greenbuttonconnect.org/DataCustodian/oauth/authorize</authorizationServerAuthorizationEndpoint>
        <authorizationServerRegistrationEndpoint>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/register</authorizationServerRegistrationEndpoint>
        <authorizationServerTokenEndpoint>https://data.greenbuttonconnect.org/DataCustodian/oauth/token</authorizationServerTokenEndpoint>
        <dataCustodianBulkRequestURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/Bulk</dataCustodianBulkRequestURI>
        <dataCustodianResourceEndpoint>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource</dataCustodianResourceEndpoint>
        <client_secret>secret_abcdef123456</client_secret>
        <logo_uri>https://thirdparty.example.com/logo.png</logo_uri>
        <client_name>GreenEnergy Analytics</client_name>
        <client_uri>https://thirdparty.example.com</client_uri>
        <redirect_uri>https://thirdparty.example.com/espi/1_1/OAuthCallBack</redirect_uri>
        <client_id>third_party_247931</client_id>
        <tos_uri>https://thirdparty.example.com/tos</tos_uri>
        <policy_uri>https://thirdparty.example.com/privacy</policy_uri>
        <software_id>GreenEnergy_Analytics</software_id>
        <software_version>2.1.0</software_version>
        <client_id_issued_at>1697823155</client_id_issued_at>
        <client_secret_expires_at>0</client_secret_expires_at>
        <contacts>admin@thirdparty.example.com</contacts>
        <token_endpoint_auth_method>client_secret_basic</token_endpoint_auth_method>
        <scope>FB=1_3_4_5_8_13_14_15_18_19_31_32_33_34_35_37_39;IntervalDuration=900;BlockDuration=monthly;HistoryLength=13</scope>
        <grant_types>authorization_code</grant_types>
        <grant_types>client_credentials</grant_types>
        <grant_types>refresh_token</grant_types>
        <response_types>code</response_types>
        <registration_client_uri>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ApplicationInformation/247931</registration_client_uri>
        <registration_access_token>reg_token_d4e5f6a7b8c9</registration_access_token>
      </ApplicationInformation>
    </content>
  </entry>
</feed>

Retrieve an Application Information resource by its ID [FB_3]

Returns an Atom entry containing the Application Information resource identified by the given ID. Requires a valid data_custodian_access_token or registration_access_token.

Authorizations:

oauth2

path Parameters

applicationInformationId

required

string

The ID of the Application Information to be retrieved.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:af6e8b01-3c52-5d19-84a3-7f2e9d4b6c08</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ApplicationInformation/247931" type="espi-entry/ApplicationInformation"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ApplicationInformation" type="espi-feed/ApplicationInformation"/>
  <published>2023-10-20T17:32:35.448812Z</published>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <title>ApplicationInformation</title>
  <content>
    <ApplicationInformation xmlns="http://naesb.org/espi">
      <dataCustodianId>DATA_CUSTODIAN_001</dataCustodianId>
      <dataCustodianApplicationStatus>3</dataCustodianApplicationStatus>
      <thirdPartyApplicationDescription>Energy analytics platform for residential customers</thirdPartyApplicationDescription>
      <thirdPartyApplicationStatus>3</thirdPartyApplicationStatus>
      <thirdPartyApplicationType>1</thirdPartyApplicationType>
      <thirdPartyApplicationUse>1</thirdPartyApplicationUse>
      <thirdPartyPhone>555-123-4567</thirdPartyPhone>
      <authorizationServerUri>https://data.greenbuttonconnect.org/DataCustodian</authorizationServerUri>
      <thirdPartyNotifyUri>https://thirdparty.example.com/espi/1_1/Notification</thirdPartyNotifyUri>
      <authorizationServerAuthorizationEndpoint>https://data.greenbuttonconnect.org/DataCustodian/oauth/authorize</authorizationServerAuthorizationEndpoint>
      <authorizationServerRegistrationEndpoint>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/register</authorizationServerRegistrationEndpoint>
      <authorizationServerTokenEndpoint>https://data.greenbuttonconnect.org/DataCustodian/oauth/token</authorizationServerTokenEndpoint>
      <dataCustodianBulkRequestURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/Bulk</dataCustodianBulkRequestURI>
      <dataCustodianResourceEndpoint>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource</dataCustodianResourceEndpoint>
      <client_secret>secret_abcdef123456</client_secret>
      <logo_uri>https://thirdparty.example.com/logo.png</logo_uri>
      <client_name>GreenEnergy Analytics</client_name>
      <client_uri>https://thirdparty.example.com</client_uri>
      <redirect_uri>https://thirdparty.example.com/espi/1_1/OAuthCallBack</redirect_uri>
      <client_id>third_party_247931</client_id>
      <tos_uri>https://thirdparty.example.com/tos</tos_uri>
      <policy_uri>https://thirdparty.example.com/privacy</policy_uri>
      <software_id>GreenEnergy_Analytics</software_id>
      <software_version>2.1.0</software_version>
      <client_id_issued_at>1697823155</client_id_issued_at>
      <client_secret_expires_at>0</client_secret_expires_at>
      <contacts>admin@thirdparty.example.com</contacts>
      <token_endpoint_auth_method>client_secret_basic</token_endpoint_auth_method>
      <scope>FB=1_3_4_5_8_13_14_15_18_19_31_32_33_34_35_37_39;IntervalDuration=900;BlockDuration=monthly;HistoryLength=13</scope>
      <grant_types>authorization_code</grant_types>
      <grant_types>client_credentials</grant_types>
      <grant_types>refresh_token</grant_types>
      <response_types>code</response_types>
      <registration_client_uri>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ApplicationInformation/247931</registration_client_uri>
      <registration_access_token>reg_token_d4e5f6a7b8c9</registration_access_token>
    </ApplicationInformation>
  </content>
</entry>

Authorization

Operations for managing OAuth 2.0 authorizations that grant Third Party Applications access to energy usage data.

Retrieve all Authorizations [FB_3]

Returns an Atom feed containing all Authorization resources. Requires a valid data_custodian_access_token or client_access_token.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:9d4a2e71-6b83-5f02-a1c5-3e7f8d9a0b12</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization" type="espi-feed/Authorization"/>
  <title>Authorization</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:b3c7d1e5-4a98-5f26-8b03-1d5e7f9a2c46</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization/407593" type="espi-entry/Authorization"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization" type="espi-feed/Authorization"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>Authorization</title>
    <content>
      <Authorization xmlns="http://naesb.org/espi">
        <authorizedPeriod>
          <duration>31536000</duration>
          <start>1697823155</start>
        </authorizedPeriod>
        <publishedPeriod>
          <duration>31536000</duration>
          <start>1697823155</start>
        </publishedPeriod>
        <status>1</status>
        <expires_at>1729359155</expires_at>
        <grant_type>authorization_code</grant_type>
        <scope>FB=1_3_4_5_8_13_14_15_18_19_31_32_33_34_35_37_39;IntervalDuration=900;BlockDuration=monthly;HistoryLength=13</scope>
        <token_type>Bearer</token_type>
        <resourceURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593</resourceURI>
        <authorizationURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization/407593</authorizationURI>
        <customerResourceURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/RetailCustomer/618934/UsagePoint</customerResourceURI>
      </Authorization>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:e8f2a6d4-5c17-5b39-9e04-8a3d6f1c7e52</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization/407594" type="espi-entry/Authorization"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization" type="espi-feed/Authorization"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>Authorization</title>
    <content>
      <Authorization xmlns="http://naesb.org/espi">
        <authorizedPeriod>
          <duration>31536000</duration>
          <start>1697823155</start>
        </authorizedPeriod>
        <publishedPeriod>
          <duration>31536000</duration>
          <start>1697823155</start>
        </publishedPeriod>
        <status>0</status>
        <expires_at>1729359155</expires_at>
        <grant_type>authorization_code</grant_type>
        <scope>FB=1_3_4_5_8_13_14_15_18_19_31_32_33_34_35_37_39;IntervalDuration=3600;BlockDuration=daily;HistoryLength=13</scope>
        <token_type>Bearer</token_type>
        <resourceURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407594</resourceURI>
        <authorizationURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization/407594</authorizationURI>
        <customerResourceURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/RetailCustomer/618935/UsagePoint</customerResourceURI>
      </Authorization>
    </content>
  </entry>
</feed>

Retrieve an Authorization by its ID [FB_3]

Returns an Atom entry containing the Authorization resource identified by the given ID. Requires a valid data_custodian_access_token or client_access_token.

Authorizations:

oauth2

path Parameters

authorizationId

required

string

ID of the Authorization to be retrieved.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:b3c7d1e5-4a98-5f26-8b03-1d5e7f9a2c46</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization/407593" type="espi-entry/Authorization"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization" type="espi-feed/Authorization"/>
  <published>2023-10-20T17:32:35.448812Z</published>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <title>Authorization</title>
  <content>
    <Authorization xmlns="http://naesb.org/espi">
      <authorizedPeriod>
        <duration>31536000</duration>
        <start>1697823155</start>
      </authorizedPeriod>
      <publishedPeriod>
        <duration>31536000</duration>
        <start>1697823155</start>
      </publishedPeriod>
      <status>1</status>
      <expires_at>1729359155</expires_at>
      <grant_type>authorization_code</grant_type>
      <scope>FB=1_3_4_5_8_13_14_15_18_19_31_32_33_34_35_37_39;IntervalDuration=900;BlockDuration=monthly;HistoryLength=13</scope>
      <token_type>Bearer</token_type>
      <resourceURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593</resourceURI>
      <authorizationURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Authorization/407593</authorizationURI>
      <customerResourceURI>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/RetailCustomer/618934/UsagePoint</customerResourceURI>
    </Authorization>
  </content>
</entry>

Batch

Batch operations for bulk data transfer, subscription feeds, and Green Button Download My Data / Connect My Data flows.

Request a Bulk transfer from a DataCustodian [FB_35]

Initiates a bulk data transfer. Returns an Atom feed containing all resources associated with the specified Bulk ID. Requires a valid data_custodian_access_token or client_access_token.

Authorizations:

oauth2

path Parameters

bulkId

required

string

The Bulk ID as specified in the OAuth2 SCOPE string.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

Example

A complete Subscription feed with UsagePoint, LocalTimeParameters, MeterReading, ReadingType, and IntervalBlock entries

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:abf12767-5352-5615-b41a-fef23ba42bad</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/Subscription/407593" type="espi-feed/Subscription"/>
  <link rel="related" href="https://cert.greenbuttonalliance.org/certificate/26b96996-d393-5e95-b78d-9419f3080469" type="text/html"/>
  <title>Subscription</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:e6896122-a094-5d30-be14-e44544247e14</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>UsagePoint</title>
    <content>
      <UsagePoint xmlns="http://naesb.org/espi">
        <ServiceCategory>
          <kind>0</kind>
        </ServiceCategory>
      </UsagePoint>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:305129b8-503c-5b50-b293-333cd7fb6adf</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters" type="espi-feed/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>LocalTimeParameters</title>
    <content>
      <LocalTimeParameters xmlns="http://naesb.org/espi">
        <dstEndRule>B40E2000</dstEndRule>
        <dstOffset>3600</dstOffset>
        <dstStartRule>360E2000</dstStartRule>
        <tzOffset>-18000</tzOffset>
      </LocalTimeParameters>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:6052217b-aadf-5cca-b803-c611f9fcf89e</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-entry/MeterReading"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>MeterReading</title>
    <content>
      <MeterReading xmlns="http://naesb.org/espi"/>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:06ff0942-04fc-5f91-bc35-ca5e51b49dbb</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType" type="espi-feed/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>ReadingType</title>
    <content>
      <ReadingType xmlns="http://naesb.org/espi">
        <accumulationBehaviour>1</accumulationBehaviour>
        <commodity>1</commodity>
        <currency>840</currency>
        <flowDirection>1</flowDirection>
        <intervalLength>2332800</intervalLength>
        <kind>12</kind>
        <phase>0</phase>
        <powerOfTenMultiplier>-3</powerOfTenMultiplier>
        <uom>72</uom>
      </ReadingType>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:1e530409-5dbe-572f-aad8-fa06f6a68cfc</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-feed/MeterReading"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>IntervalBlock</title>
    <content>
      <IntervalBlock xmlns="http://naesb.org/espi">
        <interval>
          <duration>2332800</duration>
          <start>1663992000</start>
        </interval>
        <IntervalReading>
          <cost>115780000</cost>
          <timePeriod>
            <duration>2332800</duration>
            <start>1663992000</start>
          </timePeriod>
          <value>1330890000</value>
        </IntervalReading>
      </IntervalBlock>
    </content>
  </entry>
</feed>

Request a Green Button Subscription from a DataCustodian [FB_3]

Returns an Atom feed containing all resources associated with the specified Subscription. This is the Connect My Data feed endpoint. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId

required

string

The Subscription's ID.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

Example

A complete Subscription feed with UsagePoint, LocalTimeParameters, MeterReading, ReadingType, and IntervalBlock entries

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:abf12767-5352-5615-b41a-fef23ba42bad</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/Subscription/407593" type="espi-feed/Subscription"/>
  <link rel="related" href="https://cert.greenbuttonalliance.org/certificate/26b96996-d393-5e95-b78d-9419f3080469" type="text/html"/>
  <title>Subscription</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:e6896122-a094-5d30-be14-e44544247e14</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>UsagePoint</title>
    <content>
      <UsagePoint xmlns="http://naesb.org/espi">
        <ServiceCategory>
          <kind>0</kind>
        </ServiceCategory>
      </UsagePoint>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:305129b8-503c-5b50-b293-333cd7fb6adf</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters" type="espi-feed/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>LocalTimeParameters</title>
    <content>
      <LocalTimeParameters xmlns="http://naesb.org/espi">
        <dstEndRule>B40E2000</dstEndRule>
        <dstOffset>3600</dstOffset>
        <dstStartRule>360E2000</dstStartRule>
        <tzOffset>-18000</tzOffset>
      </LocalTimeParameters>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:6052217b-aadf-5cca-b803-c611f9fcf89e</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-entry/MeterReading"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>MeterReading</title>
    <content>
      <MeterReading xmlns="http://naesb.org/espi"/>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:06ff0942-04fc-5f91-bc35-ca5e51b49dbb</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType" type="espi-feed/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>ReadingType</title>
    <content>
      <ReadingType xmlns="http://naesb.org/espi">
        <accumulationBehaviour>1</accumulationBehaviour>
        <commodity>1</commodity>
        <currency>840</currency>
        <flowDirection>1</flowDirection>
        <intervalLength>2332800</intervalLength>
        <kind>12</kind>
        <phase>0</phase>
        <powerOfTenMultiplier>-3</powerOfTenMultiplier>
        <uom>72</uom>
      </ReadingType>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:1e530409-5dbe-572f-aad8-fa06f6a68cfc</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-feed/MeterReading"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>IntervalBlock</title>
    <content>
      <IntervalBlock xmlns="http://naesb.org/espi">
        <interval>
          <duration>2332800</duration>
          <start>1663992000</start>
        </interval>
        <IntervalReading>
          <cost>115780000</cost>
          <timePeriod>
            <duration>2332800</duration>
            <start>1663992000</start>
          </timePeriod>
          <value>1330890000</value>
        </IntervalReading>
      </IntervalBlock>
    </content>
  </entry>
</feed>

Download a Green Button XML file for a RetailCustomer [FB_33]

Downloads a Green Button XML file containing UsagePoint data for the specified Retail Customer. This is the Download My Data endpoint. Requires a valid data_custodian_access_token or upload_access_token.

Authorizations:

oauth2

path Parameters

retailCustomerId

required

string

The Retail Customer's ID.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

Example

A complete Subscription feed with UsagePoint, LocalTimeParameters, MeterReading, ReadingType, and IntervalBlock entries

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:abf12767-5352-5615-b41a-fef23ba42bad</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/Subscription/407593" type="espi-feed/Subscription"/>
  <link rel="related" href="https://cert.greenbuttonalliance.org/certificate/26b96996-d393-5e95-b78d-9419f3080469" type="text/html"/>
  <title>Subscription</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:e6896122-a094-5d30-be14-e44544247e14</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>UsagePoint</title>
    <content>
      <UsagePoint xmlns="http://naesb.org/espi">
        <ServiceCategory>
          <kind>0</kind>
        </ServiceCategory>
      </UsagePoint>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:305129b8-503c-5b50-b293-333cd7fb6adf</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters" type="espi-feed/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>LocalTimeParameters</title>
    <content>
      <LocalTimeParameters xmlns="http://naesb.org/espi">
        <dstEndRule>B40E2000</dstEndRule>
        <dstOffset>3600</dstOffset>
        <dstStartRule>360E2000</dstStartRule>
        <tzOffset>-18000</tzOffset>
      </LocalTimeParameters>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:6052217b-aadf-5cca-b803-c611f9fcf89e</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-entry/MeterReading"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>MeterReading</title>
    <content>
      <MeterReading xmlns="http://naesb.org/espi"/>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:06ff0942-04fc-5f91-bc35-ca5e51b49dbb</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType" type="espi-feed/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>ReadingType</title>
    <content>
      <ReadingType xmlns="http://naesb.org/espi">
        <accumulationBehaviour>1</accumulationBehaviour>
        <commodity>1</commodity>
        <currency>840</currency>
        <flowDirection>1</flowDirection>
        <intervalLength>2332800</intervalLength>
        <kind>12</kind>
        <phase>0</phase>
        <powerOfTenMultiplier>-3</powerOfTenMultiplier>
        <uom>72</uom>
      </ReadingType>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:1e530409-5dbe-572f-aad8-fa06f6a68cfc</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-feed/MeterReading"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>IntervalBlock</title>
    <content>
      <IntervalBlock xmlns="http://naesb.org/espi">
        <interval>
          <duration>2332800</duration>
          <start>1663992000</start>
        </interval>
        <IntervalReading>
          <cost>115780000</cost>
          <timePeriod>
            <duration>2332800</duration>
            <start>1663992000</start>
          </timePeriod>
          <value>1330890000</value>
        </IntervalReading>
      </IntervalBlock>
    </content>
  </entry>
</feed>

Request a Green Button Subscription for a specific UsagePoint [FB_32]

Returns an Atom feed containing all resources associated with the specified Subscription and UsagePoint. This is the Connect My Data feed endpoint scoped to a specific UsagePoint. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string The Subscription's ID.
usagePointId required	string The UsagePoint's ID.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

Example

A complete Subscription feed with UsagePoint, LocalTimeParameters, MeterReading, ReadingType, and IntervalBlock entries

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:abf12767-5352-5615-b41a-fef23ba42bad</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Batch/Subscription/407593" type="espi-feed/Subscription"/>
  <link rel="related" href="https://cert.greenbuttonalliance.org/certificate/26b96996-d393-5e95-b78d-9419f3080469" type="text/html"/>
  <title>Subscription</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:e6896122-a094-5d30-be14-e44544247e14</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>UsagePoint</title>
    <content>
      <UsagePoint xmlns="http://naesb.org/espi">
        <ServiceCategory>
          <kind>0</kind>
        </ServiceCategory>
      </UsagePoint>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:305129b8-503c-5b50-b293-333cd7fb6adf</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters" type="espi-feed/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>LocalTimeParameters</title>
    <content>
      <LocalTimeParameters xmlns="http://naesb.org/espi">
        <dstEndRule>B40E2000</dstEndRule>
        <dstOffset>3600</dstOffset>
        <dstStartRule>360E2000</dstStartRule>
        <tzOffset>-18000</tzOffset>
      </LocalTimeParameters>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:6052217b-aadf-5cca-b803-c611f9fcf89e</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-entry/MeterReading"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>MeterReading</title>
    <content>
      <MeterReading xmlns="http://naesb.org/espi"/>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:06ff0942-04fc-5f91-bc35-ca5e51b49dbb</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType" type="espi-feed/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>ReadingType</title>
    <content>
      <ReadingType xmlns="http://naesb.org/espi">
        <accumulationBehaviour>1</accumulationBehaviour>
        <commodity>1</commodity>
        <currency>840</currency>
        <flowDirection>1</flowDirection>
        <intervalLength>2332800</intervalLength>
        <kind>12</kind>
        <phase>0</phase>
        <powerOfTenMultiplier>-3</powerOfTenMultiplier>
        <uom>72</uom>
      </ReadingType>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:1e530409-5dbe-572f-aad8-fa06f6a68cfc</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-feed/MeterReading"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>IntervalBlock</title>
    <content>
      <IntervalBlock xmlns="http://naesb.org/espi">
        <interval>
          <duration>2332800</duration>
          <start>1663992000</start>
        </interval>
        <IntervalReading>
          <cost>115780000</cost>
          <timePeriod>
            <duration>2332800</duration>
            <start>1663992000</start>
          </timePeriod>
          <value>1330890000</value>
        </IntervalReading>
      </IntervalBlock>
    </content>
  </entry>
</feed>

UsagePoint

Operations for accessing Usage Points, which represent logical points on the network where energy consumption or production is measured.

Retrieve all Usage Points [FB_33]

Returns an Atom feed containing all Usage Points within the Data Custodian. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:abf12767-5352-5615-b41a-fef23ba42bad</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
  <title>UsagePoint</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:e6896122-a094-5d30-be14-e44544247e14</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>UsagePoint</title>
    <content>
      <UsagePoint xmlns="http://naesb.org/espi">
        <ServiceCategory>
          <kind>0</kind>
        </ServiceCategory>
      </UsagePoint>
    </content>
  </entry>
</feed>

Retrieve a Usage Point by its ID [FB_32]

Returns an Atom entry containing the Usage Point identified by the given ID. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

usagePointId

required

string

ID of the Usage Point.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:e6896122-a094-5d30-be14-e44544247e14</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
  <published>2023-10-20T17:32:35.448812Z</published>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <title>UsagePoint</title>
  <content>
    <UsagePoint xmlns="http://naesb.org/espi">
      <ServiceCategory>
        <kind>0</kind>
      </ServiceCategory>
    </UsagePoint>
  </content>
</entry>

Retrieve all Usage Points by Subscription ID [FB_32]

Returns an Atom feed containing all Usage Points associated with the specified Subscription. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId

required

string

The Subscription's ID.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:abf12767-5352-5615-b41a-fef23ba42bad</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
  <title>UsagePoint</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:e6896122-a094-5d30-be14-e44544247e14</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>UsagePoint</title>
    <content>
      <UsagePoint xmlns="http://naesb.org/espi">
        <ServiceCategory>
          <kind>0</kind>
        </ServiceCategory>
      </UsagePoint>
    </content>
  </entry>
</feed>

Retrieve a Subscription Usage Point by its ID [FB_32]

Returns an Atom entry containing the Usage Point identified by the given ID within the specified Subscription. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string The Subscription's ID.
usagePointId required	string ID of the Usage Point.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:e6896122-a094-5d30-be14-e44544247e14</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint" type="espi-feed/UsagePoint"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
  <published>2023-10-20T17:32:35.448812Z</published>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <title>UsagePoint</title>
  <content>
    <UsagePoint xmlns="http://naesb.org/espi">
      <ServiceCategory>
        <kind>0</kind>
      </ServiceCategory>
    </UsagePoint>
  </content>
</entry>

MeterReading

Operations for accessing Meter Readings, which represent sets of values obtained from a meter.

Retrieve all Meter Readings within the Data Custodian [FB_33]

Returns an Atom feed containing all Meter Readings. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:2e4f6a8c-0b1d-5e3f-5a7b-9c0d1e2f3a4b</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
  <title>MeterReading</title>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <entry>
    <id>urn:uuid:6052217b-aadf-5cca-b803-c611f9fcf89e</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-entry/MeterReading"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>MeterReading</title>
    <content>
      <MeterReading xmlns="http://naesb.org/espi"/>
    </content>
  </entry>
</feed>

Retrieve a Meter Reading by its ID [FB_33]

Returns an Atom entry containing the Meter Reading identified by the given ID. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

meterReadingId

required

string

ID of the Meter Reading.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:6052217b-aadf-5cca-b803-c611f9fcf89e</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-entry/MeterReading"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
  <published>2023-10-20T17:32:44.801089Z</published>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <title>MeterReading</title>
  <content>
    <MeterReading xmlns="http://naesb.org/espi"/>
  </content>
</entry>

Retrieve all Meter Readings for a Usage Point [FB_32]

Returns an Atom feed containing all Meter Readings associated with the specified Usage Point within the Subscription. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string ID of the Subscription.
usagePointId required	string ID of the UsagePoint the Meter Reading references.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:2e4f6a8c-0b1d-5e3f-5a7b-9c0d1e2f3a4b</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
  <title>MeterReading</title>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <entry>
    <id>urn:uuid:6052217b-aadf-5cca-b803-c611f9fcf89e</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-entry/MeterReading"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>MeterReading</title>
    <content>
      <MeterReading xmlns="http://naesb.org/espi"/>
    </content>
  </entry>
</feed>

Retrieve a Meter Reading by its ID within a Subscription [FB_32]

Returns an Atom entry containing the Meter Reading identified by the given ID, within the specified Subscription and Usage Point. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string ID of the Subscription.
usagePointId required	string ID of the UsagePoint the Meter Reading references.
meterReadingId required	string ID of the Meter Reading.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:6052217b-aadf-5cca-b803-c611f9fcf89e</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-entry/MeterReading"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading" type="espi-feed/MeterReading"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
  <published>2023-10-20T17:32:44.801089Z</published>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <title>MeterReading</title>
  <content>
    <MeterReading xmlns="http://naesb.org/espi"/>
  </content>
</entry>

IntervalBlock

Operations for accessing Interval Blocks, which contain time sequences of interval readings for a specific ReadingType.

Retrieve all Interval Blocks [FB_33]

Returns an Atom feed containing all Interval Blocks within the Data Custodian. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:abf12767-5352-5615-b41a-fef23ba42bad</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
  <title>IntervalBlock</title>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <entry>
    <id>urn:uuid:1e530409-5dbe-572f-aad8-fa06f6a68cfc</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-feed/MeterReading"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>IntervalBlock</title>
    <content>
      <IntervalBlock xmlns="http://naesb.org/espi">
        <interval>
          <duration>2332800</duration>
          <start>1663992000</start>
        </interval>
        <IntervalReading>
          <cost>115780000</cost>
          <timePeriod>
            <duration>2332800</duration>
            <start>1663992000</start>
          </timePeriod>
          <value>1330890000</value>
        </IntervalReading>
      </IntervalBlock>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:0de5026c-9497-5712-99b0-9790101aee1b</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020674_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020674_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020674_kwh_1" type="espi-feed/MeterReading"/>
    <published>2023-10-20T17:32:44.814423Z</published>
    <updated>2023-10-20T17:32:44.814423Z</updated>
    <title>IntervalBlock</title>
    <content>
      <IntervalBlock xmlns="http://naesb.org/espi">
        <interval>
          <duration>2768400</duration>
          <start>1666411200</start>
        </interval>
        <IntervalReading>
          <cost>107994000</cost>
          <timePeriod>
            <duration>2768400</duration>
            <start>1666411200</start>
          </timePeriod>
          <value>1673810000</value>
        </IntervalReading>
      </IntervalBlock>
    </content>
  </entry>
</feed>

Retrieve an Interval Block by its ID [FB_33]

Returns an Atom entry containing the Interval Block identified by the given ID. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

intervalBlockId

required

string

ID of the Interval Block to be retrieved.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:1e530409-5dbe-572f-aad8-fa06f6a68cfc</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-feed/MeterReading"/>
  <published>2023-10-20T17:32:44.801089Z</published>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <title>IntervalBlock</title>
  <content>
    <IntervalBlock xmlns="http://naesb.org/espi">
      <interval>
        <duration>2332800</duration>
        <start>1663992000</start>
      </interval>
      <IntervalReading>
        <cost>115780000</cost>
        <timePeriod>
          <duration>2332800</duration>
          <start>1663992000</start>
        </timePeriod>
        <value>1330890000</value>
      </IntervalReading>
    </IntervalBlock>
  </content>
</entry>

Retrieve all Interval Blocks for a Meter Reading [FB_32]

Returns an Atom feed containing all Interval Blocks associated with the specified Meter Reading within the Subscription. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string ID of the Subscription.
usagePointId required	string ID of the UsagePoint the Interval Block references.
meterReadingId required	string ID of the MeterReading the Interval Block references.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:abf12767-5352-5615-b41a-fef23ba42bad</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
  <title>IntervalBlock</title>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <entry>
    <id>urn:uuid:1e530409-5dbe-572f-aad8-fa06f6a68cfc</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-feed/MeterReading"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>IntervalBlock</title>
    <content>
      <IntervalBlock xmlns="http://naesb.org/espi">
        <interval>
          <duration>2332800</duration>
          <start>1663992000</start>
        </interval>
        <IntervalReading>
          <cost>115780000</cost>
          <timePeriod>
            <duration>2332800</duration>
            <start>1663992000</start>
          </timePeriod>
          <value>1330890000</value>
        </IntervalReading>
      </IntervalBlock>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:0de5026c-9497-5712-99b0-9790101aee1b</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020674_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020674_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020674_kwh_1" type="espi-feed/MeterReading"/>
    <published>2023-10-20T17:32:44.814423Z</published>
    <updated>2023-10-20T17:32:44.814423Z</updated>
    <title>IntervalBlock</title>
    <content>
      <IntervalBlock xmlns="http://naesb.org/espi">
        <interval>
          <duration>2768400</duration>
          <start>1666411200</start>
        </interval>
        <IntervalReading>
          <cost>107994000</cost>
          <timePeriod>
            <duration>2768400</duration>
            <start>1666411200</start>
          </timePeriod>
          <value>1673810000</value>
        </IntervalReading>
      </IntervalBlock>
    </content>
  </entry>
</feed>

Retrieve an Interval Block by its ID within a Subscription [FB_32]

Returns an Atom entry containing the Interval Block identified by the given ID, within the specified Subscription, Usage Point, and Meter Reading hierarchy. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string ID of the Subscription.
usagePointId required	string ID of the UsagePoint the Interval Block references.
meterReadingId required	string ID of the MeterReading the Interval Block references.
intervalBlockId required	string ID of the Interval Block to be retrieved.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:1e530409-5dbe-572f-aad8-fa06f6a68cfc</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock/000001" type="espi-entry/IntervalBlock"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1/IntervalBlock" type="espi-feed/IntervalBlock"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/MeterReading/Ba020673_kwh_1" type="espi-feed/MeterReading"/>
  <published>2023-10-20T17:32:44.801089Z</published>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <title>IntervalBlock</title>
  <content>
    <IntervalBlock xmlns="http://naesb.org/espi">
      <interval>
        <duration>2332800</duration>
        <start>1663992000</start>
      </interval>
      <IntervalReading>
        <cost>115780000</cost>
        <timePeriod>
          <duration>2332800</duration>
          <start>1663992000</start>
        </timePeriod>
        <value>1330890000</value>
      </IntervalReading>
    </IntervalBlock>
  </content>
</entry>

ReadingType

Operations for accessing Reading Types, which describe the characteristics of meter readings.

Retrieve all Reading Types [FB_32]

Returns an Atom feed containing all Reading Types. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:3f5a7b9c-1d2e-5f40-6b8c-0d1e2f3a4b5c</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType" type="espi-feed/ReadingType"/>
  <title>ReadingType</title>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <entry>
    <id>urn:uuid:06ff0942-04fc-5f91-bc35-ca5e51b49dbb</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType" type="espi-feed/ReadingType"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>ReadingType</title>
    <content>
      <ReadingType xmlns="http://naesb.org/espi">
        <accumulationBehaviour>1</accumulationBehaviour>
        <commodity>1</commodity>
        <currency>840</currency>
        <flowDirection>1</flowDirection>
        <intervalLength>2332800</intervalLength>
        <kind>12</kind>
        <phase>0</phase>
        <powerOfTenMultiplier>-3</powerOfTenMultiplier>
        <uom>72</uom>
      </ReadingType>
    </content>
  </entry>
</feed>

Retrieve a Reading Type by its ID [FB_32]

Returns an Atom entry containing the Reading Type identified by the given ID. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

readingTypeId

required

string

ID of the Reading Type.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:06ff0942-04fc-5f91-bc35-ca5e51b49dbb</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType/407593_1455246_Ba020673_kwh_1" type="espi-entry/ReadingType"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/ReadingType" type="espi-feed/ReadingType"/>
  <published>2023-10-20T17:32:44.801089Z</published>
  <updated>2023-10-20T17:32:44.801089Z</updated>
  <title>ReadingType</title>
  <content>
    <ReadingType xmlns="http://naesb.org/espi">
      <accumulationBehaviour>1</accumulationBehaviour>
      <commodity>1</commodity>
      <currency>840</currency>
      <flowDirection>1</flowDirection>
      <intervalLength>2332800</intervalLength>
      <kind>12</kind>
      <phase>0</phase>
      <powerOfTenMultiplier>-3</powerOfTenMultiplier>
      <uom>72</uom>
    </ReadingType>
  </content>
</entry>

ElectricPowerQualitySummary

Operations for accessing Electric Power Quality Summaries, which provide power quality event information.

Retrieve all Electric Power Quality Summaries [FB_32]

Returns an Atom feed containing all Electric Power Quality Summaries associated with the specified Usage Point within the Subscription. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string The Subscription's ID.
usagePointId required	string ID of the UsagePoint the Electric Power Quality Summary references.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:a1b2c3d4-5e6f-5708-9a1b-2c3d4e5f6a7b</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
  <title>ElectricPowerQualitySummary</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:d4e5f6a7-b8c9-5d01-e2f3-a4b5c6d7e8f9</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary/328475" type="espi-entry/ElectricPowerQualitySummary"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>ElectricPowerQualitySummary</title>
    <content>
      <ElectricPowerQualitySummary xmlns="http://naesb.org/espi">
        <flickerPlt>1</flickerPlt>
        <flickerPst>2</flickerPst>
        <harmonicVoltage>3</harmonicVoltage>
        <longInterruptions>0</longInterruptions>
        <mainsVoltage>240100</mainsVoltage>
        <measurementProtocol>2</measurementProtocol>
        <powerFrequency>600</powerFrequency>
        <rapidVoltageChanges>0</rapidVoltageChanges>
        <shortInterruptions>2</shortInterruptions>
        <summaryInterval>
          <duration>2592000</duration>
          <start>1693540800</start>
        </summaryInterval>
        <supplyVoltageDips>1</supplyVoltageDips>
        <supplyVoltageImbalance>0</supplyVoltageImbalance>
        <supplyVoltageVariations>3</supplyVoltageVariations>
        <tempOvervoltage>0</tempOvervoltage>
      </ElectricPowerQualitySummary>
    </content>
  </entry>
</feed>

Retrieve an Electric Power Quality Summary by its ID [FB_32]

Returns an Atom entry containing the Electric Power Quality Summary identified by the given ID. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string The Subscription's ID.
usagePointId required	string ID of the Usage Point the Electric Power Quality Summary references.
electricPowerQualitySummaryId required	string ID of the Electric Power Quality Summary to be retrieved.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:d4e5f6a7-b8c9-5d01-e2f3-a4b5c6d7e8f9</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary/328475" type="espi-entry/ElectricPowerQualitySummary"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/ElectricPowerQualitySummary" type="espi-feed/ElectricPowerQualitySummary"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
  <published>2023-10-20T17:32:35.448812Z</published>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <title>ElectricPowerQualitySummary</title>
  <content>
    <ElectricPowerQualitySummary xmlns="http://naesb.org/espi">
      <flickerPlt>1</flickerPlt>
      <flickerPst>2</flickerPst>
      <harmonicVoltage>3</harmonicVoltage>
      <longInterruptions>0</longInterruptions>
      <mainsVoltage>240100</mainsVoltage>
      <measurementProtocol>2</measurementProtocol>
      <powerFrequency>600</powerFrequency>
      <rapidVoltageChanges>0</rapidVoltageChanges>
      <shortInterruptions>2</shortInterruptions>
      <summaryInterval>
        <duration>2592000</duration>
        <start>1693540800</start>
      </summaryInterval>
      <supplyVoltageDips>1</supplyVoltageDips>
      <supplyVoltageImbalance>0</supplyVoltageImbalance>
      <supplyVoltageVariations>3</supplyVoltageVariations>
      <tempOvervoltage>0</tempOvervoltage>
    </ElectricPowerQualitySummary>
  </content>
</entry>

UsageSummary

Operations for accessing Usage Summaries, which provide aggregated usage and billing information for specific time periods.

Retrieve all Usage Summaries [FB_32]

Returns an Atom feed containing all Usage Summaries associated with the specified Usage Point within the Subscription. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string The Subscription's ID.
usagePointId required	string ID of the UsagePoint the Usage Summary references.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:c2d3e4f5-6a7b-5809-1c2d-3e4f5a6b7c8d</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
  <title>UsageSummary</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:f1e2d3c4-b5a6-5978-8190-a2b3c4d5e6f7</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary/539217" type="espi-entry/UsageSummary"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>UsageSummary</title>
    <content>
      <UsageSummary xmlns="http://naesb.org/espi">
        <billingPeriod>
          <duration>2592000</duration>
          <start>1693540800</start>
        </billingPeriod>
        <billLastPeriod>11578000</billLastPeriod>
        <billToDate>8934000</billToDate>
        <costAdditionalLastPeriod>150000</costAdditionalLastPeriod>
        <currency>840</currency>
        <overallConsumptionLastPeriod>
          <powerOfTenMultiplier>-3</powerOfTenMultiplier>
          <uom>72</uom>
          <value>1330890000</value>
        </overallConsumptionLastPeriod>
        <currentBillingPeriodOverAllConsumption>
          <powerOfTenMultiplier>-3</powerOfTenMultiplier>
          <timeStamp>1696132800</timeStamp>
          <uom>72</uom>
          <value>987654000</value>
        </currentBillingPeriodOverAllConsumption>
        <qualityOfReading>14</qualityOfReading>
        <statusTimeStamp>1697823203</statusTimeStamp>
        <commodity>1</commodity>
        <tariffProfile>Standard Residential</tariffProfile>
        <readCycle>15</readCycle>
      </UsageSummary>
    </content>
  </entry>
  <entry>
    <id>urn:uuid:a8b9c0d1-e2f3-5a45-6b7c-8d9e0f1a2b3c</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary/539218" type="espi-entry/UsageSummary"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
    <published>2023-10-20T17:32:44.801089Z</published>
    <updated>2023-10-20T17:32:44.801089Z</updated>
    <title>UsageSummary</title>
    <content>
      <UsageSummary xmlns="http://naesb.org/espi">
        <billingPeriod>
          <duration>2678400</duration>
          <start>1696132800</start>
        </billingPeriod>
        <billLastPeriod>8934000</billLastPeriod>
        <billToDate>10245000</billToDate>
        <costAdditionalLastPeriod>125000</costAdditionalLastPeriod>
        <currency>840</currency>
        <overallConsumptionLastPeriod>
          <powerOfTenMultiplier>-3</powerOfTenMultiplier>
          <uom>72</uom>
          <value>987654000</value>
        </overallConsumptionLastPeriod>
        <currentBillingPeriodOverAllConsumption>
          <powerOfTenMultiplier>-3</powerOfTenMultiplier>
          <timeStamp>1698811200</timeStamp>
          <uom>72</uom>
          <value>1102345000</value>
        </currentBillingPeriodOverAllConsumption>
        <qualityOfReading>14</qualityOfReading>
        <statusTimeStamp>1697823203</statusTimeStamp>
        <commodity>1</commodity>
        <tariffProfile>Standard Residential</tariffProfile>
        <readCycle>15</readCycle>
      </UsageSummary>
    </content>
  </entry>
</feed>

Retrieve a Usage Summary by its ID [FB_32]

Returns an Atom entry containing the Usage Summary identified by the given ID. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

subscriptionId required	string The Subscription's ID.
usagePointId required	string ID of the UsagePoint the Usage Summary references.
usageSummaryId required	string ID of the Usage Summary to be retrieved.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:f1e2d3c4-b5a6-5978-8190-a2b3c4d5e6f7</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary/539217" type="espi-entry/UsageSummary"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246/UsageSummary" type="espi-feed/UsageSummary"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407593/UsagePoint/1455246" type="espi-entry/UsagePoint"/>
  <published>2023-10-20T17:32:35.448812Z</published>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <title>UsageSummary</title>
  <content>
    <UsageSummary xmlns="http://naesb.org/espi">
      <billingPeriod>
        <duration>2592000</duration>
        <start>1693540800</start>
      </billingPeriod>
      <billLastPeriod>11578000</billLastPeriod>
      <billToDate>8934000</billToDate>
      <costAdditionalLastPeriod>150000</costAdditionalLastPeriod>
      <currency>840</currency>
      <overallConsumptionLastPeriod>
        <powerOfTenMultiplier>-3</powerOfTenMultiplier>
        <uom>72</uom>
        <value>1330890000</value>
      </overallConsumptionLastPeriod>
      <currentBillingPeriodOverAllConsumption>
        <powerOfTenMultiplier>-3</powerOfTenMultiplier>
        <timeStamp>1696132800</timeStamp>
        <uom>72</uom>
        <value>987654000</value>
      </currentBillingPeriodOverAllConsumption>
      <qualityOfReading>14</qualityOfReading>
      <statusTimeStamp>1697823203</statusTimeStamp>
      <commodity>1</commodity>
      <tariffProfile>Standard Residential</tariffProfile>
      <readCycle>15</readCycle>
    </UsageSummary>
  </content>
</entry>

LocalTimeParameters

Operations for accessing Local Time Parameters, which describe timezone and daylight savings time configuration.

Retrieve all Local Time Parameters [FB_32]

Returns an Atom feed containing all Local Time Parameters. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:4a6b8c0d-2e3f-5a51-7b9c-1d2e3f4a5b6c</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters" type="espi-feed/LocalTimeParameters"/>
  <title>LocalTimeParameters</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:305129b8-503c-5b50-b293-333cd7fb6adf</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters" type="espi-feed/LocalTimeParameters"/>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <title>LocalTimeParameters</title>
    <content>
      <LocalTimeParameters xmlns="http://naesb.org/espi">
        <dstEndRule>B40E2000</dstEndRule>
        <dstOffset>3600</dstOffset>
        <dstStartRule>360E2000</dstStartRule>
        <tzOffset>-18000</tzOffset>
      </LocalTimeParameters>
    </content>
  </entry>
</feed>

Retrieve a Local Time Parameter by its ID [FB_32]

Returns an Atom entry containing the Local Time Parameter identified by the given ID. Requires a valid data_custodian_access_token or access_token.

Authorizations:

oauth2

path Parameters

localTimeParameterId

required

string

ID of the Local Time Parameter.

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:305129b8-503c-5b50-b293-333cd7fb6adf</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407593_1455246" type="espi-entry/LocalTimeParameters"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters" type="espi-feed/LocalTimeParameters"/>
  <published>2023-10-20T17:32:35.448812Z</published>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <title>LocalTimeParameters</title>
  <content>
    <LocalTimeParameters xmlns="http://naesb.org/espi">
      <dstEndRule>B40E2000</dstEndRule>
      <dstOffset>3600</dstOffset>
      <dstStartRule>360E2000</dstStartRule>
      <tzOffset>-18000</tzOffset>
    </LocalTimeParameters>
  </content>
</entry>

ServiceStatus

Operations for checking the current status of the Data Custodian Resource Server.

Obtain the Data Custodian Resource Server's Status [FB_3]

Returns the current status of the Data Custodian Resource Server. Requires a valid data_custodian_access_token, client_access_token, or upload_access_token.

Authorizations:

oauth2

Responses

Response samples

200

Content type

application/atom+xml

Example

Service status indicating the Data Custodian is online

<ServiceStatus xmlns="http://naesb.org/espi">
  <currentStatus>1</currentStatus>
</ServiceStatus>

Customer

Operations for accessing Customer resources, which represent organizations receiving services from a service supplier (PII-containing).

Retrieve all Customers [FB_50]

Returns an Atom feed containing all Customer resources within the Data Custodian. Requires a valid data_custodian_access_token. Customers represent organizations receiving services from a service supplier.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:b47f3a45-8d21-5c19-a3d2-7f1e4b9c6a08</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer" type="cust-feed/Customer"/>
  <title>Customer</title>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <entry>
    <id>urn:uuid:6c6d986b-bae0-54c9-b20c-f63b5fa9de56</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e" type="cust-entry/Customer"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer" type="cust-feed/Customer"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount" type="cust-feed/CustomerAccount"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407607_1455265" type="cust-entry/LocalTimeParameters"/>
    <title>Customer</title>
    <published>2023-10-20T17:56:19.660350Z</published>
    <updated>2023-10-20T17:57:21.627755Z</updated>
    <content>
      <Customer xmlns="http://naesb.org/espi/customer">
        <Organisation>
          <streetAddress>
            <streetDetail>
              <addressGeneral>200 SECOND AVE</addressGeneral>
            </streetDetail>
            <townDetail>
              <name>OLDCASTLE</name>
              <stateOrProvince>ON</stateOrProvince>
            </townDetail>
            <postalCode>N9V 2T7</postalCode>
          </streetAddress>
        </Organisation>
        <kind>other</kind>
        <customerName>JOHN DOE</customerName>
      </Customer>
    </content>
  </entry>
</feed>

Retrieve a specific Customer [FB_50]

Returns an Atom entry containing a single Customer resource identified by customerId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

customerId

required

string >= 6 characters

Example: 407630

Unique identifier for the Customer resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:6c6d986b-bae0-54c9-b20c-f63b5fa9de56</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e" type="cust-entry/Customer"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer" type="cust-feed/Customer"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount" type="cust-feed/CustomerAccount"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407607_1455265" type="cust-entry/LocalTimeParameters"/>
  <title>Customer</title>
  <published>2023-10-20T17:56:19.660350Z</published>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <content>
    <Customer xmlns="http://naesb.org/espi/customer">
      <Organisation>
        <streetAddress>
          <streetDetail>
            <addressGeneral>200 SECOND AVE</addressGeneral>
          </streetDetail>
          <townDetail>
            <name>OLDCASTLE</name>
            <stateOrProvince>ON</stateOrProvince>
          </townDetail>
          <postalCode>N9V 2T7</postalCode>
        </streetAddress>
      </Organisation>
      <kind>other</kind>
      <customerName>JOHN DOE</customerName>
    </Customer>
  </content>
</entry>

CustomerAccount

Operations for accessing Customer Account resources, which contain billing and payment information (PII-containing).

Retrieve all Customer Accounts [FB_51]

Returns an Atom feed containing all CustomerAccount resources within the Data Custodian. Requires a valid data_custodian_access_token. Customer accounts contain billing and payment information.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:d5a9c8f2-4e6b-5d7a-8c3e-1f9b6a5d8c2e</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount" type="cust-feed/CustomerAccount"/>
  <title>CustomerAccount</title>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <entry>
    <id>urn:uuid:118b34f4-64ab-5242-8ec9-bd2c6c2ae002</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe" type="cust-entry/CustomerAccount"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount" type="cust-feed/CustomerAccount"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e" type="cust-entry/Customer"/>
    <title>CustomerAccount</title>
    <published>2023-10-20T17:56:19.660350Z</published>
    <updated>2023-10-20T17:57:21.627755Z</updated>
    <content>
      <CustomerAccount xmlns="http://naesb.org/espi/customer">
        <contactInfo>
          <streetAddress>
            <streetDetail>
              <addressGeneral>200 SECOND AVE</addressGeneral>
            </streetDetail>
            <townDetail>
              <name>OLDCASTLE</name>
              <stateOrProvince>ON</stateOrProvince>
            </townDetail>
            <postalCode>N9V 2T7</postalCode>
          </streetAddress>
        </contactInfo>
        <accountId>30000000-00</accountId>
      </CustomerAccount>
    </content>
  </entry>
</feed>

Retrieve a specific Customer Account [FB_51]

Returns an Atom entry containing a single CustomerAccount resource identified by customerAccountId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

customerAccountId

required

string >= 6 characters

Example: 123456

Unique identifier for the CustomerAccount resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:118b34f4-64ab-5242-8ec9-bd2c6c2ae002</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe" type="cust-entry/CustomerAccount"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount" type="cust-feed/CustomerAccount"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e" type="cust-entry/Customer"/>
  <title>CustomerAccount</title>
  <published>2023-10-20T17:56:19.660350Z</published>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <content>
    <CustomerAccount xmlns="http://naesb.org/espi/customer">
      <contactInfo>
        <streetAddress>
          <streetDetail>
            <addressGeneral>200 SECOND AVE</addressGeneral>
          </streetDetail>
          <townDetail>
            <name>OLDCASTLE</name>
            <stateOrProvince>ON</stateOrProvince>
          </townDetail>
          <postalCode>N9V 2T7</postalCode>
        </streetAddress>
      </contactInfo>
      <accountId>30000000-00</accountId>
    </CustomerAccount>
  </content>
</entry>

CustomerAgreement

Operations for accessing Customer Agreement resources, which define service terms at specific locations (PII-containing).

Retrieve all Customer Agreements [FB_52]

Returns an Atom feed containing all CustomerAgreement resources within the Data Custodian. Requires a valid data_custodian_access_token. Customer agreements define service terms at specific locations.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:f2d8c9e5-6a7b-5c4d-8e3f-9b1a6c5d8e2f</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
  <title>CustomerAgreement</title>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <entry>
    <id>urn:uuid:b4d2b756-7442-558e-bfb2-5c3288e92f04</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceSupplier" type="cust-feed/ServiceSupplier"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings" type="cust-feed/ProgramDateIdMappings"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation" type="cust-feed/ServiceLocation"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe" type="cust-entry/CustomerAccount"/>
    <title>CustomerAgreement</title>
    <published>2023-10-20T17:56:20.594174Z</published>
    <updated>2023-10-20T17:57:21.627755Z</updated>
    <content>
      <CustomerAgreement xmlns="http://naesb.org/espi/customer">
        <agreementId>30000000-00_004_electric</agreementId>
      </CustomerAgreement>
    </content>
  </entry>
</feed>

Retrieve a specific Customer Agreement [FB_52]

Returns an Atom entry containing a single CustomerAgreement resource identified by customerAgreementId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

customerAgreementId

required

string >= 6 characters

Example: 789012

Unique identifier for the CustomerAgreement resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:b4d2b756-7442-558e-bfb2-5c3288e92f04</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement" type="cust-feed/CustomerAgreement"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceSupplier" type="cust-feed/ServiceSupplier"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings" type="cust-feed/ProgramDateIdMappings"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation" type="cust-feed/ServiceLocation"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe" type="cust-entry/CustomerAccount"/>
  <title>CustomerAgreement</title>
  <published>2023-10-20T17:56:20.594174Z</published>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <content>
    <CustomerAgreement xmlns="http://naesb.org/espi/customer">
      <agreementId>30000000-00_004_electric</agreementId>
    </CustomerAgreement>
  </content>
</entry>

ServiceLocation

Operations for accessing Service Location resources, which represent physical premises where service is provided (PII-containing).

Retrieve all Service Locations [FB_53]

Returns an Atom feed containing all ServiceLocation resources within the Data Custodian. Requires a valid data_custodian_access_token. Service locations represent physical premises where service is provided.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:b5e8f3c9-6d7a-5c4e-8f2b-9a1c6d5e8b3f</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation" type="cust-feed/ServiceLocation"/>
  <title>ServiceLocation</title>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <entry>
    <id>urn:uuid:fce8847d-4dac-5019-9d72-a2b756ac55b6</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation" type="cust-feed/ServiceLocation"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter" type="cust-feed/Meter"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice" type="cust-feed/EndDevice"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407607_1455265" type="cust-entry/LocalTimeParameters"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
    <title>ServiceLocation</title>
    <published>2023-10-20T17:56:20.594174Z</published>
    <updated>2023-10-20T17:57:21.627755Z</updated>
    <content>
      <ServiceLocation xmlns="http://naesb.org/espi/customer">
        <mainAddress>
          <streetDetail>
            <addressGeneral>200 SECOND AVE</addressGeneral>
          </streetDetail>
          <townDetail>
            <name>OLDCASTLE</name>
            <stateOrProvince>ON</stateOrProvince>
          </townDetail>
          <postalCode>N9V 2T7</postalCode>
        </mainAddress>
        <UsagePoints>
          <UsagePoint>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407607/UsagePoint/1455265</UsagePoint>
        </UsagePoints>
      </ServiceLocation>
    </content>
  </entry>
</feed>

Retrieve a specific Service Location [FB_53]

Returns an Atom entry containing a single ServiceLocation resource identified by serviceLocationId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

serviceLocationId

required

string >= 6 characters

Example: 345678

Unique identifier for the ServiceLocation resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:fce8847d-4dac-5019-9d72-a2b756ac55b6</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation" type="cust-feed/ServiceLocation"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter" type="cust-feed/Meter"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice" type="cust-feed/EndDevice"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/LocalTimeParameters/TIMEZONE_407607_1455265" type="cust-entry/LocalTimeParameters"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
  <title>ServiceLocation</title>
  <published>2023-10-20T17:56:20.594174Z</published>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <content>
    <ServiceLocation xmlns="http://naesb.org/espi/customer">
      <mainAddress>
        <streetDetail>
          <addressGeneral>200 SECOND AVE</addressGeneral>
        </streetDetail>
        <townDetail>
          <name>OLDCASTLE</name>
          <stateOrProvince>ON</stateOrProvince>
        </townDetail>
        <postalCode>N9V 2T7</postalCode>
      </mainAddress>
      <UsagePoints>
        <UsagePoint>https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Subscription/407607/UsagePoint/1455265</UsagePoint>
      </UsagePoints>
    </ServiceLocation>
  </content>
</entry>

ServiceSupplier

Operations for accessing Service Supplier resources, which represent utility or energy service providers.

Retrieve all Service Suppliers [FB_56]

Returns an Atom feed containing all ServiceSupplier resources within the Data Custodian. Requires a valid data_custodian_access_token. Service suppliers are organizations providing utility services to customers.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:b9e7f5d4-8c6a-5e4d-9f2b-7a1c6e5d8b3f</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceSupplier" type="cust-feed/ServiceSupplier"/>
  <title>ServiceSupplier</title>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <entry>
    <id>urn:uuid:fe8d9d03-6c2e-5b6a-b6c2-4d19f11cc830</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceSupplier/ddc37fc0-0417-588d-a928-c3d82a3e7dfd" type="cust-entry/ServiceSupplier"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceSupplier" type="cust-feed/ServiceSupplier"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
    <title>ServiceSupplier</title>
    <published>2023-10-20T17:56:20.594174Z</published>
    <updated>2023-10-20T17:57:21.627755Z</updated>
    <content>
      <ServiceSupplier xmlns="http://naesb.org/espi/customer">
        <Organisation>
          <organisationName>Acme Energy Supplier</organisationName>
        </Organisation>
        <kind>retailer</kind>
      </ServiceSupplier>
    </content>
  </entry>
</feed>

Retrieve a specific Service Supplier [FB_56]

Returns an Atom entry containing a single ServiceSupplier resource identified by serviceSupplierId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

serviceSupplierId

required

string >= 6 characters

Example: 111222

Unique identifier for the ServiceSupplier resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:fe8d9d03-6c2e-5b6a-b6c2-4d19f11cc830</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceSupplier/ddc37fc0-0417-588d-a928-c3d82a3e7dfd" type="cust-entry/ServiceSupplier"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceSupplier" type="cust-feed/ServiceSupplier"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
  <title>ServiceSupplier</title>
  <published>2023-10-20T17:56:20.594174Z</published>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <content>
    <ServiceSupplier xmlns="http://naesb.org/espi/customer">
      <Organisation>
        <organisationName>Acme Energy Supplier</organisationName>
      </Organisation>
      <kind>retailer</kind>
    </ServiceSupplier>
  </content>
</entry>

EndDevice

Operations for accessing End Device resources, which represent metering and load management devices.

Retrieve all End Devices [FB_54]

Returns an Atom feed containing all EndDevice resources within the Data Custodian. Requires a valid data_custodian_access_token. End devices are assets that perform metering and load management functions.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:d8e9f5c3-7a6b-5e4d-9f2c-8a1d6e5c8b3f</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice" type="cust-feed/EndDevice"/>
  <title>EndDevice</title>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <entry>
    <id>urn:uuid:73a40799-2c91-5a15-a561-25102c959fcd</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice/bd159f17-68fc-5b0e-a3d4-bd86dcade888" type="cust-entry/EndDevice"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice" type="cust-feed/EndDevice"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
    <title>EndDevice</title>
    <published>2023-10-20T17:56:20.594174Z</published>
    <updated>2023-10-20T17:57:21.627755Z</updated>
    <content>
      <EndDevice xmlns="http://naesb.org/espi/customer">
        <serialNumber>inverter-01-51111111111</serialNumber>
      </EndDevice>
    </content>
  </entry>
</feed>

Retrieve a specific End Device [FB_54]

Returns an Atom entry containing a single EndDevice resource identified by endDeviceId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

endDeviceId

required

string >= 6 characters

Example: 901234

Unique identifier for the EndDevice resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:73a40799-2c91-5a15-a561-25102c959fcd</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice/bd159f17-68fc-5b0e-a3d4-bd86dcade888" type="cust-entry/EndDevice"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/EndDevice" type="cust-feed/EndDevice"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
  <title>EndDevice</title>
  <published>2023-10-20T17:56:20.594174Z</published>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <content>
    <EndDevice xmlns="http://naesb.org/espi/customer">
      <serialNumber>inverter-01-51111111111</serialNumber>
    </EndDevice>
  </content>
</entry>

Meter

Operations for accessing Meter resources, which represent physical metering assets at usage points.

Retrieve all Meters [FB_55]

Returns an Atom feed containing all Meter resources within the Data Custodian. Requires a valid data_custodian_access_token. Meters are physical assets that perform metering at usage points.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:f9e6d4c8-7b6a-5e4d-9f2c-8a1d6e5c7b3f</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter" type="cust-feed/Meter"/>
  <title>Meter</title>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <entry>
    <id>urn:uuid:aba939ae-5ce7-5393-bcfe-cceaa298424b</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter/1556ef79-d143-595d-9e4c-8695bd5bc0df" type="cust-entry/Meter"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter" type="cust-feed/Meter"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
    <title>Meter</title>
    <published>2023-10-20T17:56:20.594174Z</published>
    <updated>2023-10-20T17:57:21.627755Z</updated>
    <content>
      <Meter xmlns="http://naesb.org/espi/customer">
        <serialNumber>EPP00004</serialNumber>
      </Meter>
    </content>
  </entry>
</feed>

Retrieve a specific Meter [FB_55]

Returns an Atom entry containing a single Meter resource identified by meterId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

meterId

required

string >= 6 characters

Example: 567890

Unique identifier for the Meter resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:aba939ae-5ce7-5393-bcfe-cceaa298424b</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter/1556ef79-d143-595d-9e4c-8695bd5bc0df" type="cust-entry/Meter"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d/Meter" type="cust-feed/Meter"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ServiceLocation/d375184b-585b-5cc7-81fb-114c9655855d" type="cust-entry/ServiceLocation"/>
  <title>Meter</title>
  <published>2023-10-20T17:56:20.594174Z</published>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <content>
    <Meter xmlns="http://naesb.org/espi/customer">
      <serialNumber>EPP00004</serialNumber>
    </Meter>
  </content>
</entry>

Statement

Operations for accessing Statement resources, which represent billing statements for services provided (PII-containing).

Retrieve all Statements [FB_57]

Returns an Atom feed containing all Statement resources within the Data Custodian. Requires a valid data_custodian_access_token. Statements are billing statements for services provided to customers.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:d9e8f6c5-7b6a-5e4d-9f2c-8a1d6e5c8b3f</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Statement" type="cust-feed/Statement"/>
  <title>Statement</title>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <entry>
    <id>urn:uuid:e8f9d6c7-6b5a-5e4d-9f2c-7a1d6e5b8c3f</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Statement/333444" type="cust-entry/Statement"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Statement" type="cust-feed/Statement"/>
    <title>Statement</title>
    <published>2023-10-20T17:32:35.448812Z</published>
    <updated>2023-10-20T17:33:23.054424Z</updated>
    <content>
      <Statement xmlns="http://naesb.org/espi/customer">
        <issueDateTime>1697820000</issueDateTime>
      </Statement>
    </content>
  </entry>
</feed>

Retrieve a specific Statement [FB_57]

Returns an Atom entry containing a single Statement resource identified by statementId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

statementId

required

string >= 6 characters

Example: 333444

Unique identifier for the Statement resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:e8f9d6c7-6b5a-5e4d-9f2c-7a1d6e5b8c3f</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Statement/333444" type="cust-entry/Statement"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/Statement" type="cust-feed/Statement"/>
  <title>Statement</title>
  <published>2023-10-20T17:32:35.448812Z</published>
  <updated>2023-10-20T17:33:23.054424Z</updated>
  <content>
    <Statement xmlns="http://naesb.org/espi/customer">
      <issueDateTime>1697820000</issueDateTime>
    </Statement>
  </content>
</entry>

ProgramDateIdMappings

Operations for accessing Program Date ID Mappings, which contain customer energy efficiency program enrollments.

Retrieve all Program Date ID Mappings [FB_58]

Returns an Atom feed containing all ProgramDateIdMappings resources within the Data Custodian. Requires a valid data_custodian_access_token. Program date mappings contain customer energy efficiency program enrollments.

Authorizations:

oauth2

query Parameters

published-max	string <date-time> The upper bound on the published date of the resource.
published-min	string <date-time> The lower bound on the published date of the resource.
updated-max	string <date-time> The upper bound on the updated date of the resource.
updated-min	string <date-time> The lower bound on the updated date of the resource.
max-results	integer <int64> The upper bound on the number of entries to be contained in the response.
start-index	integer <int64> The one-based offset in the DataCustodian's collection of resources that should be transferred as the first entry of the response.
depth	integer <int64> The maximum number of entries to be transferred in the response.

Responses

Response samples

200

Content type

application/atom+xml

<feed xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:e9f7d5c8-6b5a-5e4d-9f2c-8a1d6e5c7b3f</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings" type="cust-feed/ProgramDateIdMappings"/>
  <title>ProgramDateIdMappings</title>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <entry>
    <id>urn:uuid:913830f7-e2e4-5dc2-8264-3dd7ab3cf316</id>
    <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings/5495fa4a-ce1e-57fa-beb4-862cb1a94370" type="cust-entry/ProgramDateIdMappings"/>
    <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings" type="cust-feed/ProgramDateIdMappings"/>
    <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
    <title>ProgramDateIdMappings</title>
    <published>2023-10-20T17:56:20.594174Z</published>
    <updated>2023-10-20T17:57:21.627755Z</updated>
    <content>
      <ProgramDateIdMappings xmlns="http://naesb.org/espi/customer">
        <programDateIdMapping>
          <programDateType>CUST_DR_PROGRAM_ENROLLMENT_DATE</programDateType>
          <code>DR-01</code>
          <name>DR Enrollment</name>
        </programDateIdMapping>
      </ProgramDateIdMappings>
    </content>
  </entry>
</feed>

Retrieve specific Program Date ID Mappings [FB_58]

Returns an Atom entry containing a single ProgramDateIdMappings resource identified by programDateIdMappingsId. Requires a valid data_custodian_access_token.

Authorizations:

oauth2

path Parameters

programDateIdMappingsId

required

string >= 6 characters

Example: 555666

Unique identifier for the ProgramDateIdMappings resource

Responses

Response samples

200

Content type

application/atom+xml

<entry xmlns="http://www.w3.org/2005/Atom">
  <id>urn:uuid:913830f7-e2e4-5dc2-8264-3dd7ab3cf316</id>
  <link rel="self" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings/5495fa4a-ce1e-57fa-beb4-862cb1a94370" type="cust-entry/ProgramDateIdMappings"/>
  <link rel="up" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265/ProgramDateIdMappings" type="cust-feed/ProgramDateIdMappings"/>
  <link rel="related" href="https://data.greenbuttonconnect.org/DataCustodian/espi/1_1/resource/RetailCustomer/407607/Customer/24c95599-8b3a-5e4f-9ac4-70c2a0d9646e/CustomerAccount/8e4ef00e-4122-5a90-99f7-3c4f9f6c14fe/CustomerAgreement/1455265" type="cust-entry/CustomerAgreement"/>
  <title>ProgramDateIdMappings</title>
  <published>2023-10-20T17:56:20.594174Z</published>
  <updated>2023-10-20T17:57:21.627755Z</updated>
  <content>
    <ProgramDateIdMappings xmlns="http://naesb.org/espi/customer">
      <programDateIdMapping>
        <programDateType>CUST_DR_PROGRAM_ENROLLMENT_DATE</programDateType>
        <code>DR-01</code>
        <name>DR Enrollment</name>
      </programDateIdMapping>
    </ProgramDateIdMappings>
  </content>
</entry>