### GET /espi/1_1/resource/Batch/Subscription/{subscriptionId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Requests a Greenbutton Subscription from a Data Custodian.
```APIDOC
## GET /espi/1_1/resource/Batch/Subscription/{subscriptionId}
### Description
Requests a Greenbutton Subscription from a Data Custodian.
### Method
GET
### Endpoint
/espi/1_1/resource/Batch/Subscription/{subscriptionId}
### Parameters
#### Path Parameters
- **subscriptionId** (string) - Required - The ID of the subscription to retrieve.
### Response
(Response details not provided in the input text)
```
--------------------------------
### GET /management
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Resets the sandbox database to a known state, including preconfigured UsagePoints, access tokens, and authorizations.
```APIDOC
## GET /management
### Description
Resets the sandbox database to a known state, including preconfigured UsagePoints, access tokens, and authorizations. This is useful for restoring the sandbox after data corruption or extensive testing.
### Method
GET
### Endpoint
/management
### Parameters
#### Query Parameters
- **command** (String) - Required - The Data Custodian management command to be issued (e.g., 'reset')
### Response
#### Success Response (200, 202)
- **Response Body** (object) - Indicates the status of the reset operation.
#### Response Example
```json
{
"example": "response body"
}
```
```
--------------------------------
### GET /espi/1_1/resource/Batch/Bulk/{bulkId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Requests a Bulk transfer from a Data Custodian.
```APIDOC
## GET /espi/1_1/resource/Batch/Bulk/{bulkId}
### Description
Requests a Bulk transfer from a Data Custodian.
### Method
GET
### Endpoint
/espi/1_1/resource/Batch/Bulk/{bulkId}
### Parameters
#### Path Parameters
- **bulkId** (String) - Required - The Bulk Id as specified in the OAuth2 SCOPE string.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Bulk request.
- **published-min** (Date) - Optional - The lower bound on the published date of the Bulk request.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Bulk request.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Bulk request.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply to this response.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Bulk request that should be transferred as the first entry of this request.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response to this request.
### Response
#### Success Response (200)
OK
#### Success Response (202)
Accepted
#### Error Response (400)
Bad Request
#### Error Response (403)
Forbidden
```
--------------------------------
### GET /espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Downloads a Green Button XML file containing a specific UsagePoint for a given RetailCustomer. Supports filtering by publication and update dates, as well as pagination.
```APIDOC
## GET /espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint
### Description
Download a Green Button XML file containing a specific UsagePoint for this RetailCustomer.
### Method
GET
### Endpoint
/espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint
### Parameters
#### Path Parameters
- **retailCustomerId** (String) - Required - The Retail Customer's Id
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Green Button XML file request.
- **published-min** (Date) - Optional - The lower bound on the published date of the Green Button XML file request.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Green Button XML file request.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Green Button XML file request.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply to this response.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Green Button XML file request that should be transferred as the first entry of this request.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response to this request.
### Response
#### Success Response (200)
- The response will contain a Green Button XML file.
#### Error Response
- **400** Bad Request
- **403** Forbidden
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves all Electric Power Usage Summaries for a given Usage Point within a Subscription. Returns an XML representation.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary
### Description
Retrieves all Electric Power Usage Summaries for a given Usage Point within a Subscription. Returns an XML representation.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (string) - Required - Id of the Usage Point the Electric Power Usage Summary references.
### Response
#### Success Response (200)
- **Response Body**: An XML representation of all Electric Power Usage Summaries.
```
--------------------------------
### GET /espi/1_1/resource/Batch/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Requests a Greenbutton Subscription from a DataCustodian for a specific UsagePoint. This endpoint is used to retrieve subscription details.
```APIDOC
## GET /espi/1_1/resource/Batch/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
### Description
Request a Greenbutton Subscription from a DataCustodian for a specific UsagePoint.
### Method
GET
### Endpoint
/espi/1_1/resource/Batch/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (String) - Required - The Usage Point's Id
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Subscription.
- **published-min** (Date) - Optional - The lower bound on the published date of the Subscription.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Subscription.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Subscription.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply to this response.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Subscriptions that should be transferred as the first entry of this request.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response to this request.
### Response
#### Success Response (200)
- The response will contain details of the requested Greenbutton Subscription.
#### Error Response
- **400** Bad Request
- **403** Forbidden
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Electric Power Quality Summary for a given Usage Point within a Subscription. Supports filtering by publication and update dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}
### Description
Retrieves a specific Electric Power Quality Summary for a given Usage Point within a Subscription. Supports filtering by publication and update dates, and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (string) - Required - Id of the Usage Point the Electric Power Quality Summary references.
- **electricPowerQualitySummaryId** (string) - Required - Id of the Electric Power Quality Summary to be retrieved.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the referenced resource
- **published-min** (Date) - Optional - The lower bound on the published date of the referenced resource
- **updated-max** (Date) - Optional - The upper bound on the updated date of the referenced resource
- **updated-min** (Date) - Optional - The lower bound on the updated date of the referenced resource
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply to this response
- **start-index** (long) - Optional - The one based offset in the Data Custodian's collection of referenced resources that should be transferred as the first entry of this request.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response to this request
### Response
#### Success Response (200)
- **Response Body**: (Empty in the provided documentation, typically contains the Electric Power Quality Summary data)
#### Error Responses
- **400 Bad Request**
- **403 Forbidden**
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves all Electric Power Quality Summaries for a given subscription and usage point. Supports filtering by publication and update dates, as well as pagination.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary
### Description
Retrieve all Electric Power Quality Summaries for a given subscription and usage point. This endpoint allows for filtering by publication and update dates, and includes parameters for pagination and result limits.
### Method
GET
### Endpoint
`/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary`
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (String) - Required - The UsagePoint's Id
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Subscription.
- **published-min** (Date) - Optional - The lower bound on the published date of the Subscription.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Subscription.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Subscription.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply to this response.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Subscriptions that should be transferred as the first entry of this request.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response to this request.
### Response
#### Success Response (200)
- **Response Body** (XML) - An XML representation of all Electric Power Quality Summaries.
#### Error Responses
- **400** - Bad Request
- **403** - Forbidden
### Implementation Notes
To provide the required Bearer access token in the HTTP Authorization header, enter the **"data_custodian_access_token"** or **"access_token"** in the appropriate field at the top of this web page!
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Electric Power Quality Summary using its unique ID, associated with a given subscription and usage point.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}
### Description
Retrieves a specific Electric Power Quality Summary using its unique identifier. This endpoint requires the subscription ID, usage point ID, and the specific Electric Power Quality Summary ID.
### Method
GET
### Endpoint
`/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}`
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (String) - Required - Id of the UsagePoint the Electric Power Quality Summary references.
- **electricPowerQualitySummaryId** (String) - Required - The Id of the Electric Power Quality Summary to retrieve.
### Response
#### Success Response (200)
- **Response Body** (XML) - An XML representation of the requested Electric Power Quality Summary.
#### Error Responses
- **400** - Bad Request
- **403** - Forbidden
### Implementation Notes
Returns a Electric Power Quality Summary. To provide the required Bearer access token in the HTTP Authorization header, enter the **"data_custodian_access_token"** or **"access_token"** in the appropriate field at the top of this web page!
```
--------------------------------
### GET /espi/1_1/resource/IntervalBlock/{intervalBlockId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Interval Block using its ID. Requires a Bearer access token.
```APIDOC
## GET /espi/1_1/resource/IntervalBlock/{intervalBlockId}
### Description
Retrieves an Interval Block using its Id.
### Method
GET
### Endpoint
/espi/1_1/resource/IntervalBlock/{intervalBlockId}
### Parameters
#### Path Parameters
- **intervalBlockId** (string) - Required - The ID of the Interval Block to retrieve.
### Response
#### Success Response (200)
OK
#### Error Responses
- **400** - Bad Request
- **403** - Forbidden
```
--------------------------------
### Usage Point API - Get by ID
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Usage Point using its unique identifier. Supports filtering and pagination.
```APIDOC
## GET /espi/1_1/resource/UsagePoint/{usagePointId}
### Description
Retrieve a Usage Point Using its Id.
### Method
GET
### Endpoint
/espi/1_1/resource/UsagePoint/{usagePointId}
### Parameters
#### Path Parameters
- **usagePointId** (string) - Required - Id of the Usage Point.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Usage Point.
- **published-min** (Date) - Optional - The lower bound on the published date of the Usage Point.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Usage Point.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Usage Point.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of referenced resources that should be transferred as the first entry of this response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Request Example
None
### Response
#### Success Response (200)
- **UsagePoint** (string) - An XML representation of the Usage Point.
#### Response Example
```xml
...
...
...
...
...
```
```
--------------------------------
### GET /espi/1_1/resource/Authorization
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a list of all Data Custodian Authorizations. Supports filtering by publication and update dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/Authorization
### Description
Retrieves a list of all Data Custodian Authorizations. Supports filtering by publication and update dates, and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/Authorization
### Parameters
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Authorization.
- **published-min** (Date) - Optional - The lower bound on the published date of the Authorization.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Authorization.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Authorization.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply to this response.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Authorizations that should be transferred as the first entry of this request.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response to this request.
### Response
#### Success Response (200)
- **Success** - OK
#### Success Response (202)
- **Success** - Accepted
#### Error Response (400)
- **Error** - Bad Request
#### Error Response (403)
- **Error** - Forbidden
```
--------------------------------
### GET /espi/1_1/resource/IntervalBlock
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves all Interval Blocks. Supports filtering by publication and update dates, and pagination. Requires a Bearer access token.
```APIDOC
## GET /espi/1_1/resource/IntervalBlock
### Description
Retrieves all Interval Blocks. An XML representation of all Interval Blocks will be returned.
### Method
GET
### Endpoint
/espi/1_1/resource/IntervalBlock
### Parameters
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Interval Block.
- **published-min** (Date) - Optional - The lower bound on the published date of the Interval Block.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Interval Block.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Interval Block.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Interval Blocks that should be transferred as the first entry of the response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Response
#### Success Response (200)
OK
#### Accepted Response (202)
Accepted
#### Error Responses
- **400** - Bad Request
- **403** - Forbidden
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary/{electricPowerUsageSummaryId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Electric Power Usage Summary by its ID for a given Usage Point and Subscription. Supports filtering by publication and update dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary/{electricPowerUsageSummaryId}
### Description
Retrieves a specific Electric Power Usage Summary by its ID for a given Usage Point and Subscription. Supports filtering by publication and update dates, and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary/{electricPowerUsageSummaryId}
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (string) - Required - Id of the UsagePoint the Electric Power Usage Summary references.
- **electricPowerUsageSummaryId** (string) - Required - Id of the Electric Power Usage Summary to be retrieved.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the referenced resource
- **published-min** (Date) - Optional - The lower bound on the published date of the referenced resource
- **updated-max** (Date) - Optional - The upper bound on the updated date of the referenced resource
- **updated-min** (Date) - Optional - The lower bound on the updated date of the referenced resource
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply to this response
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of referenced resources that should be transferred as the first entry of this request.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response to this request
### Response
#### Success Response (200)
- **Response Body**: OK
#### Response Example
(No specific response body example provided in the source)
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a list of Electric Power Usage Summaries for a given Usage Point within a Subscription. Supports filtering by publication and update dates, as well as pagination.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary
### Description
Retrieves a list of Electric Power Usage Summaries for a given Usage Point within a Subscription. Supports filtering by publication and update dates, as well as pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerUsageSummary
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (string) - Required - Id of the UsagePoint the Electric Power Usage Summary references.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the referenced resource
- **published-min** (Date) - Optional - The lower bound on the published date of the referenced resource
- **updated-max** (Date) - Optional - The upper bound on the updated date of the referenced resource
- **updated-min** (Date) - Optional - The lower bound on the updated date of the referenced resource
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply to this response
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of referenced resources that should be transferred as the first entry of this request.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response to this request
### Response
#### Success Response (200)
- **Response Body**: OK
#### Response Example
(No specific response body example provided in the source)
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}/IntervalBlock
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves all Interval Blocks associated with a specific Meter Reading. Supports filtering and pagination.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}/IntervalBlock
### Description
Retrieves all Interval Blocks associated with a specific Meter Reading. Supports filtering and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}/IntervalBlock
### Parameters
#### Path Parameters
- **subscriptionId** (string) - Required - Id of the Retail Customer the Interval Block references.
- **usagePointId** (string) - Required - Id of the UsagePoint the Interval Block references.
- **meterReadingId** (string) - Required - Id of the MeterReading the Interval Block references.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Interval Block.
- **published-min** (Date) - Optional - The lower bound on the published date of the Interval Block.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Interval Block.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Interval Block.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Interval Blocks that should be transferred as the first entry of the response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Response
#### Success Response (200)
- An XML representation of all Interval Blocks will be returned.
#### Response Example
```json
{
"example": "XML representation of Interval Blocks"
}
```
```
--------------------------------
### GET /espi/1_1/resource/MeterReading
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a list of all Meter Readings within the Data Custodian. Supports filtering by publication and update dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/MeterReading
### Description
Retrieves all Meter Readings within the Data Custodian. An XML representation of all MeterReadingss will be returned. Requires a Bearer access token.
### Method
GET
### Endpoint
/espi/1_1/resource/MeterReading
### Parameters
#### Path Parameters
None
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Meter Reading.
- **published-min** (Date) - Optional - The lower bound on the published date of the Meter Reading.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Meter Reading.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Meter Reading.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one-based offset in the Data Custodian's collection of Meter Readings that should be transferred as the first entry of the response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
#### Request Body
None
### Request Example
None
### Response
#### Success Response (200)
OK - Returns an XML representation of Meter Readings.
#### Success Response (202)
Accepted
#### Error Response
- **400** Bad Request
- **403** Forbidden
#### Response Example
None
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves information about a specific Usage Point within a subscription. Supports filtering by publication and update dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
### Description
Retrieves information about a specific Usage Point within a subscription. Supports filtering by publication and update dates, and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (string) - Required - Id of the Usage Point
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Usage Point
- **published-min** (Date) - Optional - The lower bound on the published date of the Usage Point
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Usage Point
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Usage Point
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply
- **start-index** (long) - Optional - The one based offset in the Data Custodian's collection of referenced resources that should be transferred as the first entry of this response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response
### Response
#### Success Response (200)
- **Response Body** (object) - Contains the Usage Point data.
#### Response Example
```json
{
"example": "response body"
}
```
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves all Meter Readings associated with a given Usage Point within a Subscription. Supports filtering and pagination.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading
### Description
Retrieves all Meter Readings associated with a given Usage Point within a Subscription. Supports filtering and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading
### Parameters
#### Path Parameters
- **subscriptionId** (string) - Required - Id of the Subscription associated with the Usage Point containing the Meter Reading.
- **usagePointId** (string) - Required - Id of the UsagePoint the Meter Reading references.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Meter Reading.
- **published-min** (Date) - Optional - The lower bound on the published date of the Meter Reading.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Meter Reading.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Meter Reading.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Meter Readings that should be transferred as the first entry of the response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Response
#### Success Response (200)
- **(Response Model)** - OK
#### Error Response
- **(Response Model)** - Bad Request
- **(Response Model)** - Forbidden
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Usage Point by its ID within a Subscription. A Bearer access token is required.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
### Description
Retrieves a specific Usage Point by its ID within a Subscription. A Bearer access token is required.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (string) - Required - The Usage Point's Id
### Response
#### Success Response (200)
- **Response**: OK
#### Error Response (400)
- **Response**: Bad Request
#### Error Response (403)
- **Response**: Forbidden
```
--------------------------------
### GET /espi/1_1/resource/MeterReading/{meterReadingId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Meter Reading using its unique Meter Reading ID. Requires a Bearer access token.
```APIDOC
## GET /espi/1_1/resource/MeterReading/{meterReadingId}
### Description
Retrieves a Meter Reading using its Meter Reading Id. Requires a Bearer access token.
### Method
GET
### Endpoint
/espi/1_1/resource/MeterReading/{meterReadingId}
### Parameters
#### Path Parameters
- **meterReadingId** (string) - Required - The ID of the Meter Reading to retrieve.
#### Query Parameters
None
#### Request Body
None
### Request Example
None
### Response
#### Success Response (200)
OK - Returns the requested Meter Reading.
#### Error Response
- **400** Bad Request
- **403** Forbidden
#### Response Example
None
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves all Usage Points associated with a given Subscription ID. Supports filtering by date and pagination. A Bearer access token is required.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint
### Description
Retrieves all Usage Points associated with a given Subscription ID. Supports filtering by date and pagination. A Bearer access token is required.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Usage Point.
- **published-min** (Date) - Optional - The lower bound on the published date of the Usage Point.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Usage Point.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Usage Point.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of referenced resources that should be transferred as the first entry of this response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Response
#### Success Response (200)
- **Response**: OK
#### Success Response (202)
- **Response**: Accepted
#### Error Response (400)
- **Response**: Bad Request
#### Error Response (403)
- **Response**: Forbidden
```
--------------------------------
### GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Meter Reading for a Usage Point using its Meter Reading ID. Supports filtering by publication and update dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}
### Description
Retrieves a specific Meter Reading for a Usage Point using its Meter Reading ID. Supports filtering by publication and update dates, and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/MeterReading/{meterReadingId}
### Parameters
#### Path Parameters
- **subscriptionId** (string) - Required - Id of the Subscription associated with the Usage Point containing the Meter Reading.
- **usagePointId** (string) - Required - Id of the UsagePoint the Meter Reading references.
- **meterReadingId** (string) - Required - Id of the Meter Reading.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Meter Reading.
- **published-min** (Date) - Optional - The lower bound on the published date of the Meter Reading.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Meter Reading.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Meter Reading.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Meter Readings that should be transferred as the first entry of the response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Response
#### Success Responses
- **200** OK
- **202** Accepted
#### Error Responses
- **400** Bad Request
- **403** Forbidden
```
--------------------------------
### POST /espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Uploads a Green Button XML file for a specific RetailCustomer. Requires the retailCustomerId as a path parameter and the XML file content in the request body.
```APIDOC
## POST /espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint
### Description
Upload a Green Button XML file.
### Method
POST
### Endpoint
/espi/1_1/resource/Batch/RetailCustomer/{retailCustomerId}/UsagePoint
### Parameters
#### Path Parameters
- **retailCustomerId** (String) - Required - The Retail Customer's Id
#### Request Body
- **xmlFile** (string) - Required - Contents of the file being uploaded (Content-Type: application/xml)
### Response
#### Success Response (201)
- Indicates successful creation of the resource.
#### Error Response
- **400** Bad Request
- **403** Forbidden
```
--------------------------------
### GET /espi/1_1/resource/ReadingType
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a list of all Reading Types. Supports filtering by publication and update dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/ReadingType
### Description
Finds all Reading Types. An XML representation of all Reading Types will be returned.
### Method
GET
### Endpoint
/espi/1_1/resource/ReadingType
### Parameters
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Reading Type.
- **published-min** (Date) - Optional - The lower bound on the published date of the Reading Type.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Reading Type.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Reading Type.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Reading Types that should be transferred as the first entry of the response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Response
#### Success Response (200)
- **ReadingType** (XML) - An XML representation of all Reading Types.
#### Error Response
- **400** - Bad Request
- **403** - Forbidden
```
--------------------------------
### Usage Point API - Create
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Adds a new Usage Point to the system. Requires Usage Point data in XML format.
```APIDOC
## POST /espi/1_1/resource/UsagePoint/
### Description
Add a new Usage Point.
### Method
POST
### Endpoint
/espi/1_1/resource/UsagePoint/
### Parameters
#### Request Body
- **usagePointData** (string) - Required - 1 or more Usage Points to be added (Content-Type: application/atom+xml).
### Request Example
```xml
Electric
electricity
```
### Response
#### Success Response (201)
- **Location** (string) - URL to the newly created Usage Point.
#### Response Example
```json
{
"Location": "/espi/1_1/resource/UsagePoint/{newUsagePointId}"
}
```
```
--------------------------------
### PUT /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Updates an existing Electric Power Quality Summary for a given Usage Point within a Subscription. Requires the Electric Power Quality Summary to exist.
```APIDOC
## PUT /espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}
### Description
Updates an existing Electric Power Quality Summary for a given Usage Point within a Subscription. Requires the Electric Power Quality Summary to exist.
### Method
PUT
### Endpoint
/espi/1_1/resource/Subscription/{subscriptionId}/UsagePoint/{usagePointId}/ElectricPowerQualitySummary/{electricPowerQualitySummaryId}
### Parameters
#### Path Parameters
- **subscriptionId** (String) - Required - The Subscription's Id
- **usagePointId** (string) - Required - Id of the UsagePoint the Electric Power Quality Summary references.
- **electricPowerQualitySummaryId** (string) - Required - Id of the Electric Power Quality Summary to be updated.
#### Request Body
- **electricPowerQualitySummaryData** (string) - Required - Id of the Electric Power Quality Summary data. Content type: application/atom+xml
### Response
#### Success Response (200)
- **Response Body**: (Empty in the provided documentation)
#### Success Response (201)
- **Response Body**: (Empty in the provided documentation)
#### Error Responses
- **400 Bad Request**
- **403 Forbidden**
```
--------------------------------
### GET /espi/1_1/resource/IntervalBlock/{intervalBlockId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Interval Block by its ID. Supports filtering by published and updated dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/IntervalBlock/{intervalBlockId}
### Description
Retrieves a specific Interval Block by its ID. Supports filtering by published and updated dates, and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/IntervalBlock/{intervalBlockId}
### Parameters
#### Path Parameters
- **intervalBlockId** (string) - Required - Id of the Interval Block to be retrieved.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Interval Block.
- **published-min** (Date) - Optional - The lower bound on the published date of the Interval Block.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Interval Block.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Interval Block.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Interval Blocks that should be transferred as the first entry of the response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Response
#### Success Response (200)
- The response will contain the requested Interval Block data.
#### Response Example
```json
{
"example": "Interval Block data"
}
```
```
--------------------------------
### GET /espi/1_1/resource/ReadingType/{readingTypeId}
Source: https://greenbuttonalliance.github.io/OpenESPI-GreenButton-API-Documentation/API
Retrieves a specific Reading Type by its ID. Supports filtering by publication and update dates, and pagination.
```APIDOC
## GET /espi/1_1/resource/ReadingType/{readingTypeId}
### Description
Retrieves a Reading Type using its ID. Supports filtering and pagination.
### Method
GET
### Endpoint
/espi/1_1/resource/ReadingType/{readingTypeId}
### Parameters
#### Path Parameters
- **readingTypeId** (string) - Required - ID of the Reading Type.
#### Query Parameters
- **published-max** (Date) - Optional - The upper bound on the published date of the Reading Type.
- **published-min** (Date) - Optional - The lower bound on the published date of the Reading Type.
- **updated-max** (Date) - Optional - The upper bound on the updated date of the Reading Type.
- **updated-min** (Date) - Optional - The lower bound on the updated date of the Reading Type.
- **max-results** (long) - Optional - The upper bound on the number of entries to be contained in a reply.
- **start-index** (long) - Optional - The one based offset in the DataCustodian's collection of Reading Types that should be transferred as the first entry of the response.
- **depth** (long) - Optional - The maximum number of entries to be transferred in the response.
### Response
#### Success Response (200)
- **ReadingType** (XML) - The requested Reading Type.
#### Error Response
- **400** - Bad Request
- **403** - Forbidden
```