Webportal v2

embedded apps

API Reference - navigation.guidanceCriteria

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

This API allows to interact with current navigation guidance criteria.

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

Avoids toll roads.

boolean

n/a

 		false
avoidFerries

Avoids ferries.

boolean

n/a

 		false
avoidHOVLanes

Avoids hight occupancy lanes.

boolean

n/a

 		false
avoidUnpavedRoads

Avoids unpaved roads.

boolean

n/a

 		true
avoidMotorways

Avoids motorways roads.

boolean

n/a

 		false
routeType

Type of route.

boolean

 - 0: Shortest
- 1: Fatest
- 2: Eco 		1
reroutingMode

Mode of rerouting.

boolean

 - 1: auto, will rerout without confirmation.
- 2: manual, will ask confirmation for rerouting. 		1
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13

webportal.get(
    /* api name */
    "navigation.guidanceCriteria",
    /* 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.guidanceCriteria",
  "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": "navigation.guidanceCriteria",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "avoidTollRoads": false,
    "avoidFerries": false,
    "avoidHOVLanes": false,
    "avoidUnpavedRoads": true,
    "avoidMotorways": false,
    "routeType": 1,
    "reroutingMode": 1
  } 
}

false

SET
navigation.guidanceCriteria
Edit

This API allows to interact with current navigation guidance criteria.

Input Parameter
Param name Description Type Unit/Values Example Required
avoidTollRoads

Avoids toll roads.

boolean

n/a

 		false false
avoidFerries

Avoids ferries.

boolean

n/a

 		false false
avoidHOVLanes

Avoids hight occupancy lanes.

boolean

n/a

 		false false
avoidUnpavedRoads

Avoids unpaved roads.

boolean

n/a

 		true false
avoidMotorways

Avoids motorways roads.

boolean

n/a

 		false false
routeType

Type of route.

boolean

 - 0: Shortest
- 1: Fatest
- 2: Eco 		1 false
reroutingMode

Mode of rerouting.

boolean

 - 1: auto, will rerout without confirmation.
- 2: manual, will ask confirmation for rerouting. 		1 false
Output Data
No outputted data
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

webportal.set(
    /* api name */
    "navigation.guidanceCriteria",
    /* parameters */
     { 
      "avoidTollRoads": false,
      "avoidFerries": false,
      "avoidHOVLanes": false,
      "avoidUnpavedRoads": true,
      "avoidMotorways": false,
      "routeType": 1,
      "reroutingMode": 1
        }
  )
  /* callback for `REPLY` messages */
  .then((message) => {
    if (message.status === 200) {
      /* handle `REPLY` success */
    }
    else { /* handle `REPLY` error */ }
  })

1
2
3
4
5
6
7
8
9
10
11
12
13
14

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0", 
  "type": "SET", 
  "api": "navigation.guidanceCriteria",
  "params":  { 
    "avoidTollRoads": false,
    "avoidFerries": false,
    "avoidHOVLanes": false,
    "avoidUnpavedRoads": true,
    "avoidMotorways": false,
    "routeType": 1,
    "reroutingMode": 1
  }
}

1
2
3
4
5
6
7
8
9

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

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "navigation.guidanceCriteria",
  "status": 200,
  "statusText": "OK"
}

false

SUBSCRIBE
navigation.guidanceCriteria
Edit

This API allows to interact with current navigation guidance criteria.

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

Avoids toll roads.

boolean

n/a

 		false
avoidFerries

Avoids ferries.

boolean

n/a

 		false
avoidHOVLanes

Avoids hight occupancy lanes.

boolean

n/a

 		false
avoidUnpavedRoads

Avoids unpaved roads.

boolean

n/a

 		true
avoidMotorways

Avoids motorways roads.

boolean

n/a

 		false
routeType

Type of route.

boolean

 - 0: Shortest
- 1: Fatest
- 2: Eco 		1
reroutingMode

Mode of rerouting.

boolean

 - 1: auto, will rerout without confirmation.
- 2: manual, will ask confirmation for rerouting. 		1
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.guidanceCriteria",
    /* 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.guidanceCriteria",
  "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": "navigation.guidanceCriteria",
  "status": 200,
  "statusText": "OK", 
  "data":  { 
    "avoidTollRoads": false,
    "avoidFerries": false,
    "avoidHOVLanes": false,
    "avoidUnpavedRoads": true,
    "avoidMotorways": false,
    "routeType": 1,
    "reroutingMode": 1
  } 
}

Back to Ref List

Related References