Other/Enode

List Vehicles

v1.0.0

Input

{
  "type": "object",
  "properties": {
    "field[]": {
      "type": "array",
      "items": {
        "description": "An optional array of Vehicle fields that should be included in the response, for example: `?field[]=information&field[]=location` \n\nBy default, no fields are included and only the Vehicle ID will be returned. Response time may be impacted by which fields you request.",
        "type": "object"
      }
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "lastSeen",
      "isReachable",
      "chargingLocationId"
    ],
    "properties": {
      "chargeState": {
        "type": "object",
        "properties": {
          "batteryCapacity": {
            "type": "number",
            "description": "Vehicle's maximum physical battery capacity in kWh. This number slowly decreases/degrades over time."
          },
          "batteryLevel": {
            "type": "number",
            "description": "Remaining battery in percent"
          },
          "chargeLimit": {
            "type": "number",
            "description": "Charge limit, as a percent of `batteryCapacity`."
          },
          "chargeRate": {
            "type": "number",
            "description": "The current charge rate in kW.\n\nThis property is only available when the vehicle is charging, and is `null` any other time."
          },
          "chargeTimeRemaining": {
            "type": "number",
            "description": "Estimated time until the current charging intent is completed, in minutes.\n\nThis property is only available when the vehicle is charging, and is `null` any other time."
          },
          "isCharging": {
            "type": "boolean",
            "description": "Current charging status of the vehicle"
          },
          "isChargingReasons": {
            "type": "array",
            "description": "Array of string constants that explain why the car is or is not charging. May contain multiple values.\n\n**Any:**\n- DEFAULT - the car is not being controlled by Enode\n\n**Not Charging:**\n- NOT_PLUGGED_IN - because the car is not plugged into a charger\n- FULLY_CHARGED - because the car is fully charged\n- MANUALLY_STOPPED - because the car has been manually commanded to stop charging\n- SMART_CHARGING_DELAY - because Smart Charging has identified an opportunity to delay charging until prices are lower\n\n**Charging:**\n- MANUALLY_STARTED - because the car has been manually commanded to start charging\n- SMART_CHARGING_ACTIVE - because Smart Charging has identified that this is an optimal time to charge\n- SMART_CHARGING_DEADLINE - because, regardless of price, charging must be active to meet the configured deadline",
            "items": {
              "type": "string",
              "enum": [
                {
                  "override": true
                },
                "DEFAULT"
              ]
            }
          },
          "isPluggedIn": {
            "type": "boolean",
            "description": "Indicates whether the vehicle is connected to a charging box (regardless of whether it is actually charging)"
          },
          "range": {
            "type": "number",
            "description": "Estimated remaining kilometers"
          }
        }
      },
      "chargingLocationId": {
        "type": "string",
        "description": "Id of the charging location the vehicle is currently positioned at (if any)"
      },
      "id": {
        "type": "string",
        "description": "Vehicle ID"
      },
      "information": {
        "type": "object",
        "description": "Descriptive information about the Vehicle",
        "properties": {
          "brand": {
            "type": "string",
            "description": "Vehicle brand"
          },
          "id": {
            "type": "string",
            "description": "Vehicle ID"
          },
          "model": {
            "type": "string",
            "description": "Vehicle model"
          },
          "year": {
            "type": "integer",
            "description": "Vehicle production year"
          }
        }
      },
      "isReachable": {
        "type": "boolean",
        "description": "Is the vehicle currently reachable?"
      },
      "lastSeen": {
        "type": "string",
        "format": "date",
        "description": "The last time vehicle was successfully communicated with"
      },
      "location": {
        "type": "object",
        "description": "Vehicle's GPS coordinates with timestamp",
        "properties": {
          "lastUpdated": {
            "type": "string",
            "format": "date",
            "description": "ISO8601 UTC timestamp of last received location"
          },
          "latitude": {
            "type": "number",
            "description": "Latitude in degrees"
          },
          "longitude": {
            "type": "number",
            "description": "Longitude in degrees"
          }
        }
      },
      "odometer": {
        "type": "object",
        "description": "Vehicle's odometer with timestamp",
        "properties": {
          "distance": {
            "type": "number",
            "description": "Odometer in kilometers"
          },
          "lastUpdated": {
            "type": "string",
            "format": "date",
            "description": "ISO8601 UTC timestamp of last received odometer update"
          }
        }
      },
      "smartChargingPolicy": {
        "type": "object",
        "properties": {
          "deadline": {
            "type": "string",
            "description": "The deadline for fully charging the vehicle. Smart charging does not work without setting a deadline. The deadline is expressed as a time on a 24h clock in UTC"
          },
          "isEnabled": {
            "type": "boolean",
            "description": "When enabled, this vehicle's charging status may be controlled by Smart Charging."
          }
        }
      }
    }
  }
}