/asset-management/v1/assets
This endpoint retrieves a list of all assets available to the authenticated user.
limit
string
The maximum number of assets to return (default 20, maximum 100)
startingAfter
string
The ID of the last asset in the previous page of results. Results will start after this asset
chargingStationMake
string
The make of the charging station to filter the results
chargingStationModel
string
The model of the charging station to filter the results
firmwareVersion
string
The firmware version of the charging station to filter the results
assetGroups
string
A comma-separated list of asset group IDs to filter the results
A list of assets
{
"data": {
"hasMore": true,
"items": [
{
"id": "string",
"type": "chargingStation",
"network": {
"id": "string"
},
"sitePartners": [
{
"id": "string"
}
],
"assetGroup": {
"id": "string"
},
"createdAt": "2023-06-07T17:32:28Z",
"updatedAt": "2023-06-07T17:32:28Z",
"chargingStation": {
"serialNumber": "string",
"name": "string",
"rate": "string",
"status": "PLANNED",
"connectors": [
{
"id": 123.0,
"status": "Available",
"rawStatus": "string",
"isActive": true,
"connectionType": "CHADEMO",
"format": "CABLE",
"maxAmperage": 123.0,
"maxVoltage": 123.0,
"updatedAt": "2023-06-07T17:32:28Z"
}
],
"localAuthorization": true,
"geoLocation": {
"longitude": 123.0,
"latitude": 123.0
},
"powerType": "AC_1_PHASE",
"protocol": "OCPP_1_6",
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"imgType": "string"
}
],
"manufacturingInfo": {
"chargePointVendor": "string",
"chargePointModel": "string",
"chargePointSerialNumber": "string",
"chargeBoxSerialNumber": "string",
"firwareVersion": "string",
"imsi": "string",
"meterType": "string",
"meterSerialNumber": "string"
},
"sortOrder": 123.0,
"directionHint": "string",
"simInfo": {
"iccid": "string",
"fleet": "string",
"createdAt": "2023-06-07T17:32:28Z"
},
"supportsSimultaneousCharging": true,
"paymentTerminal": {
"serialNumber": "string",
"provider": "PAYTER",
"integrationType": "CLOUD",
"authorizationIdTag": "string",
"preAuthAmount": 123.0
},
"shortCode": "string"
},
"latestHealthcheck": {
"timestamp": "string"
},
"assetLifecycles": {
"timestamp": "string",
"eventType": "CONNECTED"
}
}
]
}
}
/asset-management/v1/assets
This endpoint creates a new asset
type
string
required
The type of asset to be created
network
string
required
The network associated with the asset
assetGroup
string
required
The asset-group to which the asset belongs
chargingStation
object (CreateChargingStationParams)
Details specific to the charging station type of asset
serialNumber
string
required
The identifier the station will use when connecting to the central system. It is USUALLY the serial number of the hardware unit itself, but it could be different.
name
string
required
rate
string
required
status
string
required
Describes the status of a charging station. PLANNED means that the station is waiting to be installed. MAINTENANCE means that the station is not available for charging. ACTIVE means that the station is available for charging. INACTIVE essentially means the station is offline and likely to be removed
connectors
array
required
localAuthorization
boolean
required
Set to true if the station should authenticate itself when starting a charge session
geoLocation
object
The geographical location of the station. If this is not provided we will inherit the values from the parent location.
powerType
string
required
protocol
string
The communication protocol used by the station. Currently only OCPP 1.6 is supported
images
array
sortOrder
number
This is used to order stations when displayed in a list
directionHint
string
simInfo
object
If the iccid is a managed sim then the simGroup is required
supportsSimultaneousCharging
boolean
Set to true if the station supports charging on multiple cables at the same time
paymentTerminal
object
If the integrationType is HARDWARE then an authorizationIdTag will be present
securityProfile
object
If the profile is PASSWORD and a password is not provided we will configure the station in the background. If a password is provided we will assume the station is already configured with that password
shortCode
string
A short string to more easily identify the station
{
"type": "chargingStation",
"network": "string",
"assetGroup": "string",
"chargingStation": {
"serialNumber": "string",
"name": "string",
"rate": "string",
"status": "PLANNED",
"connectors": [
{
"id": 123.0,
"isActive": true,
"connectionType": "CHADEMO",
"format": "CABLE",
"maxAmperage": 123.0,
"maxVoltage": 123.0
}
],
"localAuthorization": true,
"geoLocation": {
"longitude": 123.0,
"latitude": 123.0
},
"powerType": "AC_1_PHASE",
"protocol": "OCPP_1_6",
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"imgType": "string"
}
],
"sortOrder": 123.0,
"directionHint": "string",
"simInfo": {
"iccid": "string",
"simGroup": "string"
},
"supportsSimultaneousCharging": true,
"paymentTerminal": {
"serialNumber": "string",
"provider": "PAYTER",
"integrationType": "CLOUD",
"authorizationIdTag": "string",
"preAuthAmount": 123.0
},
"securityProfile": {
"profile": "PASSWORD",
"password": "string"
},
"shortCode": "string"
}
}
Success
{
"data": {
"id": "string",
"type": "chargingStation",
"network": {
"id": "string"
},
"sitePartners": [
{
"id": "string"
}
],
"assetGroup": {
"id": "string"
},
"createdAt": "2023-06-07T17:32:28Z",
"updatedAt": "2023-06-07T17:32:28Z",
"chargingStation": {
"authMethods": {
"rfid": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"mobileApp": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"autoCharge": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"freeVend": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"paymentTerminal": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
}
},
"serialNumber": "string",
"name": "string",
"rate": "string",
"status": "PLANNED",
"connectors": [
{
"id": 123.0,
"isActive": true,
"connectionType": "CHADEMO",
"format": "CABLE",
"maxAmperage": 123.0,
"maxVoltage": 123.0,
"updatedAt": "2023-06-07T17:32:28Z"
}
],
"localAuthorization": true,
"geoLocation": {
"longitude": 123.0,
"latitude": 123.0
},
"powerType": "AC_1_PHASE",
"protocol": "OCPP_1_6",
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"imgType": "string"
}
],
"manufacturingInfo": {
"chargePointVendor": "string",
"chargePointModel": "string",
"chargePointSerialNumber": "string",
"chargeBoxSerialNumber": "string",
"firwareVersion": "string",
"imsi": "string",
"meterType": "string",
"meterSerialNumber": "string"
},
"sortOrder": 123.0,
"directionHint": "string",
"simInfo": {
"iccid": "string",
"fleet": "string",
"createdAt": "2023-06-07T17:32:28Z"
},
"supportsSimultaneousCharging": true,
"paymentTerminal": {
"serialNumber": "string",
"provider": "string",
"integrationType": "CLOUD",
"authorizationIdTag": "string",
"preAuthAmount": 123.0
},
"shortCode": "string",
"license": {
"externalId": "string",
"expirationDate": "2023-06-07T17:32:28Z",
"assignedAt": "2023-06-07T17:32:28Z"
}
}
}
}
/asset-management/v1/assets/{assetId}
This endpoint retrieve an asset by the provided id
assetId
string
required
The id of the asset to retrieve
A list of assets
{
"data": {
"id": "string",
"type": "chargingStation",
"network": {
"id": "string"
},
"sitePartners": [
{
"id": "string"
}
],
"assetGroup": {
"id": "string"
},
"createdAt": "2023-06-07T17:32:28Z",
"updatedAt": "2023-06-07T17:32:28Z",
"chargingStation": {
"serialNumber": "string",
"name": "string",
"rate": "string",
"status": "PLANNED",
"connectors": [
{
"id": 123.0,
"status": "Available",
"rawStatus": "string",
"isActive": true,
"connectionType": "CHADEMO",
"format": "CABLE",
"maxAmperage": 123.0,
"maxVoltage": 123.0,
"updatedAt": "2023-06-07T17:32:28Z"
}
],
"localAuthorization": true,
"geoLocation": {
"longitude": 123.0,
"latitude": 123.0
},
"powerType": "AC_1_PHASE",
"protocol": "OCPP_1_6",
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"imgType": "string"
}
],
"manufacturingInfo": {
"chargePointVendor": "string",
"chargePointModel": "string",
"chargePointSerialNumber": "string",
"chargeBoxSerialNumber": "string",
"firwareVersion": "string",
"imsi": "string",
"meterType": "string",
"meterSerialNumber": "string"
},
"sortOrder": 123.0,
"directionHint": "string",
"simInfo": {
"iccid": "string",
"fleet": "string",
"createdAt": "2023-06-07T17:32:28Z"
},
"supportsSimultaneousCharging": true,
"paymentTerminal": {
"serialNumber": "string",
"provider": "PAYTER",
"integrationType": "CLOUD",
"authorizationIdTag": "string",
"preAuthAmount": 123.0
},
"shortCode": "string"
},
"latestHealthcheck": {
"timestamp": "string"
},
"assetLifecycles": {
"timestamp": "string",
"eventType": "CONNECTED"
}
}
}
/asset-management/v1/assets/{assetId}
This endpoint updates an existing asset by its ID.
chargingStation
object (UpdateChargingStationParams)
authMethods
object
The methods of authentication that are enabled for the station. Cannot be an empty object
serialNumber
string
The identifier the station will use when connecting to the central system. It is USUALLY the serial number of the hardware unit itself, but it could be different.
name
string
rate
string
status
string
Describes the status of a charging station. PLANNED means that the station is waiting to be installed. MAINTENANCE means that the station is not available for charging. ACTIVE means that the station is available for charging. INACTIVE essentially means the station is offline and likely to be removed
connectors
array
localAuthorization
boolean
Set to true if the station should authenticate itself when starting a charge session
geoLocation
object
powerType
string
protocol
string
The communication protocol used by the station. Currently only OCPP 1.6 is supported
images
array
sortOrder
number or null
This is used to order stations when displayed in a list
directionHint
string or null
simInfo
object
If the iccid is a managed sim then the simGroup is required
supportsSimultaneousCharging
boolean or null
Set to true if the station supports charging on multiple cables at the same time
paymentTerminal
object
If the integrationType is HARDWARE then an authorizationIdTag will be present
shortCode
string or null
A short string to more easily identify the station
{
"chargingStation": {
"authMethods": {
"rfid": {
"enabled": true
},
"mobileApp": {
"enabled": true
},
"autoCharge": {
"enabled": true
},
"freeVend": {
"enabled": true
},
"paymentTerminal": {
"enabled": true
}
},
"serialNumber": "string",
"name": "string",
"rate": "string",
"status": "PLANNED",
"connectors": [
{
"id": 123.0,
"isActive": true,
"connectionType": "CHADEMO",
"format": "CABLE",
"maxAmperage": 123.0,
"maxVoltage": 123.0
}
],
"localAuthorization": true,
"geoLocation": {
"longitude": 123.0,
"latitude": 123.0
},
"powerType": "AC_1_PHASE",
"protocol": "OCPP_1_6",
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"imgType": "string"
}
],
"sortOrder": 123.0,
"directionHint": "string",
"simInfo": {
"iccid": "string",
"simGroup": "string"
},
"supportsSimultaneousCharging": true,
"paymentTerminal": {
"serialNumber": "string",
"provider": "PAYTER",
"integrationType": "CLOUD",
"authorizationIdTag": "string",
"preAuthAmount": 123.0
},
"shortCode": "string"
}
}
Success. Returns the updated asset.
{
"data": {
"id": "string",
"type": "chargingStation",
"network": {
"id": "string"
},
"sitePartners": [
{
"id": "string"
}
],
"assetGroup": {
"id": "string"
},
"createdAt": "2023-06-07T17:32:28Z",
"updatedAt": "2023-06-07T17:32:28Z",
"chargingStation": {
"authMethods": {
"rfid": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"mobileApp": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"autoCharge": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"freeVend": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"paymentTerminal": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
}
},
"serialNumber": "string",
"name": "string",
"rate": "string",
"status": "PLANNED",
"connectors": [
{
"id": 123.0,
"isActive": true,
"connectionType": "CHADEMO",
"format": "CABLE",
"maxAmperage": 123.0,
"maxVoltage": 123.0,
"updatedAt": "2023-06-07T17:32:28Z"
}
],
"localAuthorization": true,
"geoLocation": {
"longitude": 123.0,
"latitude": 123.0
},
"powerType": "AC_1_PHASE",
"protocol": "OCPP_1_6",
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"imgType": "string"
}
],
"manufacturingInfo": {
"chargePointVendor": "string",
"chargePointModel": "string",
"chargePointSerialNumber": "string",
"chargeBoxSerialNumber": "string",
"firwareVersion": "string",
"imsi": "string",
"meterType": "string",
"meterSerialNumber": "string"
},
"sortOrder": 123.0,
"directionHint": "string",
"simInfo": {
"iccid": "string",
"fleet": "string",
"createdAt": "2023-06-07T17:32:28Z"
},
"supportsSimultaneousCharging": true,
"paymentTerminal": {
"serialNumber": "string",
"provider": "string",
"integrationType": "CLOUD",
"authorizationIdTag": "string",
"preAuthAmount": 123.0
},
"shortCode": "string",
"license": {
"externalId": "string",
"expirationDate": "2023-06-07T17:32:28Z",
"assignedAt": "2023-06-07T17:32:28Z"
}
}
}
}
/asset-management/v1/asset-statuses
This endpoint retrieves a list of all assets statuses available to the authenticated user.
limit
string
The maximum number of asset statuses to return (default 20, maximum 100)
startingAfter
string
The ID of the last asset status in the previous page of results. Results will start after this asset status
A list of asset statuses.
{
"hasMore": true,
"items": [
{
"type": "chargingStation",
"network": {
"id": "string"
},
"chargingStation": {
"connection": {
"id": "string",
"action": "string"
},
"heartbeat": {
"timestamp": "2023-06-07T17:32:28Z"
},
"connectorStatuses": [
{
"id": 123.0,
"status": "string"
}
]
},
"createdAt": "2023-06-07T17:32:28Z",
"updatedAt": "2023-06-07T17:32:28Z"
}
]
}
/asset-management/v1/asset-groups/{assetGroupId}/session-limits
This endpoint updates the session limits for a list of assets in an asset group.
assetIds
array
required
sessionLimits
object
required
energyLimitKwh
number
durationLimitMins
number
{
"assetIds": [
"string"
],
"sessionLimits": {
"energyLimitKwh": 123.0,
"durationLimitMins": 123.0
}
}
Success. Returns a message indicating the session limits have been updated.
{
"message": "Asset with ids: testAssetId session limits updated successfully and session limits removed for remaining assets in assetGroup:testAssetGroupId"
}
/asset-management/v1/assets/{assetId}/make-insecure
Sets the central system to not check for a password when an asset connects.
WARNING! This action is potentially dangerous and irreversible!
assetId
string
required
The ID of the asset to make insecure.
Success. Return station security profile if applicable.
{
"id": "string",
"profile": "INSECURE",
"createdAt": "2023-06-07T17:32:28Z",
"updatedAt": "2023-06-07T17:32:28Z"
}
/asset-management/v1/assets/{assetId}/license
This endpoint assigns/updates the license of an existing asset by its ID. If the license is set to null, the asset will be unlicensed.
license
object
externalId
string
required
expirationDate
string
required
assignedAt
string
required
{
"license": {
"externalId": "string",
"expirationDate": "2023-06-07T17:32:28Z",
"assignedAt": "2023-06-07T17:32:28Z"
}
}
Success. Returns the asset updated with the license.
{
"data": {
"id": "string",
"type": "chargingStation",
"network": {
"id": "string"
},
"sitePartners": [
{
"id": "string"
}
],
"assetGroup": {
"id": "string"
},
"createdAt": "2023-06-07T17:32:28Z",
"updatedAt": "2023-06-07T17:32:28Z",
"chargingStation": {
"authMethods": {
"rfid": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"mobileApp": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"autoCharge": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"freeVend": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
},
"paymentTerminal": {
"enabled": true,
"updatedAt": "2023-06-07T17:32:28Z"
}
},
"serialNumber": "string",
"name": "string",
"rate": "string",
"status": "PLANNED",
"connectors": [
{
"id": 123.0,
"isActive": true,
"connectionType": "CHADEMO",
"format": "CABLE",
"maxAmperage": 123.0,
"maxVoltage": 123.0,
"updatedAt": "2023-06-07T17:32:28Z"
}
],
"localAuthorization": true,
"geoLocation": {
"longitude": 123.0,
"latitude": 123.0
},
"powerType": "AC_1_PHASE",
"protocol": "OCPP_1_6",
"images": [
{
"url": "string",
"thumbnail": "string",
"category": "string",
"imgType": "string"
}
],
"manufacturingInfo": {
"chargePointVendor": "string",
"chargePointModel": "string",
"chargePointSerialNumber": "string",
"chargeBoxSerialNumber": "string",
"firwareVersion": "string",
"imsi": "string",
"meterType": "string",
"meterSerialNumber": "string"
},
"sortOrder": 123.0,
"directionHint": "string",
"simInfo": {
"iccid": "string",
"fleet": "string",
"createdAt": "2023-06-07T17:32:28Z"
},
"supportsSimultaneousCharging": true,
"paymentTerminal": {
"serialNumber": "string",
"provider": "string",
"integrationType": "CLOUD",
"authorizationIdTag": "string",
"preAuthAmount": 123.0
},
"shortCode": "string",
"license": {
"externalId": "string",
"expirationDate": "2023-06-07T17:32:28Z",
"assignedAt": "2023-06-07T17:32:28Z"
}
}
}
}
/asset-management/v1/assets/{assetId}/send-command
This endpoint saves and emits a new ocpp command to the station. It then waits for a response for a maximum of 25 seconds and returns it. If the status of the response body is "Success", then the "confirmation" field will be present. The "confirmation.payload" contains the raw response from the station. If the status is not "Success", then the "error" field will be present containing details of what the error was.
INFO! This route is deprecated. We now recommend using the Inject OCPP Raw Request endpoint instead.
WARNING! This action is potentially dangerous and irreversible!
action
string
required
The type of OCPP action to be executed
payload
string
required
JSON string of the ocpp payload based on the action and protocol
protocol
string
required
The OCPP protocol version
{
"action": "BootNotification",
"payload": "string",
"protocol": "OCPP_1_6"
}
Success
{
"data": {
"id": "string",
"assetId": "string",
"networkId": "string",
"action": "CancelReservation",
"request": {
"timestamp": "2023-06-07T17:32:28Z",
"payload": {}
},
"status": "Success",
"confirmation": {
"timestamp": "2023-06-07T17:32:28Z",
"payload": {}
},
"error": {
"reason": "string",
"timestamp": "2023-06-07T17:32:28Z"
},
"protocol": "OCPP_1_6"
}
}
/asset-management/v1/assets/basic-auth
Authenticates an asset using password authentication. If the asset is not configured to use password authentication, the password will be ignored. If the asset has an expired software license, the authentication request will be rejected.
id
string
required
The id of the asset that is authenticating
password
string
Must be provided if the profile is PASSWORD. If the profile is INSECURE then it is optional and will be ignored
{
"id": "string",
"password": "string"
}
Success. Return station security profile if applicable.
{
"id": "string",
"profile": "INSECURE",
"createdAt": "2023-06-07T17:32:28Z",
"updatedAt": "2023-06-07T17:32:28Z"
}
/asset-management/v1/assets/change-password
Changes the password of the asset with the specified ID to the specified new password. If the password is not provided, generates a new random password. The new password will be configured with the asset internally.
WARNING! This action is potentially dangerous and irreversible!
id
string
required
Id of the asset that you want to change the password for
password
string
{
"id": "string",
"password": "string"
}
Success
Empty response
/asset-management/v1/assets/verify-password
Verifies the pending password of the asset with the specified ID to complete the password configuration. If the password is rejected, the asset will be configured with the previously configured password or set to insecure if no password was previously configured.
id
string
required
The id of the asset that you want to verify the password for
result
string
required
The result of the password verification process
{
"id": "string",
"result": "ACCEPTED"
}
Success
Empty response
/asset-management/v1/assets/{assetId}/sim-status
This endpoint retrieves a list of all assets statuses available to the authenticated user.
assetId
string
required
The ID of the asset.
Successful response
{
"data": {
"status": "NEW"
}
}
Was this page helpful?