Mobile SDK

iOS or Android

    API Reference - pims.vehicle.destinations

    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 retrieving the list of stored navigations. Navigation are stored when the vehicle was not reachable when sending a navigation using pims.vehicle.destination.

    See pims.vehicle.destination - Coordinate or pims.vehicle.destination - Extension.

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

    Destinations information.

    List of Object

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

    Facade not initialized

    2301

    Need Basic Authentication (to get CVS token)

    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"] == "SUCEEDED"    { }    // 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
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    
    // representation of the `succeeded` dictionary object message as JSON
    {
      "transactionId": "953cfefb-bc72",
      "status": "SUCCEEDED",
      "result": { 
        "destination": [
          // First Destination
          {
            "vin": "VR1AB12C3D45678909",
            "userid": "user@provider.tld"
            "location": {
              "latitude": "trustedPhone",
              "longitude": "2.2151043",
              "address": "Rte de Gisy, 78140 Vélizy-Villacoublay"
            }
          },
          // Second Destination
          {
            "vin": "VR2AB12C3D45678909",
            "userid": "otheruser@provider.tld"
            "location": {
              "latitude": "37.32772",
              "longitude": "12.0432151",
              "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
    
    // 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: 2301 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2301,
        "label": "Need Basic Authentication (to get CVS token)"
      }
    }