openapi: 3.2.0 info: title: OnConnect Lookup APIs v1.1 Movies on TV API description: '**Note:** The OnConnect API returns JSON responses. For additional response examples, see the OnConnect documentation.' version: '1.1' servers: - url: /proxy/onconnect tags: - name: Movies on TV paths: /v1.1/movies/airings: get: summary: All Movies Airing on TV description: Returns movies and associated metadata that are airing on a lineup for a given time period up to 24 hours in length and up to 14 days in advance. tags: - Movies on TV parameters: - $ref: '#/components/parameters/ApiKeyQuery' - name: lineupId in: query required: true schema: type: string default: USA-TX42500-X description: Lineup ID - name: startDateTime in: query required: true schema: type: dateTime default: '' description: Date/Time to start from (ISO 8601). - name: endDateTime in: query required: false schema: type: dateTime default: '' description: Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours. - name: includeAdult in: query required: false schema: type: boolean default: '' enum: - '' - 'true' - 'false' description: Boolean indicating whether to include adult TV shows in response. Defaults to false. - name: imageSize in: query required: false schema: type: string default: '' enum: - '' - Sm - Md - Lg - Ms description: Size of the image referenced by the preferred image URI returned. The default value is Md (medium) - name: imageText in: query required: false schema: type: boolean default: '' enum: - '' - 'true' - 'false' description: Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text). - name: market in: query required: false schema: type: string default: '' description: Outputs source provided imagery that is specific to a certain country, if available. - name: descriptionLang in: query required: false schema: type: string default: '' enum: - '' - da - de - en - en-GB - en-AU - es - fi - fr - fr-CA - it - nl - 'no' - pt - pt-BR - sv description: Optional filter based on specified description language. If not specified, all movies airings returned. responses: '200': description: Successful response operationId: getV11MoviesAirings x-operation-id-source: derived /v1.1/movies/{rootId}/versions: get: summary: Movie Versions description: Returns all versions of a given movie. *Available with R&D/Commercial plans only. tags: - Movies on TV parameters: - $ref: '#/components/parameters/ApiKeyQuery' - name: rootId in: path required: true schema: type: string default: '3542039' description: Movie Root ID - name: imageSize in: query required: false schema: type: string default: '' enum: - '' - Sm - Md - Lg - Ms description: Size of the image referenced by the preferred image URI returned. The default value is Md (medium) - name: imageText in: query required: false schema: type: boolean default: '' enum: - '' - 'true' - 'false' description: Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text). - name: market in: query required: false schema: type: string default: '' description: Outputs source provided imagery that is specific to a certain country, if available. - name: descriptionLang in: query required: false schema: type: string default: '' enum: - '' - da - de - en - en-GB - en-AU - es - fi - fr - fr-CA - it - nl - 'no' - pt - pt-BR - sv description: Filter results based on the specified description language. When not specified, returns English versions, or if no English descriptions available, returns versions with descriptionLang of primary TMS ID. responses: '200': description: Successful response operationId: getV11MoviesByRootIdVersions x-operation-id-source: derived /v1.1/movies/{rootId}/airings: get: summary: Movie Airings description: Returns all airings of a movie for a given lineup and time period up to 14 days in advance. tags: - Movies on TV parameters: - $ref: '#/components/parameters/ApiKeyQuery' - name: rootId in: path required: true schema: type: string default: '169874' description: Movie Root ID - name: lineupId in: query required: true schema: type: string default: USA-TX42500-X description: Lineup ID - name: startDateTime in: query required: true schema: type: dateTime default: '' description: Date/Time to start from (ISO 8601). - name: endDateTime in: query required: false schema: type: dateTime default: '' description: Date/Time to end on (ISO 8601). Defaults to startDateTime plus three hours. - name: includeDetail in: query required: false schema: type: boolean default: 'true' enum: - '' - 'true' - 'false' description: Boolean indicating whether to include detailed movie metadata with each airing. Defaults to false. - name: imageSize in: query required: false schema: type: string default: '' enum: - '' - Sm - Md - Lg - Ms description: Size of the image referenced by the preferred image URI returned. The default value is Md (medium) - name: imageText in: query required: false schema: type: boolean default: '' enum: - '' - 'true' - 'false' description: Boolean indicating preference for image with or without text. If no image is found matching text preference, next available image will be returned. Defaults to true (prefer images with text). - name: market in: query required: false schema: type: string default: '' description: Outputs source provided imagery that is specific to a certain country, if available. - name: descriptionLang in: query required: false schema: type: string default: '' enum: - '' - da - de - en - en-GB - en-AU - es - fi - fr - fr-CA - it - nl - 'no' - pt - pt-BR - sv description: Optional filter based on specified description language. If not specified, all airings of movie returned. responses: '200': description: Successful response operationId: getV11MoviesByRootIdAirings x-operation-id-source: derived components: parameters: ApiKeyQuery: name: api_key in: query required: true schema: type: string description: API key for authentication