Spark OpenADR API - Partner Endpoints (v1)

Download OpenAPI specification:Download

Events

/events

Authorizations:

Bearer

Responses

Response samples

200

Content type

application/json

[{"createdDateTime": "2019-08-24T14:15:22Z",
"ID": "string",
"modificationDateTime": "2019-08-24T14:15:22Z",
"name": "string",
"priority": 0,
"programID": "string",
"reportDescriptors": [{"payloadType": "string",
"readingType": "string",
"targets": [{"targetType": "string",
"values": ["string"
]
}
],
"aggregate": true,
"frequency": 0,
"historical": true,
"numIntervals": 0,
"repeat": 0,
"startInterval": 0
}
],
"targets": [{"targetType": "string",
"values": ["string"
]
}
],
"intervalPeriod": {"duration": "02:00:00",
"start": "2019-08-24T14:15:22Z",
"randomizeStart": "02:00:00"
},
"payload": {"targetCurrent": 0,
"payloadType": "Unknown"
}
}
]

/events/{eventId}

Authorizations:

Bearer

path Parameters

eventId

required

string

Responses

Response samples

200

Content type

application/json

{"createdDateTime": "2019-08-24T14:15:22Z",
"ID": "string",
"modificationDateTime": "2019-08-24T14:15:22Z",
"name": "string",
"priority": 0,
"programID": "string",
"reportDescriptors": [{"payloadType": "string",
"readingType": "string",
"targets": [{"targetType": "string",
"values": ["string"
]
}
],
"aggregate": true,
"frequency": 0,
"historical": true,
"numIntervals": 0,
"repeat": 0,
"startInterval": 0
}
],
"targets": [{"targetType": "string",
"values": ["string"
]
}
],
"intervalPeriod": {"duration": "02:00:00",
"start": "2019-08-24T14:15:22Z",
"randomizeStart": "02:00:00"
},
"payload": {"targetCurrent": 0,
"payloadType": "Unknown"
}
}

Reports

/reports

Authorizations:

Bearer

Responses

Response samples

200

Content type

application/json

[{"clientID": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"eventID": "string",
"ID": "string",
"modificationDateTime": "2019-08-24T14:15:22Z",
"name": "string",
"programID": "string",
"payloads": [{"resourceId": "string",
"location": {"latitude": 0,
"longitude": 0
},
"actionType": "Unknown",
"current": 0,
"power": 0,
"stateOfCharge": 0,
"batteryCapacity": 0,
"payloadType": "Unknown"
}
]
}
]

/reports

Authorizations:

Bearer

Request Body schema: application/json

clientID	string or null
createdDateTime	string <date-time>
eventID	string or null
ID	string or null
modificationDateTime	string <date-time>
name	string or null
programID	string or null
	Array of VehicleChargeActionPayload (object) or null

Responses

Request samples

Payload

Content type

application/json

{"clientID": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"eventID": "string",
"ID": "string",
"modificationDateTime": "2019-08-24T14:15:22Z",
"name": "string",
"programID": "string",
"payloads": [{"resourceId": "string",
"location": {"latitude": 0,
"longitude": 0
},
"actionType": "Unknown",
"current": 0,
"power": 0,
"stateOfCharge": 0,
"batteryCapacity": 0,
"payloadType": "Unknown"
}
]
}

Response samples

200

Content type

application/json

{"clientID": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"eventID": "string",
"ID": "string",
"modificationDateTime": "2019-08-24T14:15:22Z",
"name": "string",
"programID": "string",
"payloads": [{"resourceId": "string",
"location": {"latitude": 0,
"longitude": 0
},
"actionType": "Unknown",
"current": 0,
"power": 0,
"stateOfCharge": 0,
"batteryCapacity": 0,
"payloadType": "Unknown"
}
]
}

/reports/{reportId}

Authorizations:

Bearer

path Parameters

reportId

required

string

Responses

Response samples

200

Content type

application/json

{"clientID": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"eventID": "string",
"ID": "string",
"modificationDateTime": "2019-08-24T14:15:22Z",
"name": "string",
"programID": "string",
"payloads": [{"resourceId": "string",
"location": {"latitude": 0,
"longitude": 0
},
"actionType": "Unknown",
"current": 0,
"power": 0,
"stateOfCharge": 0,
"batteryCapacity": 0,
"payloadType": "Unknown"
}
]
}

/reports/{reportId}

Authorizations:

Bearer

path Parameters

reportId

required

string

Request Body schema: application/json

clientID	string or null
createdDateTime	string <date-time>
eventID	string or null
ID	string or null
modificationDateTime	string <date-time>
name	string or null
programID	string or null
	Array of VehicleChargeActionPayload (object) or null

Responses

Request samples

Payload

Content type

application/json

{"clientID": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"eventID": "string",
"ID": "string",
"modificationDateTime": "2019-08-24T14:15:22Z",
"name": "string",
"programID": "string",
"payloads": [{"resourceId": "string",
"location": {"latitude": 0,
"longitude": 0
},
"actionType": "Unknown",
"current": 0,
"power": 0,
"stateOfCharge": 0,
"batteryCapacity": 0,
"payloadType": "Unknown"
}
]
}

Response samples

200

Content type

application/json

{"clientID": "string",
"createdDateTime": "2019-08-24T14:15:22Z",
"eventID": "string",
"ID": "string",
"modificationDateTime": "2019-08-24T14:15:22Z",
"name": "string",
"programID": "string",
"payloads": [{"resourceId": "string",
"location": {"latitude": 0,
"longitude": 0
},
"actionType": "Unknown",
"current": 0,
"power": 0,
"stateOfCharge": 0,
"batteryCapacity": 0,
"payloadType": "Unknown"
}
]
}

/reports/{reportId}

Authorizations:

Bearer

path Parameters

reportId

required

string

Responses

/reports/{reportId}/test

Authorizations:

Bearer

path Parameters

reportId

required

string

Responses

Resources

/resources

Authorizations:

Bearer

query Parameters

skip	integer <int32> Default: 0
take	integer <int32> Default: 100

Responses

/resources

Authorizations:

Bearer

Request Body schema: application/json

id	string or null
name	string or null
	object (Point)
currentAmperage	number <double>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string",
"location": {"factory": {"precisionModel": {"scale": 0,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {"ordinates": "None"
},
"geometryServices": {"geometryOverlay": { },
"coordinateEqualityComparer": { },
"defaultCoordinateSequenceFactory": {"ordinates": "None"
},
"defaultPrecisionModel": {"scale": 0,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"precisionModel": {"scale": 0,
"precisionModelType": "Floating"
},
"centroid": { },
"interiorPoint": { },
"pointOnSurface": { },
"envelope": {"factory": {"precisionModel": {"scale": 0,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {"ordinates": "None"
},
"geometryServices": {"geometryOverlay": { },
"coordinateEqualityComparer": { },
"defaultCoordinateSequenceFactory": {"ordinates": "None"
},
"defaultPrecisionModel": {"scale": 0,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"ogcGeometryType": "Point",
"precisionModel": {"scale": 0,
"precisionModelType": "Floating"
},
"coordinate": {"x": 0,
"y": 0,
"z": 0,
"m": 0,
"coordinateValue": { }
},
"centroid": { },
"interiorPoint": { },
"pointOnSurface": { },
"dimension": "P",
"boundary": { },
"boundaryDimension": "P",
"envelope": { },
"envelopeInternal": {"centre": {"x": 0,
"y": 0,
"z": 0,
"m": 0,
"coordinateValue": { }
}
}
},
"envelopeInternal": {"centre": {"x": 0,
"y": 0,
"z": 0,
"m": 0,
"coordinateValue": { }
}
},
"coordinateSequence": {"ordinates": "None",
"first": {"x": 0,
"y": 0,
"z": 0,
"m": 0,
"coordinateValue": { }
},
"last": {"x": 0,
"y": 0,
"z": 0,
"m": 0,
"coordinateValue": { }
}
},
"dimension": "P",
"boundaryDimension": "P",
"x": 0,
"y": 0,
"coordinate": {"x": 0,
"y": 0,
"z": 0,
"m": 0,
"coordinateValue": { }
},
"ogcGeometryType": "Point",
"boundary": {"factory": {"precisionModel": {"scale": 0,
"precisionModelType": "Floating"
},
"coordinateSequenceFactory": {"ordinates": "None"
},
"geometryServices": {"geometryOverlay": { },
"coordinateEqualityComparer": { },
"defaultCoordinateSequenceFactory": {"ordinates": "None"
},
"defaultPrecisionModel": {"scale": 0,
"precisionModelType": "Floating"
}
}
},
"userData": null,
"srid": 0,
"ogcGeometryType": "Point",
"precisionModel": {"scale": 0,
"precisionModelType": "Floating"
},
"coordinate": {"x": 0,
"y": 0,
"z": 0,
"m": 0,
"coordinateValue": { }
},
"centroid": { },
"interiorPoint": { },
"pointOnSurface": { },
"dimension": "P",
"boundary": { },
"boundaryDimension": "P",
"envelope": { },
"envelopeInternal": {"centre": {"x": 0,
"y": 0,
"z": 0,
"m": 0,
"coordinateValue": { }
}
}
},
"z": 0,
"m": 0
},
"currentAmperage": 0
}

/resources

Authorizations:

Bearer

Responses

/resources

Authorizations:

Bearer

Responses

/resources/{eventId}

Authorizations:

Bearer

query Parameters

id

required

string

Responses

Subscriptions

/subscriptions

Authorizations:

Bearer

query Parameters

programId

string

Responses

Response samples

200

Content type

application/json

[{"id": "string",
"programId": "string",
"webhookUrl": "string"
}
]

/subscriptions

Authorizations:

Bearer

Request Body schema: application/json

programId	string or null
webhookUrl	string or null

Responses

Request samples

Payload

Content type

application/json

{"programId": "string",
"webhookUrl": "string"
}

Response samples

200

Content type

application/json

{"id": "string",
"programId": "string",
"webhookUrl": "string"
}

/subscriptions/{subscriptionId}

Authorizations:

Bearer

path Parameters

subscriptionId

required

string

Responses

Response samples

200

Content type

application/json

{"id": "string",
"programId": "string",
"webhookUrl": "string"
}