Webportal v2

embedded apps

API Reference - navigation.destinationCoordinates

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

This API allows to retrieve list of waypoints & destination’s coordinates of the current navigation.

“If no active guidance, data should be an empty array : 'data': [].”

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

Array of coordinates, last one is the destination, the others are waypoints.

Object

 /
coordinates
 .longitude

Current longitude of the vehicle.

number

 8.74301
coordinates
 .latitude

Current latitude of the vehicle.

number

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

webportal.get(
    /* api name */
    "navigation.destinationCoordinates",
    /* 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.destinationCoordinates",
  "params":  null
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

// --- format of the `REPLY` message ---

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "navigation.destinationCoordinates",
  "status": 200,
  "statusText": "OK", 
  "data": [
    // Waypoint n°1 (Vigo, Spain)
    {
        "latitude": 42.3933508502848,
        "longitude": -8.72297033825389
    },
    // Waypoint n°2 (Paris, France)
    {
        "latitude": 48.895069010883354,
        "longitude": 2.3453705580761044
    },
    // Waypoint n°3 (Rüsselsheim, Germany)
    {
        "latitude": 50.10911076628903,
        "longitude": 8.42731739843672
    },
    // Destination (Turin, Italy)
    {
        "latitude": 45.1474698617253,
        "longitude": 7.691179283428212
    }
  ] 
}

false

SUBSCRIBE
navigation.destinationCoordinates
Edit

This API allows to retrieve list of waypoints & destination’s coordinates of the current navigation.

This event is triggered when the waypoints or destination are changed AND when the navigation destination is reached.

If destination is reached, data should be an empty array : 'data': [].

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

Array of coordinates, last one is the destination, the others are waypoints.

Object

 /
coordinates
 .longitude

Current longitude of the vehicle.

number

 8.74301
coordinates
 .latitude

Current latitude of the vehicle.

number

 8.74301
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.destinationCoordinates",
    /* 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.destinationCoordinates",
  "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
21
22
23
24
25
26
27
28
29
30
31
32
33

// --- 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.destinationCoordinates",
  "status": 200,
  "statusText": "OK", 
  "data": [
    // Waypoint n°1 (Vigo, Spain)
    {
        "latitude": 42.3933508502848,
        "longitude": -8.72297033825389
    },
    // Waypoint n°2 (Paris, France)
    {
        "latitude": 48.895069010883354,
        "longitude": 2.3453705580761044
    },
    // Waypoint n°3 (Rüsselsheim, Germany)
    {
        "latitude": 50.10911076628903,
        "longitude": 8.42731739843672
    },
    // Destination (Turin, Italy)
    {
        "latitude": 45.1474698617253,
        "longitude": 7.691179283428212
    }
  ] 
}

Back to Ref List

Related References