# Retrieve schedules for a charging sub-session

Retrieve schedules for a specific charging sub-session.

Schedules represent charging instructions for a charging session. Each schedule specifies a current (in milliamps) and a time period during which that current should be applied.

Endpoint: GET /charging_sub_sessions/{charging_sub_session_id}/schedules
Version: 2.0
Security: oauth2

## Path parameters:

  - `charging_sub_session_id` (string, required)
    Uniquely identify a specific charging sub-session.
    Example: "csub01HSH04KDEWF6Z4DB2J77J74K5"

## Header parameters:

  - `EvEnergy-Version` (number)
    Specify the version of this endpoint to use.
    Enum: 2

## Query parameters:

  - `expand` (array)
    Specify a url field to expand into a nested resource.
    Enum: "charging_sub_session"

  - `started_at__gte` (string)
    Filter schedules with started_at greater than or equal to this datetime.

  - `started_at__lte` (string)
    Filter schedules with started_at less than or equal to this datetime.

  - `schedule_plan_id` (string)
    Filter schedules generated from a specific schedule plan.
    Example: "scpl01HSH04KDEWF6Z4DB2J77J74K5"

  - `only_most_recently_created` (boolean)
    Only show the most recently created schedule for each time period

## Response 200 fields (application/json):

  - `url` (string)
    Example: "https://api.ev.energy/v2/charging_sub_sessions/csub01HSH04KDEWF6Z4DB2J77J74K5/schedules"

  - `charging_sub_session` (any)
    The charging sub-session these schedules belong to. Defaults to a url, but can be expanded to the full ChargingSubSession resource via the expand query parameter.

  - `schedules` (array)
    A list of schedule intervals for this charging sub-session.

  - `schedules.started_at` (string)
    The start time of the period this schedule applies to. Always aligned to half-hour boundaries (:00 or :30).
    Example: "2024-01-01T02:00:00Z"

  - `schedules.interval_seconds` (integer,null)
    The duration of this schedule in seconds. Currently always 1800 seconds (30 minutes), or null for boost sessions which have no defined end time.
    Example: 1800

  - `schedules.current_milliamps` (integer)
    The charging current in milliamps that should be applied during this period. A value of 0 means no charging.
    Example: 7400

  - `schedules.schedule_type` (string)
    The type of scheduling that generated this instruction.

- INITIAL_CHARGE_TIME: Initial charge to condition the battery
- BATTERY_WARMING: Pre-warming the hour before the ready-by-time
- SMART: Optimised smart charging
- BOOST: Immediate charging at maximum rate
- SOLAR_ONLY: Charging only from solar generation
- SOLAR_SMART: Combined solar and smart charging
- V2G_DISCHARGE: Vehicle-to-grid discharge
- V2G_CHARGEBACK: Charging back after V2G discharge
- LEGACY: Legacy schedules from before type tracking
    Enum: "INITIAL_CHARGE_TIME", "BATTERY_WARMING", "SMART", "BOOST", "SOLAR_ONLY", "SOLAR_SMART", "V2G_DISCHARGE", "V2G_CHARGEBACK", "LEGACY"

  - `schedules.dispatched_at` (string,null)
    When this schedule was last sent to the device. Null if not yet dispatched.
    Example: "2024-01-01T02:00:15Z"

  - `schedules.created_at` (string)
    When this schedule was created.
    Example: "2024-01-01T01:55:00Z"

## Response 400 fields (application/problem+json):

  - `type` (string)
    Example: "https://api.ev.energy/v2/problems/example-problem/"

  - `status` (number)
    Example: 400

  - `title` (string, required)
    Example: "Short description"

  - `detail` (string, required)
    Example: "Long, more specific description."

  - `instance` (string)
    Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"

  - `notification` (object)
    Something that the user should be informed about.

  - `notification.id` (string, required)
    Unique identifier for the Notification
    Example: "notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.url` (string, required)
    Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.message_id` (string, required)
    Internal identifier for this notification type. E.g. 'ERR0023'

  - `notification.category` (any, required)
    Category of this notification type
    Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL"

  - `notification.event_time` (string, required)
    The timestamp of the event described by this notification

  - `notification.short_text_title` (string, required)
    Short title for the notification

  - `notification.short_text_body` (string, required)
    Short description of the event being notified

  - `notification.detail_page_title` (string)
    Title of a help page giving more information about this notification

  - `notification.detail_page_body` (string)
    Text of a help page giving more information about this notification

  - `notification.external_link` (string,null)
    URL of a web page giving further information about this notification

  - `notification.external_button_label` (string)
    Text to be displayed on a button leading to the external_link location

  - `notification.read_at` (string)
    When the user examined the contents of this notification

  - `notification.resolved_at` (string)
    When the problem associated with this notification was resolved

## Response 401 fields (application/problem+json):

  - `status` (number)
    Example: 401

  - `title` (string, required)
    Example: "Unauthorized"

  - `detail` (string, required)
    Example: "Authentication credentials were not provided."

## Response 403 fields (application/problem+json):

  - `status` (number)
    Example: 403

  - `title` (string, required)
    Example: "Forbidden"

  - `detail` (string, required)
    Example: "You do not have permission to perform this action."

## Response 404 fields (application/problem+json):

  - `status` (number)
    Example: 404

  - `title` (string, required)
    Example: "Not found"

  - `detail` (string, required)
    Example: "Resource does not exist or cannot be accessed."

## Response 406 fields (application/problem+json):

  - `status` (number)
    Example: 406

  - `title` (string, required)
    Example: "Not Acceptable"

  - `detail` (string, required)
    Example: "Could not satisfy the request Accept header."

## Response 429 fields (application/problem+json):

  - `type` (string)
    Example: "https://api.ev.energy/v2/problems/example-problem/"

  - `status` (number)
    Example: 400

  - `title` (string, required)
    Example: "Short description"

  - `detail` (string, required)
    Example: "Long, more specific description."

  - `instance` (string)
    Example: "https://api.ev.energy/v2/users/user01HN2P75GBNFRJPCZJXEFVXH5E"

  - `notification` (object)
    Something that the user should be informed about.

  - `notification.id` (string, required)
    Unique identifier for the Notification
    Example: "notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.url` (string, required)
    Example: "https://api.ev.energy/notifications/notf67O36PLTFDB57M0E5L33JZLGM0"

  - `notification.message_id` (string, required)
    Internal identifier for this notification type. E.g. 'ERR0023'

  - `notification.category` (any, required)
    Category of this notification type
    Enum: "ACTIONABLE", "SERVICE", "RETRY", "MARKETING", "INTERNAL"

  - `notification.event_time` (string, required)
    The timestamp of the event described by this notification

  - `notification.short_text_title` (string, required)
    Short title for the notification

  - `notification.short_text_body` (string, required)
    Short description of the event being notified

  - `notification.detail_page_title` (string)
    Title of a help page giving more information about this notification

  - `notification.detail_page_body` (string)
    Text of a help page giving more information about this notification

  - `notification.external_link` (string,null)
    URL of a web page giving further information about this notification

  - `notification.external_button_label` (string)
    Text to be displayed on a button leading to the external_link location

  - `notification.read_at` (string)
    When the user examined the contents of this notification

  - `notification.resolved_at` (string)
    When the problem associated with this notification was resolved