Mobile SDK

iOS or Android

    API Reference - pims.vehicle.device

    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:
    SET
    pims.vehicle.device
    Edit

    This api allows filtering device to connect or not. This API exists only for Android, this step is not required, and does not exist for iOS.

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

    Indicates if you choose to connect the device or not.

    Boolean

    n/a

         		true true
    Output Data
    No data
    Error
    Error Code Error Label
    2001

    Facade not initialized
    2101

    Missing [PARAMETER] parameter
    2102

    Invalid [PARAMETER] parameter
    2301

    Need Basic Authentication (to get CVS token)
    2345

    No data saved
    Code Example 
    1
2
3
4
5
6
7
8
9

    pims.set("pims.vehicle.device",
  mapOf( /* parameters */  
    Pair("isConnected", "true")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }

    1
2
3
4
5
6
7
8
9

    pims.set(api: "pims.vehicle.device",
  parameters: [  
  "isConnected": "true"
  ]
  ) { (message) in 
    if message["status"] == "SUCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 

    1
2
3
4
5
6

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

    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

    // 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: 2301 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2301,
    "label": "Need Basic Authentication (to get CVS token)"
  }
}
/* -------- STATUS FAILED: 2345 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2345,
    "label": "No data saved"
  }
}