API Reference - pims.vehicle.informations-O2X

Edit

Info: Stellantis Mobile SDK is not publicly available.

Component: 🚙 AMI & Rocks-e ^O2X

Tutorial: check-out AMI & Rocks-e.

SDK Version: v2.3

API Available since: v2.0

API Last update: v2.0

Plateforme Compatibility: O2X

Security: none

Operations:

GET

pims.vehicle.informations - O2X

This API allows to retrieve O2X vehicle informations.

Input Parameters Object
Param name	Description	Type	Unit/Values	Example	Required
actionType	Action name, in this case `O2X`.	String	`O2X: ‘get the last saved vehicle information from O2X’`	`O2X`	`true`

Output Data Object
Data name	Description	Type	Unit/Values	Example
vin	Vehicle Identification Number.	String	`n/a`	`VR1AB12C3D4567890`
receivedAt	Receive time.	String	`n/a`	`YYYY-MM-DDTHH:MM:SSZ`
status	Vehicle status.	String	`- unknown` `- driving` `- parked` `- charging`	`charging`
currentAlert	CurrentAlert informations.	Object	/
currentAlert .parkingBrake	Is parking brake alert active.	Boolean	`n/a`	`false`
currentAlert .clusterIssue	Is cluster issue alert active.	Boolean	`n/a`	`false`
currentAlert .stop	Is stop alert active.	Boolean	`n/a`	`true`
currentAlert .batteryCharge	Is battery charge alert active.	Boolean	`n/a`	`true`
currentAlert .brakeSystemProblem	Is brake system problem alert.	Boolean	`n/a`	`true`
currentAlert .service	Is service alert active.	Boolean	`n/a`	`false`
currentAlert .batteryTemperature	Is battery temperature alert active.	Boolean	`n/a`	`true`
currentAlert .turtleMode	Is turtle mode alert active.	Boolean	`n/a`	`false`
previousAlert	PreviousAlert informations.	Object	/
previousAlert .parkingBrake	Is parking brake alert was active.	Boolean	`n/a`	`false`
previousAlert .clusterIssue	Is cluster issue alert was active.	Boolean	`n/a`	`false`
previousAlert .stop	Is stop alert was active.	Boolean	`n/a`	`true`
previousAlert .batteryCharge	Is battery charge alert was active.	Boolean	`n/a`	`true`
previousAlert .brakeSystemProblem	Is brake system problem alert was active.	Boolean	`n/a`	`true`
previousAlert .service	Is service alert was active.	Boolean	`n/a`	`false`
previousAlert .batteryTemperature	Is batter temperature alert was active.	Boolean	`n/a`	`true`
previousAlert .turtleMode	Is turtle mode alert was active.	Boolean	`n/a`	`false`
data	Data informations.	Object	/
data .batterySoc	BatterySoc informations.	Object	/
data .batterySoc .value	Battery soc value.	String	`n/a`	`42`
data .batterySoc .unit	Battery soc unit.	String	`n/a`	`%`
data .systemState	System state value.	String	`- init` `- standby` `- driving` `- charging` `- noticed` `- powerdown` `- sleep` `- unknown`	`sleep`
data .batteryState	battery state value	String	`- ready` `- maintenaceautoid` `- bootloader` `- maintenancelogflash` `- maintenanceexit` `- maintenanceinit` `- shutdownwait` `- bootwait` `- bootexit` `- bootinit` `- errorwait` `- errorexit` `- errorinit` `- chargewait` `- chargeheatingaftercharging` `- chargeopenpwrrelays` `- chargechargingwithheating` `- chargecharging` `- chargeclosepwrrelays` `- chargeheatingforcharging` `- chargecheckchargerstatus` `- chargeactivebaltest` `- chargeexit` `- chargeinit` `- downgradedsafetyline` `- downgradedopenpwrrelays` `- downgradedheating` `- downgradedrunning` `- downgradedclosepwrrelays` `- downgradedexit` `- downgradedinit` `- runwaiting` `- runsafetyline` `- runopenpwrrelays` `- runheating` `- runrunning` `- runclosepwrrelays` `- runexit` `- runinit` `- docerror` `- unknown`	`ready`
data .remainingAutonomy	remainingAutonomy informations.	Object	/
data .remainingAutonomy .value	Remaining autonomy value.	String	`n/a`	`42`
data .remainingAutonomy .unit	Remaining autonomy unit.	String	`n/a`	`%`
data .rnd	the position of the gearbox	String	`- unknown` `- reverse` `- neutral` `- drive`	`neutral`
data .chargeDelay	chargeDelay informations.	Object	/
data .chargeDelay .value	Charge delay value.	String	`n/a`	`42`
data .chargeDelay .unit	Charge delay unit.	String	`n/a`	`%`
data .parkBrakeStatus	Park brake status.	String	`- activated` `- notActivated` `- unknown`	`notActivated`
data .totalOdometer	Total odometer information.	Object	/
data .totalOdometer .value	Total odometer value.	String	`n/a`	`%`
data .totalOdometer .unit	Total odometer unit.	String	`n/a`	`42`

Error
No errors

Code Example

          
              
                
              
              Request Kotlin
            

              
                
              
              Request Swift
            

        
pims.get("pims.vehicle.informations",
  mapOf( /* parameters */  
    Pair("actionType", "O2X")
  ) 
) { message -> when (message["status"] as? String) {
      "SUCCEEDED" -> { }                          // handle succeeded status
      "FAILED" ->    { }                          // handle failed status
  } }
pims.get(api: "pims.vehicle.informations",
  parameters: [  
    "actionType": "O2X"
  ]
  ) { (message) in 
    if message["status"] == "SUCCEEDED"    { }    // handle succeeded status
    else if message["status"] == "FAILED" { }    // handle failed status
  } 

// representation of the `succeeded` dictionary object message as JSON
{
  "transactionId": "953cfefb-bc72",
  "status": "SUCCEEDED",
  "result": {
    "vin": "VR1AB12C3D4567890",
    "receivedAt": "YYYY-MM-DDTHH:MM:SSZ",
    "status": "charging",
    "currentAlert": {
      "parkingBrake": false,
      "clusterIssue": false,
      "stop": true,
      "batteryCharge": true,
      "brakeSystemProblem": true,
      "service": false,
      "batteryTemperature": true,
      "turtleMode": false
    },
    "previousAlert": {
      "parkingBrake": false,
      "clusterIssue": false,
      "stop": true,
      "batteryCharge": true,
      "brakeSystemProblem": true,
      "service": false,
      "batteryTemperature": true,
      "turtleMode": false
    },
    "data": {
      "batterySoc": {
        "value": "42",
        "unit": "%"
      },
      "systemState": "sleep",
      "batteryState": "ready",
      "remainingAutonomy": {
        "value": "42",
        "unit": "%"
      },
      "rnd": "neutral",
      "chargeDelay": {
        "value": "42",
        "unit": "%"
      },
      "parkBrakeStatus": "notActivated",
      "totalOdometer": {
        "value": "%",
        "unit": "42"
      }
    }
  }
}

false

Mobile SDK

iOS or Android

API Reference - pims.vehicle.informations-O2X