Mobile SDK

iOS or Android

API Reference - pims.vehicle.destinations

Edit
Info: Stellantis Mobile SDK is not publicly available.
Component: 🏁  Send Navigation PSA
Tutorial: check-out Send Navigation.
SDK Version: v2.3
API Available since: v2.0
API Last update: v2.0
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:
GET
pims.vehicle.destinations

This api allows retrieving the list of navigations stored in vehicle cache. Navigation are stored when the vehicle was not reachable when sending a navigation.

Input Parameters Object
No input params.
Output Data Object
Data name Description Type Unit/Values Example
destinations

Destinations information.

Array of Objects

 /
destinations
 .vin

Vehicle Identification Number.

String

n/a

 		VR1AB12C3D45678909
destinations
 .userid

User id value.

String

n/a

 		user@provider.tld
destinations
 .location

Location of the destination.

Object

 /
destinations
 .location
  .latitude

latitude value

Double

n/a

 		48.77232
destinations
 .location
  .longitude

longitude value

Double

n/a

 		2.2151043
destinations
 .location
  .address

address value

String

n/a

 		Rte de Gisy, 78140 Vélizy-Villacoublay
Error
No errors
Code Example 
1
2
3
4
5
6
7

pims.get("pims.vehicle.destinations"
  /* no params */
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }

1
2
3
4
5
6
7

pims.get(api: "pims.vehicle.destinations"
  /* no params */
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 

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

// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": {
    "destinations": [ 
    {
      "vin": "VR1AB12C3D45678909",
      "userid": "user@provider.tld",
      "location": {
        "latitude": 48.77232,
        "longitude": 2.2151043,
        "address": "Rte de Gisy, 78140 Vélizy-Villacoublay"
      }
    }, /* Other destinations objects */ ]
  }
}

false

Back to Ref List 2.3

🏁 Send Navigation PSA  APIs: