Webportal v2

embedded apps

API Reference - navigation.nextManeuverFullAddress

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

This API allows to retrieve next maneuver address.

List of instructionDirection values:

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

{
  "instructionDirectionEnum": ["UNKNOWN", "STRAIGHT", "BEAR_RIGHT", "RIGHT", "SHARP_RIGHT", "RIGHT_U_TURN", "BEAR_LEFT", "LEFT", "SHARP_LEFT", "LEFT_U_TURN", "ROUNDABOUT_STRAIGHT", "ROUNDABOUT_STRAIGHT_UK", "ROUNDABOUT_BEAR_RIGHT"
  "ROUNDABOUT_BEAR_RIGHT_UK", "ROUNDABOUT_RIGHT", "ROUNDABOUT_RIGHT_UK", "ROUNDABOUT_SHARP_RIGHT", "ROUNDABOUT_SHARP_RIGHT_UK", "ROUNDABOUT_BEAR_LEFT", "ROUNDABOUT_BEAR_LEFT_UK", "ROUNDABOUT_LEFT"
  "ROUNDABOUT_LEFT_UK", "ROUNDABOUT_SHARP_LEFT", "ROUNDABOUT_SHARP_LEFT_UK", "ROUNDABOUT_U_TURN", "ROUNDABOUT_U_TURN_UK", "BIFURCATION_BEAR_RIGHT", "BIFURCATION_KEEP_RIGHT", "BIFURCATION_KEEP_RIGHT_LANE"
  "BIFURCATION_BEAR_LEFT", "BIFURCATION_KEEP_LEFT", "BIFURCATION_KEEP_LEFT_LANE", "ARRIVAL", "ARRIVAL_WAY_POINT", "FREEWAY", "FERRY", "CHAIN_INSTRUCTION_RIGHT_THEN_TURN_RIGHT"
  "CHAIN_INSTRUCTION_RIGHT_THEN_TURN_LEFT", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_NEXT_STOP", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_DESTINATION", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_FERRY"
  "CHAIN_INSTRUCTION_RIGHT_THEN_ENTER_MOTORWAY", "CHAIN_INSTRUCTION_RIGHT_THEN_ENTER_FREEWAY", "CHAIN_INSTRUCTION_LEFT_THEN_TURN_RIGHT", "CHAIN_INSTRUCTION_LEFT_THEN_TURN_LEFT"
  "CHAIN_INSTRUCTION_LEFT_THEN_REACH_NEXT_STOP", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_DESTINATION", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_FERRY", "CHAIN_INSTRUCTION_LEFT_THEN_ENTER_MOTORWAY"
  "CHAIN_INSTRUCTION_LEFT_THEN_ENTER_FREEWAY", "SECOND_RIGHT", "THIRD_RIGHT", "SECOND_LEFT", "THIRD_LEFT", "DRIVER_ROUTE", "BIFURCATION_MERGE_RIGHT_LANE", "BIFURCATION_MERGE_LEFT_LANE"
  "ARRIVAL_RIGHT", "ARRIVAL_LEFT", "ARRIVAL_WAYPOINT_RIGHT", "ARRIVAL_WAYPOINT_LEFT", "CARTRAIN", "TOLLROAD", "RESTRICTED_AREA", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_ARRIVAL_RIGHT"
  "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_ARRIVAL_LEFT", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_ARRIVAL_WAYPOINT_RIGHT", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_ARRIVAL_WAYPOINT_LEFT"
  "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_CARTRAIN", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_TOLLROAD", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_RESTRICTED_AREA", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_ARRIVAL_RIGHT"
  "CHAIN_INSTRUCTION_LEFT_THEN_REACH_ARRIVAL_LEFT", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_ARRIVAL_WAYPOINT_RIGHT", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_ARRIVAL_WAYPOINT_LEFT"
  "CHAIN_INSTRUCTION_LEFT_THEN_REACH_CARTRAIN", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_TOLLROAD", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_RESTRICTED_AREA" ]
}

List of laneGuidance.directionType values:

1
2
3
4
5

{
  "laneGuidanceDirectionTypeEnum": ["UNKNOWN", "STRAIGHT", "STRAIGHT_FLIPPED", "BEAR_RIGHT", "RIGHT", "SHARP_RIGHT", "RIGHT_U_TURN", "BEAR_LEFT", "LEFT", "SHARP_LEFT",
  "LEFT_U_TURN", "CONDENSED_STRAIGHT", "CONDENSED_STRAIGHT_FLIPPED", "CONDENSED_BEAR_RIGHT", "CONDENSED_RIGHT", "CONDENSED_SHARP_RIGHT", "CONDENSED_RIGHT_U_TURN",
  "CONDENSED_BEAR_LEFT", "CONDENSED_LEFT", "CONDENSED_SHARP_LEFT", "CONDENSED_LEFT_U_TURN"]
}
Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
exit

Next exit.

Object

 /
exit
 .status

Next exit status.

String

 VALID
exit
 .type

Next exit type.

String

 LEFT
exit
 .number

Next exit number.

String

 Exit A42
instructionRoadShield

Current road information.

Object

 /
instructionRoadShield
 .status

Current road information status.

String

 VALID
instructionRoadShield
 .roadNumber

Number of the road.

String

 D394
instructionRoadShield
 .iconSetId

Current road shield icon id.

String
instructionRoadShield
 .affixList

Array of objects

 /
instructionRoadShield
 .affixList
  .type

String
instructionRoadShield
 .affixList
  .content

String
instructionRoadName

Name of the current street.

String

n/a

 		rue de Paris
instructionDistance

Distance to next waypoint.

Array of objects

 /
instructionDistance
 .status

Distance to next waypoint status.

String
instructionDistance
 .integerPart

Distance to next waypoint integer value.

String

 42
instructionDistance
 .fractionalPart

Distance to next waypoint fractional value.

String

 34
instructionDistance
 .unit

Distance to next waypoint unit.

String

 KILOMETERS
instructionDirection

Current instruction direction in the navigation.

String

 - UNKNOWN
- See values list below. 		right
laneGuidance

Lane guidance information.

Array of objects

 /
laneGuidance
 .directionType

Lane guidance direction instruction.

String

 STRAIGHT
laneGuidance
 .toFollow

Lane guidance to follow parameter.

boolean

 false
drivingSide

Current driving side on the road.

String

 - UNKNOWN
- LEFT
- RIGHT 		RIGHT
secondaryRoadShield

Secondary road information.

Object

 /
secondaryRoadShield
 .status

Current road information status.

String

 VALID
secondaryRoadShield
 .roadNumber

Number of the road.

String

 D394
secondaryRoadShield
 .iconSetId

Current road shield icon id.

String
secondaryRoadShield
 .affixList

Array of objects

 /
secondaryRoadShield
 .affixList
  .type

String
secondaryRoadShield
 .affixList
  .content

String
instructionTowardsName

String

n/a

 		Gran Via de Vigo
coordinates

Current position coordinates of the vehicle.

Object

 /
coordinates
 .longitude

Current longitude of the vehicle.

number

 8.74301
coordinates
 .latitude

Current latitude of the vehicle.

number

 8.74301
intersectionName

Name of the intersection.

String

n/a

 		Stellantis Cross-road
Code Example 
1
2
3
4
5
6
7
8
9
10
11
12
13

webportal.get(
    /* api name */
    "navigation.nextManeuverFullAddress",
    /* 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.nextManeuverFullAddress",
  "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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

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

{
  "id": "7372c16f-5f2f-42c9-84a7-5490e35f1be0",
  "type": "REPLY",
  "api": "navigation.nextManeuverFullAddress",
  "status": 200,
  "statusText": "OK", 
  "data": {
  "exit": {
      "status": "INVALID",
      "type": "NONE",
      "number": "Exit A42"
  },
  "instructionRoadShield": {
      "status": "INVALID",
      "roadNumber": "D394",
      "iconSetId": "...",
      "affixList": [
          { "type": "NORTH", "content": "example_data_1" },
          { "type": "NORTH", "content": "example_data_2" }
      ]
  },
  "instructionRoadName": "rue de Paris",
  "instructionDistance": {
      "status": "INVALID",
      "integerPart": 42,
      "fractionalPart": 34,
      "unit": "KILOMETERS"
  },
  "instructionDirection": "right",
  "laneGuidance": [
      { "directionType": "STRAIGHT","toFollow": false },
      { "directionType": "STRAIGHT", "toFollow": false },
      { "directionType": "STRAIGHT", "toFollow": false },
      { "directionType": "RIGHT", "toFollow": true },
      { "directionType": "RIGHT", "toFollow": tru e}
  ],
  "drivingSide": "RIGHT",
  "secondaryRoadShield": {
      "status": "INVALID",
      "roadNumber": "D394",
      "iconSetId": "...",
      "affixList": [
          { "type": "NORTH", "content": "example_data_1" },
          { "type": "NORTH", "content": "example_data_2" }
      ]
  },
  "instructionTowardsName": "Gran Via de Vigo",
  "coordinates": {
      "latitude": 42.24375034099321,
      "longitude": -8.721478119598396
  },
  "intersectionName": "Stellantis Cross-road"
} 
}

false

SUBSCRIBE
navigation.nextManeuverFullAddress
Edit

This API allows to retrieve next maneuver address.

List of instructionDirection values:

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

{
  "instructionDirectionEnum": ["UNKNOWN", "STRAIGHT", "BEAR_RIGHT", "RIGHT", "SHARP_RIGHT", "RIGHT_U_TURN", "BEAR_LEFT", "LEFT", "SHARP_LEFT", "LEFT_U_TURN", "ROUNDABOUT_STRAIGHT", "ROUNDABOUT_STRAIGHT_UK", "ROUNDABOUT_BEAR_RIGHT"
  "ROUNDABOUT_BEAR_RIGHT_UK", "ROUNDABOUT_RIGHT", "ROUNDABOUT_RIGHT_UK", "ROUNDABOUT_SHARP_RIGHT", "ROUNDABOUT_SHARP_RIGHT_UK", "ROUNDABOUT_BEAR_LEFT", "ROUNDABOUT_BEAR_LEFT_UK", "ROUNDABOUT_LEFT"
  "ROUNDABOUT_LEFT_UK", "ROUNDABOUT_SHARP_LEFT", "ROUNDABOUT_SHARP_LEFT_UK", "ROUNDABOUT_U_TURN", "ROUNDABOUT_U_TURN_UK", "BIFURCATION_BEAR_RIGHT", "BIFURCATION_KEEP_RIGHT", "BIFURCATION_KEEP_RIGHT_LANE"
  "BIFURCATION_BEAR_LEFT", "BIFURCATION_KEEP_LEFT", "BIFURCATION_KEEP_LEFT_LANE", "ARRIVAL", "ARRIVAL_WAY_POINT", "FREEWAY", "FERRY", "CHAIN_INSTRUCTION_RIGHT_THEN_TURN_RIGHT"
  "CHAIN_INSTRUCTION_RIGHT_THEN_TURN_LEFT", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_NEXT_STOP", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_DESTINATION", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_FERRY"
  "CHAIN_INSTRUCTION_RIGHT_THEN_ENTER_MOTORWAY", "CHAIN_INSTRUCTION_RIGHT_THEN_ENTER_FREEWAY", "CHAIN_INSTRUCTION_LEFT_THEN_TURN_RIGHT", "CHAIN_INSTRUCTION_LEFT_THEN_TURN_LEFT"
  "CHAIN_INSTRUCTION_LEFT_THEN_REACH_NEXT_STOP", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_DESTINATION", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_FERRY", "CHAIN_INSTRUCTION_LEFT_THEN_ENTER_MOTORWAY"
  "CHAIN_INSTRUCTION_LEFT_THEN_ENTER_FREEWAY", "SECOND_RIGHT", "THIRD_RIGHT", "SECOND_LEFT", "THIRD_LEFT", "DRIVER_ROUTE", "BIFURCATION_MERGE_RIGHT_LANE", "BIFURCATION_MERGE_LEFT_LANE"
  "ARRIVAL_RIGHT", "ARRIVAL_LEFT", "ARRIVAL_WAYPOINT_RIGHT", "ARRIVAL_WAYPOINT_LEFT", "CARTRAIN", "TOLLROAD", "RESTRICTED_AREA", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_ARRIVAL_RIGHT"
  "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_ARRIVAL_LEFT", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_ARRIVAL_WAYPOINT_RIGHT", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_ARRIVAL_WAYPOINT_LEFT"
  "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_CARTRAIN", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_TOLLROAD", "CHAIN_INSTRUCTION_RIGHT_THEN_REACH_RESTRICTED_AREA", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_ARRIVAL_RIGHT"
  "CHAIN_INSTRUCTION_LEFT_THEN_REACH_ARRIVAL_LEFT", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_ARRIVAL_WAYPOINT_RIGHT", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_ARRIVAL_WAYPOINT_LEFT"
  "CHAIN_INSTRUCTION_LEFT_THEN_REACH_CARTRAIN", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_TOLLROAD", "CHAIN_INSTRUCTION_LEFT_THEN_REACH_RESTRICTED_AREA" ]
}

List of laneGuidance.directionType values:

1
2
3
4
5

{
  "laneGuidanceDirectionTypeEnum": ["UNKNOWN", "STRAIGHT", "STRAIGHT_FLIPPED", "BEAR_RIGHT", "RIGHT", "SHARP_RIGHT", "RIGHT_U_TURN", "BEAR_LEFT", "LEFT", "SHARP_LEFT",
  "LEFT_U_TURN", "CONDENSED_STRAIGHT", "CONDENSED_STRAIGHT_FLIPPED", "CONDENSED_BEAR_RIGHT", "CONDENSED_RIGHT", "CONDENSED_SHARP_RIGHT", "CONDENSED_RIGHT_U_TURN",
  "CONDENSED_BEAR_LEFT", "CONDENSED_LEFT", "CONDENSED_SHARP_LEFT", "CONDENSED_LEFT_U_TURN"]
}
Input Parameter
No input params
Output Data
Data name Description Type Unit/Values Example
exit

Next exit.

Object

 /
exit
 .status

Next exit status.

String

 VALID
exit
 .type

Next exit type.

String

 LEFT
exit
 .number

Next exit number.

String

 Exit A42
instructionRoadShield

Current road information.

Object

 /
instructionRoadShield
 .status

Current road information status.

String

 VALID
instructionRoadShield
 .roadNumber

Number of the road.

String

 D394
instructionRoadShield
 .iconSetId

Current road shield icon id.

String
instructionRoadShield
 .affixList

Array of objects

 /
instructionRoadShield
 .affixList
  .type

String
instructionRoadShield
 .affixList
  .content

String
instructionRoadName

Name of the current street.

String

n/a

 		rue de Paris
instructionDistance

Distance to next waypoint.

Array of objects

 /
instructionDistance
 .status

Distance to next waypoint status.

String
instructionDistance
 .integerPart

Distance to next waypoint integer value.

String

 42
instructionDistance
 .fractionalPart

Distance to next waypoint fractional value.

String

 34
instructionDistance
 .unit

Distance to next waypoint unit.

String

 KILOMETERS
instructionDirection

Current instruction direction in the navigation.

String

 - UNKNOWN
- See values list below. 		right
laneGuidance

Lane guidance information.

Array of objects

 /
laneGuidance
 .directionType

Lane guidance direction instruction.

String

 STRAIGHT
laneGuidance
 .toFollow

Lane guidance to follow parameter.

boolean

 false
drivingSide

Current driving side on the road.

String

 - UNKNOWN
- LEFT
- RIGHT 		RIGHT
secondaryRoadShield

Secondary road information.

Object

 /
secondaryRoadShield
 .status

Current road information status.

String

 VALID
secondaryRoadShield
 .roadNumber

Number of the road.

String

 D394
secondaryRoadShield
 .iconSetId

Current road shield icon id.

String
secondaryRoadShield
 .affixList

Array of objects

 /
secondaryRoadShield
 .affixList
  .type

String
secondaryRoadShield
 .affixList
  .content

String
instructionTowardsName

String

n/a

 		Gran Via de Vigo
coordinates

Current position coordinates of the vehicle.

Object

 /
coordinates
 .longitude

Current longitude of the vehicle.

number

 8.74301
coordinates
 .latitude

Current latitude of the vehicle.

number

 8.74301
intersectionName

Name of the intersection.

String

n/a

 		Stellantis Cross-road
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.nextManeuverFullAddress",
    /* 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.nextManeuverFullAddress",
  "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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

// --- 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.nextManeuverFullAddress",
  "status": 200,
  "statusText": "OK", 
  "data": {
  "exit": {
      "status": "INVALID",
      "type": "NONE",
      "number": "Exit A42"
  },
  "instructionRoadShield": {
      "status": "INVALID",
      "roadNumber": "D394",
      "iconSetId": "...",
      "affixList": [
          { "type": "NORTH", "content": "example_data_1" },
          { "type": "NORTH", "content": "example_data_2" }
      ]
  },
  "instructionRoadName": "rue de Paris",
  "instructionDistance": {
      "status": "INVALID",
      "integerPart": 42,
      "fractionalPart": 34,
      "unit": "KILOMETERS"
  },
  "instructionDirection": "right",
  "laneGuidance": [
      { "directionType": "STRAIGHT","toFollow": false },
      { "directionType": "STRAIGHT", "toFollow": false },
      { "directionType": "STRAIGHT", "toFollow": false },
      { "directionType": "RIGHT", "toFollow": true },
      { "directionType": "RIGHT", "toFollow": tru e}
  ],
  "drivingSide": "RIGHT",
  "secondaryRoadShield": {
      "status": "INVALID",
      "roadNumber": "D394",
      "iconSetId": "...",
      "affixList": [
          { "type": "NORTH", "content": "example_data_1" },
          { "type": "NORTH", "content": "example_data_2" }
      ]
  },
  "instructionTowardsName": "Gran Via de Vigo",
  "coordinates": {
      "latitude": 42.24375034099321,
      "longitude": -8.721478119598396
  },
  "intersectionName": "Stellantis Cross-road"
} 
}

Back to Ref List

Related References