Mobile SDK

iOS or Android

API Reference - pims.vehicle.trips-remove

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:

This API allows removing trip(s) in stored the head-unit.

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

Vehicle Identification Number

String

n/a

VR1AB12C3D4567890 true
action

Filter mode, in this case remove.

String

remove

remove true
ids

Identifier of the trip(s) to remove.

List of Numbers

n/a

[418, 419] true
Output Data
No outputted 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)

2370

Can’t remove trip with identifier: [IDENTIFIER]

Code Example
1
2
3
4
5
6
7
8
9
10
11
pims.set("pims.vehicle.trips",
  mapOf( /* parameters */  
    Pair("", ""),
    Pair("action", "remove"),
    Pair("ids", "[418, 419]")
  ) 
) { 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.trips",
  parameters: [  
  "": "",
  "action": "remove",
  "ids": "[418, 419]"
  ]
  ) { (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: 2370 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2370,
    "label": "Can't remove trip with identifier: [IDENTIFIER]"
  }
}