Difference between revisions of "EfficientMetering/APIProposalv1"
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
Notes: | Notes: | ||
− | * All results are provided JSON or | + | * All results are provided JSON or XML format. |
* [] denotes optional information | * [] denotes optional information | ||
− | * date_time is assumed to use ISO format | + | * date_time is assumed to use ISO format and to use UTC |
* [start_time and end_time] are optional date_times for most of the request. It has previously been agreed that the range is exclusive for start and inclusive for end. | * [start_time and end_time] are optional date_times for most of the request. It has previously been agreed that the range is exclusive for start and inclusive for end. | ||
Revision as of 16:40, 17 May 2012
Notes:
- All results are provided JSON or XML format.
- [] denotes optional information
- date_time is assumed to use ISO format and to use UTC
- [start_time and end_time] are optional date_times for most of the request. It has previously been agreed that the range is exclusive for start and inclusive for end.
Verb | URL | Parameters |
GET | v1 | - |
GET | v1/EXTENSIONS | - |
GET | v1/EXTENSIONS/<ALIAS> | - |
GET | v1/SOURCES | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]LIST | - |
GET | v1/[SOURCES/<SOURCE>/]LIST/COMPONENTS | - |
GET | v1/[SOURCES/<SOURCE>/]LIST/<COMPONENT>/METERS | - |
GET | v1/[SOURCES/<SOURCE>/]LIST/METERS | - |
GET | v1/[SOURCES/<SOURCE>/]LIST/RESOURCES | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID> | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER> | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER>/VOLUME | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/<METER>/DURATION | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/ | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER> | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER>/VOLUME | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]USERS/<USER_ID>/RESOURCES/<RESOURCE_ID>/<METER>/DURATION | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID> | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER> | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER>/VOLUME | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/<METER>/DURATION | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/ | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER> | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER>/VOLUME | [start_time and end_time] |
GET | v1/[SOURCES/<SOURCE>/]PROJECTS/<PROJECT_ID>/RESOURCES/<RESOURCE_ID>/<METER>/DURATION | [start_time and end_time] |