Mobile SDK

iOS or Android

    API Reference - pims.vehicle.coordinate

    Info: Stellantis Mobile SDK for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is not publicly available for now.
    Available since: v2.0.X
    Component: SendToNav
    Security: Authentication is required.
    Operation:

    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 Parameter
    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
    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
    Error Code Error Label
    2001

    Facade not initialized

    2101

    Missing [PARAMETER] parameter

    2102

    Invalid [PARAMETER] parameter

    2205

    CEA Error

    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"] == "SUCEEDED"    { }    // 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"
        }
      }
    }
    
    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
    
    // representation of the `failed` dictionary objects messages as JSON
    
    /* -------- STATUS FAILED: 2001 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2001,
        "label": "Facade not initialized"
      }
    }
    /* -------- STATUS FAILED: 2101 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2101,
        "label": "Missing [PARAMETER] parameter"
      }
    }
    /* -------- STATUS FAILED: 2102 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2102,
        "label": "Invalid [PARAMETER] parameter"
      }
    }
    /* -------- STATUS FAILED: 2205 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2205,
        "label": "CEA Error"
      }
    }