Webportal v2

embedded apps

API Reference - navigation.nextWaypointCoordinates

Required Privacy: Always available
Operations:

This api allows to retrieve the navigation waypoint coordinates.

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

latitude value

Double

n/a

48.77232
longitude

longitude value

Double

n/a

2.2151043
altitude

altitude value

Double

n/a

2.2151043
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.get(
    /* api name */
    "navigation.nextWaypointCoordinates",
    /* 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.nextWaypointCoordinates",
  "params":  null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "navigation.nextWaypointCoordinates",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "latitude": "48.77232",
    "longitude": "2.2151043",
    "altitude": "2.2151043"
  } 
}

false

This api allows to retrieve the navigation waypoint coordinates.

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

latitude value

Double

n/a

48.77232
longitude

longitude value

Double

n/a

2.2151043
altitude

altitude value

Double

n/a

2.2151043
Code Example
1
2
3
4
5
6
7
8
9
10
11
12
13
webportal.set(
    /* api name */
    "navigation.nextWaypointCoordinates",
    /* 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": "SET", 
  "api": "navigation.nextWaypointCoordinates",
  "params":  null
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "navigation.nextWaypointCoordinates",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "latitude": "48.77232",
    "longitude": "2.2151043",
    "altitude": "2.2151043"
  } 
}

false