action britbox_get_schedules {
  label: "getSchedules"
  description: "Returns schedules for a defined set of channels over a requested period.\n\nSchedules are requested in hour blocks and returned grouped by the channel\nthey belong to.\n\nFor example, to load 12 hours of schedules for channels `4343` and `5234`,\non 21/2/2017 starting from 08:00.\n\n```\nchannels=4343,5234\ndate=2017-02-21\nhour=8\nduration=12\n```\n\nPlease remember that `date` and `hour` combined represent a normal datetime, \nso they should be converted to UTC on the client - this will help to avoid \nissues with EPG schedules near midnight.\n\nIf a channel id is passed which doesn't exist then this endpoint will\nreturn an empty schedule list for it. If instead we returned 404,\nthis would invalidate all other channel schedules in the same request\nwhich would be unfriendly for clients presenting these channel schedules.\n"
  provider: britbox
  method: GET
  path: "/schedules"
  encoding: json
  input: {
    type: "object"
    properties: {
      channels: {
        type: "array"
        items: {
          type: "string"
        }
      }
      date: {
        type: "string"
        format: "date"
      }
      duration: {
        type: "integer"
        format: "int32"
      }
      hour: {
        type: "integer"
        format: "int32"
      }
      intersect: {
        type: "boolean"
      }
    }
    required: ["channels", "date", "duration", "hour"]
    additionalProperties: false
  }
  output: {
    type: "array"
    items: {
      type: "object"
      required: ["channelId", "startDate", "endDate", "schedules"]
      properties: {
        channelId: {
          type: "string"
          description: "The id of the channel the schedules belong to."
        }
        endDate: {
          type: "string"
          format: "date-time"
          description: "The date and time this list of schedules ends."
        }
        schedules: {
          type: "array"
          description: "The list of item schedules."
          items: {
            type: "object"
            required: ["id", "channelId", "startDate", "endDate"]
            properties: {
              blackout: {
                type: "boolean"
                description: "True if this schedule represents time when the channel is completely off air."
              }
              channelId: {
                type: "string"
                description: "The id of the channel item this schedule belongs to."
              }
              endDate: {
                type: "string"
                format: "date-time"
                description: "The date and time this schedule ends."
              }
              featured: {
                type: "boolean"
                description: "True if this is a featured item schedule."
              }
              id: {
                type: "string"
              }
              live: {
                type: "boolean"
                description: "True if this is a live event."
              }
              repeat: {
                type: "boolean"
                description: "True if this has been aired previously on the same channel."
              }
              startDate: {
                type: "string"
                format: "date-time"
                description: "The date and time this schedule starts."
              }
            }
          }
        }
        startDate: {
          type: "string"
          format: "date-time"
          description: "The date and time this list of schedules starts."
        }
      }
      additionalProperties: false
    }
  }
}