API Reference - ecocoaching.noteDay
This API allows to retrieve the eco coaching weeks note, providing global notes of every day’s trips.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| Monday | Monday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Tuesday | Tuesday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Wednesday | Wednesday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Thursday | Thursday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Friday | Friday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Saturday | Saturday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Sunday | Sunday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
/* api name */
"ecocoaching.noteDay",
/* 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": "ecocoaching.noteDay",
"params": null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
// --- format of the `REPLY` message ---
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"api": "ecocoaching.noteDay",
"status": 200,
"statusText": "OK",
"data": {
"Monday": 8,
"Tuesday": 8,
"Wednesday": 8,
"Thursday": 8,
"Friday": 8,
"Saturday": 8,
"Sunday": 8
}
}
false
This API allows to retrieve the eco coaching weeks note, providing global notes of every day’s trips.
| Input Parameter | |||||
|---|---|---|---|---|---|
| No input params |
| Output Data | ||||
|---|---|---|---|---|
| Data name | Description | Type | Unit/Values | Example |
| Monday | Monday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Tuesday | Tuesday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Wednesday | Wednesday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Thursday | Thursday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Friday | Friday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Saturday | Saturday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
| Sunday | Sunday note in Eco Coaching. |
int |
- [0, 10]: 'Accelereation Note'
- 14: 'Unavailable'
- 15: 'Invalid'
|
8
|
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
webportal.subscribe(
/* api name */
"ecocoaching.noteDay",
/* parameters */
null,
/* callback for `NOTIFY` messages */
async (notifyMessage) => {
if (notifyMessage.status === 200) {
/* handle `NOTIFY` response */
}
else { /* handle `NOTIFY` error */ }
}
)
/* 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": "SUBSCRIBE",
"api": "ecocoaching.noteDay",
"params": null
}
1
2
3
4
5
6
7
8
9
10
11
// --- format of the `REPLY` message ---
// type: acknowledge the status of the subscription
// reception: only once after the subscription request
// contains outputed data: no
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "REPLY",
"status": 200,
"statusText": "OK"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// --- format of the `NOTIFY` message ---
// type: event message about the subscription
// reception: each time the conditions of the subscription are met
// contains outputed data: yes
{
"id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
"type": "NOTIFY",
"api": "ecocoaching.noteDay",
"status": 200,
"statusText": "OK",
"data": {
"Monday": 8,
"Tuesday": 8,
"Wednesday": 8,
"Thursday": 8,
"Friday": 8,
"Saturday": 8,
"Sunday": 8
}
}