Digital Twin

GET Get vehicle sensor data

GET /digitalTwin/v1/sensor/{vin}

Retrieves the sensor values for a vehicle using the vehicle identification number.

Parameters

  • vin (path, string, required) The unique identifier of the vehicle.
    Example: 01t1Q000007zUlWQAU.
  • attributes (query, string, required) The attributes of the vehicle for which the sensor data must be fetched.
    Example: PERF_ODOMETER,FUEL_LEVEL,RANGE_REMAINING,DOOR_POSITION::ROW_1_RIGHT.

Responses

  • 200

    Media type: application/json. Schema: object.

    Example

    "responseData":
      -
        "attributeName": "PERF_ODOMETER"
        "unit": "km"
        "value": "25.0"
        "minValue": ""
        "maxValue": ""
      -
        "attributeName": "FUEL_LEVEL"
        "unit": "ml"
        "value": "80.0"
        "minValue": ""
        "maxValue": ""
      -
        "attributeName": "RANGE_REMAINING"
        "unit": "km"
        "value": "0.0"
        "minValue": ""
        "maxValue": ""
      -
        "attributeName": "DOOR_POS::ROW_1_RIGHT"
        "unit": "NA"
        "value": "0"
        "minValue": ""
        "maxValue": ""
  • 400 There was an issue with your request.

    Media type: application/json. Schema: any.

    Type: any.

    Example

    code: "400"
    message: Bad request.
    isSuccess: false
    correlationId: "1234444"
  • 401 Authorization failed.

    Media type: application/json. Schema: any.

    Type: any.

    Example

    code: "401"
    message: Unauthorized
    isSuccess: false
    correlationId: "1234444"
  • 404 The requested resource was not found.

    Media type: application/json. Schema: any.

    Type: any.

    Example

    code: "404"
    message: Not found.
    isSuccess: false
    correlationId: "1234444"
  • 405 Method not allowed.

    Media type: application/json. Schema: any.

    Type: any.

    Example

    code: "405"
    message: Method not allowed.
    isSuccess: false
    correlationId: "1234444"
  • 406 Not acceptable.

    Media type: application/json. Schema: any.

    Type: any.

    Example

    code: "406"
    message: Not acceptable.
    isSuccess: false
    correlationId: "1234444"
  • 415 The media type is not supported.

    Media type: application/json. Schema: any.

    Type: any.

    Example

    code: "415"
    message: Unsupported media type.
    isSuccess: false
    correlationId: "1234444"
  • 500 Unable to complete the request as the server encountered an error.

    Media type: application/json. Schema: any.

    Type: any.

    Example

    code: "500"
    message: Internal server error.
    isSuccess: false
    correlationId: "1234444"
  • 501 Not implemented

    Media type: application/json. Schema: any.

    Type: any.

    Example

    code: "501"
    message: Not implemented.
    isSuccess: false
    correlationId: "1234444"