Mobile SDK

iOS or Android

    API Reference - pims.vehicle.event-remote

    Edit
    Info: Stellantis Mobile SDK for ex Groupe PSA brands (CitroĂŤn, DS, Peugeot, Opel and Vauxhall) is not publicly available for now.
    Available since: v2.0.X
    Component: LongRangeRemote
    Security: Authentication is required.
    Prerequisites: Activation Steps being performed.
    Operation:
    SUBSCRIBE
    pims.vehicle.event - remote
    Edit

    This api allows to be notified when a remote charge ends.

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

    Action name, in this case remote.

    String

    remote

         		remote true
    type

    Service type.

    Array of Strings

    		 - remoteChargeFinished
    - remoteChargeInterrupted     		["remoteChargeFinished", "remoteChargeInterrupted"] true
    Output Data
    Data name Description Type Unit/Values Example
    notification

    Notification received when the charging is finished or interrupted.

    String

    		 - remoteChargeFinished
    - remoteChargeInterrupted     		remoteChargeFinished
    Error
    Error Code Error Label
    2000

    Unknown error
    2101

    Missing [PARAMETER] parameter
    2102

    Invalid [PARAMETER] parameter
    2201

    Timeout/Polling Timeout/Command Timeout
    2202

    Network problem : No internet
    2203

    Invalid return [Parsing error] ou [No data] ou [invalid Data]
    2204

    Server Error
    2301

    Need Basic Authentication (to get CVS token)
    2302

    Need Strong Authentication
    Code Example 
    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

    /* Subscribe, see unsubscribe below */
pims.subscribe("pims.vehicle.event",
  mapOf( /* parameters */  
    Pair("actionType", "remote"),
    Pair("type", "["remoteChargeFinished", "remoteChargeInterrupted"]")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
      "RESULT" ->    {
        if(message["error"] != null) { }            // handle error event code
        else { }                                 // handle result event code
      }
  } }

/* Unsubscribe */
pims.unsubscribe( "pims.vehicle.event" /* no params */ )

    1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

    /* Subscribe, see unsubscribe below */
pims.subscribe(api: "pims.vehicle.event",
  parameters: [  
  "actionType": "remote",
  "type": "["remoteChargeFinished", "remoteChargeInterrupted"]"
  ]
  ) { (message) in 
    if message["status"] == "SUCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
    else if status == "RESULT" {
      if !message["error"].isEmpty { }            // handle error event code
      else { }                                    // handle result event code
    }
  } 

/* Unsubscribe */
pims.unsubscribe( api: "pims.vehicle.event" /* no params */ )

    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

    // representation of the `result` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "RESULT",
  "result": { 
    "notification": "remoteChargeFinished"
  } 
}

    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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

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

/* -------- STATUS FAILED: 2000 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2000,
    "label": "Unknown error"
  }
}
/* -------- 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: 2201 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2201,
    "label": "Timeout/Polling Timeout/Command Timeout"
  }
}
/* -------- STATUS FAILED: 2202 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2202,
    "label": "Network problem : No internet"
  }
}
/* -------- STATUS FAILED: 2203 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2203,
    "label": "Invalid return [Parsing error] ou [No data] ou [invalid Data]"
  }
}
/* -------- STATUS FAILED: 2204 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2204,
    "label": "Server Error"
  }
}
/* -------- STATUS FAILED: 2301 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2301,
    "label": "Need Basic Authentication (to get CVS token)"
  }
}
/* -------- STATUS FAILED: 2302 -------- */
{
  "transactionId": "953cfefb-bc72",
  "status": "FAILED",
  "error": {
    "code": 2302,
    "label": "Need Strong Authentication "
  }
}