Code Monkey home page Code Monkey logo

openespi-greenbutton-api-documentation's Introduction

Green Button API Documentation

====================

A repository for the Green Button API Documentation. This documentation is intended to serve as a developers guide to implementing Green Button applications.

The Green Button API Documentation is served directly from the gh_pages branch of the repository using the following:

Developers Guide:

http://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/

API documentation:

http://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API/

openespi-greenbutton-api-documentation's People

Contributors

dfcoffin avatar jateeter avatar martyburns avatar snyk-bot avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

openespi-greenbutton-api-documentation's Issues

Consistency in access_token names

There is an inconsistency in the way we speak about the (6) various access_tokens. The GreenButtonAuthorization.docx defines these and we should stick with these names in all cases.

access_token: allocated by datacustodian for individual account authorizations
refresh_token: allocated at the time of authoriztion and used to renew an access_token
datacustodian_access_token: access token used by trusted administrative accounts
client_access_token: used by thirdparty applications to access bulk or multiple authorization subscriptions
upload_access_token: used by MeterDataManagement (backend) systems to upload/import data into a datacustodian
registration_access_token: reserved for future use in dynamic registration patterns

API sandbox not returning any data

None of the API calls in the sandbox seem to be working since the past few days. I am testing using the Data Custodian token and here is a sample output from one of the calls. I've also tried the batch API with subscription ID and I get the same response. Can someone please take a look and provide a resolution?We are building a sample app based on this and are presently blocked.

Request URL
https://services.greenbuttondata.org:443/DataCustodian/espi/1_1/resource/ApplicationInformation?published-max=All&published-min=All&updated-max=All&updated-min=All&max-results=All&start-index=1&depth=All

Response Body
no content
Response Code
0
Response Headers
{}

Thanks,
Rashmi

No Authorization found.

I am using the GreenButtonData API sandbox and trying to authorize using datacustodian_access_token(Bearer 2a85f4bd-30db-4b7d-8f41-b046b0566cb3) but I am getting "No Authorization Found" error.

Response body:

<error_description>No Authorization Found</error_description>
access_denied

Am I missing something here?

Requests made w/o a proper access token return 401 rather than 403

All unauthorized status codes returned by Spring security are 401 - UnAuthorized.

The documentation indicates a 403 - Forbidden should be returned. Which is right?

(I'm thinking all the 403's should be changed to 401's and that the ESPI documentation, if any, should indicate a 401 be returned)

ElectricPowerUsageSummary for a specific Subscription/UsagePoint combination returns multiple usage points

I am using the GreenButtonData API sandbox and testing the ElectricPowerUsageSummary for user Alan (subscription ID = 5) with the access token for Alan (Bearer c59f88ed-26fb-4650-b07e-d5a031bfeb63).

When calling the ElectricPowerUsageSummary using the following API call, I see all UsagePoints 1 - 12 returned for Subscription 5.

Here is the API call:
https://services.greenbuttondata.org:443/DataCustodian/espi/1_1/resource/Subscription/5/UsagePoint/1/ElectricPowerUsageSummary?published-max=All&published-min=All&updated-max=All&updated-min=All&max-results=All&start-index=1&depth=All

Shouldn't this data be limited only to UsagePoint 1 given Subscription 5 has only 1 UsagePoint? Even if it had multiple usage points, the fact that I have asked for only UsagePoint 1 should be honored?

Sample Access token not working

Hello, I am attempting developing an API connection using the green button this API documentation. However, all of the API tokens dont work when trying them out in this application.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.