API Reference - engine.energyType
Required Privacy:
Data &
Location
Operation:
This API allows to work with vehicle energy type.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| electricalEngine | Is this vehicle has an electrical engine? |
boolean |
|
true
|
| internalCombustionEngine | Is this vehicle has an internal comustion engine? |
boolean |
|
false
|
| rearEletricalEngine | Is this vehicle has a rear electrical engine? |
boolean |
|
true
|
| hybridType | Vehicle hybrid type. |
int |
- 0: 'PHEV'
- 1: 'MHEV'
|
1
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"engine.energyType",
/* parameters */
null
)
/* callback for `REPLY` messages */
.then((message) => {
if (message.status === 200) {
/* handle `REPLY` success */
}
else { /* handle `REPLY` error */ }
})
1
2
3
4
5
6
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "GET",
"api": "engine.energyType",
"params": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "engine.energyType",
"status": 200,
"statusText": "OK",
"data": {
"electricalEngine": true,
"internalCombustionEngine": false,
"rearEletricalEngine": true,
"hybridType": 1
}
}
false