Mobile SDK

iOS or Android

API Reference - pims.vehicle.statistics-distance

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.1
Component:
  • TripNDrive
Security: Authentication is required.
Operation:
GET
pims.vehicle.statistics - distance
Edit

Returns the total distance traveled in Trips during the requested time period.

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

Action Name, in this case distance.

String

distance

 		distance true
vin

Vehicle Identification Number

String

n/a

 		VR1AB12C3D4567890 true
period

Time period of the statistics.

Enum of String

 - day
- week
- month
- year
- beginning 		day true
Output Data
Data name Description Type Unit/Values Example
distance

Sum of Trips distance during the period.

Number

n/a

 		3600
Error
Error Code Error Label
2001

Facade not initialized
2101

Missing [PARAMETER] parameter
2102

Invalid [PARAMETER] parameter
Code Example 
1
2
3
4
5
6
7
8
9
10
11

pims.get("pims.vehicle.statistics",
  mapOf( /* parameters */  
    Pair("action", "distance"),
    Pair("vin", "VR1AB12C3D4567890"),
    Pair("period", "day")
  ) 
) { 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.get(api: "pims.vehicle.statistics",
  parameters: [  
  "action": "distance",
  "vin": "VR1AB12C3D4567890",
  "period": "day"
  ]
  ) { (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

// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": { 
  "distance": "3600"
} 
}

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

// 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"
  }
}

Back to Ref List

Related References