getSchedules

v1.0.0

Returns schedules for a defined set of channels over a requested period.

Schedules are requested in hour blocks and returned grouped by the channel they belong to.

For example, to load 12 hours of schedules for channels 4343 and 5234, on 21/2/2017 starting from 08:00.

Please remember that date and hour combined represent a normal datetime, so they should be converted to UTC on the client - this will help to avoid issues with EPG schedules near midnight.

If a channel id is passed which doesn't exist then this endpoint will return an empty schedule list for it. If instead we returned 404, this would invalidate all other channel schedules in the same request which would be unfriendly for clients presenting these channel schedules.

Input

{
  "type": "object",
  "properties": {
    "channels": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "date": {
      "type": "string",
      "format": "date"
    },
    "device": {
      "type": "string"
    },
    "duration": {
      "type": "integer",
      "format": "int32"
    },
    "ff": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "all",
          "idp",
          "ldp",
          "hb",
          "rpt",
          "cas",
          "lrl",
          "cd"
        ]
      }
    },
    "hour": {
      "type": "integer",
      "format": "int32"
    },
    "intersect": {
      "type": "boolean"
    },
    "lang": {
      "type": "string"
    },
    "segments": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "sub": {
      "type": "string"
    }
  },
  "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
  }
}