Mobile SDK

iOS or Android

API Reference - pims.subscription.steps-stepsID

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:
  • UserVehicleSteps
Security: Authentication is required.
Operation:

Returns the user vehicle steps with stepsID.

Use resetSteps = true in tow cases:

  • Whenever you receive the error code 2312.
  • If you get the error code 2317 while using your pin code.
Input Parameter
Param name Description Type Unit/Values Example Required
stepsID

Steps id value.

String

n/a

false
resetSteps

Indicates if must reset all step status.

Boolean

n/a

true true
stepsStatus

Step name used to filter the result.

String

- all

- todo

- alreadyDone
all true
Output Data
Data name Description Type Unit/Values Example
stepsID

Steps id value.

String

n/a

trustedPhone

Information about trusted phone.

Object

/
trustedPhone
 .name

Step name value.

String

- trustedPhone

- deviceActivation

- mediumCarKey
trustedphone
trustedPhone
 .status

Status of the step.

String

- todo

- alreadyDone
todo
trustedPhone
 .order

Order of the steps.

Integer

- 1

- 2

- 3
2
deviceActivation

Information about device activation.

Object

/
deviceActivation
 .name

Step name value.

String

- trustedPhone

- deviceActivation

- mediumCarKey
trustedphone
deviceActivation
 .status

Status of the step.

String

- todo

- alreadyDone
todo
deviceActivation
 .order

Order of the steps.

Integer

- 1

- 2

- 3
2
mediumCarKey

Information about medium car key.

Object

/
mediumCarKey
 .name

Step name value.

String

- trustedPhone

- deviceActivation

- mediumCarKey
trustedphone
mediumCarKey
 .status

Status of the step.

String

- todo

- alreadyDone
todo
mediumCarKey
 .order

Order of the steps.

Integer

- 1

- 2

- 3
2
Error
Error Code Error Label
2000

Unknown error

2101

Missing [PARAMETER] parameter

2102

Invalid [PARAMETER] parameter

2201

Timeout

2202

Network problem : No internet

2203

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

2204

Server Error

Code Example
1
2
3
4
5
6
7
8
9
10
11
pims.get("pims.subscription.steps",
  mapOf( /* parameters */  
    Pair("stepsID", " "),
    Pair("resetSteps", "true"),
    Pair("stepsStatus", "all")
  ) 
) { 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.subscription.steps",
  parameters: [  
  "stepsID": " ",
  "resetSteps": "true",
  "stepsStatus": "all"
  ]
  ) { (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
16
17
18
19
20
21
22
23
// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": { 
    "stepsId": 132324,
    "trustedPhone": {
        "name": "trustedPhone",
        "status": "alreadyDone",
        "order": 1
    },
    "deviceActivation": {
        "name": "deviceActivation",
        "status": "todo",
        "order": 2
    },
    "mediumCarKey": {
        "name": "mediumCarKey",
        "status": "todo",
        "order": 3
    }
  }
}
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
// 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"
  }
}
/* -------- 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"
  }
}