Webportal v2

embedded apps

API Reference - navigation.remainingTravelTime

Edit
Required Privacy: Always available
Operations:
GET
navigation.remainingTravelTime
Edit

This API allows to work with the remaining travel time of the navigation feature within the infotainment system.

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

Remaining time (in second) before arrival in current navigation guidance within the infotainment system. null if no guidance active.

int

seconds

 		2438
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13

webportal.get(
    /* api name */
    "navigation.remainingTravelTime",
    /* 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": "navigation.remainingTravelTime",
  "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": "navigation.remainingTravelTime",
  "status": 200,
  "statusText": "OK", 
  "data": 2438
}

false

SUBSCRIBE
navigation.remainingTravelTime
Edit

This API allows to work with the remaining travel time of the navigation feature within the infotainment system.

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

Remaining time (in second) before arrival in current navigation guidance within the infotainment system. null if no guidance active.

int

seconds

 		2438
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 */
    "navigation.remainingTravelTime",
    /* 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": "navigation.remainingTravelTime",
  "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": "navigation.remainingTravelTime",
  "status": 200,
  "statusText": "OK", 
  "data": 2438
}

Back to Ref List

Related References