Download OpenAPI specification:Download
Rewatt's simple charging session API descriptor. Implement this API to share charging session data. For a reference implementation on AWS, follow this guide. View the change history. View previous versions.
The idea here is to quickly get a list of chargers, matching the chargerIds if supplied. To keep things sane, if there are a lot of chargers, and no chargerIds supplied, the impl can include paging. Rewatt uses chargerIds to keep things sane, rather than paging.
chargerIds | Array of strings |
page | integer <int64> Default: 1 Example: page=3 1-based page number |
pageSize | integer <int64> Default: 10 Example: pageSize=50 number of rows on a page |
{- "chargers": [
- {
- "id": "string",
- "name": "string",
- "serialNumber": "string",
- "model": "CT4011-GW1",
- "manufacturer": "ChargePoint",
- "maxOutputPower": 7200,
- "maxAvailableCurrent": 30,
- "outputVoltage": 240,
- "numberOfConnectors": 2,
- "timeZone": "America/Edmonton",
- "latitude": 0,
- "longitude": 0,
- "commissioningDate": "2021-04-12"
}
], - "total": 43
}
Get the details about a charger specified by the chargerId.
chargerId required | string Example: 12 |
{- "id": "string",
- "name": "string",
- "serialNumber": "string",
- "model": "CT4011-GW1",
- "manufacturer": "ChargePoint",
- "maxOutputPower": 7200,
- "maxAvailableCurrent": 30,
- "outputVoltage": 240,
- "numberOfConnectors": 2,
- "timeZone": "America/Edmonton",
- "latitude": 0,
- "longitude": 0,
- "commissioningDate": "2021-04-12"
}
Gets charging sessions over a time period for a specific charger. Charging sessions returned should start within the specified date parameters.
chargerId required | string Example: UX123ASD |
startDate | string <date> Example: startDate=2021-01-01 start date in UTC (ie any session with any charging starting on or after 00:00:00 on the specified date) |
endDate | string <date> Example: endDate=2021-03-31 end date in UTC (ie any session with any charging starting on or before 23:59:59 on the specified date) |
page | integer <int64> Default: 1 Example: page=3 1-based page number |
pageSize | integer <int64> Default: 10 Example: pageSize=50 number of rows on a page |
{- "sessions": [
- {
- "id": "string",
- "chargerId": "string",
- "energy": 0,
- "startTime": "2017-07-21T17:32:28Z",
- "endTime": "2017-08-13T17:32:28Z",
- "chargingDuration": 0
}
], - "total": 43
}
Gets paged maintenance logs for a charger. It's expected there is about 1 log entry per charger per year.
chargerId required | string Example: UX123ASD |
page | integer <int64> Default: 1 Example: page=3 1-based page number |
pageSize | integer <int64> Default: 10 Example: pageSize=50 number of rows on a page |
{- "logEntries": [
- {
- "id": "string",
- "date": "2021-04-12",
- "findings": "string"
}
], - "total": 43
}