Mobile SDK

iOS or Android

    API Reference - pims.vehicle.informations-remote

    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 retrieve Remote vehicle informations.

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

    Action name, in this case remote.

    String

    remote: ‘get vehicle information from server’

    remote true
    action

    Name of the action to perform, in this case Remote. Required only for remote service .

    String

    - get: 'Get vehicle information from server, if a network problem occurred, the last vehicle information from cache will be returned.'

    - refresh: 'Force the refresh of vehicle information from server, if: (1) the charge state is in progress or (2) the vehicle is plugged but disconnected ; a wake up remote will be send to the vehicle.'

    - refreshWithWakeUp: 'force the refresh information with send a wake up remote.'
    refresh true
    Output Data
    Data name Description Type Unit/Values Example
    vehicle

    Vehicle informations.

    Object

    /
    vehicle
     .ressources

    Ressources informations.

    Object

    /
    vehicle
     .ressources
      .status

    Status informations.

    Object

    /
    vehicle
     .ressources
      .status
       .autonomy

    Autonomy value.

    Double

    n/a

    130.0
    vehicle
     .ressources
      .status
       .lastUpdate

    The last update of vehicle information.

    String

    n/a

    2021-07-29T22:25:09.898Z
    vehicle
     .ressources
      .status
       .fuelInformation

    Fuel Information.

    Object

    /
    vehicle
     .ressources
      .status
       .fuelInformation
        .autonomy

    Autonomy value.

    Double

    n/a

    130.0
    vehicle
     .ressources
      .status
       .fuelInformation
        .chargingLevel

    The charging level value.

    Double

    percentage

    100.0
    vehicle
     .ressources
      .status
       .fuelInformation
        .lastUpdate

    The last update of preconditioning information.

    String

    date time

    2021-07-29 22:25:09 +0000
    vehicle
     .ressources
      .status
       .fuelInformation
        .consumption

    The consumption value.

    Double

    n/a

    23.0
    vehicle
     .ressources
      .status
       .fuelInformation
        .type

    The energy information type.

    Enum of Strings

    - electric

    - fuel
    fuel
    vehicle
     .ressources
      .status
       .doorStateInformation

    Door State Information.

    Object

    /
    vehicle
     .ressources
      .status
       .doorStateInformation
        .isRearRightDoorOpened

    True if rear right door opened false otherwise.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .doorStateInformation
        .isTrunkDoorOpened

    True if trunk opened false otherwise.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .doorStateInformation
        .isLocked

    True if vehicle is locked, false otherwise.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .doorStateInformation
        .isRearWindowDoorOpened

    True if rear window is opened false otherwise.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .doorStateInformation
        .isPassengerDoorOpened

    True if passenger door opened false otherwise.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .doorStateInformation
        .isRearLeftDoorOpened

    True if rear left door opened false otherwise.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .doorStateInformation
        .state

    The door status.

    Array of String

    - unlocked

    - locked

    - superLocked

    - driverDoorUnlocked

    - cabinDoorsUnlocked

    - cargoDoorsLocked

    - cargoDoorsUnlocked

    - rearDoorsUnlocked

    - rearDoorsLocked

    - trunkLocked
    Unlocked
    vehicle
     .ressources
      .status
       .doorStateInformation
        .isDriverDoorOpened

    True if driver door opened false otherwise.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .precondInformation

    Preconditioning Information.

    Object

    /
    vehicle
     .ressources
      .status
       .precondInformation
        .lastUpdate

    The last update of preconditioning information.

    String

    date time

    2021-07-29T22:25:09.898Z
    vehicle
     .ressources
      .status
       .precondInformation
        .PrecondScheduling

    Preconditioning Scheduling Information.

    Object

    /
    vehicle
     .ressources
      .status
       .precondInformation
        .PrecondScheduling
         .hour

    The hour of the preconditioning program.

    Integer

    Hour

    16
    vehicle
     .ressources
      .status
       .precondInformation
        .PrecondScheduling
         .isEnabled

    true if preconditioning program is enabled, false otherwis.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .precondInformation
        .PrecondScheduling
         .occurrence

    The days of preconditioning program.

    List

    - mon

    - tue

    - wed

    - thu

    - fri

    - sat

    - sun
    ["mon", "fri", "sat"]
    vehicle
     .ressources
      .status
       .precondInformation
        .PrecondScheduling
         .slot

    Slot of the preconditionning program.

    Integer

    n/a

    1
    vehicle
     .ressources
      .status
       .precondInformation
        .PrecondScheduling
         .minute

    The minute of the preconditioning program.

    Integer

    minutes

    25
    vehicle
     .ressources
      .status
       .precondInformation
        .status

    The status of preconditioning.

    String

    - Unknown

    - Disabled

    - Enabled

    - Finished

    - Failure
    Enabled
    vehicle
     .ressources
      .status
       .electricInformation

    Electric Information.

    Object

    /
    vehicle
     .ressources
      .status
       .electricInformation
        .autonomy

    The autonomy value.

    Integer

    n/a

    22
    vehicle
     .ressources
      .status
       .electricInformation
        .ChargingInfo

    Charging Information.

    Object

    /
    vehicle
     .ressources
      .status
       .electricInformation
        .ChargingInfo
         .chargingMode

    The charging mode.

    Enum

    - SLOW

    - QUICK

    - false

    - UNKNOWN
    QUICK
    vehicle
     .ressources
      .status
       .electricInformation
        .ChargingInfo
         .chargingRate

    The charge rating value.

    Double

    percentage

    90.0
    vehicle
     .ressources
      .status
       .electricInformation
        .ChargingInfo
         .isPlugged

    true if vehicle is plugged, false otherwise.

    Boolean

    n/a

    true
    vehicle
     .ressources
      .status
       .electricInformation
        .ChargingInfo
         .nextDeferredChargingDate

    Date of next deferred charge.

    String

    duration

    vehicle
     .ressources
      .status
       .electricInformation
        .ChargingInfo
         .chargingState

    The charging state.

    Enum of Strings

    - DISCONNECTED

    - INPROGRESS

    - FAILURE

    - STOPPED

    - FINISHED

    - UNKNOWN
    DISCONNECTED
    vehicle
     .ressources
      .status
       .electricInformation
        .ChargingInfo
         .remainingTime

    The time remaining for the full charg.

    Long

    time

    PT0S
    vehicle
     .ressources
      .status
       .electricInformation
        .chargingLevel

    The charging level value.

    Double

    percentage

    100.0
    vehicle
     .ressources
      .status
       .electricInformation
        .lastUpdate

    The last update of preconditioning information.

    String

    date time

    2021-07-29T22:25:09.898Z
    vehicle
     .ressources
      .status
       .electricInformation
        .consumption

    The consumption value.

    Double

    n/a

    23.0
    vehicle
     .ressources
      .status
       .electricInformation
        .type

    The energy information type.

    String

    - electric

    - fuel
    electric
    vehicle
     .ressources
      .status
       .vehicleType

    Propulsion type of the vehicle.

    string

    hybrid

    hybrid
    vehicle
     .attributes

    Attributes informations.

    Object

    /
    vehicle
     .attributes
      .engine

    Vehicle engine type.

    String

    - bev

    - phev

    - thermal
    bev
    vin

    Vehicle Identification Number

    String

    n/a

    VR1AB12C3D4567890
    vehicle
     .attributes
      .brand

    Name of the vehicle brand.

    String

    - peugeot

    - citroen

    - opel

    - vauxhall
    opel
    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
    
    pims.get("pims.vehicle.informations",
      mapOf( /* parameters */  
        Pair("actionType", "remote"),
        Pair("action", "refresh")
      ) 
    ) { 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.get(api: "pims.vehicle.informations",
      parameters: [  
      "actionType": "remote",
      "action": "refresh"
      ]
      ) { (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
    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
    
    // representation of the `succeeded` dictionary object message as JSON
    {
      "transactionId": "953cfefb-bc72",
      "status": "SUCCEEDED",
      "result": {
        "resources": {
            "status": {
              "autonomy":145.0,
              "lastUpdate": "2022-02-14T13':'41':58Z",
              "fuelInformation": {
                  "autonomy":145.0,
                  "chargingInformation": {
                    "chargingMode":null,
                    "chargingRate":0.0,
                    "isPlugged":false,
                    "chargingState":null,
                    "remainingTime": "PT0S"
                  },
                  "chargingLevel":42.0,
                  "lastUpdate": "2022-02-14T13':'41':57Z",
                  "consumption":0.0,
                  "type": "fuel"
              },
              "doorStateInformation": {
                  "isRearRightDoorOpened":false,
                  "isTrunkDoorOpened":false,
                  "isLocked":true,
                  "isRearWindowDoorOpened":false,
                  "isPassengerDoorOpened":false,
                  "isRearLeftDoorOpened":false,
                  "state": [
                    "trunkLocked",
                    "locked"
                  ],
                  "isDriverDoorOpened":false
              },
              "precondInformation": {
                  "lastUpdate": "2022-02-14T13':'41':57Z",
                  "precondScheduling": [
                    {
                        "hour":1,
                        "isEnabled":false,
                        "occurrence": [
                          "mon"
                        ],
                        "slot":1,
                        "minute":48
                    }
                  ],
                  "status": "disabled"
              },
              "electricInformation": {
                  "autonomy":0.0,
                  "chargingInformation": {
                    "chargingMode": "no",
                    "chargingRate":0.0,
                    "isPlugged":false,
                    "nextDeferredChargingDate": "2022-02-14T18':'00':10.715Z",
                    "chargingState": "disconnected",
                    "remainingTime": "PT0S"
                  },
                  "chargingLevel":1.0,
                  "lastUpdate": "2022-02-14T13':'41':57Z",
                  "consumption":0.0,
                  "type": "electric"
              },
              "vehicleType": "hybrid"
            }
        },
        "attributes": {
            "engine": "phev",
            "vin": "VR3ATTENTKY102274",
            "brand": "peugeot"
        }
      }
    }
    
    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 "
      }
    }