Webportal v2

embedded apps

API Reference - ecocoaching.noteColdEngine

Required Privacy: Location
Plateforme Compatibility:
Operations:

This API allows to retrieve the eco coaching Cold Engine note, providing instant Cold Engine ranking in EcoCoaching trip.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
noteColdEngine

Cold Engine note in Eco Coaching.

int

- [0, 10]: 'Cold Engine 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.noteColdEngine",
    /* 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.noteColdEngine",
  "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": "ecocoaching.noteColdEngine",
  "status": 200,
  "statusText": "OK", 
  "data": 8
}

false

This API allows to retrieve the eco coaching Cold Engine note, providing instant Cold Engine ranking in EcoCoaching trip.

Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
noteColdEngine

Cold Engine note in Eco Coaching.

int

- [0, 10]: 'Cold Engine 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.noteColdEngine",
    /* 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.noteColdEngine",
  "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
// --- 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.noteColdEngine",
  "status": 200,
  "statusText": "OK", 
  "data": 8
}