Mobile SDK

iOS or Android

API Reference - pims.vehicle.connection

Edit
Info: Stellantis Mobile SDK for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is not publicly available yet.
Available since: v2.0
Component:
  • TripNDrive
Security: Authentication is required.
Operation:
GET
pims.vehicle.connection
Edit

This API allows to retrieve if the Trip service is enabled or not. Check out SUBSCRIBE pims.vehicle.connection.

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

Vehicle’s VIN. It can be null if no VIN connected.

String

n/a

 		VR1AB12C3D45678909
protocol

Field present if vin!=null

Enum of Strings

 - CEA
- Altran 		CEA
model

Field present if vin!=null

Enum of Strings

 - SMEG
- NAC
- RCC
- RCE
- AIO_NAC
- AIO_RCC
- IVI 		NAC
version
Protocol version (SemVer format). Field present if vin!=null. Field has value if protocol=="CEA". With protocol=="Altran" value is empty ("")

String

n/a

 		1.0.2
privacy

Field present if vin!=null. For Altran connections, value will be always "Unknown".

Enum of Strings

 - Full
- Geolocation
- None
- Unknown 		Full
Error
Error Code Error Label
2001

Facade not initialized
Code Example 
1
2
3
4
5
6
7

pims.get("pims.vehicle.connection"
  /* 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.connection"
  /* 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

// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": { 
  "vin": "VR1AB12C3D45678909",
  "protocol": "CEA",
  "model": "NAC",
  "version": "1.0.2",
  "privacy": "Full"
} 
}

1
2
3
4
5
6
7
8
9
10
11

// representation of the `failed` dictionary objects messages as JSON

/* -------- STATUS FAILED: 2001 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2001,
    "label": "Facade not initialized"
  }
}

Back to Ref List

Related References