Charge Schedule by Location

GET

vehicles

{id}

{make}

charge

schedule_by_location

curl "https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/schedule_by_location" \
-H "Authorization: Bearer {token}" \
-X "GET"

{
  "chargingLocations": [
    {
      "chargeLimit": 0.8,
      "chargingSchedules": {
        "weekday": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ],
        "weekend": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ]
      },
      "location": {
        "latitude": 48.8566,
        "longitude": 2.3522
      }
    }
  ]
}

This endpoint is currently available for ford and lincoln

Permission

read_charge_locations

Request

Path

string

required

The vehicle ID of the vehicle you are making a request to.

make

string

required

The make of the vehicle you are making a request to.

curl "https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/schedule_by_location" \
-H "Authorization: Bearer {token}" \
-X "GET"

Response

chargingLocations

[object] | [empty]

An array of charging locations. Empty if none are currently set on the vehicle.

Show child attributes

chargeLimit

number

The maximum charge limit for the vehicle at the location as a percent.

location

object

The latitude and longitude of the charging location.

Show location

longitude

number

The longitude of the charging location.

latitude

number

The latitude of the charging location.

chargingSchedules

object

The weekday and weekend charging schedules for the vehicle at the location.

Show child attributes

weekday

[object] | [empty]

The charging schedule for the vehicle on weekdays (Monday - Friday).

Show child attributes

start

string

The exact hour a vehicle should start charging in HH:00 e.g. 17:00.

end

string

The exact hour a vehicle should stop charging in HH:00 e.g. 21:00.

weekend

[object] | [empty]

The charging schedule for the vehicle on weekends (Saturday - Sunday).

Show child attributes

start

string

The exact hour a vehicle should start charging in HH:00 e.g. 17:00.

end

string

The exact hour a vehicle should stop charging in HH:00 e.g. 21:00.

{
  "chargingLocations": [
    {
      "chargeLimit": 0.8,
      "chargingSchedules": {
        "weekday": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ],
        "weekend": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ]
      },
      "location": {
        "latitude": 48.8566,
        "longitude": 2.3522
      }
    }
  ]
}

Example Schedule States

Vehicle will charge at any time

{
  "chargingLocations": [
    {
      "chargeLimit": 0.8,
      "chargingSchedules": {
        "weekday": [],
        "weekend": []
      },
      "location": {
        "latitude": 48.8566,
        "longitude": 2.3522
      }
    }
  ]
}

Vehicle has a schedule for Weekdays only

{
  "chargingLocations": [
    {
      "chargeLimit": 0.8,
      "chargingSchedules": {
        "weekday": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ],
        "weekend": []
      },
      "location": {
        "latitude": 48.8566,
        "longitude": 2.3522
      }
    }
  ]
}

Vehicle has a schedule for Weekends only

{
    "chargingLocation" : {   
        "chargeLimit": 0.9, 
        "chargingSchedules": {
            "weekday": [], 
            "weekend": [
                {   
                    "start": "16:00", 
                    "end": "07:00"
                }
            ]
        }
    }
}

Charge Records Charge Schedule by Location

curl "https://api.smartcar.com/v2.0/vehicles/{id}/{make}/charge/schedule_by_location" \
-H "Authorization: Bearer {token}" \
-X "GET"

{
  "chargingLocations": [
    {
      "chargeLimit": 0.8,
      "chargingSchedules": {
        "weekday": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ],
        "weekend": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ]
      },
      "location": {
        "latitude": 48.8566,
        "longitude": 2.3522
      }
    }
  ]
}

Introduction

Compatibility

Connection Management

Vehicle Endpoints

Make Specific

Webhooks

Charge Schedule by Location

Permission

Request

Response

Example Schedule States

Introduction

Compatibility

Connection Management

Vehicle Endpoints

Make Specific

Webhooks

​Permission

​Request

​Response

​Example Schedule States

Permission

Request

Response

Example Schedule States