Mobile SDK

iOS or Android

API Reference - pims.vehicle.coordinate

Info: Stellantis Mobile SDK is not publicly available.
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:

This API allows to retrieve coordinates from ShaeExtension (Apple Maps, Google Maps, Here WeGo, Waze & Whats3Words). Depending on the link the response can also contain an address field.

Input Parameters Object
Param name Description Type Unit/Values Example Required
extensionInformation

Link of the address get from an external application.

String

n/a

https://goo.gl/maps/8VPNW6yTfHgPPqb16 true
Output Data Object
Data name Description Type Unit/Values Example
location

Location of the destination.

Object

/
location
 .latitude

latitude value

Double

n/a

48.77232
location
 .longitude

longitude value

Double

n/a

2.2151043
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
8
9
pims.get("pims.vehicle.coordinate",
  mapOf( /* parameters */  
    Pair("extensionInformation", "https://goo.gl/maps/8VPNW6yTfHgPPqb16")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }
1
2
3
4
5
6
7
8
9
pims.get(api: "pims.vehicle.coordinate",
  parameters: [  
    "extensionInformation": "https://goo.gl/maps/8VPNW6yTfHgPPqb16"
  ]
  ) { (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
// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": {
    "location": {
      "latitude": 48.77232,
      "longitude": 2.2151043,
      "address": "Rte de Gisy, 78140 Vélizy-Villacoublay"
    }
  }
}

false