GRgroupe-psa
Remote

Get remote action by id.

Returns the remote action requested for vehicle by ID.

get/fleets/{fid}/vehicles/{vid}/callbacks/{cbid}/remotes/{rid}

Request

Path parameters

fidstring required

Resource is related to this fleet ID only.

vidstring required

Resource is related to this Vehicle ID only.

cbidstring required

The remote callback ID.

ridstring required

The remote action ID.

Response

A remote action response.

remoteActionIdstring

The uniq remote action ID returned when the remote action was posted and accepted.

status'Accepted' | 'Failed' | 'Success' | 'AlreadyDone' | 'WakingUpVehicle' | 'CheckingVehicle' | 'SentToVehicle' | 'VehicleBatteryChargeTooLow' | 'TooManyWakeUpsOverMonth'
type'ThermalPreconditioning' | 'ElectricBatteryChargingRequest' | 'Horn' | 'Doors' | 'Lights' | 'Immobilization' | 'Stolen' | 'WakeUp' | 'Navigation'
failureCause'GeneralError' | 'VehicleError' | 'WrongCommand' | 'VehicleConnectionTimeout' | 'MissingRights' | 'NotPossibleDueToVehicleBatteryLevel' | 'NotPossibleDueToVehiclePrivacyLevel' | 'TooManyWakeUpsOverMonth' | 'TooManyRequestInShortTime' | 'SameActionInProgress' | 'NotPossibleDueToVehicleStolenState' | 'VehicleInUse' | 'TooManyRequestSent' | 'DoorsOpen' | 'VehicleErrorOrCidInside' | 'CidInside' | 'ExternalChargingSystemError' | 'VehicleChargingSystemError' | 'VehicleIsNotLocked' | 'CanceledByDriver'

The failure cause for event with failed status. This field is filled only is failure state.

feedbackDetail'NoCIDBlacklisted' | 'CIDBlacklisted'

Additionnal detail in case of success on some specific behavior :

FeatureDescriptionBehavior
Lock DoorsSend a lock doors by forceNoCIDBlacklisted if lock is OK but IML not blacklisted, CIDBlacklisted is when the doors are locked and the IML is well blacklisted

Example response

{
  "type": "Doors",
  "_links": {
    "fleet": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "callback": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "self": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    }
  },
  "remote": {
    "preconditioning": {
      "airConditioning": {
        "programs": [
          {
            "start": "PT14H30M"
          }
        ]
      }
    },
    "charging": {
      "schedule": {
        "programs": [
          {
            "start": "PT14H30M",
            "enabled": true,
            "end": "PT14H30M"
          }
        ]
      },
      "immediate": true,
      "preferences": {
        "level": "Level1",
        "type": "Partial"
      }
    },
    "stolen": {
      "stolen": true,
      "trackingPeriod": {
        "running": 30,
        "shutdown": 120
      }
    },
    "wakeUp": {
      "action": "WakeUp"
    },
    "navigation": {
      "positions": [
        {
          "type": "Point",
          "coordinates": [
            5.970338,
            -62.536239
          ]
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.