API Descriptions and timeouts

CPO

CPO is Charge Point Operator, and offers APIs for controlling CPO entities that can be configured in the EV Portal.

Name	Method	Description	Timeout (sec)	Endpoint
Create a location	POST	This API allows you to create a location.	100	/api/{versionNumber}/locations/
Update a location	PUT	This API allows you to update a location.	100	/api/{versionNumber}/locations/{locationid}
Patch a location	PATCH	This API allows you to patch an individual field for a location.	100	/api/{versionNumber}/locations/{locationid}
Batch Patch multiple locations	PATCH	This API allows you to patch an individual field for multiple locations.	100	/api/{versionNumber}/locations/batch
Get Batch Patch report for locations	PATCH	This API allows you to retrive the report for a batch patch of locations.	100	/api/{versionNumber}/locations/batch/report/{reportId}
Get multiple locations	GET	This API allows you to retrieve multiple locations.	100	/api/{versionNumber}/locations/
Get a location	GET	This API allows you to get a location by it's ID.	100	/api/{versionNumber}/locations/{locationid}
Get an evse	GET	This API allows you to get an evse by it's ID.	100	/api/{versionNumber}/locations/{locationid}/{evseUid}
Get a connector	GET	This API allows you to get a connector by it's evse ID and connector number.	100	/api/{versionNumber}/locations/{locationid}/{evseUid}/{connectorId}
Create a charge station	POST	This API allows you to ceate a charge station.	100	/api/{versionNumber}/chargestations/
Update a charge station	PUT	This API allows you to update a charge station.	100	/api/{versionNumber}/chargestations/{chargestationId}
Patch a charge station	PATCH	This API allows you to patch an individual field for a charge station.	100	/api/{versionNumber}/chargestations/{chargestationId}
Batch Patch multiple charge stations	PATCH	This API allows you to patch an individual field for multiple charge stations.	100	/api/{versionNumber}/chargestations/batch
Get Batch Patch report for charge stations	PATCH	This API allows you to retrive the report for a batch patch of charge stations.	100	/api/{versionNumber}/chargestations/batch/report/{reportId}
Get multiple charge stations	GET	This API allows you to retrieve multiple chargestations	100	/api/{versionNumber}/chargestations/
Get single charge station	GET	This API allows you to get a charge station by it's ID.	100	/api/{versionNumber}/chargestations/{chargestationId}
Get multiple hardware templates	GET		100	/api/{versionNumber}/chargestations/chargestationtemplate
Create/Update a hardware template	POST		100	/api/{versionNumber}/chargestations/chargestationtemplate
Get multiple tariff codes	GET	This API allows you to retrieve multiple tariff codes.	100	/api/{versionNumber}/tariffcodes/

CPI
CPI is Charge Point Interaction, and offers APIs for retrieving CPI entities that are sent and received from a charge station.

Name	GET Method	Description	Timeout (sec)	Endpoint
Get batch Charge Station notifications	GET	This API allows you to retrieve multiple notifications in batch for all charge stations available to the caller.	230	/api/{versionNumber}/chargestationnotifications/
Get Charge Station notifications in real time	GET	This API allows you to retrieve multiple Charge Station notifications in real time.	100	/api/{versionNumber}/chargestationnotifications/{chargeStationId}
Send a command to a charge station	POST	This endpoint allows you to send a command to a charge station.	100	/api/{versionNumber}/commands/{command}
Get a command by its ocpp message ID	GET	This endpoint allows you to get a command by its ocpp message ID.	100	/api/{versionNumber}/commands/{evse_uid}/{charge_station_messge_id}
Get batch meter values	GET	This API allows you to retrieve multiple meter values in batch for all charge stations available to the caller.	230	/api/{versionNumber}/metervalues/
Push Charge Station notifications in real time	POST	This mechanism allows you to push Charge Station notifications in real time to external endpoints.	N/A	N/A