Residential customers of Cool Power with a compatible EV or home charger.
","description":"HTML description of who is eligible to join the program.","readOnly":true},"benefits":{"type":["string","null"],"example":"Earn a monthly bill credit for charging off-peak.
","description":"HTML description of the benefits of joining the program.","readOnly":true},"country":{"type":"string","example":"US","description":"ISO 3166-1 alpha-2 code of the country the program operates in.","readOnly":true},"faqs_url":{"type":["string","null"],"format":"uri","example":"https://www.example.com/coolcharge/faqs","description":"URL of the program's FAQ page, where one exists.","readOnly":true},"support_email":{"type":"string","format":"email","example":"support@ev.energy","description":"Customer support email address for this program.","readOnly":true},"payment_frequency":{"type":["string","null"],"enum":["WEEKLY","MONTHLY","QUARTERLY",null],"example":"MONTHLY","description":"How often incentive payments are made, where the program pays incentives.","readOnly":true},"payment_day_of_month":{"type":["integer","null"],"minimum":1,"maximum":31,"example":15,"description":"Day of the month incentive payments are made, for monthly or quarterly programs. 31 means the last day of the month. Null when the program has no payment day configured.","readOnly":true},"payment_weekday":{"type":["string","null"],"enum":["MON","TUE","WED","THU","FRI","SAT","SUN",null],"example":"FRI","description":"Day of the week incentive payments are made, for weekly programs. Null when the program has no payment weekday configured.","readOnly":true},"hidden":{"type":"boolean","example":false,"description":"Whether the program is hidden from public program lists. Hidden programs (test, internal, ended or mothballed) are omitted from the list endpoint for anonymous and driver-scoped requests, but are still returned by ID and are always listed for organisation-scoped API clients.","readOnly":true}}}},"components/schemas/ProgramTier":{"id":"components/schemas/ProgramTier","kind":"json-schema","title":"ProgramTier","data":{"title":"ProgramTier","type":"object","example":{"id":"tier01JCK1HPNAANB8WN253G27SFPC","url":"https://api.ev.energy/v2/programs/prog01JCK1HPNAANB8WN253G27SFPC/tiers/tier01JCK1HPNAANB8WN253G27SFPC","short_name":"standard","name":"Standard Tier","logo_svg":"https://api.ev.energy/media/program_tiers/standard.svg","description_short":"Charge at off-peak times to earn standard rewards.","description_long":"Members of the Standard Tier earn rewards for charging during off-peak hours. No additional eligibility requirements apply.
","smart_charging_enabled":true,"disable_changing_tariff":false,"visible":true,"eligible":true},"properties":{"id":{"type":"string","example":"tier01JCK1HPNAANB8WN253G27SFPC","pattern":"tier[A-Z\\d]{26}","readOnly":true},"url":{"type":"string","example":"https://api.ev.energy/v2/programs/prog01JCK1HPNAANB8WN253G27SFPC/tiers/tier01JCK1HPNAANB8WN253G27SFPC","format":"uri","readOnly":true},"short_name":{"type":"string","example":"standard","description":"A short slug-style identifier for the tier, unique within a program.","readOnly":true},"name":{"type":["string","null"],"example":"Standard Tier","description":"A human-friendly name for the tier.","readOnly":true},"logo_svg":{"type":["string","null"],"format":"uri","description":"URL to download an SVG logo for the tier.","readOnly":true},"description_short":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Short HTML description of the tier. Wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tags on both real and sandbox responses."},"children":[]}]}]}],"readOnly":true},"description_long":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Longer HTML description of the tier. Wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tags on both real and sandbox responses."},"children":[]}]}]}],"readOnly":true},"smart_charging_enabled":{"type":"boolean","description":"Whether smart charging is enabled for users in this tier.","readOnly":true},"disable_changing_tariff":{"type":"boolean","description":"Whether users in this tier are blocked from changing their tariff.","readOnly":true},"visible":{"type":"boolean","description":"Whether this tier should be shown to users when selecting a tier within the program.","readOnly":true},"eligible":{"type":["boolean","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether the authenticated user is eligible to join this tier. Populated only when"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the request is authenticated as a specific user (Authorization Code / Password grant,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or Client Credentials with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EvEnergy-User"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for anonymous and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pure client-credentials requests."},"children":[]}]}]}],"readOnly":true}}}},"components/schemas/ParticipationAgreementVersion":{"id":"components/schemas/ParticipationAgreementVersion","kind":"json-schema","title":"ParticipationAgreementVersion","data":{"title":"ParticipationAgreementVersion","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A version of a Program's Participation Agreement. Programs have a single"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Participation Agreement with versioned content; users accept a version"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"via "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST .../{id}/accept"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The currently active version is the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"highest-numbered published one — fetch it from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"current"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"sub-resource."},"children":[]}]}]}],"properties":{"id":{"type":"string","example":"pagv01JCDYP6Z8MX9XWVAV0A7G3KPN","pattern":"pagv[A-Z\\d]{26}","readOnly":true},"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/programs/prog01JCK1HPNAANB8WN253G27SFPC/participation_agreement_versions/pagv01JCDYP6Z8MX9XWVAV0A7G3KPN","readOnly":true},"version_number":{"type":"integer","example":1,"description":"Monotonically increasing version number scoped to the parent agreement.","readOnly":true},"published":{"type":"boolean","description":"Whether this version is the currently active one shown to users.\nOnly one version per agreement should be published at a time.\n","readOnly":true},"content":{"type":"string","description":"HTML content of the agreement, translated for the requesting user's language.","readOnly":true},"created_at":{"type":"string","format":"date-time","description":"When this version was created.","readOnly":true}}}},"components/schemas/Region":{"id":"components/schemas/Region","kind":"json-schema","title":"Region","data":{"title":"Region","type":"object","description":"A named geographic boundary (WGS 84) used to gate program tier eligibility, tariffs, carbon feeds and reward offers. Names are globally unique and immutable once created. The list representation omits the geometry; request a single region for the full GeoJSON MultiPolygon.","properties":{"id":{"type":"string","example":"regn01JCK1HPNAANB8WN253G27SFPC","pattern":"regn[A-Z\\d]{26}","readOnly":true},"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/regions/regn01JCK1HPNAANB8WN253G27SFPC","readOnly":true},"name":{"type":"string","example":"WEST ROXBURY","description":"Globally unique region name. Immutable after creation."},"type":{"type":["string","null"],"enum":["OTHER","ELECTRICITY",null],"description":"Optional classification of the region."},"region_groups":{"type":"array","description":"URLs of the region groups this region belongs to.","readOnly":true,"items":{"type":"string","format":"uri"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}}}},"components/schemas/RegionDetail":{"id":"components/schemas/RegionDetail","kind":"json-schema","title":"Region","data":{"title":"Region","description":"Region including its full geometry. Served for single-region requests; the geometry is omitted from region lists.","allOf":[{"$ref":"#/components/schemas/Region"},{"type":"object","properties":{"geometry":{"description":"The region's boundary as a GeoJSON MultiPolygon, or null if the region has no geometry.","oneOf":[{"$ref":"#/components/schemas/GeoJsonMultiPolygon"},{"type":"null"}]}}}]}},"components/schemas/RegionCreate":{"id":"components/schemas/RegionCreate","kind":"json-schema","title":"RegionCreate","data":{"title":"RegionCreate","type":"object","required":["name","geometries"],"properties":{"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Globally unique region name. A clash returns 409 region-name-conflict — there is no upsert on this endpoint."},"children":[]}]}]}]},"type":{"type":["string","null"],"enum":["OTHER","ELECTRICITY",null]},"geometries":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One or more GeoJSON Polygon/MultiPolygon geometries. The server unions them (GEOS unary union, make_valid applied) into a single MultiPolygon."},"children":[]}]}]}],"minItems":1,"maxItems":1000,"items":{"oneOf":[{"$ref":"#/components/schemas/GeoJsonPolygon"},{"$ref":"#/components/schemas/GeoJsonMultiPolygon"}]}},"region_groups":{"type":"array","description":"URLs of existing region groups to link the new region to.","items":{"type":"string","format":"uri"}}}}},"components/schemas/RegionGroupEntry":{"id":"components/schemas/RegionGroupEntry","kind":"json-schema","title":"RegionGroupEntry","data":{"title":"RegionGroupEntry","type":"object","required":["name","geometries"],"properties":{"name":{"type":"string","example":"MILTON","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must not match any existing region — clashes fail the whole request with 409."},"children":[]}]}]}]},"type":{"type":["string","null"],"enum":["OTHER","ELECTRICITY",null]},"geometries":{"type":"array","description":"One or more GeoJSON Polygon/MultiPolygon geometries, unioned server-side into a single MultiPolygon.","minItems":1,"maxItems":1000,"items":{"oneOf":[{"$ref":"#/components/schemas/GeoJsonPolygon"},{"$ref":"#/components/schemas/GeoJsonMultiPolygon"}]}}}}},"components/schemas/RegionGroupCreate":{"id":"components/schemas/RegionGroupCreate","kind":"json-schema","title":"RegionGroupCreate","data":{"title":"RegionGroupCreate","type":"object","required":["name","regions"],"properties":{"name":{"type":"string","example":"Eversource MA Pilot 1A","description":"Unique name for the new group."},"regions":{"type":"array","minItems":1,"maxItems":500,"items":{"$ref":"#/components/schemas/RegionGroupEntry"}}}}},"components/schemas/RegionGroup":{"id":"components/schemas/RegionGroup","kind":"json-schema","title":"RegionGroup","data":{"title":"RegionGroup","type":"object","properties":{"id":{"type":"string","example":"rgrp01JCK1HPNAANB8WN253G27SFPC","pattern":"rgrp[A-Z\\d]{26}","readOnly":true},"url":{"type":"string","format":"uri","readOnly":true},"name":{"type":"string","example":"Eversource MA Pilot 1A"},"regions":{"type":"array","description":"URLs of the member regions.","readOnly":true,"items":{"type":"string","format":"uri"}},"regions_collection":{"type":"string","format":"uri","description":"Pre-built link to the regions collection filtered to this group.","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true}}}},"components/schemas/RegionValidationResult":{"id":"components/schemas/RegionValidationResult","kind":"json-schema","title":"RegionValidationResult","data":{"title":"RegionValidationResult","type":"object","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["OK","NAME_EXISTS","INVALID_GEOMETRY","INVALID"]},"problems":{"type":"array","items":{"type":"string"}},"computed":{"type":["object","null"],"properties":{"geometry_count":{"type":"integer"},"resulting_polygon_count":{"type":"integer"},"area_sq_km":{"type":"number"}}},"existing_region":{"type":["string","null"],"format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Present when status is NAME_EXISTS — URL of the clashing region."},"children":[]}]}]}]}}}},"components/schemas/RegionGroupValidationResult":{"id":"components/schemas/RegionGroupValidationResult","kind":"json-schema","title":"RegionGroupValidationResult","data":{"title":"RegionGroupValidationResult","type":"object","properties":{"valid":{"type":"boolean","description":"True when committing the identical body would succeed."},"group":{"type":"object","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["AVAILABLE","NAME_EXISTS"]},"problems":{"type":"array","items":{"type":"string"}}}},"regions":{"type":"array","items":{"$ref":"#/components/schemas/RegionValidationResult"}}}}},"components/schemas/CountryCode":{"id":"components/schemas/CountryCode","kind":"json-schema","title":"CountryCode","data":{"description":"ISO 3166-1 2 letter Country Codes.","type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","UM","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"]}},"components/schemas/UsageInterval":{"id":"components/schemas/UsageInterval","kind":"json-schema","title":"UsageInterval","data":{"title":"UsageInterval","type":"object","properties":{"interval_seconds":{"type":"integer","description":"The number of seconds that this interval lasts for.","readOnly":true},"started_at":{"type":"string","format":"date-time","description":"When this interval began.","readOnly":true},"total_energy_delivered_watt_hours":{"type":"integer","description":"The total number of watt hours delivered during the interval.","readOnly":true},"meter_usage_watt_hours":{"type":"integer","nullable":true,"description":"An estimate of the supply meter usage in watt hours during the interval, accounting for charging system losses between the supply meter and the EVSE/Vehicle. Null when not available.","readOnly":true},"alt_usage_watt_hours":{"type":"integer","nullable":true,"description":"Counterfactual energy usage in watt hours. Represents the estimated energy that would have been delivered during this interval if the vehicle had charged immediately without managed charging. Null when not available.","readOnly":true},"percentage_import":{"type":"integer","nullable":true,"minimum":0,"maximum":100,"description":"The percentage of energy imported from the grid during this interval (0-100). Used for calculating costs with home solar.","readOnly":true},"electricity_cost_sub_unit":{"type":"string","format":"decimal","nullable":true,"description":"The electricity rate for this interval, in the smallest sub-unit of the currency (e.g. pence/kWh, cents/kWh). For merged intervals with multiple pricing tiers, this is the sum of the distinct rate values.","readOnly":true},"energy_delivered_by_price":{"type":"object","$ref":"#/components/schemas/EnergyDeliveredByPrice","description":"Energy delivered during the interval, broken down by the price paid for that energy. For example, if half the period was at peak price (50p) and half at off-peak price (20p), this field would contain an entry for 20p and an entry for 50p with the total energy delivered at each price. Note that prices are always quoted in the smallest sub-unit of the currency. (Ie. cents for USD, pence for GBP.)","readOnly":true}}}},"components/schemas/EnergyDeliveredByPrice":{"id":"components/schemas/EnergyDeliveredByPrice","kind":"json-schema","title":"EnergyDeliveredByPrice","data":{"title":"EnergyDeliveredByPrice","type":"object","properties":{"price":{"type":"string","description":"The price paid for the energy in the smallest unit of the currency.","example":"21.3","format":"decimal"},"energy_delivered_watt_hours":{"type":"integer","example":1800}}}},"components/schemas/EnergyUsage":{"id":"components/schemas/EnergyUsage","kind":"json-schema","title":"EnergyUsage","data":{"title":"EnergyUsage","type":"object","description":"Detailed energy usage for a charging sub-session, reported as a list of intervals recording when energy was actually delivered to the vehicle and how much. Use this (rather than the sub-session's start/end) to determine when charging actually happened.","properties":{"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5/energy_usage","readOnly":true},"currency":{"type":"string","example":"GBP","description":"The currency that prices for intervals are quoted in. Note that we always use the smallest unit of the currency.","readOnly":true},"charging_sub_session":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5","readOnly":true},"intervals":{"type":"array","description":"A list of energy usage intervals for this charging sub-session.","items":{"$ref":"#/components/schemas/UsageInterval"},"readOnly":true},"last_updated_at":{"type":"string","format":"date-time","description":"The datetime when the energy usages were last updated at."}}}},"components/schemas/ChargingSessionFlag":{"id":"components/schemas/ChargingSessionFlag","kind":"json-schema","title":"ChargingSessionFlag","data":{"title":"ChargingSessionFlag","type":"object","properties":{"name":{"type":"string","description":"Name describing the type of issue flagged. New values may be added over time.","example":"ENERGY_OVER_DELIVERY"},"root_cause":{"type":"string","description":"Category describing the root cause of the issue. New values may be added over time.","example":"CHARGE_MEASUREMENT_OSCILLATION"}},"required":["name","root_cause"]}},"components/schemas/ChargingSubSessionFlags":{"id":"components/schemas/ChargingSubSessionFlags","kind":"json-schema","title":"ChargingSubSessionFlags","data":{"title":"ChargingSubSessionFlags","type":"object","properties":{"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5/flags","readOnly":true},"charging_sub_session":{"oneOf":[{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5","readOnly":true},{"$ref":"#/components/schemas/ChargingSubSession"}],"description":"The charging sub-session these flags belong to. Expandable."},"flags":{"type":"array","description":"A list of flags associated with this charging sub-session.","items":{"$ref":"#/components/schemas/ChargingSessionFlag"},"readOnly":true}},"required":["url","charging_sub_session","flags"]}},"components/schemas/ChargingSubSessionDebugMetadata":{"id":"components/schemas/ChargingSubSessionDebugMetadata","kind":"json-schema","title":"ChargingSubSessionDebugMetadata","data":{"title":"ChargingSubSessionDebugMetadata","type":"object","description":"Session-level diagnostic information for a charging sub-session.","properties":{"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5/debug_metadata","readOnly":true},"charging_sub_session":{"oneOf":[{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5","readOnly":true},{"$ref":"#/components/schemas/ChargingSubSession"}],"description":"The charging sub-session this debug metadata belongs to. Expandable."},"start_reason":{"oneOf":[{"type":"string","enum":["BOOST_START","SMART_CHARGE_ENABLED","SMART_CHARGE_DISABLED","SOLAR_SETTINGS","ADMIN_CREATE_FAKE","ADMIN_IMPORT_CSV","REPROCESS_VEHICLEDATALOGS_CMD","SFTP_IMPORTER","EVSE_CONNECT","CP_EVSE_CONNECT","VEHICLE_LOG_CONNECT","USER_SETTINGS"]},{"type":"null"}],"description":"The reason the session was started. New values may be added over time.","readOnly":true},"finish_reason":{"oneOf":[{"type":"string","enum":["BOOST_START","SMART_CHARGE_ENABLED","SMART_CHARGE_DISABLED","SOLAR_SETTINGS","ADMIN_ACTION","FAKE_CURRENT_CHARGING_CMD","REPROCESS_VEHICLEDATALOGS_CMD","SFTP_IMPORTER","INVALIDATE_ACCOUNT","REMOVE_INTEGRATION","EVSE_UNPAIR","EVSE_DISCONNECT"]},{"type":"null"}],"description":"The reason the session finished. New values may be added over time.","readOnly":true},"is_energy_delivered_capped":{"type":"boolean","description":"Indicates whether delivered energy was capped to prevent unrealistic over-delivery beyond the vehicle's battery capacity.","readOnly":true},"uncapped_energy_delivered_watt_hours":{"oneOf":[{"type":"integer"},{"type":"null"}],"description":"The recalculated energy in watt-hours that would have been delivered without capping. Null when energy delivery was not capped or when recalculation cannot be completed.","readOnly":true},"energy_usage_calculation_method":{"type":"string","enum":["ESTIMATED_CHARGE_ENERGY_ADDED","ESTIMATED_CHARGE_LEVEL","ESTIMATED_CHARGE_RATE","METERED","METERED_CHARGE_RATE","BETA_ESTIMATED_CHARGE_ENERGY_ADDED","ESTIMATED_CHARGE_LEVEL_WITH_INFERENCE","MANUAL_ENTRY"],"description":"The method used to calculate energy usage for this session.","readOnly":true},"energy_usage_interpolation_method":{"type":"string","enum":["LINEAR","LINEAR_WITH_CHARGE_STEP"],"description":"The method used to interpolate data readings when calculating energy usage.","readOnly":true},"solar_integration_type":{"oneOf":[{"type":"string","enum":["UNAVAILABLE","HARDWARE","SOFTWARE","SOFTWARE_BETA","HARDWARE_PASSTHROUGH"]},{"type":"null"}],"description":"The solar integration type of the EVSE paired with this session. Null when no EVSE is associated with the session.","readOnly":true}},"required":["url","charging_sub_session","start_reason","finish_reason","is_energy_delivered_capped","uncapped_energy_delivered_watt_hours","energy_usage_calculation_method","energy_usage_interpolation_method","solar_integration_type"]}},"components/schemas/Schedules":{"id":"components/schemas/Schedules","kind":"json-schema","title":"Schedules","data":{"title":"Schedules","type":"object","properties":{"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5/schedules","readOnly":true},"charging_sub_session":{"oneOf":[{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5"},{"$ref":"#/components/schemas/ChargingSubSession"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charging sub-session these schedules belong to. Defaults to a url, but can be expanded to the full ChargingSubSession resource via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true},"schedules":{"type":"array","description":"A list of schedule intervals for this charging sub-session.","items":{"$ref":"#/components/schemas/ScheduleInterval"},"readOnly":true}}}},"components/schemas/SchedulePlans":{"id":"components/schemas/SchedulePlans","kind":"json-schema","title":"SchedulePlans","data":{"title":"SchedulePlans","type":"object","properties":{"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5/schedule_plans","readOnly":true},"charging_sub_session":{"oneOf":[{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5"},{"$ref":"#/components/schemas/ChargingSubSession"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The charging sub-session these schedule plans belong to. Defaults to a url, but can be expanded to the full ChargingSubSession resource via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true},"schedule_plans":{"type":"array","description":"A list of schedule plans for this charging sub-session.","items":{"$ref":"#/components/schemas/SchedulePlan"},"readOnly":true}}}},"components/schemas/SchedulePlan":{"id":"components/schemas/SchedulePlan","kind":"json-schema","title":"SchedulePlan","data":{"title":"SchedulePlan","type":"object","description":"A schedule plan containing the parameters used to generate charging schedules.","properties":{"id":{"type":"string","pattern":"scpl[A-Z\\d]{26}","example":"scpl01HSH04KDEWF6Z4DB2J77J74K5","description":"Unique identifier for this schedule plan.","readOnly":true},"created_at":{"type":"string","format":"date-time","example":"2024-01-01T02:00:00Z","description":"When this schedule plan was created.","readOnly":true},"ready_by_time":{"type":"string","format":"date-time","example":"2024-01-01T08:00:00Z","description":"The target time by which charging should be complete.","readOnly":true},"price_threshold_minor_unit":{"type":["integer","null"],"example":1500,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Price threshold in minor currency units (e.g., cents/pence) multiplied by 100. For example, 1500 represents 15 pence (£0.15), and 50 represents 0.5 pence (£0.005). Null if no threshold set."},"children":[]}]}]}],"readOnly":true},"power_on_current_milliamps":{"type":"integer","example":32000,"description":"The charging current in milliamps when power is on.","readOnly":true},"power_off_current_milliamps":{"type":"integer","example":0,"description":"The current in milliamps when power is off (typically 0).","readOnly":true},"seconds_to_charge":{"type":"integer","example":10800,"description":"The number of seconds required to complete charging.","readOnly":true},"vehicle_charge_level_watt_hours":{"type":["integer","null"],"example":25000,"description":"The vehicle's battery level in watt-hours at the time the plan was created. Null if unknown.","readOnly":true},"estimated_charge_rate_watts":{"type":"integer","example":7400,"description":"The estimated charging rate in watts.","readOnly":true},"estimated_charge_rate_source":{"type":["string","null"],"enum":["CURRENT_SESSION_EVSE_DATA_LOGS","CURRENT_SESSION_VEHICLE_DATA_LOGS","ENERGY_TRANSFER_PERIODS","DEFAULT_CHARGE_RATE","MAX_EVSE_CHARGE_RATE","MAX_VEHICLE_CHARGE_RATE",null],"description":"The source of data used for estimating charge rate. Null if not specified.","readOnly":true},"watt_hours_to_charge":{"type":"integer","example":22000,"description":"The total energy required to complete charging in watt-hours.","readOnly":true},"min_charge_limit_percent":{"type":"integer","minimum":0,"maximum":100,"example":0,"description":"The minimum charge limit as a percentage (0-100).","readOnly":true},"max_charge_limit_percent":{"type":"integer","minimum":0,"maximum":100,"example":80,"description":"The maximum charge limit as a percentage (0-100).","readOnly":true},"price_data":{"oneOf":[{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/Price"}}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tariff rate intervals active when this schedule plan was created. Null by default; expand with ?expand=price_data to populate. Returns null if no tariff is associated with the session."},"children":[]}]}]}],"readOnly":true}}}},"components/schemas/ChargingSubSessionAssessment":{"id":"components/schemas/ChargingSubSessionAssessment","kind":"json-schema","title":"ChargingSubSessionAssessment","data":{"title":"ChargingSubSessionAssessment","type":"object","description":"Performance assessment for a completed charging sub-session.","properties":{"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5/assessment","readOnly":true},"charging_sub_session":{"oneOf":[{"type":"string","format":"uri","example":"https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5"},{"$ref":"#/components/schemas/ChargingSubSession"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parent charging sub-session. Defaults to a url, but can be expanded to the full ChargingSubSession resource via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}],"readOnly":true},"energy_delivered_to_capacity_percentage":{"type":["integer","null"],"description":"Energy delivered as a percentage of battery capacity. Values above 100 indicate overdelivery.","example":85,"readOnly":true},"energy_delivery_percentage":{"type":["integer","null"],"description":"Energy delivered as a percentage of energy required.","example":92,"readOnly":true},"average_charge_rate_watts":{"type":["integer","null"],"description":"Average charge rate in watts throughout the session.","example":7200,"readOnly":true},"max_charge_rate_watts":{"type":["integer","null"],"description":"Maximum charge rate in watts throughout the session.","example":11000,"readOnly":true},"metrics":{"$ref":"#/components/schemas/ChargingSubSessionAssessmentMetrics","readOnly":true},"ratings":{"$ref":"#/components/schemas/ChargingSubSessionAssessmentRatings","readOnly":true},"updated_at":{"type":"string","format":"date-time","description":"When the assessment was last updated.","readOnly":true}}}},"components/schemas/ChargingSubSessionAssessmentMetrics":{"id":"components/schemas/ChargingSubSessionAssessmentMetrics","kind":"json-schema","title":"ChargingSubSessionAssessmentMetrics","data":{"title":"ChargingSubSessionAssessmentMetrics","type":"object","description":"Performance quality metrics for a charging session assessment. All fields are nullable.","properties":{"vehicle_data_uptime":{"type":["integer","null"],"description":"Vehicle data uptime as a percentage (0-100).","example":95},"vehicle_location_uptime":{"type":["integer","null"],"description":"Vehicle location uptime as a percentage (0-100).","example":90},"vehicle_error_rate":{"type":["integer","null"],"description":"Vehicle error rate as a percentage (0-100).","example":2},"vehicle_command_adherence":{"type":["integer","null"],"description":"Vehicle command adherence as a percentage (0-100).","example":88},"evse_data_uptime":{"type":["integer","null"],"description":"EVSE data uptime as a percentage (0-100).","example":98},"evse_command_adherence":{"type":["integer","null"],"description":"EVSE command adherence as a percentage (0-100).","example":92},"schedule_quality":{"type":["integer","null"],"description":"Time that schedule requested charging but no charge occurred as a percentage (0-100).","example":85},"charge_outside_of_schedule":{"type":["integer","null"],"description":"Energy usage outside of schedule as a percentage (0-100).","example":5},"session_duration":{"type":["integer","null"],"description":"Session duration.","example":28800},"energy_delivered_vs_required":{"type":["integer","null"],"description":"Energy delivered vs required as a percentage (0-100).","example":95},"savings_attainment_rate":{"type":["integer","null"],"description":"Savings achieved compared to theoretical maximum as a percentage (0-100).","example":78},"session_savings_range":{"type":["integer","null"],"description":"Difference between maximum and minimum theoretical session costs (units of currency).","example":30},"charge_energy_added_meter_reset":{"type":["boolean","null"],"description":"Whether a charge energy added meter reset was detected.","example":false},"charge_energy_added_oscillation_count":{"type":["integer","null"],"description":"Number of charge energy added oscillations.","example":0},"charge_level_oscillation_count":{"type":["integer","null"],"description":"Number of charge level oscillations.","example":1},"charge_location_data_at_session_start_minutes":{"type":["integer","null"],"description":"Age of charge location data at session start, in minutes.","example":5},"last_location_update_implied_velocity_kmh":{"type":["integer","null"],"description":"Implied velocity from last location update, in km/h.","example":0},"distance_from_home_meters":{"type":["integer","null"],"description":"Distance from home in meters.","example":15},"missing_location":{"type":["boolean","null"],"description":"Whether location data is missing.","example":false},"vehicle_median_data_gap_duration_minutes":{"type":["integer","null"],"description":"Median vehicle data gap duration in minutes.","example":3},"vehicle_max_data_gap_duration_minutes":{"type":["integer","null"],"description":"Maximum vehicle data gap duration in minutes.","example":12},"vehicle_data_frequency_below_threshold":{"type":["integer","null"],"description":"Vehicle data frequency below threshold as a percentage (0-100).","example":8},"evse_median_data_gap_duration_minutes":{"type":["integer","null"],"description":"Median EVSE data gap duration in minutes.","example":2},"evse_max_data_gap_duration_minutes":{"type":["integer","null"],"description":"Maximum EVSE data gap duration in minutes.","example":8},"evse_data_frequency_below_threshold":{"type":["integer","null"],"description":"EVSE data frequency below threshold as a percentage (0-100).","example":5},"charge_rate_max_mad_score":{"type":["integer","null"],"description":"Maximum MAD score for charge rate.","example":3},"charge_rate_max_median_ratio":{"type":["integer","null"],"description":"Charge rate max to median ratio as a percentage (0-100).","example":140}}}},"components/schemas/ChargingSubSessionAssessmentRatings":{"id":"components/schemas/ChargingSubSessionAssessmentRatings","kind":"json-schema","title":"ChargingSubSessionAssessmentRatings","data":{"title":"ChargingSubSessionAssessmentRatings","type":"object","description":"RAG (Red/Amber/Green) quality ratings for assessment metrics. Includes an overall quality rating.","additionalProperties":{"type":"string","enum":["RED","AMBER","GREEN","NOT_APPLICABLE"]},"example":{"overall":"RED","energy_delivered_to_capacity_ratio":"RED","energy_delivery_ratio":"RED","average_charge_rate_watts":"AMBER","max_charge_rate_watts":"AMBER","vehicle_data_uptime":"GREEN","schedule_quality":"GREEN","session_duration":"GREEN"}}},"components/schemas/IncentiveScheme":{"id":"components/schemas/IncentiveScheme","kind":"json-schema","title":"IncentiveScheme","data":{"title":"IncentiveScheme","type":"object","description":"Incentive Schemes define a set of rules for how an elgible User can earn monetary Incentives.","examples":[{"id":"incs01JE3ZY9Z2C0E087C942B9WKBC","name":"Off-Peak Charging Incentives","description":"Earn $0.10 per kWh when charging off-peak","visible":false,"available":true}],"properties":{"id":{"type":"string","description":"Prefix: \"incs\""},"name":{"type":"string","description":"Name to be displayed to the User."},"description":{"type":"string","description":"Describes the rules of how the User earns this Incentive."},"visible":{"type":"boolean","default":false,"description":"Should this Incentive Scheme be visible to the User in the App."},"available":{"type":"boolean","default":true,"description":"Is this Incentive available for the User to earn.\nSome Incentive Schemes can only be earned a limitted number of times per User or Device.\nE.g. A Sign Up Incentive that can only be earned once per Device.\nThis will also be False if it is outside the active period of the Incentive Scheme."}}}},"components/schemas/EVSESite":{"id":"components/schemas/EVSESite","kind":"json-schema","title":"EVSESite","data":{"title":"EVSESite","type":"object","description":"Represents a place with one or more EVSEs installed which can be accessed by multiple users.","required":["id","url","evses","cpms_connection"],"properties":{"id":{"type":"string","pattern":"site[A-Z\\d]{26}","examples":["site01JX2SZ0WAFTDYVYY0JRAYREY7"],"readOnly":true},"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/evse_sites/site01JX2SZ0WAFTDYVYY0JRAYREY7","readOnly":true},"evses":{"type":"array","description":"A list of all EVSEs that are currently associated with this site.","items":{"type":"string","format":"uri","examples":["https://api.ev.energy/v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5"]},"readOnly":true},"cpms_connection":{"type":["string","null"],"description":"The type of ChargePoint Management System that this site is connected to, if there is one.","enum":[null,"CHARGEPOINT","SWTCH"],"readOnly":true},"cpms_connection_display_name":{"type":["string","null"],"description":"A human-readable name for the Chargepoint Management System that the site is connected to.","example":"ChargePoint"},"user_connected":{"type":["boolean","null"],"description":"When authenticated as a specific user (eg. via the Authorisation Code grant type) or when the EvEnergy-User header is set to a valid user ID, this field will indicate whether the user is currently connected to this EVSE Site's CPMS. If the request is not made in the context of a user, or the site does not have a CPMS connection, this field will be null.","readOnly":true}}}},"components/schemas/VPPModes":{"id":"components/schemas/VPPModes","kind":"json-schema","title":"VPPModes","data":{"title":"VPPModes","type":"object","description":"VPP (Virtual Power Plant) mode capabilities indicating which control modes are supported by the resource.","required":["target_power","import_max_power","export_max_power","charge_mode"],"properties":{"target_power":{"type":"boolean","description":"Whether target power control mode is supported.","readOnly":true,"example":true},"import_max_power":{"type":"boolean","description":"Whether import maximum power control mode is supported.","readOnly":true,"example":true},"export_max_power":{"type":"boolean","description":"Whether export maximum power control mode is supported.","readOnly":true,"example":false},"charge_mode":{"type":"boolean","description":"Whether charge mode control is supported.","readOnly":true,"example":true}},"examples":[{"target_power":true,"import_max_power":true,"export_max_power":false,"charge_mode":true}]}},"components/schemas/EVSEConnectivity":{"id":"components/schemas/EVSEConnectivity","kind":"json-schema","title":"EVSEConnectivity","data":{"title":"EVSEConnectivity","type":"object","description":"Connectivity snapshot for an EVSE including signal strength, SIM data, firmware version, and connection reliability.","required":["signal_strength_rssi_dbm","lowest_signal_strength_rssi_dbm_7d","highest_signal_strength_rssi_dbm_7d","connection_reliability_30d","ip_address","iccid","firmware_version","latest_status_log"],"properties":{"signal_strength_rssi_dbm":{"type":["integer","null"],"description":"Last known signal strength in RSSI dBm. Null for WiFi EVSEs.","readOnly":true,"example":-65},"lowest_signal_strength_rssi_dbm_7d":{"type":["integer","null"],"description":"Lowest signal strength in RSSI dBm over the past 7 days. Null for WiFi EVSEs.","readOnly":true,"example":-89},"highest_signal_strength_rssi_dbm_7d":{"type":["integer","null"],"description":"Highest signal strength in RSSI dBm over the past 7 days. Null for WiFi EVSEs.","readOnly":true,"example":-57},"connection_reliability_30d":{"type":"integer","description":"Connection reliability over the past 30 days, from 0 (fully offline) to 100 (fully online).","readOnly":true,"example":97},"ip_address":{"type":["string","null"],"description":"The IP address assigned to the EVSE's SIM. Null if no SIM data is available.","readOnly":true,"example":"10.193.28.42"},"iccid":{"type":["string","null"],"description":"The ICCID of the EVSE's SIM card. Null if no SIM data is available.","readOnly":true,"example":"8944110000001234567"},"firmware_version":{"type":["string","null"],"description":"The current firmware version running on the EVSE. Null if not known.","readOnly":true,"example":"1.2.3"},"latest_status_log":{"oneOf":[{"type":["string","null"],"example":"https://api.ev.energy/v2/evses/evse01HSH04KDEWF6Z4DB2J77J74K5/status_logs/2024-04-17T09:39:45.984584Z/","format":"uri"},{"$ref":"#/components/schemas/EVSEStatusLog"}],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An expandable reference to the most recent status log for this EVSE. URL by default, full object when ?expand=latest_status_log is used."},"children":[]}]}]}],"readOnly":true}}}},"components/schemas/EVSEFirmwareVersion":{"id":"components/schemas/EVSEFirmwareVersion","kind":"json-schema","title":"EVSEFirmwareVersion","data":{"title":"EVSEFirmwareVersion","type":"object","description":"A specific firmware release available for one or more EVSE models.","required":["id","url","version","public_version","change_log","support_url"],"properties":{"id":{"type":"string","pattern":"evsf[A-Z\\d]{26}","example":"evsf01HSH04KDEWF6Z4DB2J77J74K5","readOnly":true},"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/evse_firmware_versions/evsf01HSH04KDEWF6Z4DB2J77J74K5/","readOnly":true},"version":{"type":"string","description":"The internal firmware version identifier.","example":"1.2.3","readOnly":true},"public_version":{"type":["string","null"],"description":"The publicly displayed version label, if different from the internal version.","example":"1.2","readOnly":true},"change_log":{"type":["string","null"],"description":"A summary of the changes in this firmware release.","example":"Bug fixes and stability improvements","readOnly":true},"support_url":{"type":["string","null"],"format":"uri","description":"A link to documentation describing this firmware version.","example":"https://example.com/firmware/1.2","readOnly":true}}}},"components/schemas/VehicleReconnectionUrl":{"id":"components/schemas/VehicleReconnectionUrl","kind":"json-schema","title":"VehicleReconnectionUrl","data":{"title":"VehicleReconnectionUrl","type":"object","examples":[{"url":"https://app.ev.energy/vehicle-onboarding/start/56091b3b-86e9-4e7c-a825-f99e5d131234","expiry":"2022-11-03T20:26:10.344522Z"}],"description":"A URL for a user to re-authenticate their vehicle alongside it's metadata.","properties":{"url":{"type":"string","format":"uri","example":"https://app.ev.energy/vehicle-onboarding/start/56091b3b-86e9-4e7c-a825-f99e5d131234","readOnly":true},"expires_at":{"type":"string","format":"date-time","example":"2022-11-03T20:26:10.344522Z","readOnly":true}}}},"components/schemas/EVSEReconnectionUrl":{"id":"components/schemas/EVSEReconnectionUrl","kind":"json-schema","title":"EVSEReconnectionUrl","data":{"title":"EVSEReconnectionUrl","x-stoplight":{"id":"evse-reconnection-url-schema"},"type":"object","examples":[{"url":"https://app.ev.energy/evse-onboarding/start/56091b3b-86e9-4e7c-a825-f99e5d131234"}],"description":"A URL for a user to re-authenticate their EVSE.","properties":{"url":{"type":"string","x-stoplight":{"id":"evse-reconnection-url-field"},"format":"uri","example":"https://app.ev.energy/evse-onboarding/start/56091b3b-86e9-4e7c-a825-f99e5d131234","readOnly":true}}}},"components/schemas/CarbonFeed":{"id":"components/schemas/CarbonFeed","kind":"json-schema","title":"CarbonFeed","data":{"title":"CarbonFeed","type":"object","description":"A carbon feed representing a source of carbon intensity data for a specific region or grid.","x-tags":["Carbon"],"required":["id","url","name"],"properties":{"id":{"type":"string","description":"Unique identifier for the carbon feed.","pattern":"cabf[A-Z\\d]{26}","example":"cabf01HN2NJ9NMRZBXT1H6FT9N7735","readOnly":true},"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/carbon_feeds/cabf01HN2NJ9NMRZBXT1H6FT9N7735","readOnly":true},"name":{"type":"string","description":"Human-readable name for the carbon feed.","example":"UK National Grid","readOnly":true}}}},"components/schemas/GridFeed":{"id":"components/schemas/GridFeed","kind":"json-schema","title":"GridFeed","data":{"title":"GridFeed","type":"object","description":"A grid feed representing a source of grid signal data used for smart charging decisions.","x-tags":["Grid"],"required":["id","url","name","reference_code","priority"],"properties":{"id":{"type":"string","description":"Unique identifier for the grid feed.","pattern":"grfd[A-Z\\d]{26}","example":"grfd01HN2NJ9NMRZBXT1H6FT9N7735","readOnly":true},"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/grid_feeds/grfd01HN2NJ9NMRZBXT1H6FT9N7735","readOnly":true},"name":{"type":"string","description":"Human-readable name for the grid feed.","example":"CAISO Peak Demand","readOnly":true},"reference_code":{"type":"string","description":"Machine-readable reference code for the grid feed, consistent across environments.","example":"CAISO_PEAK","readOnly":true},"priority":{"type":"integer","description":"Priority level (1-10) used to resolve conflicts when a user has multiple overlapping grid feeds.","minimum":1,"maximum":10,"example":8,"readOnly":true}}}},"components/schemas/GridLevel":{"id":"components/schemas/GridLevel","kind":"json-schema","title":"GridLevel","data":{"title":"GridLevel","type":"object","description":"A grid level representing a time-varying signal value within a grid feed. Values are between 1 and 100; values above 50 discourage charging during the interval, while values below 50 encourage it. A value of 50 has no effect.","x-tags":["Grid"],"required":["value","started_at","interval_seconds","created_at"],"properties":{"value":{"type":"integer","description":"The grid level value (1-100). 50 is neutral, higher values discourage charging, lower values encourage it.","minimum":1,"maximum":100,"example":80,"readOnly":true},"started_at":{"type":"string","format":"date-time","nullable":true,"description":"When this grid level interval began (ISO 8601 datetime). Null if the interval has no lower bound.","example":"2024-01-15T18:00:00Z","readOnly":true},"interval_seconds":{"type":"integer","nullable":true,"description":"The duration of this grid level interval in seconds. Null if the interval has no upper or lower bound.","example":10800,"readOnly":true},"created_at":{"type":"string","format":"date-time","description":"When this grid level was created (ISO 8601 datetime).","example":"2024-01-14T09:00:00Z","readOnly":true}}}},"components/schemas/CarbonIntensities":{"id":"components/schemas/CarbonIntensities","kind":"json-schema","title":"CarbonIntensities","data":{"title":"CarbonIntensities","type":"object","description":"A collection of carbon intensity data points for a specific carbon feed.","properties":{"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/carbon_feeds/cabf01HN2NJ9NMRZBXT1H6FT9N7735/carbon_intensities","readOnly":true},"carbon_feed":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/carbon_feeds/cabf01HN2NJ9NMRZBXT1H6FT9N7735","readOnly":true},"carbon_intensities":{"type":"array","description":"A list of carbon intensity data points.","items":{"$ref":"#/components/schemas/CarbonIntensity"},"readOnly":true}}}},"components/schemas/CarbonIntensity":{"id":"components/schemas/CarbonIntensity","kind":"json-schema","title":"CarbonIntensity","data":{"title":"CarbonIntensity","type":"object","description":"A carbon intensity data point representing CO2 emissions per unit of electricity generated.","x-tags":["Carbon"],"required":["started_at","interval_seconds","co2_intensity_grams_per_kilowatt_hour","created_at"],"properties":{"started_at":{"type":"string","format":"date-time","description":"When this interval began.","example":"2024-01-15T10:00:00Z","readOnly":true},"interval_seconds":{"type":"integer","description":"The number of seconds that this interval lasts for.","example":1800,"readOnly":true},"co2_intensity_grams_per_kilowatt_hour":{"type":"integer","description":"Carbon intensity in gCO2/kWh.","example":245,"readOnly":true},"created_at":{"type":"string","format":"date-time","description":"When this record was created (ISO 8601 datetime).","example":"2024-01-15T09:45:00Z","readOnly":true}}}},"components/schemas/Price":{"id":"components/schemas/Price","kind":"json-schema","title":"Price","data":{"title":"Price","type":"object","description":"A price for a specific time interval.","x-tags":["Tariffs"],"required":["started_at","interval_seconds","price_minor_units"],"properties":{"started_at":{"type":"string","format":"date-time","description":"When this price interval began (ISO 8601 datetime).","example":"2024-01-15T10:00:00Z","readOnly":true},"interval_seconds":{"type":"integer","description":"The duration of this price interval in seconds.","example":1800,"readOnly":true},"price_minor_units":{"type":"integer","description":"The price in minor currency units (e.g., pence for GBP).","example":10,"readOnly":true}}}},"components/schemas/CPMSProvider":{"id":"components/schemas/CPMSProvider","kind":"json-schema","title":"CPMSProvider","data":{"title":"CPMSProvider","type":"object","description":"Represents a ChargePoint Management System provider.","required":["id","url","name","icon"],"properties":{"id":{"enum":["CHARGEPOINT","SWTCH"]},"url":{"type":"string","example":"https://api.ev.energy/v2/cpms_providers/CHARGEPOINT/"},"name":{"type":"string"},"icon":{"type":["string","null"],"format":"uri"}}}},"components/schemas/Timezone":{"id":"components/schemas/Timezone","kind":"json-schema","title":"Timezone","data":{"title":"Timezone","type":"object","description":"An IANA timezone that can be assigned to user-facing resources such as smart charging schedules.","required":["id","url","name"],"properties":{"id":{"type":"string","pattern":"tzon[A-Z\\d]{26}","example":"tzon01HRFHBCM7VBSWRPVYFBQMH2BR"},"url":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/timezones/tzon01HRFHBCM7VBSWRPVYFBQMH2BR"},"name":{"type":"string","example":"Europe/London","description":"IANA timezone name."}}}},"components/schemas/Notification":{"id":"components/schemas/Notification","kind":"json-schema","title":"Notification","data":{"title":"Notification","description":"Something that the user should be informed about.","type":"object","examples":[{"id":"notf67O36PLTFDB57M0E5L33JZLGM0","url":"https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0","message_id":"ERR0123","category":"ACTIONABLE","event_time":"2019-08-24T14:15:22Z","short_text_title":"Your car is disconnected","short_text_body":"We need to reconnect to keep smart charging your car","detail_page_title":"Your car is disconnected","detail_page_body":"Your car has been disconnected. This happens when your password is reset. We need you to re-authorise ev.energy to access your account in order for us to keep managing your charging. Blah blah blah.","external_link":"http://example.com","external_button_label":"More info","read_at":"2019-08-24T14:20:22Z","resolved_at":"2019-08-25T14:15:22Z"}],"required":["id","url","message_id","category","event_time","short_text_title","short_text_body","detail_page_title","detail_page_body","external_link","external_button_label"],"properties":{"id":{"type":"string","pattern":"notf[A-Z\\d]{26}","example":"notf67O36PLTFDB57M0E5L33JZLGM0","description":"Unique identifier for the Notification"},"url":{"type":"string","format":"uri","example":"https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"},"message_id":{"type":"string","description":"Internal identifier for this notification type. E.g. 'ERR0023'"},"category":{"description":"Category of this notification type","enum":["ACTIONABLE","SERVICE","RETRY","MARKETING","INTERNAL"]},"event_time":{"type":"string","format":"date-time","description":"The timestamp of the event described by this notification"},"short_text_title":{"type":"string","description":"Short title for the notification","maxLength":33},"short_text_body":{"type":"string","description":"Short description of the event being notified","maxLength":49},"detail_page_title":{"type":"string","description":"Title of a help page giving more information about this notification"},"detail_page_body":{"type":"string","description":"Text of a help page giving more information about this notification"},"external_link":{"type":["string","null"],"description":"URL of a web page giving further information about this notification","format":"uri"},"external_button_label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Text to be displayed on a button leading to the external_link location"},"children":[]}]}]}]},"read_at":{"type":"string","format":"date-time","description":"When the user examined the contents of this notification"},"resolved_at":{"type":"string","format":"date-time","description":"When the problem associated with this notification was resolved"}}}},"components/schemas/RFC9457ProblemDetail":{"id":"components/schemas/RFC9457ProblemDetail","kind":"json-schema","title":"RFC 9457 Problem Detail","data":{"title":"RFC 9457 Problem Detail","x-tags":["problems"],"type":"object","required":["title","detail"],"properties":{"type":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/problems/example-problem/"},"status":{"type":"number","example":400},"title":{"type":"string","example":"Short description"},"detail":{"type":"string","example":"Long, more specific description."},"instance":{"type":"string","format":"uri","example":"https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"},"notification":{"$ref":"#/components/schemas/Notification"}},"examples":[{"type":"https://api.ev.energy/v2/problems/example-problem/","status":400,"title":"Short description","detail":"Long, more specific description.","instance":"https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E","notification":{"id":"notf01HTHKTXVB77901324BCQPF1RB","url":"https://api.ev.energy/notifications/notf01HTHKTXVB77901324BCQPF1RB","message_id":"ERR0123","category":"ACTIONABLE","event_time":"2019-08-24T14:15:22Z","short_text_title":"Your car is disconnected","short_text_body":"We need to reconnect to keep smart charging your car","detail_page_title":"Your car is disconnected","detail_page_body":"Your car has been disconnected. This happens when your password is reset. We need you to re-authorise ev.energy to access your account in order for us to keep managing your charging. Blah blah blah.","external_link":"http://example.com","external_button_label":"More info","read_at":"2019-08-24T14:20:22Z","resolved_at":"2019-08-25T14:15:22Z"}}]}},"components/schemas/GeoJsonPolygon":{"id":"components/schemas/GeoJsonPolygon","kind":"json-schema","title":"GeoJsonPolygon","data":{"title":"GeoJsonPolygon","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7946 GeoJSON Polygon in WGS 84. Positions are [longitude, latitude] (note the order — this is the GeoJSON interchange standard, not the {latitude, longitude} object used elsewhere in this API). The first ring is the exterior boundary; any further rings are holes."},"children":[]}]}]}],"required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["Polygon"]},"coordinates":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of linear rings; each ring is a closed list of [longitude, latitude] positions (first position repeated last)."},"children":[]}]}]}],"minItems":1,"maxItems":100,"items":{"type":"array","minItems":4,"maxItems":25000,"items":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"}}}}}}},"components/schemas/GeoJsonMultiPolygon":{"id":"components/schemas/GeoJsonMultiPolygon","kind":"json-schema","title":"GeoJsonMultiPolygon","data":{"title":"GeoJsonMultiPolygon","type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC 7946 GeoJSON MultiPolygon in WGS 84. Positions are [longitude, latitude]. Each member is a Polygon coordinate array."},"children":[]}]}]}],"required":["type","coordinates"],"properties":{"type":{"type":"string","enum":["MultiPolygon"]},"coordinates":{"type":"array","description":"Array of Polygon coordinate arrays.","minItems":1,"maxItems":500,"items":{"type":"array","minItems":1,"maxItems":100,"items":{"type":"array","minItems":4,"maxItems":25000,"items":{"type":"array","minItems":2,"maxItems":2,"items":{"type":"number"}}}}}}}},"schema_248":{"kind":"json-schema","data":{"type":"string","pattern":"[a-z]{4}[A-Z\\d]{26}","example":"xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR"},"id":"schema_248"},"schema_249":{"kind":"json-schema","data":{"type":"integer","default":25,"minimum":1,"maximum":100,"example":10},"id":"schema_249"},"schema_250":{"kind":"json-schema","data":{"type":"number","enum":[2]},"id":"schema_250"},"schema_251":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/CarbonFeed"}},"id":"schema_251"},"schema_252":{"kind":"json-schema","data":{"type":"object","properties":{"Link":{"type":"string","description":"Provides links to the previous and next pages of data, if they exist.","example":"