WEB API

for fleet owner

Remote - Notifications & Errors

Info: Stellantis Fleet Owner API for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is made for organisations owning fleet of vehicles.

Being Notified #

As we have seen before, to set up a remote you should first register a callback and then use this callback to send a remote to your vehicle.

When you send a remote action through a callback, you will receive (on your server) one or several HTTP notification(s) in order to inform you about the course of the events. It is also possible to retrieve these notifications through the REST API using the following endpoints:

Get all remote action of vehicle and callback:

Get remote action by ID:

Notifications Details #

When you attempt to send a remote action to a vehicle, one or many notification(s) will be sent to your server. These notifications are sent in order to inform you about the availability of this remote action and the status of your vehicle.

  • First, we will check if you are able to send this remote action and if the state of the vehicle allows it. In this case the notification type will be type: Pending.
  • Then, if it is available to send this remote action, it will be sent to the vehicle. You will receive notification about its status regarding the specific remote action you have sent. In this case the notification type will be type: Done or type: Failed.

Notification Workflow

Execute
Remote Action
Execute...
Fleet
Owner
Fleet...
HTTP Requestsend a remote
Remote
Available?
Remote...
Notification Failed
type: Done
RemoteDone: Failed
failureCause: 
MissingRights,
  SameActionInProgress,
  TooManyWakesUpsOverMonth,
  VehicleBatteryChargeTooLow ]
Notification Failed...
Process ends.
Please send
again when available
Process ends....
HTTP request 
processed?
HTTP request...
HTTP Responsecode different from 202HTTP Responsecode different from 202
Notification Pending
type: Pending
RemotePending: Accepted
Notification Pending...
Process ends.
Please send
again
Process ends....
Vehicle
awake?
Vehicle...
Awakening Vehicle
Awakening Vehicle
[ Awaked
 Successfully]
[ Awaked...
Awake!
Awake!
Notification Pending
type: Pending
RemotePending: SentToVehicle
Notification Pending...
Send Remote Action
Send Remote Action
Vehicle Response
Vehicle Response
[ Error]
[ Error]
Notification Failed
type: Failed
RemoteDone:
[ GeneralError, VehicleError,WrongCommand,
VehicleConnectionTimeout, MissingRights,
NotPossibleDueToVehicleBatteryLevel,
NotPossibleDueToVehiclePrivacyLevel,
TooManyWakeUpsOverMonth,
TooManyRequestInShortTime,
SameActionInProgress,
NotPossibleDueToVehicleStolenState,
VehicleInUse, TooManyRequestSent, DoorsOpen,
VehicleErrorOrCidInside, CidInside,
ExternalChargingSystemError,
VehicleChargingSystemError, VehicleIsNotLocked ]
Notification Failed...
Process ends.
Please send
again when available
Process ends....
Notification Done
type: Done
RemoteDone: Succes
Notification Done...
[ Success
Remote
performed]
[ Success...
Notification Done
type: Done
RemoteDone: AlreadyDone
Notification Done...
[ Succes but
Already in 
this state]
[ Succes but...
[ Awakening 
failed ]
[ Awakening...
Vehicle
Not
awaked
Vehicle...
Notification Failed
type: Done
RemoteDone: Failed
failureCause: VehicleConnectionTimeout
Notification Failed...
Process ends.
Please send
again when available
Process ends....
[ Vehicle
 Not Awake]
[ Vehicle...
[ Vehicle
Awake]
[ Vehicle...
[ Remote
Not
Available]
[ Remote...
[ Remote
Available]
[ Remote...
[ Notification 
Not
Processed]
[ Notification...
[ Notification
Processed]
[ Notification...
Process
Continue
in 1!
Process...
1
1
Process
Continue
in 2!
Process...
2
2
Process
Continue
in 3!
Process...
3
3
Process
Continue
in 4!
Process...
4
4
Sucess: 
The vehicle
was alredy in the required state
Sucess:...
Sucess, 
the vehicle performed the remote 
action
Sucess,...
Viewer does not support full SVG 1.1

Format

1
2
3
4
5
6
7
8
  "eventStatus": {
    "type": "[Pending, Done]",
    "status": {
      "RemoteDoneEventStatus": "[Success, AlreadyDone, Failed]",
      "RemotePendingEventStatus": "[Accepted, WakingUpVehicle, CheckingVehicle, SentToVehicle, VehicleBatteryChargeTooLow, TooManyWakeUpsOverMonth]",
    },
    "failureCause": "[GeneralError, VehicleError, WrongCommand, VehicleConnectionTimeout, MissingRights, NotPossibleDueToVehicleBatteryLevel, NotPossibleDueToVehiclePrivacyLevel, TooManyWakeUpsOverMonth, TooManyRequestInShortTime, SameActionInProgress, NotPossibleDueToVehicleStolenState, VehicleInUse, TooManyRequestSent, DoorsOpen, VehicleErrorOrCidInside, CidInside, ExternalChargingSystemError, VehicleChargingSystemError, VehicleIsNotLocked]"
  }
  • RemoteDoneEventStatus: This field is returned if type: Done.
  • failureCause: This field is returned if type: Done & RemoteDoneEventStatus: Failed.
  • RemotePendingEventStatus: This field is returned if type: Pending.

This page describes only eventStatus object, if you need the full response specification, please refer to the webhook reference.

Info: In the case of sending a remote navigation (RemoteNavigation), you’ll NOT receive the following events : "RemotePendingEventStatus": "Accepted" & "RemotePendingEventStatus": "WakingUpVehicle".

Messages Description

  • Vehicle Sleep: if the vehicle is stopped, it stays awake during 3min, when a message is sent to the vehicle, it will stays awake 3 min more. Otherwise, if a vehicle is sleeping, we will to send a special command to awake it. In this case you are notified by a WakingUpVehicle because the delay to apply the remote action could be longer.

  • Too Many Wake Ups: In order to preserve your vehicle health, it is not allowed to awake a vehicle too often. That’s why a monthly limit is set. If you reach this limit it will not be possible to send a remote to your vehicle again during this month, and you’ll receive a TooManyWakeUpsOverMonth notification.

  • Time Out: in case your vehicle is not connected to the internet, it is not possible to send a remote action to it. In this case you will receive an error notification until your vehicle is reconnected.

  • Already Done: if the vehicle was already in the status requested by your remote, you will recevei an AlreadyDone notification.

  • Charge Too Low: in case of an electric vehicle, the system will preserve your vehicle battery life by not sending remote action when the charge is less than a limit. In this case you’ll receive a VehicleBatteryChargeTooLow or a NotPossibleDueToVehicleBatteryLevel notification.

State Machine

remote-notification-error-flowchart