{
"openapi": "3.1.1",
"info": {
"title": "GN IDS API v1.9.3",
"description": "The purpose of this application is to provide an API to create, retrieve, update, delete,\nand publish client programs.",
"version": "1.9.3"
},
"servers": [
{
"url": "/proxy/gnids/api/v1"
}
],
"tags": [
{
"name": "movie-root"
},
{
"name": "movie-version"
},
{
"name": "movie-presentation"
},
{
"name": "show-root"
},
{
"name": "show-version"
},
{
"name": "show-presentation"
},
{
"name": "show-season"
},
{
"name": "show-episode"
},
{
"name": "program-summaries"
},
{
"name": "publications"
},
{
"name": "publish"
},
{
"name": "catalog"
},
{
"name": "images"
},
{
"name": "vocabulary"
},
{
"name": "export"
}
],
"paths": {
"/bulk/movies/batches": {
"get": {
"tags": [
"bulk"
],
"summary": "Retrieve bulk movie batches.",
"description": "Retrieves a paginated array of movie batch resources. Supports query parameters for `limit`, `page`, `sortField` (created, updated),\nand `sortDirection` (ASC, DESC) to control result set.",
"operationId": "queryMovieBatches",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"required": true,
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "sortField",
"in": "query",
"description": "Field by which to sort batches by.",
"schema": {
"type": "string",
"default": "updated",
"enum": [
"created",
"updated"
]
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Direction by which to sort the search results.",
"schema": {
"type": "string",
"default": "DESC",
"enum": [
"ASC",
"asc",
"DESC",
"desc"
]
}
}
],
"responses": {
"200": {
"description": "BatchesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchesResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"bulk"
],
"summary": "Create a new bulk movies batch.",
"description": "Creates a new movie batch. Accepts a JSON payload adhering to the `MoviePayload` schema for batch creation.",
"operationId": "createMovieBatch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoviePayload"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "MovieBatchResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieBatchResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityErrorBulkMovies",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"validation errors"
]
},
"descriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"fields": {
"title.value": {
"error": "title value string exceeds the maximum length of 120"
}
},
"index": "roots[0].versions[0].presentations[0]",
"message": "title exceeds max length",
"type": "required_field"
},
{
"index": "roots[2].versions[1]",
"message": "user is not entitled to language \"fr\"",
"type": "entitlement_error"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"81fcfc04-2182-4567-963f-5g0a9a629a15"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "payload",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/bulk/movies/batches/{gnID}": {
"get": {
"tags": [
"bulk"
],
"summary": "Search for movie batch using its GnID.",
"description": "Retrieves a specific movie batch resource identified by its `gnID` path parameter.",
"operationId": "queryMovieBatch",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the movie batch to retrieve.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "MovieBatchResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieBatchResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/bulk/programs/exports": {
"get": {
"tags": [
"export"
],
"summary": "Returns a paginated collection of exports in a source's catalog.",
"description": "it provides information for all exports to a source with current export statuses",
"operationId": "getExports",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"required": true,
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "sortField",
"in": "query",
"description": "Field by which to sort batches by.",
"schema": {
"type": "string",
"default": "updated",
"enum": [
"created",
"updated"
]
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Direction by which to sort the search results.",
"schema": {
"type": "string",
"default": "DESC",
"enum": [
"ASC",
"asc",
"DESC",
"desc"
]
}
}
],
"responses": {
"200": {
"description": "ExportsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportsResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"export"
],
"summary": "creates a new export with user provided filters",
"description": "An Export is a user provided filter and context information that will be used by batch to fetch programs based on provided criteria",
"operationId": "createExport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewExport"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ExportResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "newExport",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/bulk/programs/exports/{gnID}": {
"get": {
"tags": [
"export"
],
"description": "Fetches an export by its GNID",
"operationId": "getExportByGnID",
"responses": {
"200": {
"description": "ExportResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/bulk/programs/exports/{gnID}/results": {
"get": {
"tags": [
"export"
],
"summary": "Fetches the results for an export by its GNID",
"description": "Page and limit are required parameters to fetch the results",
"operationId": "getExportByGnID",
"responses": {
"200": {
"description": "ExportResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExportResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/bulk/publish": {
"post": {
"tags": [
"publish"
],
"summary": "Submit multiple presentations for publish.",
"description": "This API endpoint allows you to submit a list of Gracenote IDs (GnIDs) for bulk publishing.\nIt supports publishing movies, shows, and episodes.\n\n## Submit a list of publishables (presentations) for publishing.\n\nProvided a list of gnIDs, the API attempts to submit all the presentations at once for publishing.\nThe publishables (presentations) will be marked as \"inProcess\". If image certify entitlement\nis active images with gracenoteUsage = true will be published alongside the presentations/seasons.\n\n## Submit a list of publishables (presentations) with self-mapping.\n\nIf provided a list of gnIDs, along with a Mapping object (mapping object should be the part of\neach publishable that we want to self-map), the API will attempt to publish the provided\npublishables (presentations) with the provided tmsID. The publishables (presentations) will be marked as \"published\".\nIf image certify entitlement is active images with gracenoteUsage = true will be published alongside the presentations/seasons.\n\n## Conditions for publish\n\nFor a given publishable in the list of publishables, conditions remain same as they are for a single presentation publish\n\n In a single request, at max 1000 publications can be published. The API will not accept the request if there are more than 1000 publications\nin the request body.\n In the list, each publication must have the field \"gnID\".\n The presentations represented by the included gnIDs must fall under catalog of the requesting user.\n The gnIDs sent in the body of the request must correspond to the existing video presentations.\n The presentations must be of type movie, (and/or) show and/or episode, i.e. one request can have mixed of movie, show and episode\npresentations or all presentations can be of the same type.\n Only the following movie subTypes are publishable: featureFilm, shortFilm, trailer, and tvMovie\n Only the following show subTypes are publishable: series, and special\n Only the following episode subTypes are publishable: episode\n\n## Fields Required for Publishing\n\n### Movies:\n Root: Program Title, Title Language, Program SubType\n Version: Program Title, Title Language, Program SubType, Release Date OR Release Year\n Presentation: Program Title, Title Language, Program SubType, Release Date OR Release Year, Genres\n\n### Shows:\n Root: Program Title, Title Language, Program SubType\n Version: Program Title, Title Language, Program SubType, Release Date\n Presentation: Program Title, Title Language, Program SubType, Release Date, Genres\n\n### Episodes\n Episode: Program Title, Title Language, Program SubType, Release Date, Genres\n\n## Post-conditions\n\n### Success\n The API will return status code 200 along with a response body which includes the list of programs having entire hierarchy of the program.\n The indicated gnIDs in the response list have been submitted for publishing and will be processed by the distribution system.\n If self mapped, the provided IDs will be displayed and will be submitted to be processed by the distribution system.\n response JSON varies with the program type.\n\n### Failure\n The api will return an appropriate 4xx or 5xx series status with a relevant error message.\n The response will have an array of responses having types PublishMovieResponse (and/or), PublishShowResponse and/or PublishEpisodeResponse.\n For error code 422 (unprocessable_entity), the possible error types are:\n\n- publishable_not_found
\n- duplicate_publishable
\n- publish requirements not met
\n
",
"operationId": "bulkPublishPresentations",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkPublishInput"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "PublishResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityErrorBulkPublish",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"bulk publishing errors"
]
},
"descriptionDetails": {
"type": "array",
"description": "Possible type values: publishable_not_found, duplicate_publishable,publish requirements not met",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"fields": [
{
"error": "at least one genre must be provided before publishing.",
"field": "genres",
"level": "presentation"
},
{
"error": "releaseDate must be provided before publishing. if releaseYear is not specified.",
"field": "releaseDate",
"level": "presentation"
},
{
"error": "releaseYear must be provided before publishing. if releaseDate is not specified.",
"field": "releaseYear",
"level": "presentation"
}
],
"gnid": "GNXX00000XXXXXX",
"message": "publish requirements not met"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/publish"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "publishables",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/bulk/shows/batches": {
"get": {
"tags": [
"bulk"
],
"summary": "Retrieve bulk show batches.",
"description": "Retrieves a paginated array of show batch resources. Supports query parameters for `limit`, `page`,\n`sortField` (created, updated), and `sortDirection` (ASC, DESC) to control result set.",
"operationId": "queryShowBatches",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"required": true,
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "sortField",
"in": "query",
"description": "Field by which to sort batches by.",
"schema": {
"type": "string",
"default": "updated",
"enum": [
"created",
"updated"
]
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Direction by which to sort the search results.",
"schema": {
"type": "string",
"default": "DESC",
"enum": [
"ASC",
"asc",
"DESC",
"desc"
]
}
}
],
"responses": {
"200": {
"description": "BatchesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchesResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"bulk"
],
"summary": "Create a new bulk shows batch.",
"description": "Creates a new show batch. Accepts a JSON payload conforming to the `ShowPayload` schema for batch creation.\nPayload size must be less than or equal to 25MB.",
"operationId": "createShowBatch",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowPayload"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ShowBatchResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowBatchResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityErrorBulkShows",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"validation errors"
]
},
"descriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"fields": {
"title.value": {
"error": "title value string exceeds the maximum length of 150"
}
},
"index": "roots[0].versions[0].presentations[0]",
"message": "title exceeds max length",
"type": "required_field"
},
{
"index": "roots[2].versions[1]",
"message": "user is not entitled to language \"fr\"",
"type": "entitlement_error"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/shows/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"73fdfc07-2182-4567-963f-5f0f9a621d15"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "payload",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/bulk/shows/batches/{gnID}": {
"get": {
"tags": [
"bulk"
],
"summary": "Search for show batch using its GnID.",
"description": "Retrieves a specific show batch resource identified by its `gnID` path parameter.",
"operationId": "queryShowBatch",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the show batch to retrieve.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ShowBatchResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowBatchResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/catalogPrograms": {
"post": {
"tags": [
"catalog"
],
"summary": "Adds presentations to a catalog.",
"description": "Adds one or more presentation resources to a catalog. Expects a JSON array of\n`CatalogProgram` objects, each specifying `catalogGnID` and `presentationGnID`.",
"operationId": "addProgramsToCatalog",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogProgram"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "AddProgramsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddProgramsResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityErrorCatalogPrograms",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"mapping not found"
]
},
"descriptionDetails": {
"type": "array",
"description": "Possible type values: duplicate_mapping, presentation_not_found, catalog_not_found, duplicate_mapping_request",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"catalogGnID": "GNLZZXZ00000000",
"presentationGnID": "GN1234567890123",
"type": "presentation_not_found"
},
{
"catalogGnID": "GNLZZXZ00000000",
"presentationGnID": "GN1234567890123",
"type": "catalog_not_found"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/catalogPrograms"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "catalog",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
},
"patch": {
"tags": [
"catalog"
],
"summary": "Remove presentation(s) from a Catalog.",
"description": "Removes one or more presentation resources from a catalog. Requires a JSON array of `CatalogProgram` objects,\neach defining the `catalogGnID` and `presentationGnID` to be removed.",
"operationId": "removePresFromCatalog",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogProgram"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "DeletedCatalogProgramMappingsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedCatalogProgramMappingsResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityErrorCatalogPrograms",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"mapping not found"
]
},
"descriptionDetails": {
"type": "array",
"description": "Possible type values: mapping_not_found",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"catalogGnID": "GNLZZXZ00000000",
"presentationGnID": "GN1234567890123",
"type": "mapping_not_found"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/catalogPrograms"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "catalog",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/catalogs": {
"get": {
"tags": [
"catalog"
],
"summary": "Query Catalogs.",
"description": "Retrieves an array of catalog resources. Supports query parameters for pagination and filtering.\n\nIf provided limit and page parameters returns a paginated response for given limit and page number.\nIf not provided limit and page parameters returns a non paginated response containing all catalogs.",
"operationId": "queryCatalogs",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "CatalogsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CatalogsResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"catalog"
],
"summary": "Update a Catalog.",
"description": "Updates an existing catalog resource. Requires the catalog's `gnID` and accepts a JSON payload with the catalog's updated attributes.",
"operationId": "updateCatalog",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the catalog that is being updated",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewCatalog"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "CatalogResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CatalogResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"409": {
"description": "ConflictError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "catalog"
},
"post": {
"tags": [
"catalog"
],
"summary": "Create a new Catalog.",
"description": "Creates a new catalog resource. Accepts a JSON payload defining the attributes of the new catalog.",
"operationId": "createCatalog",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewCatalog"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "CatalogResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CatalogResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"409": {
"description": "ConflictError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "catalog",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/catalogs/{gnID}": {
"get": {
"tags": [
"catalog"
],
"summary": "Query Catalog using gnID.",
"description": "Retrieves a specific catalog resource identified by its `gnID` path parameter.",
"operationId": "getCatalog",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the Catalog to retrieve.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "CatalogsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CatalogsResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"delete": {
"tags": [
"catalog"
],
"summary": "Delete Catalog.",
"description": "Deletes a catalog resource identified by its `gnID` path parameter.",
"operationId": "deleteCatalog",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the Catalog to be deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedCatalogResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedCatalogResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/gnvocabulary": {
"get": {
"tags": [
"vocabulary"
],
"summary": "Retrieve the Gracenote Vocabulary.",
"description": "Retrieves Gracenote vocabulary lists. Optionally accepts a query parameter to filter by a specific list name.",
"operationId": "getVocabulary",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "listname",
"in": "query",
"description": "The field to filter on.",
"schema": {
"type": "string",
"enum": [
"airingType",
"castType",
"color",
"countries",
"crewType",
"descriptionLength",
"genre",
"imageCategories",
"languages",
"programType",
"ratingBody",
"targetAudience",
"versionLabels",
"publishStatus",
"entitlements",
"batchStatuses"
]
}
}
],
"responses": {
"200": {
"description": "VocabResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VocabResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/images": {
"get": {
"tags": [
"images"
],
"operationId": "searchImages",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"required": true,
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "aspectRatio",
"in": "query",
"description": "Aspect Ratios to filter images by.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "category",
"in": "query",
"description": "Image categories to filter by.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "language",
"in": "query",
"description": "Language string to filter by.\nResults may have overlap but not strictly be a sub-set.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "market",
"in": "query",
"description": "Market string to filter by.\nResults may have overlap but not strictly be a sub-set.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "sortField",
"in": "query",
"description": "Field by which to sort images by.",
"schema": {
"type": "string",
"default": "updated",
"enum": [
"gnID",
"title",
"category",
"width",
"height",
"updated"
]
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Direction by which to sort the search results.",
"schema": {
"type": "string",
"default": "DESC",
"enum": [
"ASC",
"asc",
"DESC",
"desc"
]
}
}
],
"responses": {
"200": {
"description": "ImagesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImagesResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"images"
],
"summary": "Create a new image.",
"description": "Create a new image resource. Accepts JSON image data in the request body.\n\nIt is necessary to have the image register entitlement to use this endpoint.\n\n### Below are the list of categories (confirming) those can be used while registering an image.\n\n1. __Production Art (Texted)__ - Home video movie art that includes the movie title only\n(does not contain billing block). Promotional series art that includes the show title only.\nDeliver the most recent/upcoming season artwork and previous season artwork upon request.\nActor names and taglines are also acceptable. Layered files are preferred.\n\n2. __Production Art (Textless)__ - Promotional Key Art without any text. Promotional series should\nbe centered and represent the show by featuring leading cast or scenic elements. Ideally, the\ntextless artwork matches the texted key art, but this is not a requirement.\n\n3. __Still Frame__ - For a movie, 5-10 images from a scene in the movie. For an episode, 3-5 unique\nimages from scenes from the episode. The show should have multiple images for each episode in\nthe season. Contains no text.\n__Note__: Do not send: Behind-the-scenes photos. (green screens, visible microphones, directors on-set).\n\n4. __Backdrop__ - For movie and show, right-justified, full-frame art. For the movie that does not contain\nany text.\n__Note__: For a show, do not apply a gradient that conceals any part of the image.\n\n5. __Title Treatment__ - The title of a movie or series with a transparent background. Layered files only.\nVector, TIFF, PNG or PSD files are acceptable.\n__Note__: Title Treatment should not include channel or streaming service logo or branding.\n\n6. __Cast in Character__ - Cast images of of a celebrity or host as their character. Separate from celebrity images.\n\n7. __Cast Ensemble__ - Cast images as part of program image library. Separate from celebrity images.\n\n### Below table provides confirming programType mapping for category and aspect ratio.\n\n Category | Aspect Ratio |\n | 2:3 | 3:4 | 4:3 | 16:9 | 2:1 | 1:1 | 9:5 |\n Production Art(Texted) | M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| |\n Production Art(Textless)| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| |\n Still Frame | M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| |\n Backdrop | | | | M,SH,SE,E| | | |\n Title Treatment | | | | | | | M,SH,SE,E|\n Cast in Character | | M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| | | |\n Cast Ensemble | | M,SH,SE,E| M,SH,SE,E| M,SH,SE,E| | | |\n\n### Legend:\nM - Movie\nSH - Show/Series\nSE - Season\nE - Episode",
"operationId": "createImage",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewImage"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ImageResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"409": {
"description": "ConflictError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "newImage",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/images/{gnID}": {
"get": {
"tags": [
"images"
],
"summary": "Query an image using its gnID.",
"description": "Retrieves a specific image resource identified by its `gnID` path parameter.",
"operationId": "queryImageByID",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the image being queried.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ImageResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"images"
],
"summary": "Update an existing image.",
"description": "Updates an existing image resource. Requires the `gnID` path parameter and\naccepts a JSON payload with the image's updated attributes.",
"operationId": "updateImage",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the image being queried.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewImage"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ImageResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImageResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "newImage"
},
"delete": {
"tags": [
"images"
],
"summary": "Delete an image using its gnID.",
"description": "Deletes an image resource identified by its `gnID` path parameter.",
"operationId": "deleteImage",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the image being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedImageResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedImageResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/movies": {
"post": {
"tags": [
"movie-root"
],
"summary": "Create a movie root.",
"operationId": "createMovieRoot",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewMovieRoot"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "MovieRootResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieRootResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "NewMovieRoot",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/movies/{gnID}": {
"get": {
"tags": [
"movie-root"
],
"summary": "Query for a movie's root with the provided gnID.",
"operationId": "getMovieRoot",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the root being queried.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "MovieRootResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieRootResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"movie-root"
],
"summary": "Update a movie root identified by the provided gnID.",
"operationId": "updateMovieRoot",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the movie root.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMovieRoot"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "MovieRootResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieRootResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "UpdatedMovieRoot"
},
"delete": {
"tags": [
"movie-root"
],
"summary": "Delete a movie's root with the provided gnID.",
"description": "All children versions and presentations will also be deleted.",
"operationId": "deleteMovieRoot",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the root being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedMovieRootResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedMovieRootResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/movies/{rootGnID}/versions": {
"post": {
"tags": [
"movie-version"
],
"summary": "Create a movie version under a movie root given the root's gnID.",
"operationId": "createMovieVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "rootGnID",
"in": "path",
"description": "The Gracenote ID of the parent movie root to create the version under.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewMovieVersion"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "MovieVersionResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieVersionResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "NewMovieVersion"
}
},
"/movies/versions": {
"get": {
"tags": [
"movie-version"
],
"summary": "Query for movie versions which match the provided search criteria.",
"description": "At least one query parameter must be specified.",
"operationId": "getMovieVersions",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "rootGnID",
"in": "query",
"description": "The gnID of a version's parent movie Root.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "MovieVersionsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieVersionsResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
}
}
},
"/movies/versions/{gnID}": {
"get": {
"tags": [
"movie-version"
],
"summary": "Query for a version of a movie with the provided gnID.",
"operationId": "getMovieVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the version being queried.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "MovieVersionResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieVersionResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"movie-version"
],
"summary": "Update a movie version identified by the provided gnID.",
"operationId": "updateMovieVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the movie version.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMovieVersion"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "MovieVersionResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MovieVersionResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "UpdatedMovieVersion"
},
"delete": {
"tags": [
"movie-version"
],
"summary": "Delete a movie's version with the provided gnID.",
"description": "All presentations of the version will be deleted as well.",
"operationId": "deleteMovieVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the version being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedMovieVersionResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedMovieVersionResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/movies/versions/{versionGnID}/presentations": {
"post": {
"tags": [
"movie-presentation"
],
"summary": "Create a movie presentation under a movie version given the version's gnID.",
"description": "Creates a new movie presentation resource under a specific movie version.\nRequires the `versionGnID` path parameter and a JSON payload defining the presentation's attributes.",
"operationId": "createMoviePresentationWithVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "versionGnID",
"in": "path",
"description": "The Gracenote ID of the parent movie version to create the presentation under.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewMoviePresentation"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "MoviePresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoviePresentationResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "NewMoviePresentation"
}
},
"/movies/versions/presentationRelationships": {
"patch": {
"tags": [
"movie-presentation"
],
"summary": "Map movie presentations to versions.",
"description": "Maps one or more movie presentations to their respective versions. Each presentation can only be mapped to one version.\nThis endpoint is part of the relaxed presentation hierarchy functionality.",
"operationId": "mapMoviePresentationsToVersion",
"requestBody": {
"description": "Array of version-presentation mappings to create.\nEach mapping associates a presentation with a version.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionPresentationMapping"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "VersionPresentationMappingsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionPresentationMappingsResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"presentation GN1234567890123 is already mapped to catalog"
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/catalogPrograms"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "MovieVersionPresentationMappings",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/movies/versions/presentationRelationships/{gnID}": {
"delete": {
"tags": [
"movie-presentation"
],
"summary": "Delete version mapping from a movie presentation.",
"description": "Removes the version mapping from a movie presentation, effectively making it a relaxed presentation\nwithout a direct parent version relationship.",
"operationId": "deleteMoviePresentationToVersionMapping",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the movie presentation to unmap from its version.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeleteVersionPresentationMappingsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteVersionPresentationMappingsResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/movies/versions/presentations": {
"get": {
"tags": [
"movie-presentation"
],
"summary": "Query for movie presentations associated with the provided filter criteria.",
"description": "rootGnID and presentationGnIDs are filterable options and at least one must be provided.",
"operationId": "getMoviePresentations",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "rootGnID",
"in": "query",
"description": "Filter movie presentations by those associated with the provided movie root gnID.",
"schema": {
"type": "string"
}
},
{
"name": "presentationGnIDs",
"in": "query",
"description": "Filter movie presentations by the provided presentation gnID values",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "MoviePresentationsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoviePresentationsResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"movie-presentation"
],
"summary": "Create a new movie presentation without a movie version.",
"description": "Create a new movie presentation without a movie version. This endpoint supports relaxed\npresentation hierarchy where presentations can exist without being directly linked to versions.",
"operationId": "createMoviePresentation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewMoviePresentation"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "MoviePresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoviePresentationResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "NewMoviePresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/movies/versions/presentations/{gnID}": {
"get": {
"tags": [
"movie-presentation"
],
"summary": "Query for a movie presentation with the provided gnID.",
"operationId": "getMoviePresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the presentation being queried.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "MoviePresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoviePresentationResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"movie-presentation"
],
"summary": "Update a movie presentation identified by the provided gnID.",
"description": "Updates a specific movie presentation resource. Requires the presentation\n`gnID` path parameter and a JSON payload with the presentation's updated attributes.",
"operationId": "updateMoviePresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the movie presentation.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMoviePresentation"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "MoviePresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MoviePresentationResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "UpdatedMoviePresentation"
},
"delete": {
"tags": [
"movie-presentation"
],
"summary": "Delete a presentation of a movie with the provided gnID.",
"description": "Deletes a specific movie presentation resource. Requires the presentation `gnID` path parameter.",
"operationId": "deleteMoviePresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the presentation being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedMoviePresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedMoviePresentationResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/programImages": {
"get": {
"tags": [
"images"
],
"summary": "Search for program-image mappings.",
"operationId": "searchProgramImages",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"required": true,
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "imageGnID",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "presentationGnID",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ProgramImagesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgramImagesResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"images"
],
"summary": "Map an image to a presentation (movie, show, season or episode) using their gnIDs.",
"description": "Maps an image resource to a program presentation (movie, show, season, or episode).\nRequires `gnID`s for both the image and the presentation within the JSON payload.",
"operationId": "mapProgramImages",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgramImage"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ProgramImagesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgramImagesResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityErrorProgramImages",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"mapping conflicts"
]
},
"descriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "image_not_found"
},
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "presentation_not_found"
},
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "duplicate_mapping"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/programImages"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "newProgramImage",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
},
"patch": {
"tags": [
"images"
],
"summary": "Delete a mapping between an image and a presentation (movie, show, season or episode) using their gnIDs.",
"operationId": "unmapProgramImages",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgramImage"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ProgramImagesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgramImagesResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityErrorProgramImages",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"mapping conflicts"
]
},
"descriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "duplicate_mapping"
},
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "mapping_not_found"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/programImages"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"73fdfc07-2182-4567-963f-5f0f9a621d15"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "newProgramImage",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/programSummaries": {
"get": {
"tags": [
"program-summaries"
],
"summary": "Returns a paginated collection of program summaries\nin a source's catalog. The query supports optional filtering and sorting.",
"description": "A program summary is a simplified version of a presentation which contains only the minimal\ninformation needed to search though and identify programs in a source's catalog.",
"operationId": "getProgramSummaries",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"required": true,
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "type",
"in": "query",
"description": "Program types to filter summaries by.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "subTypes",
"in": "query",
"description": "SubTypes to filter summaries by.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "publishStatus",
"in": "query",
"description": "PublishingStatuses to filter summaries by. Valid values may be\nfound in the Gracenote Vocabulary.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "genres",
"in": "query",
"description": "Genres to filter summaries by.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "catalogGnIDs",
"in": "query",
"description": "CatalogGnIDs to filter summaries by",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "title",
"in": "query",
"description": "The raw string value of a title to filter summaries by.",
"schema": {
"type": "string"
}
},
{
"name": "externalIDs",
"in": "query",
"description": "ExternalIDs to filter summaries by.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "tmsIDs",
"in": "query",
"description": "TMSIDs to filter summaries by.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Sort hits in ascending or descending order.",
"schema": {
"type": "string",
"enum": [
"ASC",
" asc",
" DESC",
" desc"
]
}
},
{
"name": "sortField",
"in": "query",
"description": "Field by which to sort hits by.",
"schema": {
"type": "string",
"enum": [
"presentationGnID versionGnID rootGnID seasonGnID showPresentationGnID showTitle seasonNumber episodeNumber title type subType releaseDate releaseYear tmsID updated"
]
}
}
],
"responses": {
"200": {
"description": "ProgramSummariesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProgramSummariesResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/publications": {
"get": {
"tags": [
"publications",
""
],
"summary": "Retrieve presentations' publish status.",
"description": "Retrieves a paginated collection of presentation resources for a given source.\nSupports query parameters for filtering and sorting.\n\nA Publication is a simplified version of a presentation which contains only the minimal\ninformation needed to track the publishing status.\n\nThis endpoint does not contain details about presentations which have publishStatus as \"registered\".",
"operationId": "getPublications",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"required": true,
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"required": true,
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64"
}
},
{
"name": "sortField",
"in": "query",
"description": "Field by which to sort batches by.",
"schema": {
"type": "string",
"default": "updated",
"enum": [
"updated"
]
}
},
{
"name": "sortDirection",
"in": "query",
"description": "Direction by which to sort the search results.",
"schema": {
"type": "string",
"default": "DESC",
"enum": [
"ASC",
"asc",
"DESC",
"desc"
]
}
},
{
"name": "updatedFrom",
"in": "query",
"description": "Updated timestamp to filter from, records updated after this will be shown (inclusive).",
"schema": {
"type": "string"
}
},
{
"name": "updatedTo",
"in": "query",
"description": "Updated timestamp to filter to, records updated after this will not be shown (exclusive).",
"schema": {
"type": "string"
}
},
{
"name": "type",
"in": "query",
"description": "Program types to filter summaries by.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "publishStatus",
"in": "query",
"description": "PublishingStatuses to filter publications by. Valid values may be\nfound in the Gracenote Vocabulary.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "titleValue",
"in": "query",
"description": "The raw string value of a title to filter publications by.",
"schema": {
"type": "string"
}
},
{
"name": "titleLanguage",
"in": "query",
"description": "TitleLanguage to filter publications by. Valid values may be\nfound in the Gracenote Vocabulary.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "PublicationsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationsResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/publish": {
"post": {
"tags": [
"publish"
],
"summary": "Submit a presentation for publish.",
"description": "This API endpoint allows you to submit a presentation Gracenote ID (GnIDs) for publishing.\nIt supports publishing movies, shows, and episodes.\n\n## Submit a presentation for publishing.\n\nProvided a gnID, the API attempts to submit the presentation\nfor publishing. The presentation will be marked as \"inProcess\". If image certify entitlement\nis active images with gracenoteUsage = true will be published alongside the presentation/seasons.\n\n## Submit a presentation with self-mapping.\n\nIf provided a gnID, along with a Mapping object, the API will attempt to publish the provided\npresentation with the tmsID. The presentation will be marked as \"published\". If image certify entitlement is active\nimages with gracenoteUsage = true will be published alongside the presentations/seasons.\n\n## Conditions for publish\n\n A field \"gnID\" which is a string must be present in request body.\n The presentation represented by the included gnID must fall under catalog of the requesting user.\n The gnID sent in the body of the request must correspond to an existing video presentation.\n The presentation must be of type movie, show, or episode.\n Only the following movie subTypes are publishable: featureFilm, shortFilm, trailer, and tvMovie\n Only the following show subTypes are publishable: series, and special\n Only the following episode subTypes are publishable: episode\n\n## Fields Required for Publishing\n\n### Movies:\n Root: Program Title, Title Language, Program SubType\n Version: Program Title, Title Language, Program SubType, Release Date OR Release Year\n Presentation: Program Title, Title Language, Program SubType, Release Date OR Release Year, Genres\n\n### Shows:\n Root: Program Title, Title Language, Program SubType\n Version: Program Title, Title Language, Program SubType, Release Date\n Presentation: Program Title, Title Language, Program SubType, Release Date, Genres\n\n### Episodes\n Episode: Program Title, Title Language, Program SubType, Release Date, Genres\n\n## Post-conditions\n\n### Success\n The API will return status code 200 along with a response body which includes the entire hierarchy of the program.\n The indicated gnIDs have been submitted for publishing and will be processed by the distribution system.\n If self mapped the provided ID will be displayed and will be submitted to be processed by the distribution system.\n response JSON varies with the program type.\n\n### Failure\n The api will return an appropriate 4xx or 5xx series status with a relevant error message.",
"operationId": "publishPresentation",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishInput"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "PublishResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "PublishInput",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/shows": {
"post": {
"tags": [
"show-root"
],
"summary": "Create a show root.",
"operationId": "createShowRoot",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewShowRoot"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ShowRootResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowRootResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "NewShowRoot",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/shows/{gnID}": {
"get": {
"tags": [
"show-root"
],
"summary": "Query for the root of a show with the provided gnID.",
"operationId": "getShowRoot",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the root being queried.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ShowRootResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowRootResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"show-root"
],
"summary": "Update a show root identified by the provided gnID.",
"operationId": "updateShowRoot",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the show root.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateShowRoot"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ShowRootResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowRootResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "UpdatedShowRoot"
},
"delete": {
"tags": [
"show-root"
],
"summary": "Delete a show's root with the provided gnID.",
"description": "All children versions, presentations, seasons, and episodes will also be deleted.",
"operationId": "deleteShowRoot",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the show root being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedShowRootResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedShowRootResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/shows/{gnID}/versions": {
"post": {
"tags": [
"show-version"
],
"summary": "Create a show version under a show root given the root's gnID.",
"operationId": "createShowVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the parent show root to create the version under.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewShowVersion"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ShowVersionResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowVersionResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "ShowVersion"
}
},
"/shows/versions": {
"get": {
"tags": [
"show-version"
],
"summary": "Query for show versions which match the provided search criteria.",
"description": "At least one query parameter must be specified.",
"operationId": "getShowVersions",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "rootGnID",
"in": "query",
"description": "The gnID of a version's parent show Root.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ShowVersionsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowVersionsResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
}
}
},
"/shows/versions/{gnID}": {
"get": {
"tags": [
"show-version"
],
"summary": "Query for a show's version with the provided gnID.",
"operationId": "getShowVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the version being queried.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ShowVersionResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowVersionResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"show-version"
],
"summary": "Update a show version identified by the provided gnID.",
"operationId": "updateShowVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the show version.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateShowVersion"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ShowVersionResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowVersionResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "UpdatedShowVersion"
},
"delete": {
"tags": [
"show-version"
],
"summary": "Delete a show's version with the provided gnID.",
"description": "All children presentations, seasons, and episodes will be deleted as well.",
"operationId": "deleteShowVersion",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the version being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedShowVersionResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedShowVersionResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/shows/versions/{gnID}/presentations": {
"post": {
"tags": [
"show-presentation"
],
"summary": "Create a show presentation under a show version given the version's gnID.",
"operationId": "createShowPresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the parent show version to create the presentation under.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewShowPresentation"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ShowPresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowPresentationResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "ShowPresentation"
}
},
"/shows/versions/presentationRelationships": {
"patch": {
"tags": [
"show-presentation"
],
"summary": "Map show presentations to versions.",
"description": "Maps one or more show presentations to their respective versions. Each presentation can only be mapped to one version.\nThis endpoint is part of the relaxed presentation hierarchy functionality.",
"operationId": "mapShowPresentationsToVersion",
"requestBody": {
"description": "Array of version-presentation mappings to create.\nEach mapping associates a presentation with a version.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionPresentationMapping"
}
}
}
},
"required": false
},
"responses": {
"200": {
"description": "VersionPresentationMappingsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VersionPresentationMappingsResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"422": {
"description": "UnprocessableEntityError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"presentation GN1234567890123 is already mapped to catalog"
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/catalogPrograms"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "ShowVersionPresentationMappings",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/shows/versions/presentationRelationships/{gnID}": {
"delete": {
"tags": [
"show-presentation"
],
"summary": "Delete version mapping from a show presentation.",
"description": "Removes the version mapping from a show presentation, effectively making it a relaxed presentation\nwithout a direct parent version relationship.",
"operationId": "deleteShowPresentationToVersionMapping",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the show presentation to unmap from its version.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeleteVersionPresentationMappingsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeleteVersionPresentationMappingsResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/shows/versions/presentations": {
"get": {
"tags": [
"show-presentation"
],
"summary": "Query for show presentations associated with the provided filter criteria.",
"description": "Currently, rootGnID and presentationGnIDs are filterable options and at least one must be provided.",
"operationId": "getShowPresentations",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "rootGnID",
"in": "query",
"description": "Filter show presentations by those associated with the provided show root gnID.",
"schema": {
"type": "string"
}
},
{
"name": "presentationGnIDs",
"in": "query",
"description": "Filter show presentations by the provided show presentation gnID values",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "ShowPresentationsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowPresentationsResponse"
}
}
}
},
"400": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"post": {
"tags": [
"show-presentation"
],
"summary": "Create a new show presentation without a show version.",
"description": "Create a new show presentation without linking it to a show version. This endpoint supports relaxed\npresentation hierarchy where presentations can exist without being directly linked to versions.",
"operationId": "createShowPresentationWithoutVersion",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewShowPresentation"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ShowPresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowPresentationResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "NewShowPresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
}
]
}
},
"/shows/versions/presentations/{gnID}": {
"get": {
"tags": [
"show-presentation"
],
"summary": "Query for a presentation of a show with the provided gnID.",
"operationId": "getShowPresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the presentation being queried.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "ShowPresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowPresentationResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"show-presentation"
],
"summary": "Update a show presentation identified by the provided gnID.",
"operationId": "updateShowPresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the show presentation.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateShowPresentation"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "ShowPresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShowPresentationResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"413": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"598": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "UpdatedShowPresentation"
},
"delete": {
"tags": [
"show-presentation"
],
"summary": "Delete a show's presentation with the provided gnID.",
"description": "All children seasons and episodes will be deleted as well.",
"operationId": "deleteShowPresentation",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the presentation being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedShowPresentationResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedShowPresentationResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/shows/versions/presentations/{gnID}/seasons": {
"post": {
"tags": [
"show-season"
],
"summary": "Create a season of a show with the provided show presentation gnID.",
"operationId": "createShowSeason",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the show presentation that the season will belong to.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewSeason"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "SeasonResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeasonResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "ShowSeason"
}
},
"/shows/versions/presentations/seasons": {
"get": {
"tags": [
"show-season"
],
"description": "Query for seasons of a show with the provided show presentation gnID or a list of show presentation gnIDs at\nleast one must be provided.",
"operationId": "searchShowSeasons",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "showPresentationGnID",
"in": "query",
"description": "Filter show seasons by those associated with the provided show presentation gnID.",
"schema": {
"type": "string"
}
},
{
"name": "showPresentationGnIDs",
"in": "query",
"description": "Filter show seasons by the provided show presentation gnID values",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "SeasonsResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeasonsResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/shows/versions/presentations/seasons/{gnID}": {
"get": {
"tags": [
"show-season"
],
"summary": "Query for a season of a show with the provided gnID.",
"operationId": "getShowSeason",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the season being queired for.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "SeasonResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeasonResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"show-season"
],
"summary": "Update season identified by the provided season gnID.",
"operationId": "updateShowSeason",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the season.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSeason"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "SeasonResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SeasonResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "UpdatedShowSeason"
},
"delete": {
"tags": [
"show-season"
],
"summary": "Delete a show's season with the provided gnID.",
"description": "All children episodes will be deleted as well.",
"operationId": "deleteShowSeason",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the season being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedShowSeasonResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedShowSeasonResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/shows/versions/presentations/seasons/{gnID}/episodes": {
"post": {
"tags": [
"show-episode"
],
"summary": "Create an episode of a show with the provided show season gnID.",
"operationId": "createShowEpisode",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the show season that the episode will belong to.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewEpisode"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "EpisodeResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "ShowEpisode"
}
},
"/shows/versions/presentations/seasons/episodes": {
"get": {
"tags": [
"show-episode"
],
"summary": "Query for episodes of a show with the provided show presentation and/or season gnID.",
"description": "If no pagination is specified, a default pagination will be provided.",
"operationId": "searchShowEpisodes",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "limit",
"in": "query",
"schema": {
"maximum": 1000,
"minimum": 1,
"type": "integer",
"format": "int64",
"default": 1000
}
},
{
"name": "page",
"in": "query",
"schema": {
"minimum": 1,
"type": "integer",
"format": "int64",
"default": 1
}
},
{
"name": "showPresentationGnID",
"in": "query",
"description": "The Gracenote ID of the show presentation.",
"schema": {
"type": "string"
}
},
{
"name": "seasonGnID",
"in": "query",
"description": "The Gracenote ID of the show season.",
"schema": {
"type": "string"
}
},
{
"name": "catalogGnIDs",
"in": "query",
"description": "The Gracenote ID of Catalogs to filter episodes.",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "showPresentationGnIDs",
"in": "query",
"description": "Filter episodes by the provided show presentation gnID values",
"style": "form",
"explode": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "EpisodesResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodesResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
},
"/shows/versions/presentations/seasons/episodes/{gnID}": {
"get": {
"tags": [
"show-episode"
],
"summary": "Query for an episode of a show with the provided gnID.",
"operationId": "getShowEpisode",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the episode being queried for.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "EpisodeResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
},
"put": {
"tags": [
"show-episode"
],
"summary": "Update season identified by the provided season gnID.",
"operationId": "updateShowEpisode",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the episode.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateEpisode"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "EpisodeResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EpisodeResponse"
}
}
}
},
"400": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"403": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"415": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
],
"x-codegen-request-body-name": "UpdatedShowEpisode"
},
"delete": {
"tags": [
"show-episode"
],
"summary": "Delete a show's episode with the provided gnID.",
"operationId": "deleteShowEpisode",
"parameters": [
{
"$ref": "#/components/parameters/apiKeyParam"
},
{
"name": "gnID",
"in": "path",
"description": "The Gracenote ID of the episode being deleted.",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "DeletedEpisodeResponse",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeletedEpisodeResponse"
}
}
}
},
"401": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"404": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"500": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
}
},
"security": [
{
"api_key": []
}
]
}
}
},
"components": {
"schemas": {
"AddProgramsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogProgram"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"AspectRatio": {
"title": "AspectRatio defines aspect ratio values which are known to conform.",
"type": "string",
"description": "Custom aspect ratios may be used, but they will never conform."
},
"Batch": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"created": {
"type": "string",
"description": "When the batch was first created",
"readOnly": true
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the batch",
"readOnly": true
},
"status": {
"type": "string",
"description": "The current status of the batch - inProgress, succeeded, or failed",
"readOnly": true
},
"updated": {
"type": "string",
"description": "When the batch was last updated",
"readOnly": true
}
},
"description": "Batch contains the toplevel information about the particular batch"
},
"BatchEpisodeResponse": {
"type": "object",
"properties": {
"episode": {
"$ref": "#/components/schemas/Episode"
}
},
"description": "EpisodeResponse is the response after creating an episode as part of a batch"
},
"BatchMoviePresentationResponse": {
"type": "object",
"properties": {
"presentation": {
"$ref": "#/components/schemas/MoviePresentation"
}
},
"description": "MoviePresentationResponse is the response after creating a movie presentation as part of a batch"
},
"BatchMovieResponse": {
"type": "object",
"properties": {
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchMoviePresentationResponse"
}
},
"roots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchMovieRootResponse"
}
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchMovieVersionResponse"
}
}
},
"description": "MovieResponse is the response after creating movie roots, versions, and presentations as part of a batch"
},
"BatchMovieRootResponse": {
"type": "object",
"properties": {
"root": {
"$ref": "#/components/schemas/MovieRoot"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchMovieVersionResponse"
}
}
},
"description": "MovieRootResponse is the response after creating a movie root as part of a batch"
},
"BatchMovieVersionResponse": {
"type": "object",
"properties": {
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchMoviePresentationResponse"
}
},
"version": {
"$ref": "#/components/schemas/MovieVersion"
}
},
"description": "MovieVersionResponse is the response after creating a movie version as part of a batch"
},
"BatchSeasonResponse": {
"type": "object",
"properties": {
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchEpisodeResponse"
}
},
"season": {
"$ref": "#/components/schemas/Season"
}
},
"description": "SeasonResponse is the response after creating a season as part of a batch"
},
"BatchShowPresentationResponse": {
"type": "object",
"properties": {
"presentation": {
"$ref": "#/components/schemas/ShowPresentation"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchSeasonResponse"
}
}
},
"description": "ShowPresentationResponse is the response after creating a show presentation as part of a batch"
},
"BatchShowResponse": {
"type": "object",
"properties": {
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchEpisodeResponse"
}
},
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchShowPresentationResponse"
}
},
"roots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchShowRootResponse"
}
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchSeasonResponse"
}
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchShowVersionResponse"
}
}
},
"description": "ShowResponse is the response after creating show roots, versions, presentations, seasons, and episodes as part of a batch"
},
"BatchShowRootResponse": {
"type": "object",
"properties": {
"root": {
"$ref": "#/components/schemas/ShowRoot"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchShowVersionResponse"
}
}
},
"description": "ShowRootResponse is the response after creating a show root as part of a batch"
},
"BatchShowVersionResponse": {
"type": "object",
"properties": {
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BatchShowPresentationResponse"
}
},
"version": {
"$ref": "#/components/schemas/ShowVersion"
}
},
"description": "ShowVersionResponse is the response after creating a show version as part of a batch"
},
"BatchesResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Batch"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"BulkPublishInput": {
"type": "object",
"properties": {
"publishables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublishInput"
}
}
},
"description": "BulkPublishInput represents a list of publishables(presentations) required for publishing together"
},
"Cast": {
"description": "Cast is an individual who performed in a production",
"required": [
"name",
"order",
"role"
],
"type": "object",
"properties": {
"aka": {
"$ref": "#/components/schemas/Name"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"order": {
"minimum": 1,
"type": "integer",
"description": "Order in which the cast member appears on the billing. Must be unique\nper program and cannot be negative or zero.",
"format": "int64",
"examples": [
1
]
},
"character": {
"type": "string",
"description": "Character is the name of the cast member's portrayed character."
},
"role": {
"type": "string",
"description": "Role defines the cast member's credited contribution.\nDefined by the Gracenote Vocabulary."
}
}
},
"Catalog": {
"title": "Catalog represents a conceptual container of programs to be distributed to particular consumers.",
"required": [
"name"
],
"type": "object",
"properties": {
"languages": {
"type": "array",
"description": "Languages of Presentations which this Catalog holds. Must conform to GNVocab languages.",
"items": {
"type": "string"
}
},
"markets": {
"type": "array",
"description": "Applicable Markets that this Catalog represents. Must conform to GNVocab countries.",
"items": {
"type": "string"
}
},
"name": {
"minLength": 1,
"type": "string",
"description": "The name of this Catalog. Must be unique to other Catalog's\nwhich the Source manages."
},
"tags": {
"type": "array",
"description": "Optional keyword tags to describe the contents of the Catalog.",
"items": {
"type": "string"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the Catalog.",
"readOnly": true
},
"presentationCount": {
"type": "integer",
"description": "Deprecated: The total number of presentations associated with this catalog.\nThis field is deprecated and always returns 0.",
"format": "int64",
"readOnly": true
},
"updated": {
"type": "string",
"description": "When the Catalog was last updated.",
"readOnly": true
}
},
"description": "NewCatalog contains information required for creating (POST)\nor updating (PUT) a Catalog."
},
"CatalogProgram": {
"required": [
"catalogGnID",
"presentationGnID"
],
"type": "object",
"properties": {
"catalogGnID": {
"type": "string",
"description": "The gnID of the Catalog."
},
"presentationGnID": {
"type": "string",
"description": "The gnID of the presentation being added."
},
"updated": {
"type": "string",
"description": "When the Catalog program mapping was last updated.",
"readOnly": true
}
},
"description": "CatalogProgram contains information required for adding (POST)\nprograms to a Catalog."
},
"CatalogResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Catalog"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"CatalogsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Catalog"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"Category": {
"title": "Category defines known categorical image types may conform.",
"type": "string",
"description": "Custom categories may be used, but they will not be conforming."
},
"Context": {
"title": "Context contains the user defined context to store/return alongside the export.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"Crew": {
"description": "Crew is a member who was part of\na program's production crew.",
"required": [
"name",
"order",
"type"
],
"type": "object",
"properties": {
"aka": {
"$ref": "#/components/schemas/Name"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"order": {
"minimum": 1,
"type": "integer",
"description": "Order in which the cast member appears on the billing. Must be unique\nper program and cannot be negative or zero.",
"format": "int64",
"examples": [
1
]
},
"type": {
"type": "string",
"description": "Type describes the role or \"crew type\" of the crew member.\nDefined by the Gracenote Vocabulary."
}
}
},
"DataResponse": {
"required": [
"data",
"meta"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
},
"description": "DataResponse embeds MetaResponse and it includes a slice of the returned data"
},
"DeleteVersionPresentationMappingsResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/VersionPresentationMapping"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedCatalog": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted catalog.",
"examples": [
"GNLZZXZ00000000"
]
}
},
"description": "DeletedCatalog represents a deleted Catalog"
},
"DeletedCatalogProgramMappingsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CatalogProgram"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedCatalogResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedCatalog"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedEpisode": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000001"
]
},
"seasonGnID": {
"type": "string",
"description": "The Gracenote ID of the episode's parent season."
}
},
"description": "DeletedEpisode reports the gnID of an episode and its parent Season"
},
"DeletedEpisodeResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedEpisode"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedImage": {
"title": "DeletedImage represents a a deleted image.",
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted image."
}
}
},
"DeletedImageResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedImage"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedMoviePresentation": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The deleted presentation's GnID.",
"readOnly": true,
"examples": [
"GNLZZXW00000001"
]
},
"versionGnID": {
"type": "string",
"description": "The GnID of the presentation's parent version.",
"readOnly": true,
"examples": [
"GNLZZXX00000001"
]
}
},
"description": "DeletedPresentation represents a deleted movie presentation"
},
"DeletedMoviePresentationResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedMoviePresentation"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedMovieRoot": {
"description": "DeletedRoot represents the root of a deleted movie",
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000000"
]
},
"versions": {
"type": "array",
"description": "The Gracenote ID of the deleted program versions.",
"items": {
"$ref": "#/components/schemas/DeletedVersion"
},
"examples": [
[
"GNLZZXZ00000000"
]
]
}
}
},
"DeletedMovieRootResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedMovieRoot"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedMovieVersion": {
"description": "DeletedVersion represents the version of a deleted movie\nThe model only has enough fields to empower the delete use case of movie versions.",
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000000"
]
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"examples": [
"GNLZZZ300000000"
]
},
"presentations": {
"type": "array",
"description": "The GracenoteID of the deleted presentations.",
"items": {
"$ref": "#/components/schemas/DeletedPresentation"
}
}
}
},
"DeletedMovieVersionResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedMovieVersion"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedPresentation": {
"description": "DeletedPresentation represents a deleted presentation",
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000000"
]
},
"versionGnID": {
"type": "string",
"description": "The ID of the presentation's parent version.",
"examples": [
"GNLZZZ300000000"
]
}
}
},
"DeletedProgram": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000000"
]
}
},
"description": "DeletedProgram represents the common fields of a deleted program"
},
"DeletedRoot": {
"description": "DeletedRoot represents the root of a deleted program",
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000000"
]
},
"versions": {
"type": "array",
"description": "The Gracenote ID of the deleted program versions.",
"items": {
"$ref": "#/components/schemas/DeletedVersion"
},
"examples": [
[
"GNLZZXZ00000000"
]
]
}
}
},
"DeletedShowPresentation": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"seasons": {
"type": "array",
"description": "The deleted show seasons that belong to the deleted show presentation.",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/DeletedShowSeason"
}
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
}
},
"description": "DeletedPresentation contains the ID of the deleted Presentation as well as\nthe parent and child IDs of the Presentation."
},
"DeletedShowPresentationResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedShowPresentation"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedShowRoot": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the show root.",
"readOnly": true,
"examples": [
"GNLZZXZ00000000"
]
},
"versions": {
"type": "array",
"description": "The Gracenote ID of the deleted show versions.",
"items": {
"$ref": "#/components/schemas/DeletedShowVersion"
}
}
},
"description": "DeletedRoot represents the deleted root of a Show\nThe model only has enough fields to empower the delete use case of show roots."
},
"DeletedShowRootResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedShowRoot"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedShowSeason": {
"type": "object",
"properties": {
"episodes": {
"type": "array",
"description": "The deleted episodes that belong to the deleted show season.",
"items": {
"$ref": "#/components/schemas/DeletedEpisode"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted season.",
"readOnly": true,
"examples": [
"GNLZZXV00000001"
]
},
"showPresentationGnID": {
"type": "string",
"description": "The ID of the season's parent presentation."
}
},
"description": "DeletedSeason contains the ID of the deleted Season as well as\nthe parent and child IDs of the Season."
},
"DeletedShowSeasonResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedShowSeason"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedShowVersion": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000000"
]
},
"presentations": {
"type": "array",
"description": "The deleted show presentations that belong to the deleted show version.",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/DeletedShowPresentation"
}
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"readOnly": true,
"examples": [
"GNLZZZ300000000"
]
}
},
"description": "DeletedVersion contains the ID of the deleted Version as well as\nthe parent and child IDs of the Version."
},
"DeletedShowVersionResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/DeletedShowVersion"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"DeletedVersion": {
"description": "DeletedVersion represents the version of a deleted entity",
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the deleted program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000000"
]
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"examples": [
"GNLZZZ300000000"
]
}
}
},
"Description": {
"required": [
"language",
"length",
"value"
],
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "Language of the description's text. User must be entitled to use the language.\nSee the Gracenote Vocabulary for valid languages."
},
"length": {
"type": "integer",
"description": "Length defines the maximum number of characters that can be used in a description.\nThe value of the description must be less than or equal to the specified length from values 1 to 1000.",
"format": "int64"
},
"value": {
"type": "string",
"description": "Value is the raw text description of a program."
}
},
"description": "Description is a set of fields that describe a program"
},
"Descriptions": {
"title": "Descriptions is an array of Description types",
"type": "array",
"description": "A maximum of 10 descriptions can be assigned to a program",
"items": {
"$ref": "#/components/schemas/Description"
}
},
"Dimensions": {
"required": [
"aspectRatio",
"height",
"width"
],
"type": "object",
"properties": {
"aspectRatio": {
"$ref": "#/components/schemas/AspectRatio"
},
"height": {
"maximum": 32767,
"type": "integer",
"description": "The pixel height of the image.",
"format": "int16"
},
"width": {
"maximum": 32767,
"type": "integer",
"description": "The pixel width of the image.",
"format": "int16"
}
},
"description": "Dimensions represents the dimensions of an Image"
},
"Entitlement": {
"type": "object",
"properties": {
"imageActions": {
"type": "array",
"description": "Which image actions a user is entitled to use.",
"items": {
"type": "string"
},
"examples": [
[
"register",
"certify",
"deliver"
]
]
},
"languages": {
"type": "array",
"description": "Which languages a user is entitled to use. Corresponds to languages\nrepresented by a LabelValuePair.Value.",
"items": {
"type": "string"
},
"examples": [
[
"en",
"es",
"fr",
"fr-CA"
]
]
},
"mappings": {
"type": "array",
"description": "Which mapping data a user is entitled to see",
"items": {
"type": "string"
},
"examples": [
[
"tmsID"
]
]
}
},
"description": "Entitlement represents what data actions and languages a user is entitled to use"
},
"Episode": {
"description": "Episode represents an episode of a season",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"color": {
"type": "string",
"description": "The color of an episode.\nSee the Gracenote Vocabulary for valid color values."
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"duration": {
"type": "integer",
"description": "The runtime duration (in milliseconds) of the episode.",
"format": "int64"
},
"episodeNumber": {
"type": "string",
"description": "The episode's number.",
"examples": [
"1"
]
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating an episode, but at least one is required\nfor publishing. Genres is a required for update when the episode is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"industryNetworkNumber": {
"type": "string",
"description": "The episode number provided by the original network."
},
"industryNetworkSyndicated": {
"type": "string",
"description": "The official, original episode number as provided by the syndicator."
},
"ordinal": {
"type": "integer",
"description": "The ordering of the episode",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"partNumbers": {
"type": "string",
"description": "Textual part numbers.",
"examples": [
"Part One"
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The release date of the episode.\n\nReleaseDate is not required for creating an episode,\nbut it is required for publishing.\nReleaseDate is required for update when the episode is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"episode"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"episode"
]
},
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"catalogGnIDs": {
"type": "array",
"description": "The IDs of the catalogs that the presentation is a part of.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000001"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"readOnly": true,
"items": {
"type": "string"
}
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"seasonGnID": {
"type": "string",
"description": "The gnID of the episode's parent season.",
"readOnly": true,
"examples": [
"GNLZZXV00000001"
]
},
"showPresentationGnID": {
"type": "string",
"description": "The gnID of the episode's parent show presentation.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"showRootGnID": {
"type": "string",
"description": "The gnID of the episode's parent show root.",
"readOnly": true,
"examples": [
"GNLZZZ700000001"
]
},
"showVersionGnID": {
"type": "string",
"description": "The gnID of the episode's parent show version.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"updated": {
"type": "string",
"description": "The time the episode was last updated",
"readOnly": true
},
"versionLabels": {
"type": "array",
"description": "The types associated with this version.\nSee the Gracenote Vocabulary for suggested version types.",
"readOnly": true,
"items": {
"type": "string"
}
}
}
},
"EpisodePayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"episode": {
"$ref": "#/components/schemas/NewEpisode"
}
},
"description": "EpisodePayload is the episode request payload provided by the user"
},
"EpisodeResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Episode"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"EpisodesResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Episode"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"Error": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID that caused the error"
},
"path": {
"type": "string",
"description": "The path to where in the payload it occurred"
},
"type": {
"$ref": "#/components/schemas/errorType"
}
},
"description": "Error contains the error type, the path to where in the payload it occurred, and the GnID that caused it"
},
"ErrorResponse": {
"required": [
"description",
"error",
"instance",
"meta",
"status"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description is a high level description or tip about why the error occurred and what the user can do\nabout it, if anything."
},
"descriptionDetails": {
"type": "array",
"description": "DescriptionDetails is a list of key value pairs describing the different errors, intended to be used in a programmatic way",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"error": {
"type": "string",
"description": "Err is a machine-readable error key, such as invalid_request."
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"description": "Fields describes request fields and their values, if present."
},
"instance": {
"type": "string",
"description": "Instance describes the path provided for the request."
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
},
"status": {
"type": "integer",
"description": "Code is the HTTP status code.",
"format": "int64"
}
},
"description": "ErrorResponse is the form used for API responses from failures in the API"
},
"ErrorWithDetails": {
"type": "object",
"properties": {
"DescriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
},
"Err": {
"type": "string"
}
},
"description": "ErrorWithDetails is used to indicate an error with additional details in a key-value format"
},
"Export": {
"title": "Export represents an export request.",
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"filter": {
"$ref": "#/components/schemas/Filter"
},
"created": {
"type": "string",
"description": "Export creation timestamp.",
"readOnly": true
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the export.",
"readOnly": true
},
"status": {
"type": "string",
"description": "The status for the export. Possible values: waiting, inProgress, succeeded, failed.\nNote: If an export fails but has not reached the maximum retry limit (3 attempts),\nthe status will be returned as 'inProgress' to indicate it will be retried automatically.\nOnly when retry_count >= 3 will the status be returned as 'failed'.",
"readOnly": true,
"enum": [
"waiting",
"inProgress",
"succeeded",
"failed"
]
},
"updated": {
"type": "string",
"description": "The timestamp when Export was last updated.",
"readOnly": true
}
}
},
"ExportPresentation": {
"title": "Presentation represents the exported program.",
"type": "object",
"properties": {
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"cast": {
"type": "array",
"description": "The cast of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"catalogGnIDs": {
"type": "array",
"description": "The Gracenote IDs of the catalogs that the program is a part of.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"color": {
"type": "string",
"description": "The color of an episode.\nSee the Gracenote Vocabulary for valid color values.\n\nOnly available for episode.",
"readOnly": true
},
"crew": {
"type": "array",
"description": "The crew of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"duration": {
"type": "integer",
"description": "The runtime duration (in milliseconds) of the episode.\nOnly available for episode.",
"format": "int64",
"readOnly": true
},
"episodeNumber": {
"type": "string",
"description": "The episode's number.\nOnly available for episode.",
"readOnly": true,
"examples": [
"1"
]
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date at which the series ends with a series finale.\nOnly available for show presentation.",
"format": "date",
"readOnly": true
},
"genres": {
"type": "array",
"description": "The applicable genres to the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"GNLZZXW00000001"
]
},
"industryNetworkNumber": {
"type": "string",
"description": "The episode number provided by the original network.\nOnly available for episode.",
"readOnly": true
},
"industryNetworkSyndicated": {
"type": "string",
"description": "The official, original episode number as provided by the syndicator.\nOnly available for episode.",
"readOnly": true
},
"ordinal": {
"type": "integer",
"description": "The ordering of the episode.\nOnly available for episode.",
"format": "int64",
"readOnly": true
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).\n\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"Lifetime"
]
},
"partNumbers": {
"type": "string",
"description": "Textual part numbers.\nOnly available for episode.",
"readOnly": true,
"examples": [
"Part One"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the program.\n\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.\n\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"productionStatus": {
"type": "string",
"description": "Describes the production status of the program.\nOnly available for movie presentation.",
"readOnly": true,
"examples": [
"completed"
]
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"ratings": {
"type": "array",
"description": "The ratings for this program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the program was released.\nAvailable for movie presentation, show presentation, and episode.",
"format": "date",
"readOnly": true
},
"releaseYear": {
"type": "integer",
"description": "The year in which the movie was released.\nOnly available for movie presentation.",
"format": "int64",
"readOnly": true,
"examples": [
2000
]
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent root.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"GNLZZZ600000001"
]
},
"seasonGnID": {
"type": "string",
"description": "The gnID of the episode's parent season.\nOnly available for episode.",
"readOnly": true,
"examples": [
"GNLZZXV00000001"
]
},
"seasonGnIDs": {
"type": "array",
"description": "The Gracenote IDs of children seasons of the show presentation.\nOnly available for show presentation.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZXV00000001",
"GNLZZXV00000002"
]
]
},
"showPresentationGnID": {
"type": "string",
"description": "The gnID of the episode's parent show presentation.\nOnly available for episode.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"showRootGnID": {
"type": "string",
"description": "The gnID of the episode's parent show root.\nOnly available for episode.",
"readOnly": true,
"examples": [
"GNLZZZ700000001"
]
},
"showVersionGnID": {
"type": "string",
"description": "The gnID of the episode's parent show version.\nOnly available for episode.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"featureFilm"
]
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"type": {
"type": "string",
"description": "The high-level type of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"movie"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"GNLZZXX00000001"
]
}
}
},
"ExportProgram": {
"title": "Program represents an exported program.",
"type": "object",
"properties": {
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"cast": {
"type": "array",
"description": "The cast of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"catalogGnIDs": {
"type": "array",
"description": "The Gracenote IDs of the catalogs that the program is a part of.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"color": {
"type": "string",
"description": "The color of an episode.\nSee the Gracenote Vocabulary for valid color values.\n\nOnly available for episode.",
"readOnly": true
},
"crew": {
"type": "array",
"description": "The crew of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"duration": {
"type": "integer",
"description": "The runtime duration (in milliseconds) of the episode.\nOnly available for episode.",
"format": "int64",
"readOnly": true
},
"episodeNumber": {
"type": "string",
"description": "The episode's number.\nOnly available for episode.",
"readOnly": true,
"examples": [
"1"
]
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date at which the series ends with a series finale.\nOnly available for show presentation.",
"format": "date",
"readOnly": true
},
"genres": {
"type": "array",
"description": "The applicable genres to the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"GNLZZXW00000001"
]
},
"industryNetworkNumber": {
"type": "string",
"description": "The episode number provided by the original network.\nOnly available for episode.",
"readOnly": true
},
"industryNetworkSyndicated": {
"type": "string",
"description": "The official, original episode number as provided by the syndicator.\nOnly available for episode.",
"readOnly": true
},
"ordinal": {
"type": "integer",
"description": "The ordering of the episode.\nOnly available for episode.",
"format": "int64",
"readOnly": true
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).\n\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"Lifetime"
]
},
"partNumbers": {
"type": "string",
"description": "Textual part numbers.\nOnly available for episode.",
"readOnly": true,
"examples": [
"Part One"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the program.\n\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.\n\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"productionStatus": {
"type": "string",
"description": "Describes the production status of the program.\nOnly available for movie presentation.",
"readOnly": true,
"examples": [
"completed"
]
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"ratings": {
"type": "array",
"description": "The ratings for this program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the program was released.\nAvailable for movie presentation, show presentation, and episode.",
"format": "date",
"readOnly": true
},
"releaseYear": {
"type": "integer",
"description": "The year in which the movie was released.\nOnly available for movie presentation.",
"format": "int64",
"readOnly": true,
"examples": [
2000
]
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent root.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"GNLZZZ600000001"
]
},
"seasonGnID": {
"type": "string",
"description": "The gnID of the episode's parent season.\nOnly available for episode.",
"readOnly": true,
"examples": [
"GNLZZXV00000001"
]
},
"seasonGnIDs": {
"type": "array",
"description": "The Gracenote IDs of children seasons of the show presentation.\nOnly available for show presentation.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZXV00000001",
"GNLZZXV00000002"
]
]
},
"showPresentationGnID": {
"type": "string",
"description": "The gnID of the episode's parent show presentation.\nOnly available for episode.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"showRootGnID": {
"type": "string",
"description": "The gnID of the episode's parent show root.\nOnly available for episode.",
"readOnly": true,
"examples": [
"GNLZZZ700000001"
]
},
"showVersionGnID": {
"type": "string",
"description": "The gnID of the episode's parent show version.\nOnly available for episode.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"featureFilm"
]
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"type": {
"type": "string",
"description": "The high-level type of the program.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"movie"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.\nAvailable for movie presentation, show presentation, and episode.",
"readOnly": true,
"examples": [
"GNLZZXX00000001"
]
},
"season": {
"$ref": "#/components/schemas/ExportSeason"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Season"
}
},
"version": {
"$ref": "#/components/schemas/ExportVersion"
}
}
},
"ExportResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Export"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ExportRoot": {
"title": "Root represents the root of an exported program.",
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.\nAvailable for movie root and show root.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.\nAvailable for movie root and show root.",
"readOnly": true
},
"subType": {
"type": "string",
"description": "The high-level type of the program.\nAvailable for movie root and show root.",
"readOnly": true,
"examples": [
"featureFilm"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"type": {
"type": "string",
"description": "The high-level type of the program.\nAvailable for movie root and show root.",
"readOnly": true,
"examples": [
"movie"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated\nAvailable for movie root and show root.",
"readOnly": true
},
"versionGnIDs": {
"type": "array",
"description": "The Gracenote IDs of child versions.\nAvailable for movie root and show root.",
"readOnly": true,
"items": {
"type": "string"
}
}
}
},
"ExportSeason": {
"title": "Season represents the parent season for an exported episode.",
"description": "Season represents a grouping of\nShow episodes",
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the season.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the season.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"type": "array",
"description": "A list of descriptions for the season.",
"items": {
"$ref": "#/components/schemas/Description"
}
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date on which the season ends with the season's finale.",
"format": "date"
},
"nonSeason": {
"type": "boolean",
"description": "Indicates that the season is a one-off occurrence and is non-repetitive. Mutually exclusive with SeasonNumber."
},
"ordinal": {
"type": "integer",
"description": "The order of which the season appears",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the season (or network if\nthe season originated on a network).",
"examples": [
"Lifetime"
]
},
"releaseDate": {
"type": "string",
"description": "The date the season was release",
"format": "date"
},
"seasonNumber": {
"type": "string",
"description": "Indicates which season of a show the season is."
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"episodeGnIDs": {
"type": "array",
"description": "The episode gnIDs which are children of the season.",
"readOnly": true,
"items": {
"type": "string"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the season.",
"readOnly": true
},
"showPresentationGnID": {
"type": "string",
"description": "The show presentation GnID that is a parent of the Season.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated.",
"readOnly": true
},
"presentation": {
"$ref": "#/components/schemas/ExportShowPresentation"
}
},
"required": [
"subType"
]
},
"ExportShowPresentation": {
"title": "ShowPresentation represents the parent show presentation for an exported episode.",
"description": "Presentation represents the Show specific presentation metadata",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date at which the series ends with a series finale.",
"format": "date"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the series was released.\n\nReleaseDate is optional for creating a presentation, but is required for publishing.\nReleaseDate is required for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"catalogGnIDs": {
"type": "array",
"description": "The Gracenote IDs of the catalogs that the presentation is a part of.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent root.",
"readOnly": true,
"examples": [
"GNLZZZ700000001"
]
},
"seasonGnIDs": {
"type": "array",
"description": "The Gracenote IDs of children seasons of the show presentation.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZXV00000001",
"GNLZZXV00000002"
]
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
},
"version": {
"$ref": "#/components/schemas/ExportShowVersion"
}
}
},
"ExportShowVersion": {
"title": "ShowVersion represents the parent show version for an exported episode.",
"description": "Version represents the version of a show",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the show.\nColor is required for publishing the show.",
"examples": [
"bw"
]
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The releaseDate of the show.\nReleaseDate is optional for creating a show version, but is required\nfor publishing a show presentation. ReleaseDate is required\nfor update when the presentation is in publishing/published state.",
"format": "date"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"presentationGnIDs": {
"type": "array",
"description": "A list of the version's children presentation GnIDs.",
"readOnly": true,
"items": {
"type": "string"
}
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"root": {
"$ref": "#/components/schemas/ShowRoot"
}
}
},
"ExportVersion": {
"title": "Version represents the version of an exported program.",
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the program.\nAvailable for movie version, and show version.",
"readOnly": true
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nAvailable for movie version, and show version.",
"format": "int64",
"readOnly": true,
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.\nAvailable for movie version, and show version.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program version.\nAvailable for movie version, and show version.",
"readOnly": true
},
"presentationGnIDs": {
"type": "array",
"description": "A list of the version's children presentation GnIDs.\nAvailable for movie version, and show version.",
"readOnly": true,
"items": {
"type": "string"
}
},
"releaseDate": {
"type": "string",
"description": "The first ever release date of the program represented by the version.\nAvailable for movie version, and show version.",
"format": "date",
"readOnly": true
},
"releaseYear": {
"type": "integer",
"description": "The first ever release year of the program represented by the version.\nOnly available for movie version.",
"format": "int64",
"readOnly": true
},
"root": {
"$ref": "#/components/schemas/ExportRoot"
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.\nAvailable for movie version, and show version.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.\nAvailable for movie version, and show version.",
"readOnly": true
},
"subType": {
"type": "string",
"description": "The high-level type of the program.\nAvailable for movie version, and show version.",
"readOnly": true,
"examples": [
"featureFilm"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"type": {
"type": "string",
"description": "The high-level type of the program.\nAvailable for movie version, and show version.",
"readOnly": true,
"examples": [
"movie"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated.\nAvailable for movie version, and show version.",
"readOnly": true
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.\nAvailable for movie version, and show version.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
}
}
},
"ExportsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Export"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ExternalID": {
"required": [
"id",
"isPrimary"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "id is the external identifier."
},
"isPrimary": {
"type": "boolean",
"description": "indicates that the external ID is the primary ID\nused to identify the program external to Gracenote.\nExactly one primary external ID is allowed (and required) per program."
},
"isProvider": {
"type": "boolean",
"description": "indicates that the source provider uses this ID as\ntheir internal ID for the program. Exactly one provider\nexternal ID is allowed per program."
},
"label": {
"type": "string",
"description": "label is a tag to describe the identifier."
}
},
"description": "ExternalID is an external (to Gracenote) identifier of the program"
},
"ExternalIDs": {
"type": "array",
"description": "ExternalIDs is a convenience alias on a slice of ExternalID types",
"items": {
"$ref": "#/components/schemas/ExternalID"
}
},
"FieldError": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"field": {
"type": "string"
},
"level": {
"type": "string"
}
},
"description": "FieldError is used to indicate an error with a specific request field"
},
"FieldErrors": {
"type": "array",
"description": "FieldErrors represents a collection of field errors",
"items": {
"$ref": "#/components/schemas/FieldError"
}
},
"Filter": {
"title": "Filter contains the fields which can be used to filter programs,",
"type": "object",
"properties": {
"catalogGnIDs": {
"type": "array",
"description": "CatalogGnIDs to filter programs by\n\nin: query",
"items": {
"type": "string"
},
"examples": [
[
"GN1",
"GN2"
]
]
},
"externalIDs": {
"type": "array",
"description": "ExternalIDs to filter programs by.\n\nin: query",
"items": {
"type": "string"
},
"examples": [
[
"EP123",
"SH123",
"MV123"
]
]
},
"genres": {
"type": "array",
"description": "Genres to filter programs by.\n\nin: query",
"items": {
"type": "string"
},
"examples": [
[
"Adventure",
"Fantasy"
]
]
},
"publishStatus": {
"type": "array",
"description": "PublishingStatuses to filter programs by. Valid values may be\nfound in the Gracenote Vocabulary.\n\nin: query",
"items": {
"type": "string"
},
"examples": [
[
"registered",
"published"
]
]
},
"subTypes": {
"type": "array",
"description": "SubTypes to filter programs by.\n\nin: query",
"items": {
"type": "string"
},
"examples": [
[
"episode"
]
]
},
"title": {
"type": "string",
"description": "The raw string value of a title to filter programs by.\n\nin: query",
"examples": [
"\"Rings of Power: Speculative Episode Title\""
]
},
"tmsIDs": {
"type": "array",
"description": "TMSIDs to filter programs by.\n\nin: query",
"items": {
"type": "string"
},
"examples": [
[
"EP123",
"SH123",
"MV123"
]
]
},
"types": {
"type": "array",
"description": "Program types to filter programs by.\n\nin: query",
"items": {
"type": "string"
},
"examples": [
[
"episode"
]
]
}
},
"description": "while generating the export results."
},
"GNVocabulary": {
"type": "object",
"properties": {
"airingType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"batchStatuses": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"castType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"color": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"crewType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"descriptionLength": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"entitlements": {
"$ref": "#/components/schemas/Entitlement"
},
"genre": {
"type": "array",
"items": {
"type": "string"
}
},
"imageCategories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Category"
}
},
"languages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"mappingIDOrigins": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"productionStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"programType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GnVocabProgramType"
}
},
"publishStatus": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"ratingBody": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RatingBody"
}
},
"targetAudience": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"userMappingIDTypes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"versionLabels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
}
},
"description": "GNVocabulary contains multiple lists of GN Vocabulary"
},
"GnVocabProgramType": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "A human-readable string of the value.",
"examples": [
"Special Edition"
]
},
"programSubType": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LabelledValue"
}
},
"value": {
"type": "string",
"description": "a camelCase string to be used in the API.",
"examples": [
"specialEdition"
]
}
},
"description": "ProgramType represents the program type in GN Vocab"
},
"Image": {
"description": "Image represents the metadata describing a source provided image",
"required": [
"category",
"dimensions",
"fileType",
"title",
"url"
],
"type": "object",
"properties": {
"brandDescription": {
"type": "string",
"description": "Description that indicates the branding applied to the image.\nIf the description is provided, then branded is assumed to be true.\nbrandDescription is not required, even if branded is specified as true.\nCannot exceed 1000 character length limit."
},
"branded": {
"type": "boolean",
"description": "Indicates that the image has branded content such as a source, channel, or network name or logo.",
"default": false
},
"category": {
"$ref": "#/components/schemas/Category"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Custom key:value pairs to associate with the image."
},
"description": {
"$ref": "#/components/schemas/Description"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"fileType": {
"type": "string",
"description": "The media or file-type of the image at the URL.",
"enum": [
"bmp",
" psd",
" jpeg",
" jpg",
" tiff",
" png"
]
},
"gracenoteUsage": {
"type": "boolean",
"description": "Indicates that the client agrees that, upon a successful publish request,\nGracenote may use the provided image in Gracenote's customer-facing datasets.\nIf the client does not agree, then this field should be set to false.",
"default": true
},
"languages": {
"type": "array",
"description": "Primary languages used in the image.",
"items": {
"type": "string"
},
"examples": [
[
"en",
"en-GB",
"en-AU",
"es",
"es-ES"
]
]
},
"markets": {
"type": "array",
"description": "Applicable markets for the image.\nMust conform to GN Vocabulary (ISO 3166-1 Alpha-2 codes).",
"items": {
"type": "string"
},
"examples": [
[
"US",
"MX",
"ES",
"AU",
"GB"
]
]
},
"productionDate": {
"type": "string",
"description": "The ISO-8601 date that the image was originally created.",
"format": "date"
},
"sensitive": {
"type": "boolean",
"description": "Indicates that the image contains sensitive material.",
"default": false
},
"tags": {
"type": "array",
"description": "Custom tags to associate with the image.",
"items": {
"type": "string"
}
},
"title": {
"type": "string",
"description": "The tile (or name) of the image. Cannot exceed 1000 character length limit."
},
"url": {
"type": "string",
"description": "The URL at which the image file may be accessed. Cannot exceed 8000 character length limit.",
"format": "uri"
},
"created": {
"type": "string",
"description": "The time at which the image was created in system.",
"readOnly": true
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the Image.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time at which the image was last updated in system.",
"readOnly": true
}
}
},
"ImageResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Image"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ImagesResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"LabelledValue": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "A human-readable string of the value.",
"examples": [
"Special Edition"
]
},
"value": {
"type": "string",
"description": "a camelCase string to be used in the API.",
"examples": [
"specialEdition"
]
}
},
"description": "LabelValuePair represents objects containing a label and a value"
},
"Mapping": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID represents user provided tmsID"
},
"type": {
"type": "string",
"description": "Type of the ID. It must be one of the types available in userMappingIDTypes in GN Vocab."
}
},
"description": "UserMapping Mapping represents the input required for issuing a self mapped publish for a Presentation"
},
"MappingInfo": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID contains the tmsID that the presentation is mapped to.\nThis can be either user-provided ID or a gracenote mapped ID."
},
"origin": {
"type": "string",
"description": "The possible values fr origin are sourceProvided and gracenote.\nIf the user-provided TmsID is used, the origin is sourceProvided.\nIf a gracenote provided TmsID is used, or if gracenote replaces the\nuser-provided TmsID, gracenote is used."
},
"type": {
"type": "string",
"description": "Type describes the type of ID that was used for mapping the presentation.\nCurrently, only tmsID is supported."
}
},
"description": "MappingInfo contains information about how the\nTmsID was determined for the presentation."
},
"Member": {
"required": [
"name",
"order"
],
"type": "object",
"properties": {
"aka": {
"$ref": "#/components/schemas/Name"
},
"name": {
"$ref": "#/components/schemas/Name"
},
"order": {
"minimum": 1,
"type": "integer",
"description": "Order in which the cast member appears on the billing. Must be unique\nper program and cannot be negative or zero.",
"format": "int64",
"examples": [
1
]
}
},
"description": "Member is a person who is a member of the billing in some form"
},
"MetaResponse": {
"required": [
"rayID"
],
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Count is the number of records included a Data field.",
"format": "int64"
},
"limit": {
"type": "integer",
"description": "Limit is the maximum requested number of objects returned by the request.",
"format": "int64"
},
"page": {
"type": "integer",
"description": "Page is the page number containing the objects in the response.",
"format": "int64"
},
"rayID": {
"type": "string",
"description": "RayID is the backend id of the request, generated at invocation time.\nAny questions or bug reports about a particular invocation should include the returned RequestID."
},
"total": {
"type": "integer",
"description": "Total is the total number of hits on a query before pagination.",
"format": "int64"
}
},
"description": "MetaResponse describes response data"
},
"MovieBatch": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"created": {
"type": "string",
"description": "When the batch was first created",
"readOnly": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the batch",
"readOnly": true
},
"payload": {
"$ref": "#/components/schemas/MoviePayload"
},
"response": {
"$ref": "#/components/schemas/BatchMovieResponse"
},
"status": {
"type": "string",
"description": "The current status of the batch - inProgress, succeeded, or failed",
"readOnly": true
},
"updated": {
"type": "string",
"description": "When the batch was last updated",
"readOnly": true
}
},
"description": "MovieBatch contains the toplevel information about the particular movie batch, as well as the payload, response, and any errors"
},
"MovieBatchResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MovieBatch"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"MovieParentPresentationPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentation": {
"$ref": "#/components/schemas/NewMoviePresentation"
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the version that the presentation belongs to"
}
}
},
"MovieParentVersionPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MoviePresentationPayload"
}
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the root that the version belongs to"
},
"version": {
"$ref": "#/components/schemas/NewMovieVersion"
}
}
},
"MoviePayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MovieParentPresentationPayload"
}
},
"roots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MovieRootPayload"
}
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MovieParentVersionPayload"
}
}
},
"description": "MoviePayload is the movie request payload provided by the user"
},
"MoviePresentation": {
"description": "Presentation represents the presentation of a movie",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"productionStatus": {
"type": "string",
"description": "Describes the production status of the movie.",
"examples": [
"completed"
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the movie was released.\n\nReleaseDate is optional for creating a presentation, but\neither ReleaseYear or ReleaseDate is required for publishing.\nEither ReleaseYear or ReleaseDate must be specified for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The year in which the movie was released.\n\nReleaseYear is optional for creating a presentation, but\neither ReleaseYear or ReleaseDate is required for publishing.\nEither ReleaseYear or ReleaseDate must be specified for update when the presentation is\nin publishing/published state.",
"format": "int64",
"examples": [
2000
]
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
},
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"catalogGnIDs": {
"type": "array",
"description": "The IDs of the catalogs that the presentation is a part of.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true,
"examples": [
"GNLZZXW00000001"
]
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent root.",
"readOnly": true,
"examples": [
"GNLZZZ600000001"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.",
"readOnly": true,
"examples": [
"GNLZZXX00000001"
]
}
}
},
"MoviePresentationPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentation": {
"$ref": "#/components/schemas/NewMoviePresentation"
}
},
"description": "MoviePresentationPayload is the movie presentation request payload provided by the user"
},
"MoviePresentationResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MoviePresentation"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"MoviePresentationsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MoviePresentation"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"MovieRoot": {
"title": "Root represents the root of a movie.",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnIDs": {
"type": "array",
"description": "The set of child version GnIDs of the root",
"readOnly": true,
"items": {
"type": "string"
}
}
}
},
"MovieRootPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"root": {
"$ref": "#/components/schemas/NewMovieRoot"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MovieVersionPayload"
}
}
},
"description": "MovieRootPayload is the movie root request payload provided by the user"
},
"MovieRootResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MovieRoot"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"MovieVersion": {
"description": "Version represents the version of a movie",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the program.\nSee the Gracenote Vocabulary for valid color values."
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The first ever release date of the program represented by the version.\nEither releaseDate or releaseYear is required for publishing a movie presentation.\nEither releaseDate or releaseYear must be specified for update when the version has a\npublishing/published presentation attached to it.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The first ever release year of the program represented by the version.\nEither releaseDate or releaseYear is required for publishing a movie presentation.\nEither releaseDate or releaseYear must be specified for update when the version has a\npublishing/published presentation attached to it.",
"format": "int64"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"presentationGnIDs": {
"type": "array",
"description": "A list of the version's children presentation GnIDs.",
"readOnly": true,
"items": {
"type": "string"
}
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
}
}
},
"MovieVersionPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MoviePresentationPayload"
}
},
"version": {
"$ref": "#/components/schemas/NewMovieVersion"
}
},
"description": "MovieVersionPayload is the movie version request payload provided by the user"
},
"MovieVersionResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/MovieVersion"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"MovieVersionsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MovieVersion"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"Name": {
"required": [
"first"
],
"type": "object",
"properties": {
"first": {
"type": "string",
"description": "The first name of the member."
},
"last": {
"type": "string",
"description": "The last name of the member."
},
"middle": {
"type": "string",
"description": "The middle name of the member."
},
"prefix": {
"type": "string",
"description": "The prefix of the member's name."
},
"suffix": {
"type": "string",
"description": "The suffix of the member's name."
}
},
"description": "Name contains the components of the full name\nof a crew or cast member."
},
"NewCatalog": {
"required": [
"name"
],
"type": "object",
"properties": {
"languages": {
"type": "array",
"description": "Languages of Presentations which this Catalog holds. Must conform to GNVocab languages.",
"items": {
"type": "string"
}
},
"markets": {
"type": "array",
"description": "Applicable Markets that this Catalog represents. Must conform to GNVocab countries.",
"items": {
"type": "string"
}
},
"name": {
"minLength": 1,
"type": "string",
"description": "The name of this Catalog. Must be unique to other Catalog's\nwhich the Source manages."
},
"tags": {
"type": "array",
"description": "Optional keyword tags to describe the contents of the Catalog.",
"items": {
"type": "string"
}
}
},
"description": "NewCatalog contains information required for creating (POST)\nor updating (PUT) a Catalog."
},
"NewEpisode": {
"description": "NewEpisode represents the fields required for creating an episode of a show",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"color": {
"type": "string",
"description": "The color of an episode.\nSee the Gracenote Vocabulary for valid color values."
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"duration": {
"type": "integer",
"description": "The runtime duration (in milliseconds) of the episode.",
"format": "int64"
},
"episodeNumber": {
"type": "string",
"description": "The episode's number.",
"examples": [
"1"
]
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating an episode, but at least one is required\nfor publishing. Genres is a required for update when the episode is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"industryNetworkNumber": {
"type": "string",
"description": "The episode number provided by the original network."
},
"industryNetworkSyndicated": {
"type": "string",
"description": "The official, original episode number as provided by the syndicator."
},
"ordinal": {
"type": "integer",
"description": "The ordering of the episode",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"partNumbers": {
"type": "string",
"description": "Textual part numbers.",
"examples": [
"Part One"
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The release date of the episode.\n\nReleaseDate is not required for creating an episode,\nbut it is required for publishing.\nReleaseDate is required for update when the episode is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"episode"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"episode"
]
}
}
},
"NewExport": {
"title": "NewExport contains the required fields for creating a new export.",
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"filter": {
"$ref": "#/components/schemas/Filter"
}
}
},
"NewImage": {
"required": [
"category",
"dimensions",
"fileType",
"title",
"url"
],
"type": "object",
"properties": {
"brandDescription": {
"type": "string",
"description": "Description that indicates the branding applied to the image.\nIf the description is provided, then branded is assumed to be true.\nbrandDescription is not required, even if branded is specified as true.\nCannot exceed 1000 character length limit."
},
"branded": {
"type": "boolean",
"description": "Indicates that the image has branded content such as a source, channel, or network name or logo.",
"default": false
},
"category": {
"$ref": "#/components/schemas/Category"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Custom key:value pairs to associate with the image."
},
"description": {
"$ref": "#/components/schemas/Description"
},
"dimensions": {
"$ref": "#/components/schemas/Dimensions"
},
"fileType": {
"type": "string",
"description": "The media or file-type of the image at the URL.",
"enum": [
"bmp",
" psd",
" jpeg",
" jpg",
" tiff",
" png"
]
},
"gracenoteUsage": {
"type": "boolean",
"description": "Indicates that the client agrees that, upon a successful publish request,\nGracenote may use the provided image in Gracenote's customer-facing datasets.\nIf the client does not agree, then this field should be set to false.",
"default": true
},
"languages": {
"type": "array",
"description": "Primary languages used in the image.",
"items": {
"type": "string"
},
"examples": [
[
"en",
"en-GB",
"en-AU",
"es",
"es-ES"
]
]
},
"markets": {
"type": "array",
"description": "Applicable markets for the image.\nMust conform to GN Vocabulary (ISO 3166-1 Alpha-2 codes).",
"items": {
"type": "string"
},
"examples": [
[
"US",
"MX",
"ES",
"AU",
"GB"
]
]
},
"productionDate": {
"type": "string",
"description": "The ISO-8601 date that the image was originally created.",
"format": "date"
},
"sensitive": {
"type": "boolean",
"description": "Indicates that the image contains sensitive material.",
"default": false
},
"tags": {
"type": "array",
"description": "Custom tags to associate with the image.",
"items": {
"type": "string"
}
},
"title": {
"type": "string",
"description": "The tile (or name) of the image. Cannot exceed 1000 character length limit."
},
"url": {
"type": "string",
"description": "The URL at which the image file may be accessed. Cannot exceed 8000 character length limit.",
"format": "uri"
}
},
"description": "NewImage represents the metadata for creating a new image"
},
"NewMoviePresentation": {
"description": "NewPresentation defines what information may be provided to create a\nnew movie presentation record.",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"productionStatus": {
"type": "string",
"description": "Describes the production status of the movie.",
"examples": [
"completed"
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the movie was released.\n\nReleaseDate is optional for creating a presentation, but\neither ReleaseYear or ReleaseDate is required for publishing.\nEither ReleaseYear or ReleaseDate must be specified for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The year in which the movie was released.\n\nReleaseYear is optional for creating a presentation, but\neither ReleaseYear or ReleaseDate is required for publishing.\nEither ReleaseYear or ReleaseDate must be specified for update when the presentation is\nin publishing/published state.",
"format": "int64",
"examples": [
2000
]
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
}
}
},
"NewMovieRoot": {
"title": "NewRoot represents the fields required for creating a root of a movie.",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
}
}
},
"NewMovieVersion": {
"description": "NewVersion defines what information may be provided to create a\nnew movie version record.",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the program.\nSee the Gracenote Vocabulary for valid color values."
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The first ever release date of the program represented by the version.\nEither releaseDate or releaseYear is required for publishing a movie presentation.\nEither releaseDate or releaseYear must be specified for update when the version has a\npublishing/published presentation attached to it.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The first ever release year of the program represented by the version.\nEither releaseDate or releaseYear is required for publishing a movie presentation.\nEither releaseDate or releaseYear must be specified for update when the version has a\npublishing/published presentation attached to it.",
"format": "int64"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
}
}
},
"NewSeason": {
"description": "NewSeason represents the fields required for creating a season of a show",
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the season.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the season.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"type": "array",
"description": "A list of descriptions for the season.",
"items": {
"$ref": "#/components/schemas/Description"
}
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date on which the season ends with the season's finale.",
"format": "date"
},
"nonSeason": {
"type": "boolean",
"description": "Indicates that the season is a one-off occurrence and is non-repetitive. Mutually exclusive with SeasonNumber."
},
"ordinal": {
"type": "integer",
"description": "The order of which the season appears",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the season (or network if\nthe season originated on a network).",
"examples": [
"Lifetime"
]
},
"releaseDate": {
"type": "string",
"description": "The date the season was release",
"format": "date"
},
"seasonNumber": {
"type": "string",
"description": "Indicates which season of a show the season is."
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
}
},
"required": [
"subType"
]
},
"NewShowPresentation": {
"description": "NewPresentation represents the fields required for creating a presentation of a show",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date at which the series ends with a series finale.",
"format": "date"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the series was released.\n\nReleaseDate is optional for creating a presentation, but is required for publishing.\nReleaseDate is required for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
}
}
},
"NewShowRoot": {
"description": "NewRoot represents the fields required for creating a root of a show",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
}
}
},
"NewShowVersion": {
"description": "NewVersion represents the fields required for creating a version of a show",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the show.\nColor is required for publishing the show.",
"examples": [
"bw"
]
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The releaseDate of the show.\nReleaseDate is optional for creating a show version, but is required\nfor publishing a show presentation. ReleaseDate is required\nfor update when the presentation is in publishing/published state.",
"format": "date"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
}
}
},
"ParentEpisodePayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"episode": {
"$ref": "#/components/schemas/NewEpisode"
},
"seasonGnID": {
"type": "string",
"description": "The Gracenote ID of the season that the episode belongs to"
}
}
},
"ParentSeasonPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodePayload"
}
},
"presentationGnID": {
"type": "string",
"description": "The Gracenote ID of the show presentation that the season belongs to"
},
"season": {
"$ref": "#/components/schemas/NewSeason"
}
}
},
"Program": {
"required": [
"subType"
],
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
}
},
"description": "Program represents the common\nfields of all program levels."
},
"ProgramImage": {
"title": "ProgramImage represents the relationship between an Image and a Presentation.",
"required": [
"imageGnID",
"presentationGnID"
],
"type": "object",
"properties": {
"imageGnID": {
"type": "string",
"description": "ImageID is the GnID of an image.",
"examples": [
"GNLZZZ200000004"
]
},
"isConforming": {
"type": "boolean",
"description": "IsConforming indicates if the Image conforms to Gracenote Rich Media\ncategorical image standards with respect to the mapped Presentation.",
"readOnly": true
},
"presentationGnID": {
"type": "string",
"description": "PresentationGnID is the GnID of a Presentation.",
"examples": [
"GNLZZXT00000004"
]
}
}
},
"ProgramImagesResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgramImage"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ProgramSummariesResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProgramSummary"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ProgramSummary": {
"type": "object",
"properties": {
"catalogGnIDs": {
"type": "array",
"description": "The associated CatalogGnIDs of a program",
"items": {
"type": "string"
},
"examples": [
[
"GN1"
]
]
},
"episodeNumber": {
"type": "string",
"description": "The episode number of the program.",
"examples": [
"1"
]
},
"externalIDs": {
"type": "array",
"description": "External identifiers of the program.",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"id": "1",
"isPrimary": true,
"isProvider": true,
"label": "source"
}
]
]
},
"genres": {
"type": "array",
"description": "Genres of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"latestUpdate": {
"type": "string",
"description": "The latest update to the program. This is the latest of the updates to the program's\nrelated root, version, presentation, and (as applicable) season and episode.",
"examples": [
"2020-10-23T00:00:00.000Z"
]
},
"presentationGnID": {
"type": "string",
"description": "The GnID of the program's Presentation.",
"examples": [
"GNLZZXZ00000000"
]
},
"presentationLabels": {
"type": "array",
"description": "Presentation labels of the program.",
"items": {
"type": "string"
},
"examples": [
[
"en-US"
]
]
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process."
},
"publishStatus": {
"type": "string",
"description": "The current publishing status of the presentation.",
"examples": [
"registered"
]
},
"releaseDate": {
"type": "string",
"description": "Release date of the program.",
"examples": [
"2022-09-02T00:00:00.000Z"
]
},
"releaseYear": {
"type": "string",
"description": "The release year of the program. This is only\npopulated for summary's with the type \"movie\".",
"examples": [
"2022"
]
},
"rootGnID": {
"type": "string",
"description": "The GnID of the program's Root.",
"examples": [
"GNLZZZ700000000"
]
},
"seasonGnID": {
"type": "string",
"description": "The GnID of an episode's season.",
"examples": [
"GNLZZZ200000000"
]
},
"seasonNumber": {
"type": "string",
"description": "The season number the program belongs to.",
"examples": [
"1"
]
},
"showPresentationGnID": {
"type": "string",
"description": "The GnID of a show's (or episode's show's) presentation GnID.\nThis will only be populated when the summary's type is of \"episode\" or \"show\".",
"examples": [
"GNLZZZ200000000"
]
},
"showTitle": {
"type": "string",
"description": "The title of a show's presentation. This will only be populated\nif the summary's type is of \"show\" or \"episode\".",
"examples": [
"Rings of Power"
]
},
"subType": {
"type": "string",
"description": "The subType of the program.",
"examples": [
"episode"
]
},
"title": {
"type": "string",
"description": "The Title of a movie presentation or episode's title.\nFor the title of a show, see showTitle.",
"examples": [
"episode one"
]
},
"tmsID": {
"type": "string",
"description": "The assigned TMS ID of a presentation. This\nwill only be assigned after a successfully publishing\nthe presentation.",
"examples": [
"EP12345678000000"
]
},
"type": {
"$ref": "#/components/schemas/ProgramType"
},
"versionGnID": {
"type": "string",
"description": "The GnID of the program's Version.",
"examples": [
"GNLZZZ300000000"
]
},
"versionLabels": {
"type": "array",
"description": "Version labels of the program.",
"items": {
"type": "string"
},
"examples": [
[
"original"
]
]
}
},
"description": "Summary represents an aggregate view of Roots, Version, Presentations, Seasons, and Episodes"
},
"ProgramType": {
"type": "string",
"description": "ProgramType aliases string to provide\n\"enums\" for available program types."
},
"Publication": {
"description": "Publication represents a view of all Presentations with their publishing statuses",
"type": "object",
"properties": {
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"gnID": {
"type": "string"
},
"mappingUpdated": {
"type": "string",
"description": "The timestamp when the TMS ID mapping was last updated.",
"examples": [
"2023-10-23T00:00:00.000Z"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"type": {
"$ref": "#/components/schemas/ProgramType"
},
"updated": {
"type": "string",
"description": "The latest update to the presentation.",
"examples": [
"2023-10-23T00:00:00.000Z"
]
}
}
},
"PublicationsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Publication"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"PublishEpisode": {
"properties": {
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"color": {
"type": "string",
"description": "The color of an episode.\nSee the Gracenote Vocabulary for valid color values."
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"duration": {
"type": "integer",
"description": "The runtime duration (in milliseconds) of the episode.",
"format": "int64"
},
"episodeNumber": {
"type": "string",
"description": "The episode's number.",
"examples": [
"1"
]
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating an episode, but at least one is required\nfor publishing. Genres is a required for update when the episode is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"industryNetworkNumber": {
"type": "string",
"description": "The episode number provided by the original network."
},
"industryNetworkSyndicated": {
"type": "string",
"description": "The official, original episode number as provided by the syndicator."
},
"ordinal": {
"type": "integer",
"description": "The ordering of the episode",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"partNumbers": {
"type": "string",
"description": "Textual part numbers.",
"examples": [
"Part One"
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The release date of the episode.\n\nReleaseDate is not required for creating an episode,\nbut it is required for publishing.\nReleaseDate is required for update when the episode is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"episode"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"episode"
]
},
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"catalogGnIDs": {
"type": "array",
"description": "The IDs of the catalogs that the presentation is a part of.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000001"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"readOnly": true,
"items": {
"type": "string"
}
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"seasonGnID": {
"type": "string",
"description": "The gnID of the episode's parent season.",
"readOnly": true,
"examples": [
"GNLZZXV00000001"
]
},
"showPresentationGnID": {
"type": "string",
"description": "The gnID of the episode's parent show presentation.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"showRootGnID": {
"type": "string",
"description": "The gnID of the episode's parent show root.",
"readOnly": true,
"examples": [
"GNLZZZ700000001"
]
},
"showVersionGnID": {
"type": "string",
"description": "The gnID of the episode's parent show version.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"updated": {
"type": "string",
"description": "The time the episode was last updated",
"readOnly": true
},
"versionLabels": {
"type": "array",
"description": "The types associated with this version.\nSee the Gracenote Vocabulary for suggested version types.",
"readOnly": true,
"items": {
"type": "string"
}
}
},
"description": "Episode is a part of the ShowSeason and contains\nthe season and episode data.",
"required": [
"title",
"subType"
],
"type": "object"
},
"PublishInfo": {
"title": "PublishInfo contains the information about presentation to TmsID mapping.",
"type": "object",
"properties": {
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
}
}
},
"PublishInput": {
"type": "object",
"properties": {
"forceCreate": {
"type": "boolean",
"description": "A flag to force create a new TMS ID for the program,\nonly applicable if the program is being published for the first time."
},
"gnID": {
"type": "string",
"description": "The GracenoteID of the program to publish"
},
"mapping": {
"$ref": "#/components/schemas/Mapping"
}
},
"description": "PublishInput represents the input required for publishing a presentation"
},
"PublishMoviePresentation": {
"title": "MoviePresentation contains the presentation data paired with the images associated to the presentation.",
"properties": {
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"productionStatus": {
"type": "string",
"description": "Describes the production status of the movie.",
"examples": [
"completed"
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the movie was released.\n\nReleaseDate is optional for creating a presentation, but\neither ReleaseYear or ReleaseDate is required for publishing.\nEither ReleaseYear or ReleaseDate must be specified for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The year in which the movie was released.\n\nReleaseYear is optional for creating a presentation, but\neither ReleaseYear or ReleaseDate is required for publishing.\nEither ReleaseYear or ReleaseDate must be specified for update when the presentation is\nin publishing/published state.",
"format": "int64",
"examples": [
2000
]
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
},
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"catalogGnIDs": {
"type": "array",
"description": "The IDs of the catalogs that the presentation is a part of.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true,
"examples": [
"GNLZZXW00000001"
]
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent root.",
"readOnly": true,
"examples": [
"GNLZZZ600000001"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.",
"readOnly": true,
"examples": [
"GNLZZXX00000001"
]
}
},
"description": "NewPresentation defines what information may be provided to create a\nnew movie presentation record.",
"required": [
"title",
"subType"
],
"type": "object"
},
"PublishMovieRoot": {
"properties": {
"version": {
"$ref": "#/components/schemas/PublishMovieVersion"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnIDs": {
"type": "array",
"description": "The set of child version GnIDs of the root",
"readOnly": true,
"items": {
"type": "string"
}
}
},
"description": "MovieJSONDoc represents the snapshot JSON of a movie (including its root, version, and presentation)\nwhich was requested to be published.",
"title": "NewRoot represents the fields required for creating a root of a movie.",
"required": [
"title",
"subType"
],
"type": "object"
},
"PublishMovieVersion": {
"title": "MovieVersion contains the version and presentation data of a movie being published.",
"properties": {
"presentation": {
"$ref": "#/components/schemas/PublishMoviePresentation"
},
"color": {
"type": "string",
"description": "The color of the program.\nSee the Gracenote Vocabulary for valid color values."
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The first ever release date of the program represented by the version.\nEither releaseDate or releaseYear is required for publishing a movie presentation.\nEither releaseDate or releaseYear must be specified for update when the version has a\npublishing/published presentation attached to it.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The first ever release year of the program represented by the version.\nEither releaseDate or releaseYear is required for publishing a movie presentation.\nEither releaseDate or releaseYear must be specified for update when the version has a\npublishing/published presentation attached to it.",
"format": "int64"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"featureFilm"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"movie"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"presentationGnIDs": {
"type": "array",
"description": "A list of the version's children presentation GnIDs.",
"readOnly": true,
"items": {
"type": "string"
}
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
}
},
"description": "NewVersion defines what information may be provided to create a\nnew movie version record.",
"required": [
"title",
"subType"
],
"type": "object"
},
"PublishResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublishedProgram"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"PublishShowPresentation": {
"properties": {
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"season": {
"$ref": "#/components/schemas/PublishShowSeason"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PublishShowSeason"
}
},
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date at which the series ends with a series finale.",
"format": "date"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the series was released.\n\nReleaseDate is optional for creating a presentation, but is required for publishing.\nReleaseDate is required for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"catalogGnIDs": {
"type": "array",
"description": "The Gracenote IDs of the catalogs that the presentation is a part of.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent root.",
"readOnly": true,
"examples": [
"GNLZZZ700000001"
]
},
"seasonGnIDs": {
"type": "array",
"description": "The Gracenote IDs of children seasons of the show presentation.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZXV00000001",
"GNLZZXV00000002"
]
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
}
},
"description": "ShowPresentation is a part of the ShowVersion and contains the season data\nunless this is the presentation being published.",
"required": [
"title",
"subType"
],
"type": "object"
},
"PublishShowRoot": {
"properties": {
"version": {
"$ref": "#/components/schemas/PublishShowVersion"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnIDs": {
"type": "array",
"description": "the ids of any children versions.",
"readOnly": true,
"items": {
"type": "string"
}
}
},
"description": "ShowJSONDoc represents the snapshot JSON of a show (including its root, version, and presentation)\nwhich was requested to be published.",
"required": [
"title",
"subType"
],
"type": "object"
},
"PublishShowSeason": {
"properties": {
"episode": {
"$ref": "#/components/schemas/PublishEpisode"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"cast": {
"type": "array",
"description": "The cast of the season.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the season.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"type": "array",
"description": "A list of descriptions for the season.",
"items": {
"$ref": "#/components/schemas/Description"
}
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date on which the season ends with the season's finale.",
"format": "date"
},
"nonSeason": {
"type": "boolean",
"description": "Indicates that the season is a one-off occurrence and is non-repetitive. Mutually exclusive with SeasonNumber."
},
"ordinal": {
"type": "integer",
"description": "The order of which the season appears",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the season (or network if\nthe season originated on a network).",
"examples": [
"Lifetime"
]
},
"releaseDate": {
"type": "string",
"description": "The date the season was release",
"format": "date"
},
"seasonNumber": {
"type": "string",
"description": "Indicates which season of a show the season is."
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"episodeGnIDs": {
"type": "array",
"description": "The episode gnIDs which are children of the season.",
"readOnly": true,
"items": {
"type": "string"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the season.",
"readOnly": true
},
"showPresentationGnID": {
"type": "string",
"description": "The show presentation GnID that is a parent of the Season.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated.",
"readOnly": true
}
},
"description": "ShowSeason is a part of the ShowPresentation and contains\nthe season and episode data.",
"type": "object",
"required": [
"subType"
]
},
"PublishShowVersion": {
"properties": {
"presentation": {
"$ref": "#/components/schemas/PublishShowPresentation"
},
"color": {
"type": "string",
"description": "The color of the show.\nColor is required for publishing the show.",
"examples": [
"bw"
]
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The releaseDate of the show.\nReleaseDate is optional for creating a show version, but is required\nfor publishing a show presentation. ReleaseDate is required\nfor update when the presentation is in publishing/published state.",
"format": "date"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"presentationGnIDs": {
"type": "array",
"description": "A list of the version's children presentation GnIDs.",
"readOnly": true,
"items": {
"type": "string"
}
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
}
},
"description": "ShowVersion is a part of the ShowJSONDoc and contains the version data\nand presentation.",
"required": [
"title",
"subType"
],
"type": "object"
},
"PublishedEpisode": {
"$ref": "#/components/schemas/PublishShowRoot"
},
"PublishedMovie": {
"$ref": "#/components/schemas/PublishMovieRoot"
},
"PublishedProgram": {
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program root.",
"examples": [
"GNLZZZ700000000"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program root.",
"examples": [
"GNLZZZ400000000"
]
},
"subType": {
"type": "string",
"description": "The high-level sub-type of the program root.",
"examples": [
"series"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"type": {
"type": "string",
"description": "The high-level type of the program root.",
"examples": [
"show"
]
},
"updated": {
"type": "string",
"description": "The time the program root was last updated."
},
"version": {
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the program.",
"examples": [
"color"
]
},
"duration": {
"type": "integer",
"description": "The runtime in milliseconds of the program.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program version.",
"examples": [
"GNLZZZ300000000"
]
},
"presentation": {
"type": "object",
"properties": {
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"cast": {
"type": "array",
"description": "The cast of the presentation.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"catalogGnIDs": {
"type": "array",
"description": "The GnIDs of the catalogs that the presentation is a part of.",
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000000"
]
]
},
"crew": {
"type": "array",
"description": "The crew of the presentation.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date at which the series ends with a series finale.\nOnly available for shows.",
"format": "date"
},
"genres": {
"type": "array",
"description": "The presentation's genres.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the presentation.",
"examples": [
"GNLZZZ200000000"
]
},
"images": {
"type": "array",
"description": "The images associated with the presentation.",
"items": {
"$ref": "#/components/schemas/Image"
}
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if the program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "The companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "The countries that the program was produced in.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"productionStatus": {
"type": "string",
"description": "Describes the production status of the movie presentation.\nOnly available for movies.",
"examples": [
"completed"
]
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"ratings": {
"type": "array",
"description": "The presentation's ratings.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the movie was released.\nOnly available for movies.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The year in which the program was released.",
"format": "int64",
"examples": [
2019
]
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent root.",
"examples": [
"GNLZZZ700000000"
]
},
"season": {
"type": "object",
"description": "The season associated with the show presentation.\nOnly available for episodes.",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the season.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the season.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"type": "array",
"description": "A list of descriptions for the season.",
"items": {
"$ref": "#/components/schemas/Description"
}
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date on which the season ends with the season's finale.",
"format": "date"
},
"nonSeason": {
"type": "boolean",
"description": "Indicates that the season is a one-off occurrence and is non-repetitive. Mutually exclusive with SeasonNumber."
},
"ordinal": {
"type": "integer",
"description": "The order of which the season appears",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the season (or network if\nthe season originated on a network).",
"examples": [
"Lifetime"
]
},
"releaseDate": {
"type": "string",
"description": "The date the season was release",
"format": "date"
},
"seasonNumber": {
"type": "string",
"description": "Indicates which season of a show the season is."
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"episodeGnIDs": {
"type": "array",
"description": "The episode gnIDs which are children of the season.",
"readOnly": true,
"items": {
"type": "string"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the season.",
"readOnly": true
},
"showPresentationGnID": {
"type": "string",
"description": "The show presentation GnID that is a parent of the Season.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated.",
"readOnly": true
},
"episode": {
"type": "object",
"description": "The published episode",
"required": [
"title",
"subType"
],
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"color": {
"type": "string",
"description": "The color of an episode.\nSee the Gracenote Vocabulary for valid color values."
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"duration": {
"type": "integer",
"description": "The runtime duration (in milliseconds) of the episode.",
"format": "int64"
},
"episodeNumber": {
"type": "string",
"description": "The episode's number.",
"examples": [
"1"
]
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating an episode, but at least one is required\nfor publishing. Genres is a required for update when the episode is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"industryNetworkNumber": {
"type": "string",
"description": "The episode number provided by the original network."
},
"industryNetworkSyndicated": {
"type": "string",
"description": "The official, original episode number as provided by the syndicator."
},
"ordinal": {
"type": "integer",
"description": "The ordering of the episode",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"partNumbers": {
"type": "string",
"description": "Textual part numbers.",
"examples": [
"Part One"
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The release date of the episode.\n\nReleaseDate is not required for creating an episode,\nbut it is required for publishing.\nReleaseDate is required for update when the episode is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"episode"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"episode"
]
},
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"catalogGnIDs": {
"type": "array",
"description": "The IDs of the catalogs that the presentation is a part of.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true,
"examples": [
"GNLZZXZ00000001"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"readOnly": true,
"items": {
"type": "string"
}
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"seasonGnID": {
"type": "string",
"description": "The gnID of the episode's parent season.",
"readOnly": true,
"examples": [
"GNLZZXV00000001"
]
},
"showPresentationGnID": {
"type": "string",
"description": "The gnID of the episode's parent show presentation.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"showRootGnID": {
"type": "string",
"description": "The gnID of the episode's parent show root.",
"readOnly": true,
"examples": [
"GNLZZZ700000001"
]
},
"showVersionGnID": {
"type": "string",
"description": "The gnID of the episode's parent show version.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"updated": {
"type": "string",
"description": "The time the episode was last updated",
"readOnly": true
},
"versionLabels": {
"type": "array",
"description": "The types associated with this version.\nSee the Gracenote Vocabulary for suggested version types.",
"readOnly": true,
"items": {
"type": "string"
}
},
"images": {
"type": "array",
"description": "The images associated with the episode.",
"items": {
"$ref": "#/components/schemas/Image"
}
}
}
},
"images": {
"type": "array",
"description": "The images associated with the season.",
"items": {
"$ref": "#/components/schemas/Image"
}
}
},
"required": [
"subType"
]
},
"seasonGnIDs": {
"type": "array",
"description": "The child seasons GnIDs of the presentation.\nOnly available for shows.",
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000000"
]
]
},
"seasons": {
"type": "array",
"description": "The seasons associated with the show presentation.\nOnly available for shows.",
"items": {
"type": "object",
"description": "Season represents a grouping of\nShow episodes",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the season.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the season.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"type": "array",
"description": "A list of descriptions for the season.",
"items": {
"$ref": "#/components/schemas/Description"
}
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date on which the season ends with the season's finale.",
"format": "date"
},
"nonSeason": {
"type": "boolean",
"description": "Indicates that the season is a one-off occurrence and is non-repetitive. Mutually exclusive with SeasonNumber."
},
"ordinal": {
"type": "integer",
"description": "The order of which the season appears",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the season (or network if\nthe season originated on a network).",
"examples": [
"Lifetime"
]
},
"releaseDate": {
"type": "string",
"description": "The date the season was release",
"format": "date"
},
"seasonNumber": {
"type": "string",
"description": "Indicates which season of a show the season is."
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"episodeGnIDs": {
"type": "array",
"description": "The episode gnIDs which are children of the season.",
"readOnly": true,
"items": {
"type": "string"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the season.",
"readOnly": true
},
"showPresentationGnID": {
"type": "string",
"description": "The show presentation GnID that is a parent of the Season.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated.",
"readOnly": true
},
"images": {
"type": "array",
"description": "The images associated with the season.",
"items": {
"$ref": "#/components/schemas/Image"
}
}
},
"required": [
"subType"
]
}
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the presentation.",
"examples": [
"GNLZZZ400000000"
]
},
"subType": {
"type": "string",
"description": "The high-level sub-type of the presentation.",
"examples": [
"series"
]
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"type": {
"type": "string",
"description": "The high-level type of the presentation.",
"examples": [
"show"
]
},
"updated": {
"type": "string",
"description": "The time the presentation was last updated"
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.",
"examples": [
"GNLZZZ300000000"
]
}
}
},
"presentationGnIDs": {
"type": "array",
"description": "A list of the version's child presentation GnIDs.",
"items": {
"type": "string"
},
"examples": [
[
"GNLZZZ200000000"
]
]
},
"releaseDate": {
"type": "string",
"description": "The first ever release date of the program represented by the version.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The first ever release year of the program represented by the version.\nOnly available for movies.",
"format": "int64",
"examples": [
2019
]
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"examples": [
"GNLZZZ700000000"
]
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program version.",
"examples": [
"GNLZZZ400000000"
]
},
"subType": {
"type": "string",
"description": "The high-level sub-type of the program version.",
"examples": [
"series"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"type": {
"type": "string",
"description": "The high-level type of the program version.",
"examples": [
"show"
]
},
"updated": {
"type": "string",
"description": "The time the program version was last updated."
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version type.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
}
}
},
"versionGnIDs": {
"type": "array",
"description": "The set of child version GnIDs of the root.",
"items": {
"type": "string"
},
"examples": [
[
"GNLZZZ300000000"
]
]
}
}
},
"PublishedShow": {
"$ref": "#/components/schemas/PublishShowRoot"
},
"Rating": {
"required": [
"ratingBody"
],
"type": "object",
"properties": {
"advisories": {
"type": "array",
"description": "Content advisories that should be attached to the presentation.\nFree form entry. Reference the GN Vocabulary for suggested advisories.",
"items": {
"type": "string"
},
"examples": [
[
"contains strong language"
]
]
},
"notYetRated": {
"type": "boolean",
"description": "When true, indicates that the presentation is yet to be rated."
},
"rating": {
"type": "string",
"description": "The assigned rating value as determined by the rating body.\nRequired if ratingBody & notYetRated are false.",
"examples": [
"PG-13"
]
},
"ratingBody": {
"type": "string",
"description": "The rating body responsible for assigning ratings.",
"examples": [
"MPAA"
]
},
"ratingExempt": {
"type": "boolean",
"description": "When set to true, indicates that the presentation is exempt from and\nwill not receive ratings."
}
},
"description": "Rating represents a rating of a program as assigned by a rating body"
},
"RatingBody": {
"type": "object",
"properties": {
"label": {
"type": "string",
"description": "A human-readable string of the value.",
"examples": [
"Special Edition"
]
},
"rating": {
"type": "array",
"items": {
"type": "string"
}
},
"value": {
"type": "string",
"description": "a camelCase string to be used in the API.",
"examples": [
"specialEdition"
]
}
},
"description": "RatingBody represents the rating body in GN Vocab"
},
"Season": {
"description": "Season represents a grouping of\nShow episodes",
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the season.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the season.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"type": "array",
"description": "A list of descriptions for the season.",
"items": {
"$ref": "#/components/schemas/Description"
}
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date on which the season ends with the season's finale.",
"format": "date"
},
"nonSeason": {
"type": "boolean",
"description": "Indicates that the season is a one-off occurrence and is non-repetitive. Mutually exclusive with SeasonNumber."
},
"ordinal": {
"type": "integer",
"description": "The order of which the season appears",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the season (or network if\nthe season originated on a network).",
"examples": [
"Lifetime"
]
},
"releaseDate": {
"type": "string",
"description": "The date the season was release",
"format": "date"
},
"seasonNumber": {
"type": "string",
"description": "Indicates which season of a show the season is."
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"episodeGnIDs": {
"type": "array",
"description": "The episode gnIDs which are children of the season.",
"readOnly": true,
"items": {
"type": "string"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the season.",
"readOnly": true
},
"showPresentationGnID": {
"type": "string",
"description": "The show presentation GnID that is a parent of the Season.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated.",
"readOnly": true
}
},
"required": [
"subType"
]
},
"SeasonPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EpisodePayload"
}
},
"season": {
"$ref": "#/components/schemas/NewSeason"
}
},
"description": "SeasonPayload is the season request payload provided by the user"
},
"SeasonResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/Season"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"SeasonsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Season"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ShowBatch": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"created": {
"type": "string",
"description": "When the batch was first created",
"readOnly": true
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the batch",
"readOnly": true
},
"payload": {
"$ref": "#/components/schemas/ShowPayload"
},
"response": {
"$ref": "#/components/schemas/BatchShowResponse"
},
"status": {
"type": "string",
"description": "The current status of the batch - inProgress, succeeded, or failed",
"readOnly": true
},
"updated": {
"type": "string",
"description": "When the batch was last updated",
"readOnly": true
}
},
"description": "ShowBatch contains the toplevel information about the particular show batch, as well as the payload, response, and any errors"
},
"ShowBatchResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ShowBatch"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ShowParentPresentationPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentation": {
"$ref": "#/components/schemas/NewShowPresentation"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeasonPayload"
}
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the version that the presentation belongs to"
}
}
},
"ShowParentVersionPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShowPresentationPayload"
}
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the root that the version belongs to"
},
"version": {
"$ref": "#/components/schemas/NewShowVersion"
}
}
},
"ShowPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"episodes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParentEpisodePayload"
}
},
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShowParentPresentationPayload"
}
},
"roots": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShowRootPayload"
}
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ParentSeasonPayload"
}
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShowParentVersionPayload"
}
}
},
"description": "ShowPayload is the show request payload provided by the user"
},
"ShowPresentation": {
"description": "Presentation represents the Show specific presentation metadata",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date at which the series ends with a series finale.",
"format": "date"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the series was released.\n\nReleaseDate is optional for creating a presentation, but is required for publishing.\nReleaseDate is required for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"catalogGnIDs": {
"type": "array",
"description": "The Gracenote IDs of the catalogs that the presentation is a part of.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZWT00000001",
"GNLZZWT00000002"
]
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true,
"examples": [
"GNLZZZ200000001"
]
},
"mappingInfo": {
"$ref": "#/components/schemas/MappingInfo"
},
"publishExceptions": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "A map of reason and details that describe why a program failed the publishing process.\nThis field is only available for presentations/episodes with publishStatus = publishException,\nand for presentations/episodes which are self-mapped and have an issue in the mapping.",
"readOnly": true
},
"publishPrereqs": {
"$ref": "#/components/schemas/FieldErrors"
},
"publishingStatus": {
"type": "string",
"description": "Describes the state of publishing in the Gracenote ID Distribution System.",
"readOnly": true,
"examples": [
"registered"
]
},
"rootGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent root.",
"readOnly": true,
"examples": [
"GNLZZZ700000001"
]
},
"seasonGnIDs": {
"type": "array",
"description": "The Gracenote IDs of children seasons of the show presentation.",
"readOnly": true,
"items": {
"type": "string"
},
"examples": [
[
"GNLZZXV00000001",
"GNLZZXV00000002"
]
]
},
"sourceId": {
"type": "string",
"description": "The internal Source Gracenote ID associated with the program.",
"readOnly": true,
"examples": [
"GNLZZZ400000001"
]
},
"tmsID": {
"type": "string",
"description": "TMSID is the industry gold standard identifier for\nrecognizing and synchronizing entertainment assets.\nThis is unique across programs.\nIt will be assigned after successfully publishing a presentation.",
"readOnly": true,
"examples": [
"EP12345678000000"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnID": {
"type": "string",
"description": "The Gracenote ID of the presentation's parent version.",
"readOnly": true,
"examples": [
"GNLZZZ300000001"
]
}
}
},
"ShowPresentationPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentation": {
"$ref": "#/components/schemas/NewShowPresentation"
},
"seasons": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SeasonPayload"
}
}
},
"description": "ShowPresentationPayload is the show presentation request payload provided by the user"
},
"ShowPresentationResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ShowPresentation"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ShowPresentationsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShowPresentation"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ShowRoot": {
"description": "Root represents the root of a show",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"title": {
"$ref": "#/components/schemas/Title"
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"versionGnIDs": {
"type": "array",
"description": "the ids of any children versions.",
"readOnly": true,
"items": {
"type": "string"
}
}
}
},
"ShowRootPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"root": {
"$ref": "#/components/schemas/NewShowRoot"
},
"versions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShowVersionPayload"
}
}
},
"description": "ShowRootPayload is the show root request payload provided by the user"
},
"ShowRootResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ShowRoot"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ShowVersion": {
"description": "Version represents the version of a show",
"required": [
"title",
"subType"
],
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the show.\nColor is required for publishing the show.",
"examples": [
"bw"
]
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The releaseDate of the show.\nReleaseDate is optional for creating a show version, but is required\nfor publishing a show presentation. ReleaseDate is required\nfor update when the presentation is in publishing/published state.",
"format": "date"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"presentationGnIDs": {
"type": "array",
"description": "A list of the version's children presentation GnIDs.",
"readOnly": true,
"items": {
"type": "string"
}
},
"rootGnID": {
"type": "string",
"description": "The GnID of the version's parent root.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
}
}
},
"ShowVersionPayload": {
"type": "object",
"properties": {
"context": {
"$ref": "#/components/schemas/Context"
},
"presentations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShowPresentationPayload"
}
},
"version": {
"$ref": "#/components/schemas/NewShowVersion"
}
},
"description": "ShowVersionPayload is the show version request payload provided by the user"
},
"ShowVersionResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/ShowVersion"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"ShowVersionsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShowVersion"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"Title": {
"required": [
"language",
"value"
],
"type": "object",
"properties": {
"language": {
"type": "string",
"description": "The language of the title's text. User must be entitled to use the language.\nSee the Gracenote Vocabulary for valid languages."
},
"value": {
"type": "string",
"description": "The text of the title."
}
},
"description": "Title holds information about\na program's title."
},
"TitledProgram": {
"description": "TitledProgram represents the common fields of\nprogram levels, including Title.",
"required": [
"subType",
"title"
],
"type": "object",
"properties": {
"gnID": {
"type": "string",
"description": "The Gracenote ID of the program.",
"readOnly": true
},
"sourceId": {
"type": "string",
"description": "The internal Source ID associated with the program.",
"readOnly": true
},
"subType": {
"type": "string",
"description": "The high-level type of the program.",
"examples": [
"series"
]
},
"type": {
"type": "string",
"description": "The high-level type of the program.",
"readOnly": true,
"examples": [
"show"
]
},
"updated": {
"type": "string",
"description": "The time the program was last updated",
"readOnly": true
},
"title": {
"$ref": "#/components/schemas/Title"
}
}
},
"UpdateEpisode": {
"required": [
"title"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"color": {
"type": "string",
"description": "The color of an episode.\nSee the Gracenote Vocabulary for valid color values."
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"duration": {
"type": "integer",
"description": "The runtime duration (in milliseconds) of the episode.",
"format": "int64"
},
"episodeNumber": {
"type": "string",
"description": "The episode's number.",
"examples": [
"1"
]
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating an episode, but at least one is required\nfor publishing. Genres is a required for update when the episode is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"industryNetworkNumber": {
"type": "string",
"description": "The episode number provided by the original network."
},
"industryNetworkSyndicated": {
"type": "string",
"description": "The official, original episode number as provided by the syndicator."
},
"ordinal": {
"type": "integer",
"description": "The ordering of the episode",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"partNumbers": {
"type": "string",
"description": "Textual part numbers.",
"examples": [
"Part One"
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The release date of the episode.\n\nReleaseDate is not required for creating an episode,\nbut it is required for publishing.\nReleaseDate is required for update when the episode is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
}
},
"description": "UpdateEpisode specifies the updatable fields of an Episode"
},
"UpdateMoviePresentation": {
"required": [
"title"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"productionStatus": {
"type": "string",
"description": "Describes the production status of the movie.",
"examples": [
"completed"
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the movie was released.\n\nReleaseDate is optional for creating a presentation, but\neither ReleaseYear or ReleaseDate is required for publishing.\nEither ReleaseYear or ReleaseDate must be specified for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The year in which the movie was released.\n\nReleaseYear is optional for creating a presentation, but\neither ReleaseYear or ReleaseDate is required for publishing.\nEither ReleaseYear or ReleaseDate must be specified for update when the presentation is\nin publishing/published state.",
"format": "int64",
"examples": [
2000
]
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
}
},
"description": "UpdatePresentation defines what information may be\nprovided to modify an existing movie presentation record."
},
"UpdateMovieRoot": {
"title": "UpdateRoot represents the fields required for updating a root of a movie.",
"required": [
"title"
],
"type": "object",
"properties": {
"title": {
"$ref": "#/components/schemas/Title"
}
}
},
"UpdateMovieVersion": {
"required": [
"title"
],
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the program.\nSee the Gracenote Vocabulary for valid color values."
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The first ever release date of the program represented by the version.\nEither releaseDate or releaseYear is required for publishing a movie presentation.\nEither releaseDate or releaseYear must be specified for update when the version has a\npublishing/published presentation attached to it.",
"format": "date"
},
"releaseYear": {
"type": "integer",
"description": "The first ever release year of the program represented by the version.\nEither releaseDate or releaseYear is required for publishing a movie presentation.\nEither releaseDate or releaseYear must be specified for update when the version has a\npublishing/published presentation attached to it.",
"format": "int64"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
}
},
"description": "UpdateVersion defines what information may be provided to modify an\nexisting Version record. All field are required, pointers are used\nto indicate that a field was not provided. Normally we do not encourage\npointer usage for basic operations, but here an exception is being made."
},
"UpdateSeason": {
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the season.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the season.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"type": "array",
"description": "A list of descriptions for the season.",
"items": {
"$ref": "#/components/schemas/Description"
}
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date on which the season ends with the season's finale.",
"format": "date"
},
"nonSeason": {
"type": "boolean",
"description": "Indicates that the season is a one-off occurrence and is non-repetitive. Mutually exclusive with SeasonNumber."
},
"ordinal": {
"type": "integer",
"description": "The order of which the season appears",
"format": "int64"
},
"originalSource": {
"type": "string",
"description": "The original source of the season (or network if\nthe season originated on a network).",
"examples": [
"Lifetime"
]
},
"releaseDate": {
"type": "string",
"description": "The date the season was release",
"format": "date"
},
"seasonNumber": {
"type": "string",
"description": "Indicates which season of a show the season is."
},
"title": {
"$ref": "#/components/schemas/Title"
}
},
"description": "UpdateSeason defines what information may be provided to modify (or create) a Season"
},
"UpdateShowPresentation": {
"required": [
"title"
],
"type": "object",
"properties": {
"cast": {
"type": "array",
"description": "The cast of the presentation.\n\nEach cast's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Cast"
}
},
"crew": {
"type": "array",
"description": "The crew of the presentation.\n\nEach crew's order field must be unique.",
"items": {
"$ref": "#/components/schemas/Crew"
}
},
"descriptions": {
"$ref": "#/components/schemas/Descriptions"
},
"externalIDs": {
"$ref": "#/components/schemas/ExternalIDs"
},
"finaleDate": {
"type": "string",
"description": "The date at which the series ends with a series finale.",
"format": "date"
},
"genres": {
"type": "array",
"description": "The applicable genres to the presentation.\n\nGenres are not required for creating a presentation,\nbut at least one is required for publishing.\nGenres is required for update when the presentation is\nin publishing/published state.",
"items": {
"type": "string"
},
"examples": [
[
"Fantasy",
"Adventure"
]
]
},
"originalSource": {
"type": "string",
"description": "The original source of the program (or network if\nthe program originated on a network).",
"examples": [
"Lifetime"
]
},
"presentationLabels": {
"type": "array",
"description": "Describes content information and/or contextual business tags to describe\nthe intent of the presentation.",
"items": {
"type": "string"
},
"examples": [
[
"UK EN",
"US EN"
]
]
},
"productionCompanies": {
"type": "array",
"description": "Any companies that have contributed in the production of the program.",
"items": {
"type": "string"
},
"examples": [
[
"Newline"
]
]
},
"productionCountries": {
"type": "array",
"description": "Any countries that the program was produced in.\nSee the Gracenote Vocabulary for valid country codes.",
"items": {
"type": "string"
},
"examples": [
[
"CA"
]
]
},
"ratings": {
"type": "array",
"description": "The ratings for this presentation.",
"items": {
"$ref": "#/components/schemas/Rating"
},
"examples": [
[
{
"advisories": [
"contains strong language"
],
"rating": "PG-13",
"ratingBody": "MPAA"
}
]
]
},
"releaseDate": {
"type": "string",
"description": "The date on which the series was released.\n\nReleaseDate is optional for creating a presentation, but is required for publishing.\nReleaseDate is required for update when the presentation is\nin publishing/published state.",
"format": "date"
},
"targetAudience": {
"type": "string",
"description": "The primary demographic that the program is targeted towards.",
"examples": [
"children"
]
},
"title": {
"$ref": "#/components/schemas/Title"
}
},
"description": "UpdatePresentation defines what information may be provided to modify an\nexisting Presentation record. All field are required, pointers are used\nto indicate that a field was not provided. Normally we do not encourage\npointer usage for basic operations, but here an exception is being made."
},
"UpdateShowRoot": {
"required": [
"title"
],
"type": "object",
"properties": {
"title": {
"$ref": "#/components/schemas/Title"
}
},
"description": "UpdateRoot represents the fields required for updating a root of a show"
},
"UpdateShowVersion": {
"required": [
"title"
],
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the show.\nColor is required for publishing the show.",
"examples": [
"bw"
]
},
"duration": {
"type": "integer",
"description": "The runtime (milliseconds) of the program.\nNot required for registration, but it is required for publishing\nwhen the subType is neither a series nor a miniseries.",
"format": "int64",
"examples": [
30800000
]
},
"genres": {
"type": "array",
"description": "Version level genres of a program.",
"items": {
"type": "string"
},
"examples": [
[
"Adventure"
]
]
},
"releaseDate": {
"type": "string",
"description": "The releaseDate of the show.\nReleaseDate is optional for creating a show version, but is required\nfor publishing a show presentation. ReleaseDate is required\nfor update when the presentation is in publishing/published state.",
"format": "date"
},
"title": {
"$ref": "#/components/schemas/Title"
},
"versionLabels": {
"type": "array",
"description": "A free-form list of version types.\nRefer to the Gracenote Vocabulary for suggested values.",
"items": {
"type": "string"
},
"examples": [
[
"Director's Cut"
]
]
}
},
"description": "UpdateVersion defines what information may be provided to modify an\nexisting Version record. All field are required, pointers are used\nto indicate that a field was not provided. Normally we do not encourage\npointer usage for basic operations, but here an exception is being made."
},
"VersionPresentationMapping": {
"type": "object",
"properties": {
"presentationGnID": {
"type": "string"
},
"versionGnID": {
"type": "string"
}
}
},
"VersionPresentationMappingsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VersionPresentationMapping"
}
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"VocabResponse": {
"type": "object",
"properties": {
"data": {
"$ref": "#/components/schemas/GNVocabulary"
},
"meta": {
"$ref": "#/components/schemas/MetaResponse"
}
}
},
"errorType": {
"type": "string"
}
},
"responses": {
"badRequestError": {
"description": "BadRequestError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body must not be empty"
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"badRequestValidationError": {
"description": "BadRequestValidationError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"see fields for details."
]
},
"error": {
"type": "string",
"examples": [
"bad_request"
]
},
"fields": {
"type": "object",
"additionalProperties": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"examples": [
{
"subType": {
"error": "subType is a required field"
}
}
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
400
]
}
}
}
}
}
},
"conflictError": {
"description": "ConflictError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"forbiddenError": {
"description": "ForbiddenError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"cannot use title language \"cs\": not entitled"
]
},
"error": {
"type": "string",
"examples": [
"forbidden"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
403
]
}
}
}
}
}
},
"internalServerError": {
"description": "InternalServerError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"internal server error"
]
},
"error": {
"type": "string",
"examples": [
"internal_server_error"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
500
]
}
}
}
}
}
},
"notFoundError": {
"description": "NotFoundError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"Meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"\"foo-bar\""
]
}
}
},
"code": {
"type": "integer",
"format": "int64"
},
"description": {
"type": "string"
},
"error": {
"type": "string"
}
}
}
}
}
},
"requestEntityTooLargeError": {
"description": "RequestEntityTooLargeError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request size exceeds 25MB limit"
]
},
"error": {
"type": "string",
"examples": [
"request_entity_too_large"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
413
]
}
}
}
}
}
},
"requestReadTimeout": {
"description": "RequestReadTimeout",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request read timed out"
]
},
"error": {
"type": "string",
"examples": [
"request_read_timeout"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
598
]
}
}
}
}
}
},
"unauthorizedError": {
"description": "UnauthorizedError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"authentication failed"
]
},
"error": {
"type": "string",
"examples": [
"unauthorized"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
401
]
}
}
}
}
}
},
"unprocessableEntityError": {
"description": "UnprocessableEntityError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"presentation GN1234567890123 is already mapped to catalog"
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/catalogPrograms"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"unprocessableEntityErrorBulkMoviesPost": {
"description": "UnprocessableEntityErrorBulkMovies",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"validation errors"
]
},
"descriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"fields": {
"title.value": {
"error": "title value string exceeds the maximum length of 120"
}
},
"index": "roots[0].versions[0].presentations[0]",
"message": "title exceeds max length",
"type": "required_field"
},
{
"index": "roots[2].versions[1]",
"message": "user is not entitled to language \"fr\"",
"type": "entitlement_error"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/movies/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"81fcfc04-2182-4567-963f-5g0a9a629a15"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"unprocessableEntityErrorBulkPublish": {
"description": "UnprocessableEntityErrorBulkPublish",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"bulk publishing errors"
]
},
"descriptionDetails": {
"type": "array",
"description": "Possible type values: publishable_not_found, duplicate_publishable,publish requirements not met",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"fields": [
{
"error": "at least one genre must be provided before publishing.",
"field": "genres",
"level": "presentation"
},
{
"error": "releaseDate must be provided before publishing. if releaseYear is not specified.",
"field": "releaseDate",
"level": "presentation"
},
{
"error": "releaseYear must be provided before publishing. if releaseDate is not specified.",
"field": "releaseYear",
"level": "presentation"
}
],
"gnid": "GNXX00000XXXXXX",
"message": "publish requirements not met"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/publish"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"unprocessableEntityErrorBulkShowsPost": {
"description": "UnprocessableEntityErrorBulkShows",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"validation errors"
]
},
"descriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"fields": {
"title.value": {
"error": "title value string exceeds the maximum length of 150"
}
},
"index": "roots[0].versions[0].presentations[0]",
"message": "title exceeds max length",
"type": "required_field"
},
{
"index": "roots[2].versions[1]",
"message": "user is not entitled to language \"fr\"",
"type": "entitlement_error"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/bulk/shows/batches"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"73fdfc07-2182-4567-963f-5f0f9a621d15"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"unprocessableEntityErrorCatalogProgramsPatch": {
"description": "UnprocessableEntityErrorCatalogPrograms",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"mapping not found"
]
},
"descriptionDetails": {
"type": "array",
"description": "Possible type values: mapping_not_found",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"catalogGnID": "GNLZZXZ00000000",
"presentationGnID": "GN1234567890123",
"type": "mapping_not_found"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/catalogPrograms"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"unprocessableEntityErrorCatalogProgramsPost": {
"description": "UnprocessableEntityErrorCatalogPrograms",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"mapping not found"
]
},
"descriptionDetails": {
"type": "array",
"description": "Possible type values: duplicate_mapping, presentation_not_found, catalog_not_found, duplicate_mapping_request",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"catalogGnID": "GNLZZXZ00000000",
"presentationGnID": "GN1234567890123",
"type": "presentation_not_found"
},
{
"catalogGnID": "GNLZZXZ00000000",
"presentationGnID": "GN1234567890123",
"type": "catalog_not_found"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/catalogPrograms"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"unprocessableEntityErrorProgramImagesPatch": {
"description": "UnprocessableEntityErrorProgramImages",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"mapping conflicts"
]
},
"descriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "duplicate_mapping"
},
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "mapping_not_found"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/programImages"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"73fdfc07-2182-4567-963f-5f0f9a621d15"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"unprocessableEntityErrorProgramImagesPost": {
"description": "UnprocessableEntityErrorProgramImages",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"mapping conflicts"
]
},
"descriptionDetails": {
"type": "array",
"items": {
"type": "object",
"additionalProperties": {
"type": "object"
}
},
"examples": [
[
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "image_not_found"
},
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "presentation_not_found"
},
{
"imageGnID": "GN2345678901234",
"presentationGnID": "GN1234567890123",
"type": "duplicate_mapping"
}
]
]
},
"error": {
"type": "string",
"examples": [
"unprocessable_entity"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/programImages"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
422
]
}
}
}
}
}
},
"unsupportedMediaError": {
"description": "UnsupportedMediaError",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"description": {
"type": "string",
"examples": [
"request body contains badly-formed JSON"
]
},
"error": {
"type": "string",
"examples": [
"unsupported_media_type"
]
},
"instance": {
"type": "string",
"examples": [
"/api/v1/shows"
]
},
"meta": {
"type": "object",
"properties": {
"rayID": {
"type": "string",
"examples": [
"52fdfc07-2182-454f-963f-5f0f9a621d72"
]
}
}
},
"status": {
"type": "integer",
"format": "int64",
"examples": [
415
]
}
}
}
}
}
}
},
"securitySchemes": {
"api_key": {
"type": "apiKey",
"in": "header",
"name": "GN-APIKEY",
"description": "API key to authorize the request. Click Authorize and paste the key created for your application."
}
},
"parameters": {
"apiKeyParam": {
"name": "GN-APIKEY",
"in": "header",
"description": "API key to authorize the request.",
"required": true,
"schema": {
"type": "string",
"examples": [
"your-api-key"
]
}
}
}
},
"x-original-swagger-version": "2.0"
}