Energy Coordination API - Partner Endpoints (v1)
Download OpenAPI specification:Download
Response samples
- 200
Content type
application/json
[- {
- "name": "string",
- "priority": 0,
- "programId": "string",
- "reportDescriptors": [
- {
- "payloadType": "Unknown",
- "targetResources": [
- "string"
]
}
], - "targetResources": [
- "string"
], - "intervalPeriod": {
- "duration": "02:00:00",
- "start": "2019-08-24T14:15:22Z",
- "randomizeStart": "02:00:00"
}, - "payload": {
- "targetCurrent": 0,
- "payloadType": "Unknown"
}, - "id": "string",
- "createdDateTime": "2019-08-24T14:15:22Z",
- "modificationDateTime": "2019-08-24T14:15:22Z"
}
]Response samples
- 200
- 400
Content type
application/json
{- "name": "string",
- "priority": 0,
- "programId": "string",
- "reportDescriptors": [
- {
- "payloadType": "Unknown",
- "targetResources": [
- "string"
]
}
], - "targetResources": [
- "string"
], - "intervalPeriod": {
- "duration": "02:00:00",
- "start": "2019-08-24T14:15:22Z",
- "randomizeStart": "02:00:00"
}, - "payload": {
- "targetCurrent": 0,
- "payloadType": "Unknown"
}, - "id": "string",
- "createdDateTime": "2019-08-24T14:15:22Z",
- "modificationDateTime": "2019-08-24T14:15:22Z"
}/reports
Authorizations:
Bearer
Request Body schema: application/json
| eventId | string or null |
| name | string or null |
Array of VehicleChargeActionPayload (object) or null |
Responses
Request samples
- Payload
Content type
application/json
{- "eventId": "string",
- "name": "string",
- "payloads": [
- {
- "resourceId": "string",
- "location": {
- "latitude": 0,
- "longitude": 0
}, - "actionType": "Start",
- "current": 0,
- "power": 0,
- "stateOfCharge": 0,
- "batteryCapacity": 0,
- "payloadType": "VehicleChargeAction"
}
]
}Response samples
- 200
- 400
Content type
application/json
{- "id": "string",
- "eventId": "string",
- "programId": "string",
- "name": "string",
- "createdDateTime": "2019-08-24T14:15:22Z",
- "modificationDateTime": "2019-08-24T14:15:22Z"
}/resources
Authorizations:
Bearer
Request Body schema: application/json
| userId | string or null |
| resourceId | string or null |
VehicleResourceMetadata (object) |
Responses
Request samples
- Payload
Content type
application/json
{- "userId": "string",
- "resourceId": "string",
- "metadata": {
- "brand": "string",
- "model": "string",
- "year": 0,
- "vin": "string",
- "resourceType": "Unknown"
}
}Response samples
- 200
- 400
Content type
application/json
{- "userId": "string",
- "resourceId": "string",
- "metadata": {
- "brand": "string",
- "model": "string",
- "year": 0,
- "vin": "string",
- "resourceType": "Unknown"
}, - "id": "string"
}/resources
Authorizations:
Bearer
query Parameters
| resourceId required | string |
Request Body schema: application/json
| userId | string or null |
| resourceId | string or null |
VehicleResourceMetadata (object) |
Responses
Request samples
- Payload
Content type
application/json
{- "userId": "string",
- "resourceId": "string",
- "metadata": {
- "brand": "string",
- "model": "string",
- "year": 0,
- "vin": "string",
- "resourceType": "Unknown"
}
}Response samples
- 200
- 400
Content type
application/json
{- "userId": "string",
- "resourceId": "string",
- "metadata": {
- "brand": "string",
- "model": "string",
- "year": 0,
- "vin": "string",
- "resourceType": "Unknown"
}, - "id": "string"
}Response samples
- 400
Content type
application/problem+json
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property1": null,
- "property2": null
}Response samples
- 200
- 400
Content type
application/json
{- "userId": "string",
- "resourceId": "string",
- "metadata": {
- "brand": "string",
- "model": "string",
- "year": 0,
- "vin": "string",
- "resourceType": "Unknown"
}, - "id": "string"
}/subscriptions
Authorizations:
Bearer
Request Body schema: application/json
| webhookSecret | string or null |
| webhookUrl | string or null |
| eventPayloadTypes | Array of strings or null (SparkEventPayloadType) Enum: "Unknown" "CurrentLevel" "PowerLevel" |
| operationTypes | Array of strings or null (OperationType) Enum: "Create" "Update" "Delete" |
Responses
Request samples
- Payload
Content type
application/json
{- "webhookSecret": "string",
- "webhookUrl": "string",
- "eventPayloadTypes": [
- "Unknown"
], - "operationTypes": [
- "Create"
]
}Response samples
- 200
- 400
Content type
application/json
{- "id": "string",
- "webhookSecret": "string",
- "webhookUrl": "string",
- "eventPayloadTypes": [
- "Unknown"
], - "operationTypes": [
- "Create"
]
}/subscriptions/{subscriptionId}
Authorizations:
Bearer
path Parameters
| subscriptionId required | string |
Request Body schema: application/json
| id | string or null |
| webhookSecret | string or null |
| webhookUrl | string or null |
| eventPayloadTypes | Array of strings or null (SparkEventPayloadType) Enum: "Unknown" "CurrentLevel" "PowerLevel" |
| operationTypes | Array of strings or null (OperationType) Enum: "Create" "Update" "Delete" |
Responses
Request samples
- Payload
Content type
application/json
{- "id": "string",
- "webhookSecret": "string",
- "webhookUrl": "string",
- "eventPayloadTypes": [
- "Unknown"
], - "operationTypes": [
- "Create"
]
}Response samples
- 200
- 400
Content type
application/json
{- "id": "string",
- "webhookSecret": "string",
- "webhookUrl": "string",
- "eventPayloadTypes": [
- "Unknown"
], - "operationTypes": [
- "Create"
]
}/subscriptions/{subscriptionId}
Authorizations:
Bearer
path Parameters
| subscriptionId required | string |
Responses
Response samples
- 400
Content type
application/problem+json
{- "type": "string",
- "title": "string",
- "status": 0,
- "detail": "string",
- "instance": "string",
- "errors": {
- "property1": [
- "string"
], - "property2": [
- "string"
]
}, - "property1": null,
- "property2": null
}