Mobile SDK

iOS or Android

    API Reference - pims.vehicle.command-doors

    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:

    This API allows to send remote command to the vehicle.

    Before sending any remote to vehicle, you should subscribe pims.vehicle.signal. Use this set of parameters with pims.vehicle.command to honk the vehicle horn.

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

    Name of the remote action to perform, in this case doors.

    String

    doors

    doors true
    doorState

    Command to send to the vehicle doors.

    Enum String

    - lock

    - unlock
    lock true
    Output Data
    No data
    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

    2357

    Doors state need to be update

    2360

    All vehicle’s doors are unlocked

    2361

    All vehicle’s doors are locked

    2362

    Lock/Unlock request discarded due to door open

    2377

    Broker connexion failed

    Code Example
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    
    pims.set("pims.vehicle.command",
      mapOf( /* parameters */  
        Pair("action", "doors"),
        Pair("doorState", "lock")
      ) 
    ) { message -> when (message["status"] as? String) {
          "SUCCEEDED" -> { }                          // handle succeeded status
          "FAILED" ->    { }                          // handle failed status
      } }
    
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    
    pims.set(api: "pims.vehicle.command",
      parameters: [  
      "action": "doors",
      "doorState": "lock"
      ]
      ) { (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
    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
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    
    // 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 "
      }
    }
    /* -------- STATUS FAILED: 2357 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2357,
        "label": "Doors state need to be update"
      }
    }
    /* -------- STATUS FAILED: 2360 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2360,
        "label": "All vehicle's doors are unlocked"
      }
    }
    /* -------- STATUS FAILED: 2361 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2361,
        "label": "All vehicle's doors are locked"
      }
    }
    /* -------- STATUS FAILED: 2362 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2362,
        "label": "Lock/Unlock request discarded due to door open"
      }
    }
    /* -------- STATUS FAILED: 2377 -------- */
    {
      "transactionId": "953cfefb-bc72",
      "status": "FAILED",
      "error": {
        "code": 2377,
        "label": "Broker connexion failed"
      }
    }