free site builder

Green Button Technology

Green Button Actors
Retail Customers, Data Custodians, and Third Parties

Green Button technology allows data to be exchanged between Utilities, Customers, and Third Parties.  The ESPI standard refers to these entities as Data Custodians, Retail Customers and Third Parties respectively.  The following section provides a definition of these actors and other Green Button terms:


Retail Customer

Any individual or enterprise that receives electricity, gas, or water services from a Data Custodian.  Retail Customers include residential, commercial, or industrial account holders.


Data Custodian

Any enterprise that holds Retail Customer Energy Usage Information, typically acquired from a meter, during the course of providing electricity, gas, or water service to a Retail Customer.  A Data Custodian holds Energy Usage Information as part of the service they provide and may, with the authorization of the Retail Customer, share that data with a Third Party.  A Data Custodian may be a Distribution Company.


Third Party

Any individual or enterprise authorized by a Retail Customer to access the Retail Customer's metered data held by a Data Custodian for the purpose of providing some service to the Retail Customer.  A Third Party, authorized to access a Retail Customer's metered data, may create a subscription with the Data Custodian holding the metered data only for the purpose of providing additional services to the Retail Customer. The Retail Customer may modify or revoke authorization for a Third Party to access their metered data at any time.


Energy Service Provider Interface

A standardized machine-to-machine interface that permits a Data Custodian to share, at the Retail Customer's request or direction, a broad set of that Retail Customer's Energy Usage or Retail Customer Information held by that Data Custodian with Authorized Third Parties.


Energy Usage Information

Any information from a metering device identifiable to an individual Retail Customer concerning that Retail Customer's energy usage.


Retail Customer Information

Any information, typically account based, used to identify an individual Retail Customer.


Authorized Third Party

A Third Party that is permitted to receive Energy Usage Information utilizing the Energy Services Provider Interface, who has met the requirements of the Applicable Regulatory Authority and Governing Documents.

Relationships between the Actors

                                                               


The actors enter into relationships as depicted in the diagram above.  The simplest relationship is the one that exists between the Data Custodian and the Retail Customer.  This relationship allows the Retail Customer to download a file that contains their Energy Usage Information.  This simple relationship is the basis for the Green Button Download My Data (DMD) operation.

Concepts

Green Button uses the Atom Syndication Format Standard to represent structured energy usage information and retail customer data in an XML format.  The power of the Atom Syndication Format to encode complex data for exchange over REST web services, were independently recognized by both the GData (Google) and OData (Microsoft) standards.  Based on this fact, the UCAIug OpenADE Task Force adopted this construct for development of the Energy Service Provide Interface (ESPI)


The high-level structure of an Atom Syndication Format data stream/file is shown below:

<feed>
  ...
  <entry>
    <id>urn:uuid:....</id>
    <link> rel="up" href="https://..." </link>
    <link> rel="self" href="https://..." </link>
    <link> rel="related" href="https://..." </link>
    <title> rel="related" href="https://..." </link>
    <content>
      <espi-resource />
    </content>
    <published>yyyy-MM-ddTHH:mm:ssZ</published>
    <updated>yyyy-MM-ddTHH:mm:ssZ</updated>
  </entry>
  ...
</feed>

An Atom data stream/file contains <feed>, <entry>,  <id>, <link>, <title>, <content>, <published> and <updated> tags. The <feed>, <entry> and <content> tags create containers for information.  Green Button "resources" (UsagePoints, MeterReadings, etc.) are expressed in XML format within the <content> container.  This results in a uniform way to express full-featured data API responses that reference a Retail Customer's encapsulated Energy Usage or Retail Customer Information.  Atom <feeds> always represent a collection of one or more Green Button resources.


The contents of the <id>, <title>, <link>, <published> and <updated> tags are defined by the ESPI standard as containing:

    <id> -- contains the espi:mRID which is implemented using UUID Type 5 values.

    <title> -- contains the espi:description which can be anything as long as it doesn't contain Personal Identifiable Information (PII)

    <link> -- indicates how the current Green Button resource is associated with other Green Button resources

    <published> -- indicates the UTC DateTime the Green Button resource was initially collected or created

    <updated> -- indicates the UTC DateTime the Green Button resource was last updated (initially the same as <published>)


Relationships


The presence of the <link> tag is critical for identifying the relationships between Green Button resources during parsing of Green Button data stream/files.  For example, these links allow the data processing application to know which MeterReadings are related to a specific UsagePoint.


For example, within an <entry>, the "related" <link> points to a collection:

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:c8c34b3a-d175-447b-bd00-176f60194de0</id>
      <link rel="up" href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint" />
      <link rel="self" href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1" />
      <link rel="related" href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/MeterReading" />
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/ElectricPowerUsageSummary" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <espi:UsagePoint>
                  <espi:ServiceCategory>
                        <espi:kind>0</espi:kind>
                  </espi:ServiceCategory>
            </espi:UsagePoint>
      </content>
      <published>2013-09-19T04:00:00Z</published>
      <updated>2013-09-19T04:00:00Z</updated>
</entry>

Green Button Connect My Data Resources

ApplicationInformation

The ApplicationInformation resource exists for each Data Custodian/Third Party registration.  The Data Custodian is responsible for maintaining the contents of the ApplicationInformation resource and makes it available to the Third Party through the ApplicationInformation API.  In order for the Third Party to retrieve the contents of the ApplicationInformation resource, they must submit access the Data Custodian's ApplicationInformation resource API using the "registration" access token assigned to them by the Data Custodian during the Third Party registration process. 

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:af6e8b03-0299-467e-972a-a883ecdcc575</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ApplicationInformation" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ApplicationInformation/2" rel="self"/>
      <title>GreenButtonData.org  ThirdParty Application</title>
      <content>
            <espi:ApplicationInformation>
                  <espi:dataCustodianId>data_custodian</espi:dataCustodianId>
                  <espi:dataCustodianApplicationStatus>1</espi:dataCustodianApplicationStatus>
                  <espi:thirdPartyNotifyUri>https://sandbox.greenbuttonalliance.org:8443/ThirdParty/espi/1_1/Notification</espi:thirdPartyNotifyUri>
                  <espi:dataCustodianBulkRequestURI></espi:dataCustodianBulkRequestURI>
                  <espi:dataCustodianResourceEndpoint>https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource</espi:dataCustodianResourceEndpoint>
                  <espi:thirdPartyScopeSelectionScreenURI>https://sandbox.greenbuttonalliance.org:8443/ThirdParty/RetailCustomer/ScopeSelection</espi:thirdPartyScopeSelectionScreenURI>
                  <espi:client_secret>secret</espi:client_secret>
                  <espi:redirect_uri>https://sandbox.greenbuttonalliance.org:8443/ThirdParty/espi/1_1/OAuthCallBack</espi:redirect_uri>
                  <espi:client_id>third_party</espi:client_id>
                  <espi:contacts>john.teeter@energyos.org,martin.burns@nist.gov,donald.coffin@reminetworks.com</espi:contacts>
                  <espi:token_endpoint_auth_method>client_secret_basic</espi:token_endpoint_auth_method>
                  <espi:scope>FB=4_5_15;IntervalDuration=900;BlockDuration=monthly;HistoryLength=13</espi:scope>
                  <espi:scope>FB=4_5_15;IntervalDuration=3600;BlockDuration=monthly;HistoryLength=13</espi:scope>
                  <espi:scope>FB=4_5_12_15_16;IntervalDuration=3600;BlockDuration=monthly;HistoryLength=13</espi:scope>
                  <espi:grant_types>refresh_token</espi:grant_types>
                  <espi:grant_types>authorization_code</espi:grant_types>
                  <espi:dataCustodianScopeSelectionScreenURI>https://sandbox.greenbuttonalliance.org:8443/DataCustodian/RetailCustomer/ScopeSelectionList</espi:dataCustodianScopeSelectionScreenURI>
            </espi:ApplicationInformation>
      </content>
      <published>2014-01-02T10:00:00Z</published>
      <updated>2014-01-02T10:00:00Z</updated>
</entry>

    

Authorization

The Authorization resource represents the current state of the Retail Customer's authorization allowing a Third Party to retrieve Energy Usage Information from a Data Custodian.  A Third Party may retrieve the contents of an Authorization resource by accessing the Data Custodian's Authorization resource API using the "client" access token either assigned by the Data Custodian during the Third Party registration process or generated through the Third Party's use of the OAuth 2.0 Client_Credential flow process.  The Data Custodian's Authorization API response will NOT contain either the access or refresh token values assigned at the time the Authorization was created for security reasons.  Therefore, it is the Third Party's responsibility to ensure they capture and persistent the access and refresh tokens locally at the time the Authorization is created.

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:bdcb34c0-7afd-4812-b30c-0d90fbeab936</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Authorization" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Authorization/5" rel="self"/>
      <content>
            <espi:Authorization>
                  <espi:authorizedPeriod>
                        <espi:duration>0</espi:duration>
                        <espi:start>0</espi:start>
                  </espi:authorizedPeriod>
                  <espi:publishedPeriod>
                        <espi:duration>0</espi:duration>
                        <espi:start>0</espi:start>
                  </espi:publishedPeriod>
                  <espi:status>1</espi:status>
                  <espi:expires_at>31535999</espi:expires_at>
                  <espi:scope>FB=4_5_15;IntervalDuration=900;BlockDuration=monthly;HistoryLength=13</espi:scope>
                  <espi:token_type>Bearer</espi:token_type>
                  <espi:resourceURI>https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Batch/Subscription/5</espi:resourceURI>
                  <espi:authorizationURI>https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Authorization/5</espi:authorizationURI>
                  <espi:retailCustomerURI>https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Batch/RetailCustomer/5</espi:retailCustomerURI>                  
            </espi:Authorization>
      </content>
      <published>2014-09-03T06:39:45Z</published>
      <updated>2014-09-03T06:39:45Z</updated>
</entry>

    

LocalTimeParameters

The LocalTimeParameters resource provides a flexible manner to enable Energy Usage Information to be provided with a reference to local time, without including any Personally Identifiable Information.  Both the Energy Usage Information and Retail Customer data stream/file requite the LocalTimeParameters resource.

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:e30ce77d-ec22-4da5-83c2-991ba34c97d6</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="self"/>
      <title>DST For North America</title>
      <content>
            <espi:LocalTimeParameters>
                  <espi:dstEndRule>B40E2000</espi:dstEndRule>
                  <espi:dstOffset>3600</espi:dstOffset>
                  <espi:dstStartRule>360E2000</espi:dstStartRule>
                  <espi:tzOffset>-18000</espi:tzOffset>
            </espi:LocalTimeParameters>
      </content>
      <published>2013-09-19T04:00:00Z</published>
      <updated>2013-09-19T04:00:00Z</updated>
</entry>

    

Green Button Energy Usage Information Resources

UsagePoint

A UsagePoint is where consumption or production is either measured (e.g., metered) or estimated (e.g., unmetered street lights).  Typically, it is a Smart Meter, but it could be the outlet on the wall, the solar panel on your roof, or even the Electric car in your garage.  UsagePoints provide the reference for all meter readings contained within a Green Button data stream/file.  UsagePoints have a ServiceCategory that defines the kind of resource (e.g., electricity, gas, or water) measurement being reported.


UsagePoint resource information is usually obtained from the Data Custodian by the Third Party accessing the Data Custodian's Batch Subscription API upon notification by the Data Custodian that new Energy Usage Information is available for an account they have been granted access to retrieve.  A Third Party then retrieves the contents of an UsagePoint resource by accessing the Data Custodian's Batch Subscription resource API using the "client" access token either assigned by the Data Custodian during the Third Party registration process or generated through the Third Party's use of the OAuth 2.0 Client_Credential flow process. 

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:c8c34b3a-d175-447b-bd00-176f60194de0</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/MeterReading" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/ElectricPowerUsageSummary" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <espi:UsagePoint>
                  <espi:ServiceCategory>
                        <espi:kind>0</espi:kind>
                  </espi:ServiceCategory>
            </espi:UsagePoint>
      </content>
      <published>2013-09-19T04:00:00Z</published>
      <updated>2013-09-19T04:00:00Z</updated>
</entry>

    

MeterReading

A MeterReading is a container for all measured IntervalBlocks within the Green Button Energy Usage Information captured at a UsagePoint.

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:4234ae39-fb6d-48ca-8856-ac9f41fb3d34</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/MeterReading" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/MeterReading/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/MeterReading/1/IntervalBlock" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ReadingType/1" rel="related"/>
      <title>Monthly Electricity Consumption</title>
      <content>
            <espi:MeterReading/>
      </content>
      <published>2013-09-19T04:00:00Z</published>
      <updated>2013-09-19T04:00:00Z</updated>
</entry>

    

ReadingType

A ReadingType provides detail specifics amount the data be retrieved.  

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:99b292fc-55f7-4f27-a3b9-cddab97cca90</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ReadingType" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ReadingType/1" rel="self"/>
      <title>Type of Meter Reading Data</title>
      <content>
            <espi:ReadingType>
                  <espi:accumulationBehaviour>4</espi:accumulationBehaviour>
                  <espi:commodity>1</espi:commodity>
                  <espi:currency>840</espi:currency>
                  <espi:dataQualifier>12</espi:dataQualifier>
                  <espi:flowDirection>1</espi:flowDirection>
                  <espi:intervalLength>86400</espi:intervalLength>
                  <espi:kind>12</espi:kind>
                  <espi:phase>769</espi:phase>
                  <espi:powerOfTenMultiplier>0</espi:powerOfTenMultiplier>
                  <espi:timeAttribute>0</espi:timeAttribute>
                  <espi:uom>72</espi:uom>
            </espi:ReadingType>
      </content>
      <published>2013-09-19T04:00:00Z</published>
      <updated>2013-09-19T04:00:00Z</updated>
</entry>

    

IntervalBlock

IntervalBlocks are the primary data carrier of Green Button Energy Usage Information.  IntervalBlocks may contain one or more Intervals, each with a start and duration value, as well as the specific IntervalReading.

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:e0383570-16b1-4ab9-8642-fdb7e89660db</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/MeterReading/1/IntervalBlock" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/MeterReading/1/IntervalBlock/1" rel="self"/>
      <title></title>
      <content>
            <espi:IntervalBlock>
                  <espi:interval>
                        <espi:duration>2678400</espi:duration>
                        <espi:start>1357016400</espi:start>
                  </espi:interval>
                  <espi:IntervalReading>
                        <espi:cost>256347</espi:cost>
                        <espi:timePeriod>
                              <espi:duration>86400</espi:duration>
                              <espi:start>1357016400</espi:start>
                        </espi:timePeriod>
                        <espi:value>21021</espi:value>
                  </espi:IntervalReading>
                  <espi:IntervalReading>
                        <espi:cost>256347</espi:cost>
                        <espi:timePeriod>
                              <espi:duration>86400</espi:duration>
                              <espi:start>1357102800</espi:start>
                        </espi:timePeriod>
                        <espi:value>21021</espi:value>
                  </espi:IntervalReading>
                  ...
                  <espi:IntervalReading>
                        <espi:cost>256347</espi:cost>
                        <espi:timePeriod>
                              <espi:duration>86400</espi:duration>
                              <espi:start>1359608400</espi:start>
                        </espi:timePeriod>
                        <espi:value>21021</espi:value>
                  </espi:IntervalReading>
            </espi:IntervalBlock>
      </content>
      <published>2013-02-01T05:00:00Z</published>
      <updated>2013-02-01T05:00:00Z</updated>
</entry>

    

UsageSummary

The UsageSummary (formerly EnergyUsageSummary) resource contains Energy Usage Information for a Billing Period and provides the ability for Data Custodians to summarize Energy Usage Information by Billing Periods for Retail Customers and Third Party applications.


The UsageSummary is usually included in the Data Custodian's Batch Subscription API response if available.

<entry xmlns:espi="http://naesb.org/espi" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:923a7143-263e-421b-bea2-e41b7e240013</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/UsageSummary" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Subscription/1/UsagePoint/1/UsageSummary/1" rel="self"/>
      <title>Usage Summary</title>
      <content>
            <espi:UsageSummary>
                  <espi:billingPeriod>
                        <espi:duration>2419200</espi:duration>
                        <espi:start>1391230800</espi:start>
                  </espi:billingPeriod>
                  <espi:billLastPeriod>6752000</espi:billLastPeriod>
                  <espi:billToDate>4807000</espi:billToDate>
                  <espi:costAdditionalLastPeriod>0</espi:costAdditionalLastPeriod>
                  <espi:currency>840</espi:currency>
                  <espi:overallConsumptionLastPeriod>
                        <espi:powerOfTenMultiplier>0</espi:powerOfTenMultiplier>
                        <espi:uom>72</espi:uom>
                        <espi:value>625716</espi:value>
                  </espi:overallConsumptionLastPeriod>
                  <espi:currentBillingPeriodOverAllConsumption>
                        <espi:powerOfTenMultiplier>0</espi:powerOfTenMultiplier>
                        <espi:timeStamp>1395374400</espi:timeStamp>
                        <espi:uom>72</espi:uom>
                        <espi:value>447993</espi:value>
                  </espi:currentBillingPeriodOverAllConsumption>
                  <espi:qualityOfReading>14</espi:qualityOfReading>
                  <espi:statusTimeStamp>1395374400</espi:statusTimeStamp>
            </espi:UsageSummary>
      </content>
      <published>2014-03-01T05:00:00Z</published>
      <updated>2014-03-01T05:00:00Z</updated>
</entry>

    

ElectricPowerQualitySummary

The ElectricPowerQualitySummary resource provides the ability for Data Custodians to provide Retail Customers and Third Party applications a summary of Power Quality Events.  The ElectricPowerQualitySummary resource represents a summary of power quality information typically required by facility energy management systems.  It is NOT intended to satisfy the detailed requirements of power quality monitoring.  All values reported are defined by the contents of the <measurementProtocol> tag during the period being reported.  The information attributes are raw measurements, not the "yes/no" determination indicated by the various standards.  See the referenced standards for definition, measurement protocol, and period.


The ElectricPowerQualitySummary is usually included in the Data Custodian's Batch Subscription API response if available.

<?xml version="1.0" encoding="UTF-8"?>
<entry xml:lang="en-us" xsi:schemaLocation="http://naesb.org/espi espiDerived.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.w3.org/2005/Atom" xmlns:espi="http://naesb.org/espi">
  <id>urn:uuid:DEB0A337-C1B5-4658-99BA-4688E253A99B</id>
  <link rel="self" href="Subscription/9b6c7063/ElectricPowerQualitySummary/01"/>
  <link rel="up" type="" href="Subscription/9b6c7063/UsagePoint/01/ElectricPowerQualitySummary"/>
  <title>Quality Summary</title>
  <content>
    <ElectricPowerQualitySummary xmlns="http://naesb.org/espi">
      <flickerPlt>1</flickerPlt>
      <flickerPst>2</flickerPst>
      <harmonicVoltage>3</harmonicVoltage>
      <longInterruptions>4</longInterruptions>
      <mainsVoltage>5</mainsVoltage>
      <measurementProtocol>6</measurementProtocol>
      <powerFrequency>7</powerFrequency>
      <rapidVoltageChanges>8</rapidVoltageChanges>
      <shortInterruptions>9</shortInterruptions>
      <summaryInterval>
        <duration>2119600</duration>
        <start>2330578000</start>
      </summaryInterval>
      <supplyVoltageDips>10</supplyVoltageDips>
      <supplyVoltageImbalance>11</supplyVoltageImbalance>
      <supplyVoltageVariations>12</supplyVoltageVariations>
      <tempOvervoltage>13</tempOvervoltage>
    </ElectricPowerQualitySummary>
  </content>
  <published>2012-10-24T00:00:00Z</published>
  <updated>2012-10-24T00:00:00Z</updated>
</entry>
    

Green Button Retail Customer Resources

Customer

The Customer resource contains location and contact information for residences and businesses receiving services from the Data Custodian.

<entry xmlns:cust="http://naesb.org/espi/customer" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:1d23ab19-addf-5383-a560-7f1e4ea8c75a</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Customer" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Customer/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Customer/1/CustomerAccount" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <cust:Customer>
                  <cust:Organization>
                        <cust:name>Green Button Alliance</cust:name>
                        <cust:streetAddress>
                              <cust:streetDetail>
                                    <cust:buildingName>Taj Mahal Towers</cust:buildingName>
                                    <cust:suiteNumber>16204</cust:suiteNumber>
                                    <cust:addressGeneral>5332 Industrial Blvd</cust:addressGeneral>
                              </cust:streetDetail>
                              <cust:townDetail>
                                    <cust:name>Atlanta</cust:name>
                                    <cust:county>Cobb</cust:county>
                                    <cust:stateOrProvince>Georgia</cust:stateOrProvince>
                                    <cust:country>United States</cust:country>
                              </cust:townDetail>
                              <cust:postalCode>30339</cust:postalCode>
                        </cust:streetAddress>
                        <cust:postalAddress>
                              <cust:streetDetail>
                                    <cust:buildingName>Taj Mahal Towers</cust:buildingName>
                                    <cust:suiteNumber>16204</cust:suiteNumber>
                                    <cust:addressGeneral>5332 Industrial Blvd</cust:addressGeneral>
                              </cust:streetDetail>
                              <cust:townDetail>
                                    <cust:name>Atlanta</cust:name>
                                    <cust:county>Cobb</cust:county>
                                    <cust:stateOrProvince>Georgia</cust:stateOrProvince>
                                    <cust:country>United States</cust:country>
                              </cust:townDetail>
                              <cust:postalCode>30339</cust:postalCode>
                        </cust:postalAddress>
                        <cust:phone1>
                              <cust:countryCode>1</cust:countryCode>
                              <cust:areaCode>404</cust:areaCode>
                              <cust:cityCode>506</cust:cityCode>
                              <cust:localNumber>9999</cust:localNumber>
                        </cust:phone1>
                        <cust:phone2>
                              <cust:countryCode>1</cust:countryCode>
                              <cust:areaCode>404</cust:areaCode>
                              <cust:cityCode>506</cust:cityCode>
                              <cust:localNumber>9998</cust:localNumber>
                        </cust:phone2>
                        <cust:electronicAddress>
                              <cust:email1>info@greenbuttonalliance.org</cust:email1>
                        </cust:electronicAddress>
                  </cust:Organization>
                  <cust:kind>Green Button Initiative Consulting</cust:kind>
                  <cust:locale>English</cust:locale>
            </cust:Customer>
      </content>
      <published>2017-11-04T04:00:00Z</published>
      <updated>2017-11-04T04:00:00Z</updated>
</entry>

CustomerAccount

The CustomerAccount resource contains information pertaining to the set of services the Retail Customer has agreed to purchase from the Data Custodian through a CustomerAgreement.  This information is used as the basis for billing of Retail Customers and receiving payments.

<entry xmlns:cust="http://naesb.org/espi/customer" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:196a461a-bf84-5430-b4d3-8650c164f111</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/CustomerAccount" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/CustomerAccount/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Customer/1/Customer/1" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Customer/1/CustomerAgreement/" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <cust:Customer>
                  <cust:name>Green Button Alliance</espi:name>
                  <cust:type>Business Customer</cust:type>
                  <cust:createdDateTime>2014-12-10T09:00:00Z</createdDateTime>
                  <cust:lastModifiedDateTime>2014-12-10T09:00:00Z</lastModifiedDateTime>
                  <cust:electronicAddress>
                        <cust:email1>info@greenbuttonalliance.org</cust:email1>
                  </cust:electronicAddress>
                  <cust:billingCycle>5th of each month</cust:billingCycle>
                  <cust:mainAddress>
                        <cust:streetDetail>
                              <cust:buildingName>Taj Mahal Towers</cust:buildingName>
                              <cust:suiteNumber>16204</cust:suiteNumber>
                              <cust:addressGeneral>5332 Industrial Blvd</cust:addressGeneral>
                        </cust:streetDetail>
                        <cust:townDetail>
                              <cust:name>Atlanta</cust:name>
                              <cust:county>Cobb</cust:county>
                              <cust:stateOrProvince>Georgia</cust:stateOrProvince>
                              <cust:country>United States</cust:country>
                        </cust:townDetail>
                        <cust:postalCode>30339</cust:postalCode>
                  </cust:mainAddress>
            </cust:Customer>
      </content>
      <published>2017-11-04T04:00:00Z</published>
      <updated>2017-11-04T04:00:00Z</updated>
</entry>

CustomerAgreement

The CustomerAgreement resource contains information pertaining to the Agreement between the Data Custodian and their customer for the services the Data Custodian will provide at specific service locations.  It documents billing information about the type of service provided at the service location and is used during the billing process to determine the fees to be charged for the type of service provided by the Data Custodian.

<entry xmlns:cust="http://naesb.org/espi/customer" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:2334e84f-1d2b-554e-aaac-4cb0b3a093db</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/CustomerAgreement" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/CustomerAgreement/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/CustomerAccount/1" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ServiceLocation" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ServiceSupplier" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <cust:CustomerAgreement>
                  <cust:name>Green Button Alliance</espi:name>
                  <cust:type>Business Customer</cust:type>
                  <cust:createdDateTime>2014-12-10T09:00:00Z</createdDateTime>
                  <cust:lastModifiedDateTime>2014-12-10T09:00:00Z</lastModifiedDateTime>
                  <cust:electronicAddress>
                        <cust:email1>info@greenbuttonalliance.org</cust:email1>
                  </cust:electronicAddress>
                  <cust:signDate>2014-12-10T10:05:00Z</cust:signDate>
                  <cust:validityInterval>
                        <cust:duration>3153600000</cust:duration>
                        <cust:start>2014-12-13T00:00:00Z</cust:start>
                  <l;/cust:validityInterval>
                  <cust:isPrePay>false</cust:isPrePay>
                  <cust:DemandResponseProgram>
                        <cust:programName>Commercial Energy Efficiency Program<cust:programName>
                        <cust:enrollmentStatus>enrolled<cust:enrollmentStatus>
                        <cust:programDescription>https://www.georgiapower.com/business/energy-efficiency/<cust:programDescription>
                        <cust:programDate>
                              <programDate>2017-10-31T00:00:00Z</cust:programDate>
                              <programDateDescription>Enrollment</cust:programDateDescription>
                        </cust:programDate>
                        <cust:programDate>
                              <cust:programDate>2018-04-01T00:00:00Z</cust:programDate>
                              <cust:programDateDescription>Termination</cust:programDateDescription>
                        </cust:programDate>
                        <cust:capacityReservationLevel>
                              <cust:powerOfTenMultiplier>0</cust:powerOfTenMultiplier>
                              <cust:timeStamp>1506830400</cust:timeStamp>
                              <cust:uom>72</cust:uom>
                              <cust:value>447993</cust:value>
                        </cust:capacityReservationLevel>
                  </cust:DemandResponseProgram>
                  <cust:PricingStructure>https://www.georgiapower.com/docs/rates-schedules/small-business/3.00_GS.pdf</cust:PricingStructure>
            </cust:CustomerAgreement>
      </content>
      <published>2017-11-04T04:00:00Z</published>
      <updated>2017-11-04T04:00:00Z</updated>
</entry>

ServiceLocation

The ServiceLocation resource contains the location physically receiving services from the Data Custodian.  It is a property location commonly referred to as premises.

<entry xmlns:cust="http://naesb.org/espi/customer" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:9fb4aa0d-29a3-5112-8fe2-c3edf31d4e50</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ServiceLocation" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ServiceLocation/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/CustomerAgreement/1" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/EndDevice" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Meter" rel="related"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <cust:ServiceLocation>
                  <cust:name>Green Button Alliance</cust:name>
                  <cust:type>Business Customer</cust:type>
                  <cust:mainAddress>
                        <cust:streetDetail>
                              <cust:buildingName>Taj Mahal Towers</cust:buildingName>
                              <cust:suiteNumber>16204</cust:suiteNumber>
                              <cust:addressGeneral>5332 Industrial Blvd</cust:addressGeneral>
                        </cust:streetDetail>
                        <cust:townDetail>
                              <cust:name>Atlanta</cust:name>
                              <cust:county>Cobb</cust:county>
                              <cust:stateOrProvince>Georgia</cust:stateOrProvince>
                              <cust:country>United States</cust:country>
                        </cust:townDetail>
                        <cust:postalCode>30339</cust:postalCode>
                  </cust:mainAddress>
                  <cust:secondaryAddress>
                        <cust:streetDetail>
                              <cust:buildingName>Taj Mahal Towers</cust:buildingName>
                              <cust:suiteNumber>16204</cust:suiteNumber>
                              <cust:addressGeneral>5332 Industrial Blvd</cust:addressGeneral>
                        </cust:streetDetail>
                        <cust:townDetail>
                              <cust:name>Atlanta</cust:name>
                              <cust:county>Cobb</cust:county>
                              <cust:stateOrProvince>Georgia</cust:stateOrProvince>
                              <cust:country>United States</cust:country>
                        </cust:townDetail>
                        <cust:postalCode>30339</cust:postalCode>
                  </cust:secondaryAddress>
                  <cust:phone1>
                        <cust:countryCode>1</cust:countryCode>
                        <cust:areaCode>404</cust:areaCode>
                        <cust:cityCode>506</cust:cityCode>
                        <cust:localNumber>9999</cust:localNumber>
                  </cust:phone1>
                  <cust:phone2>
                        <cust:countryCode>1</cust:countryCode>
                        <cust:areaCode>404</cust:areaCode>
                        <cust:cityCode>506</cust:cityCode>
                        <cust:localNumber>9998</cust:localNumber>
                  </cust:phone2>
                  <cust:electronicAddress>
                        <cust:email1>info@greenbuttonalliance.org</cust:email1>
                  </cust:electronicAddress>
                  <cust:direction>In the NW corner of the 3rd floor in the Meter closet</cust:direction>
                  <cust:status>
                        <cust:value>Disconnected</cust:value>
                        <cust:dateTime>2017-09-15T00:00:00Z</cust:dateTime>
                        <cust:reason>Electrical Service being relocated on floor</cust:reason>
                  </cust:status>
                  <cust:accessMethod>See guard at Vendor Gate</cust:accessMethod>
                  <cust:needsInspection>true</cust:needsInspection>
                  <cust:UsagePoints>
                        <cust:UsagePoint>https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/UsagePoint/1</cust:UsagePoint>
                        <cust:UsagePoint>https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/UsagePoint/101</cust:UsagePoint>
                        <cust:UsagePoint>https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/UsagePoint/301</cust:UsagePoint>
                  </cust:UsagePoint>
                  <cust:outageBlock>A2</cust:outageBlock>
            </cust:ServiceLocation>
      </content>
      <published>2017-11-04T04:00:00Z</published>
      <updated>2017-11-04T04:00:00Z</updated>
</entry>
ServiceSupplier
<entry xmlns:cust="http://naesb.org/espi/customer" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:628716ed-4e82-5d21-bf0e-a1386503a171</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ServiceSupplier" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/ServiceSupplier/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <cust:ServiceSupplier>
                  <cust:Organization>
                        <cust:name>Georgia Power Company</cust:name>
                        <cust:streetAddress>
                              <cust:streetDetail>
                                    <cust:buildingName>Georgia Power Company Building</cust:buildingName>
                                    <cust:suiteNumber>16204</cust:suiteNumber>
                                    <cust:addressGeneral>241 Ralph McGill Boulevard</cust:addressGeneral>
                              </cust:streetDetail>
                              <cust:townDetail>
                                    <cust:name>Atlanta</cust:name>
                                    <cust:county>Fulton</cust:county>
                                    <cust:stateOrProvince>Georgia</cust:stateOrProvince>
                                    <cust:country>United States</cust:country>
                              </cust:townDetail>
                              <cust:postalCode>30308</cust:postalCode>
                        </cust:streetAddress>
                        <cust:postalAddress>
                              <cust:streetDetail>
                                    <cust:buildingName>Georgia Power Company Building</cust:buildingName>
                                    <cust:suiteNumber>16204</cust:suiteNumber>
                                    <cust:addressGeneral>241 Ralph McGill Boulevard</cust:addressGeneral>
                              </cust:streetDetail>
                              <cust:townDetail>
                                    <cust:name>Atlanta</cust:name>
                                    <cust:county>Fulton</cust:county>
                                    <cust:stateOrProvince>Georgia</cust:stateOrProvince>
                                    <cust:country>United States</cust:country>
                              </cust:townDetail>
                              <cust:postalCode>30308</cust:postalCode>
                        </cust:postalAddress>
                        <cust:phone1>
                              <cust:countryCode>1</cust:countryCode>
                              <cust:areaCode>404</cust:areaCode>
                              <cust:cityCode>506</cust:cityCode>
                              <cust:localNumber>6526</cust:localNumber>
                        </cust:phone1>
                        <cust:phone2>
                              <cust:countryCode>1</cust:countryCode>
                              <cust:areaCode>404</cust:areaCode>
                              <cust:cityCode>506</cust:cityCode>
                              <cust:localNumber>6528</cust:localNumber>
                        </cust:phone2>
                        <cust:electronicAddress>
                              <cust:email1>accounting@georgiapower.com</cust:email1>
                        </cust:electronicAddress>
                  </cust:Organization>
                  <cust:kind>energyServiceSupplier</cust:kind>
                  <cust:effectiveDate>2017-12-13T00:00:00Z</cust:effectiveDate>
            </cust:ServiceSupplier>
      </content>
      <published>2017-11-04T04:00:00Z</published>
      <updated>2017-11-04T04:00:00Z</updated>
</entry>

EndDevice

The EndDevice resource represents a generic class of devices that can perform many functions.  One type of End Device is a meter which can perform metering, load management, connect/disconnect, accounting functions, etc.  Some End Devices, such as ones monitoring and controlling air conditioners, refrigerators, or pool pumps may be connected to a meter.  All End Devices may have communication capability defined by the associated communication function(s).  An End Device can be owned by a consumer, a service provider, or utility.  

<entry xmlns:cust="http://naesb.org/espi/customer" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:827f8029-7fec-5b08-95cb-7296712260a2</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/EndDevice" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/EndDevice/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <cust:EndDevice>
                  <cust:name>Georgia Power Company</cust:name>
                  <cust:utcNumber>907-V2150-01</cust:utcNumber>
                  <cust:serialNumber>00000016</cust:serialNumber>
                  <cust:lotNumber>CZ-20171011-105</cust:lotNumber>
                  <cust:purchasePrice>48.75</cust:purchasePrice>
                  <cust:critical>false</cust:critical>
                  <cust:electronicAddress>
                        <cust:mac>30-E7-7Z-53-Y6-A0</cust:mac>
                  </cust:electronicAddress>
                  <cust:lifecycle>
                        <cust:manufacturedDate>2017-09-15T00:00:00</cust:manufacturedDate>
                        <cust:purchaseDate>2017-08-01T00:00:00</cust:purchaseDate>
                        <cust:receivedDate>2017-10-15T00:00:00</cust:receivedDate>
                        <cust:installationDate>2017-11-04T00:00:00</cust:installationDate>
                  </cust:lifecycle>
                  <cust:acceptanceTest>
                        <cust:type>24 Hour Burn</cust:type>
                        <cust:success>true>/cust:success>
                        <cust:dateTime>2017-10-17T00:00:00</cust:dateTime>
                  </cust:acceptanceTest>
                  <cust:initialCondition>new</cust:initialCondition>
                  <cust:status>
                        <cust:value>Installed</cust:value;
                        <cust:dateTime>2017-11-04T00:00:00</cust:dateTime>
                  </cust:status>
                  </cust:isVirtual>false</cust:isVirtual>
                  </cust:isPan>false</cust:isPan>
            </cust:EndDevice>
      </content>
      <published>2017-11-04T04:00:00Z</published>
      <updated>2017-11-04T04:00:00Z</updated>
</entry>

Meter

The Meter is the physical asset that performs the metering role for the UsagePoint.  It is used to measure consumption and detection of events.

<entry xmlns:cust="http://naesb.org/espi/customer" xmlns="http://www.w3.org/2005/Atom">
      <id>urn:uuid:4f5d33e6-3eab-5d09-9c81-0f3b9b53bc5d</id>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Meter" rel="up"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/Meter/1" rel="self"/>
      <link href="https://sandbox.greenbuttonalliance.org:8443/DataCustodian/espi/1_1/resource/LocalTimeParameters/1" rel="related"/>
      <title>Green Button Sample Data File</title>
      <content>
            <cust:Meter>
                  <cust:name>Georgia Power Company</cust:name>
                  <cust:utcNumber>E351-AXe-SD</cust:utcNumber>
                  <cust:serialNumber>02542378</cust:serialNumber>
                  <cust:lotNumber>CZ-20171011-210</cust:lotNumber>
                  <cust:purchasePrice>73.15</cust:purchasePrice>
                  <cust:critical>false</cust:critical>
                  <cust:electronicAddress>
                        <cust:mac>30-F6-9G-53-W6-A0</cust:mac>
                  </cust:electronicAddress>
                  <cust:lifecycle>
                        <cust:manufacturedDate>2017-09-15T00:00:00</cust:manufacturedDate>
                        <cust:purchaseDate>2017-08-01T00:00:00</cust:purchaseDate>
                        <cust:receivedDate>2017-10-15T00:00:00</cust:receivedDate>
                        <cust:installationDate>2017-11-04T00:00:00</cust:installationDate>
                  </cust:lifecycle>
                  <cust:acceptanceTest>
                        <cust:type>24 Hour Burn</cust:type>
                        <cust:success>true>/cust:success>
                        <cust:dateTime>2017-10-17T00:00:00</cust:dateTime>
                  </cust:acceptanceTest>
                  <cust:initialCondition>new</cust:initialCondition>
                  <cust:status>
                        <cust:value>Installed</cust:value;
                        <cust:dateTime>2017-11-04T00:00:00</cust:dateTime>
                  </cust:status>
                  </cust:isVirtual>false</cust:isVirtual>
                  </cust:isPan>false</cust:isPan>
                  <cust:formNumber>S25</cust:formNumber>
                  <cust:MeterMultipliers>
                        <cust:kind>ptRatio</cust:kind>
                        <cust:value>3.141590118408203125</cust:value>                        
                  </cust:MeterMultipliers>
                  <cust:intervalLength>900</cust:intervalLength>
            </cust:Meter>
      </content>
      <published>2017-11-04T04:00:00Z</published>
      <updated>2017-11-04T04:00:00Z</updated>
</entry>