Mobile SDK

iOS or Android

API Reference - pims.vehicle.vins

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:

Returns the list of VINs subcribed on API pims.vehicle.trips.

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

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

Object

/
vin

Vehicle Identification Number

String

n/a

VR1AB12C3D4567890
vins
 .gdpr

GDRP configuration.

boolean

n/a

true
Error
Error Code Error Label
2001

Facade not initialized

2344

[Component] not configured

Code Example
1
2
3
4
5
6
7
pims.get("pims.vehicle.vins"
  /* 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.vins"
  /* 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
13
14
15
// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": [
    {
      "vin": "VR1AB12C3D45678908",
      "gdpr": true
    },
    {
      "vin": "VR1AB12C3D45678909",
      "gdpr": false
    }
  ]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
// 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: 2344 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2344,
    "label": "[Component] not configured"
  }
}