API Reference - pims.vehicle.connection
Info: Stellantis Mobile SDK is not publicly available.
Component:
📍
Trips
PSA
Tutorial:
check-out
Trips.
SDK Version:
v2.2
API Available since:
v2.0
API Last update:
v2.0
Plateforme Compatibility: PSA
Security:
- Authentication: Authentication is required.
Operations:
This API allows to retrieve if the Trip
service is enabled or not. Check out SUBSCRIBE pims.vehicle.connection.
Input Parameters Object | |||||
---|---|---|---|---|---|
No input params. |
Output Data Object | |||||
---|---|---|---|---|---|
Data name | Description | Type | Unit/Values | Example | |
vin | Vehicle Identification Number. |
String |
|
VR1AB12C3D4567890
|
|
protocol | Field present if |
Enum of Strings |
- CEA
- Altran
|
CEA
|
|
model | Field present if |
Enum of Strings |
- SMEG
- NAC
- RCC
- RCE
- AIO_NAC
- AIO_RCC
- IVI
|
NAC
|
|
version |
|
String |
|
1.0.2
|
|
privacy | Field present if |
Enum of Strings |
- Full
- Geolocation
- None
- Unknown
|
Full
|
Error | ||
---|---|---|
No errors |
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"] == "SUCCEEDED" { } // 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": "VR1AB12C3D4567890",
"protocol": "CEA",
"model": "NAC",
"version": "1.0.2",
"privacy": "Full"
}
}
false