Mobile SDK

iOS or Android

API Reference - pims.vehicle.service

Info: Stellantis Mobile SDK is not publicly available.
SDK Version: v2.3
API Available since: v2.3
API Last update: v2.3 New API!
Plateforme Compatibility: PSA
Security:
  • Authentication: Authentication is required.
Operations:

This api allows to connect or disconnect Bluetooth services.

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

Connect or disconnect Bluetooth services.

String

- start: start the service

- stop: stop the service
start true
service

Enable bluetooth service.

String

bluetooth

bluetooth true
vins

List of listening VINs and GDPR config. Empty if no subscribtion.

Object

/ /
vins
 .vin

Vehicle Identification Number.

String

n/a

VR1AB12C3D4567890 true
vins
 .gdpr

GDRP configuration. Check out pims.vehicle.trips.

Boolean

n/a

true true
Output Data Object
No outputted data
Error
No errors
Code Example
1
2
3
4
5
6
7
8
9
10
11
pims.set("pims.vehicle.service",
  mapOf( /* parameters */  
    Pair("action", "start"),
    Pair("service", "bluetooth"),
    Pair("vins", )
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }
1
2
3
4
5
6
7
8
9
10
11
pims.set(api: "pims.vehicle.service",
  parameters: [  
    "action": "start",
    "service": "bluetooth",
    "vins": 
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // 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": { }
}

false