GRgroupe-psa
Vehicles

Vehicle status.

Returns the latest vehicle status.

get/fleets/{fid}/vehicles/{vid}/status

Request

Path parameters

fidstring required

Resource is related to this fleet ID only.

vidstring required

Resource is related to this Vehicle ID only.

Query parameters

profile'fleet' | 'endUser'

Results will contain a relative view of the data depending on the selected profile. Indeed, endUser will expose only the data available to the end-user as if there were no intermediaries between him and the vehicle (case of B-2-B-2-C). If not specified, this parameter will be set tofleetvalue (deault value).

  • Disclaimer: Since thefleetprofile has a larger data scope, selectingendUserprofile will potentially result in not found status depending on its granted rights and privacy level.

Response

Status response

createdAtstring date-time required

Date when the resource has been created.

updatedAtstring date-time

Date when the resource has been updated.

vinstring required

Identifier of a vehicle. Set when retrieving resource in batch mode.

Example response

{
  "_links": {
    "self": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "vehicle": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    },
    "fleet": {
      "href": "http://example.com",
      "deprecation": "http://example.com"
    }
  },
  "vin": "VF3ABCDE0FG123456",
  "ignition": {
    "type": "Start"
  },
  "lastPosition": {
    "geometry": {
      "type": "Point",
      "coordinates": [
        5.970338,
        -62.536239
      ]
    },
    "properties": {
      "vin": "VF3ABCDE0FG123456"
    }
  },
  "preconditioning": {
    "airConditioning": {
      "programs": [
        {
          "start": "PT14H30M"
        }
      ]
    }
  },
  "safety": {
    "beltStatus": [
      {
        "belt": "Omission",
        "id": "Passenger"
      }
    ]
  },
  "wipingBlades": {
    "active": true,
    "speed": "Low"
  },
  "alarm": {
    "trigger": {
      "position": {
        "geometry": {
          "type": "Point",
          "coordinates": [
            5.970338,
            -62.536239
          ]
        },
        "properties": {
          "vin": "VF3ABCDE0FG123456"
        }
      }
    }
  },
  "stolen": {
    "_links": {
      "self": {
        "href": "http://example.com",
        "deprecation": "http://example.com"
      },
      "vehicle": {
        "href": "http://example.com",
        "deprecation": "http://example.com"
      }
    },
    "id": "0a9de72cc3803b12a74418acd20dcd66634fa82e44b2ec7060bca91462dc5772199559905caefe168812918d47f67253f33d477b645bb59afdd1268b81e382999",
    "state": true,
    "startPosition": {
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.970338,
          -62.536239
        ]
      },
      "properties": {
        "vin": "VF3ABCDE0FG123456"
      }
    },
    "endPosition": {
      "geometry": {
        "type": "Point",
        "coordinates": [
          5.970338,
          -62.536239
        ]
      },
      "properties": {
        "vin": "VF3ABCDE0FG123456"
      }
    }
  }
}

Changes

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