Mobile SDK

iOS or Android

    API Reference - pims.vehicle.privacy

    Edit
    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:
    GET
    pims.vehicle.privacy
    Edit

    This api allows to get the vehicle privacy. This API require sendToNav being enable using pims.vehicle.service - Start.

    They are 3 levels of privacy:

    • none: data & geolocation are authorized.
    • geolocationPrivate: data is authorized but not geolocation.
    • fullPrivate: data & geolocation are not authorized, sometime called plane mode.

    pims.vehicle.destination is available only if privacy is set to none.

    Input Parameter
    Param name Description Type Unit/Values Example Required
    vin

    Vehicle Identification Number

    String

    n/a

         		VR1AB12C3D45678909 true
    Output Data
    Data name Description Type Unit/Values Example
    privacy

    privacy value

    String

    		 - fullPrivate
    - geolocationPrivate
    - none     		geolocationprivate
    Error
    Error Code Error Label
    2001

    Facade not initialized
    2101

    Missing [PARAMETER] parameter
    2102

    Invalid [PARAMETER] parameter
    2205

    CEA Error
    2301

    Need Basic Authentication (to get CVS token)
    2341

    [Location or Bluetooth] need to be activated on the phone
    2342

    Smartphone not paired with the vehicle
    2367

    Service not started
    Code Example 
    1
2
3
4
5
6
7
8
9

    pims.get("pims.vehicle.privacy",
  mapOf( /* parameters */  
    Pair("vin", "VR1AB12C3D45678909")
  ) 
) { 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.privacy",
  parameters: [  
  "vin": "VR1AB12C3D45678909"
  ]
  ) { (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

    // representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": { 
  "privacy": "geolocationprivate"
} 
}

    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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74

    // 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"
  }
}
/* -------- STATUS FAILED: 2301 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2301,
    "label": "Need Basic Authentication (to get CVS token)"
  }
}
/* -------- STATUS FAILED: 2341 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2341,
    "label": "[Location or Bluetooth] need to be activated on the phone"
  }
}
/* -------- STATUS FAILED: 2342 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2342,
    "label": "Smartphone not paired with the vehicle"
  }
}
/* -------- STATUS FAILED: 2367 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2367,
    "label": "Service not started"
  }
}