API Reference - configuration.VIN
This API allows to work with the VIN (vehicle identification number).
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| vin | Vehicle Identification Number (VIN). |
string |
|
VF7NCRHE8AY539138
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"configuration.VIN",
/* 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": "configuration.VIN",
"params": null
}
1
2
3
4
5
6
7
8
9
10
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "configuration.VIN",
"status": 200,
"statusText": "OK",
"data": "VF7NCRHE8AY539138"
}
false