Arcadia · Schema

SmartChargeScheduleResponse

EnergyUtilitiesClean EnergyBilling DataInterval DataCarbonSolarTariff

Properties

Name Type Description
start_time string
charge_block_resolution string The duration of the charge blocks returned in the `charge_block_active` array.
charge_block_active object
View JSON Schema on GitHub

JSON Schema

arcadia-smart-charge-schedule.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.arcadia.com/schemas/SmartChargeScheduleResponse",
  "title": "SmartChargeScheduleResponse",
  "required": [
    "start_time",
    "charge_block_active",
    "charge_block_resolution"
  ],
  "properties": {
    "start_time": {
      "type": "string",
      "format": "date-time",
      "example": "2021-03-18T22:00:00-07:00"
    },
    "charge_block_resolution": {
      "description": "The duration of the charge blocks returned in the `charge_block_active` array.",
      "type": "string",
      "enum": [
        "5m",
        "10m",
        "15m",
        "30m",
        "1h"
      ],
      "example": "1h"
    },
    "charge_block_active": {
      "type": "object",
      "required": [
        "frequency",
        "data"
      ],
      "properties": {
        "frequency": {
          "description": "The duration of the charge blocks returned in the `charge_block_active` array.",
          "type": "string",
          "enum": [
            "5m",
            "10m",
            "15m",
            "30m",
            "1h"
          ],
          "example": "1h"
        },
        "data": {
          "type": "array",
          "description": "Whether or not the vehicle should be actively charging during each charging bucket, starting at the `start_time`.",
          "items": {
            "$ref": "#/components/schemas/TimeSeriesItem"
          }
        }
      }
    }
  },
  "additionalProperties": false
}