TheTVDB · Schema

AwardCategoryExtendedRecord

extended award category record

EntertainmentMoviesTelevisionMedia MetadataPublic APIsVideo

Properties

Name Type Description
allowCoNominees boolean
award object base award record
forMovies boolean
forSeries boolean
id integer
name string
nominees array
View JSON Schema on GitHub

JSON Schema

tvdb-award-category-extended-record-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tvdb/refs/heads/main/json-schema/tvdb-award-category-extended-record-schema.json",
  "title": "AwardCategoryExtendedRecord",
  "description": "extended award category record",
  "properties": {
    "allowCoNominees": {
      "type": "boolean",
      "x-go-name": "AllowCoNominees",
      "example": true
    },
    "award": {
      "description": "base award record",
      "properties": {
        "id": {
          "type": "integer",
          "example": 12345
        },
        "name": {
          "type": "string",
          "example": "Example Name"
        }
      },
      "type": "object",
      "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
    },
    "forMovies": {
      "type": "boolean",
      "x-go-name": "ForMovies",
      "example": true
    },
    "forSeries": {
      "type": "boolean",
      "x-go-name": "ForSeries",
      "example": true
    },
    "id": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "ID",
      "example": 12345
    },
    "name": {
      "type": "string",
      "example": "Example Name"
    },
    "nominees": {
      "items": {
        "description": "base award nominee record",
        "properties": {
          "character": {
            "description": "character record",
            "properties": {
              "aliases": {
                "items": {
                  "description": "An alias model, which can be associated with a series, season, movie, person, or list.",
                  "properties": {
                    "language": {
                      "type": "string",
                      "maximum": 4,
                      "description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
                      "example": "eng"
                    },
                    "name": {
                      "type": "string",
                      "maximum": 100,
                      "description": "A string containing the alias itself.",
                      "example": "Example Name"
                    }
                  },
                  "type": "object"
                },
                "type": "array",
                "x-go-name": "Aliases"
              },
              "episode": {
                "description": "base record info",
                "properties": {
                  "image": {
                    "type": "string",
                    "x-go-name": "Image",
                    "example": "https://artworks.thetvdb.com/banners/example.jpg"
                  },
                  "name": {
                    "type": "string",
                    "x-go-name": "Name",
                    "example": "Example Name"
                  },
                  "year": {
                    "type": "string",
                    "example": "2024"
                  }
                },
                "type": "object",
                "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
              },
              "episodeId": {
                "type": "integer",
                "nullable": true,
                "example": 12345
              },
              "id": {
                "format": "int64",
                "type": "integer",
                "x-go-name": "ID",
                "example": 12345
              },
              "image": {
                "type": "string",
                "example": "https://artworks.thetvdb.com/banners/example.jpg"
              },
              "isFeatured": {
                "type": "boolean",
                "x-go-name": "IsFeatured",
                "example": true
              },
              "movieId": {
                "type": "integer",
                "nullable": true,
                "example": 12345
              },
              "movie": {
                "description": "base record info",
                "properties": {
                  "image": {
                    "type": "string",
                    "x-go-name": "Image",
                    "example": "https://artworks.thetvdb.com/banners/example.jpg"
                  },
                  "name": {
                    "type": "string",
                    "x-go-name": "Name",
                    "example": "Example Name"
                  },
                  "year": {
                    "type": "string",
                    "example": "2024"
                  }
                },
                "type": "object",
                "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
              },
              "name": {
                "type": "string",
                "example": "Example Name"
              },
              "nameTranslations": {
                "items": {
                  "type": "string"
                },
                "type": "array",
                "x-go-name": "NameTranslations",
                "example": [
                  "example"
                ]
              },
              "overviewTranslations": {
                "items": {
                  "type": "string"
                },
                "type": "array",
                "x-go-name": "OverviewTranslations",
                "example": [
                  "example"
                ]
              },
              "peopleId": {
                "type": "integer",
                "example": 12345
              },
              "personImgURL": {
                "type": "string",
                "example": "https://artworks.thetvdb.com/banners/example.jpg"
              },
              "peopleType": {
                "type": "string",
                "example": "example"
              },
              "seriesId": {
                "type": "integer",
                "nullable": true,
                "example": 12345
              },
              "series": {
                "description": "base record info",
                "properties": {
                  "image": {
                    "type": "string",
                    "x-go-name": "Image",
                    "example": "https://artworks.thetvdb.com/banners/example.jpg"
                  },
                  "name": {
                    "type": "string",
                    "x-go-name": "Name",
                    "example": "Example Name"
                  },
                  "year": {
                    "type": "string",
                    "example": "2024"
                  }
                },
                "type": "object",
                "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
              },
              "sort": {
                "format": "int64",
                "type": "integer",
                "x-go-name": "Sort",
                "example": 12345
              },
              "tagOptions": {
                "items": {
                  "description": "tag option record",
                  "properties": {
                    "helpText": {
                      "type": "string",
                      "example": "example"
                    },
                    "id": {
                      "format": "int64",
                      "type": "integer",
                      "x-go-name": "ID",
                      "example": 12345
                    },
                    "name": {
                      "type": "string",
                      "x-go-name": "Name",
                      "example": "Example Name"
                    },
                    "tag": {
                      "format": "int64",
                      "type": "integer",
                      "x-go-name": "Tag",
                      "example": 12345
                    },
                    "tagName": {
                      "type": "string",
                      "x-go-name": "TagName",
                      "example": "example"
                    }
                  },
                  "type": "object",
                  "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
                },
                "type": "array",
                "x-go-name": "TagOptions"
              },
              "type": {
                "format": "int64",
                "type": "integer",
                "x-go-name": "Type",
                "example": 12345
              },
              "url": {
                "type": "string",
                "x-go-name": "URL",
                "example": "https://artworks.thetvdb.com/banners/example.jpg"
              },
              "personName": {
                "type": "string",
                "example": "example"
              }
            },
            "type": "object",
            "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
          },
          "details": {
            "type": "string",
            "example": "example"
          },
          "episode": {
            "description": "base episode record",
            "properties": {
              "absoluteNumber": {
                "type": "integer",
                "example": 1
              },
              "aired": {
                "type": "string",
                "example": "example"
              },
              "airsAfterSeason": {
                "type": "integer",
                "example": 1
              },
              "airsBeforeEpisode": {
                "type": "integer",
                "example": 1
              },
              "airsBeforeSeason": {
                "type": "integer",
                "example": 1
              },
              "finaleType": {
                "description": "season, midseason, or series",
                "type": "string",
                "example": "example"
              },
              "id": {
                "format": "int64",
                "type": "integer",
                "x-go-name": "ID",
                "example": 12345
              },
              "image": {
                "type": "string",
                "example": "https://artworks.thetvdb.com/banners/example.jpg"
              },
              "imageType": {
                "type": "integer",
                "nullable": true,
                "example": 1
              },
              "isMovie": {
                "format": "int64",
                "type": "integer",
                "x-go-name": "IsMovie",
                "example": 12345
              },
              "lastUpdated": {
                "type": "string",
                "example": "2024-01-15"
              },
              "linkedMovie": {
                "type": "integer",
                "example": 1
              },
              "name": {
                "type": "string",
                "example": "Example Name"
              },
              "nameTranslations": {
                "items": {
                  "type": "string"
                },
                "type": "array",
                "x-go-name": "NameTranslations",
                "example": [
                  "example"
                ]
              },
              "number": {
                "type": "integer",
                "example": 1
              },
              "overview": {
                "type": "string",
                "example": "A descriptive paragraph of text."
              },
              "overviewTranslations": {
                "items": {
                  "type": "string"
                },
                "type": "array",
                "x-go-name": "OverviewTranslations",
                "example": [
                  "example"
                ]
              },
              "runtime": {
                "type": "integer",
                "nullable": true,
                "example": 1
              },
              "seasonNumber": {
                "type": "integer",
                "example": 1
              },
              "seasons": {
                "items": {
                  "description": "season genre record",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 12345
                    },
                    "image": {
                      "type": "string",
                      "example": "https://artworks.thetvdb.com/banners/example.jpg"
                    },
                    "imageType": {
                      "type": "integer",
                      "example": 1
                    },
                    "lastUpdated": {
                      "type": "string",
                      "example": "2024-01-15"
                    },
                    "name": {
                      "type": "string",
                      "example": "Example Name"
                    },
                    "nameTranslations": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array",
                      "x-go-name": "NameTranslations",
                      "example": [
                        "example"
                      ]
                    },
                    "number": {
                      "format": "int64",
                      "type": "integer",
                      "x-go-name": "Number",
                      "example": 12345
                    },
                    "overviewTranslations": {
                      "items": {
                        "type": "string"
                      },
                      "type": "array",
                      "x-go-name": "OverviewTranslations",
                      "example": [
                        "example"
                      ]
                    },
                    "companies": {
                      "type": "object",
                      "description": "Companies by type record",
                      "properties": {
                        "studio": {
                          "type": "array",
                          "items": {
                            "description": "A company record",
                            "properties": {
                              "activeDate": {
                                "type": "string",
                                "example": "2024-01-15"
                              },
                              "aliases": {
                                "items": {
                                  "description": "An alias model, which can be associated with a series, season, movie, person, or list.",
                                  "properties": {
                                    "language": {
                                      "type": "string",
                                      "maximum": 4,
                                      "description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
                                      "example": "eng"
                                    },
                                    "name": {
                                      "type": "string",
                                      "maximum": 100,
                                      "description": "A string containing the alias itself.",
                                      "example": "Example Name"
                                    }
                                  },
                                  "type": "object"
                                },
                                "type": "array",
                                "x-go-name": "Aliases"
                              },
                              "country": {
                                "type": "string",
                                "example": "usa"
                              },
                              "id": {
                                "format": "int64",
                                "type": "integer",
                                "x-go-name": "ID",
                                "example": 12345
                              },
                              "inactiveDate": {
                                "type": "string",
                                "example": "2024-01-15"
                              },
                              "name": {
                                "type": "string",
                                "example": "Example Name"
                              },
                              "nameTranslations": {
                                "items": {
                                  "type": "string"
                                },
                                "type": "array",
                                "x-go-name": "NameTranslations",
                                "example": [
                                  "example"
                                ]
                              },
                              "overviewTranslations": {
                                "items": {
                                  "type": "string"
                                },
                                "type": "array",
                                "x-go-name": "OverviewTranslations",
                                "example": [
                                  "example"
                                ]
                              },
                              "primaryCompanyType": {
                                "format": "int64",
                                "type": "integer",
                                "x-go-name": "PrimaryCompanyType",
                                "nullable": true,
                                "example": 12345
                              },
                              "slug": {
                                "type": "string",
                                "x-go-name": "Slug",
                                "example": "example-slug"
                              },
                              "parentCompany": {
                                "type": "object",
                                "description": "A parent company record",
                                "properties": {
                                  "id": {
                                    "type": "integer",
                                    "nullable": true,
                                    "example": 12345
                                  },
                                  "name": {
                                    "type": "string",
                                    "example": "Example Name"
                                  },
                                  "relation": {
                                    "type": "object",
                                    "description": "A company relationship",
                                    "properties": {
                                      "id": {
                                        "type": "integer",
                                        "nullable": true,
                                        "example": 12345
                                      },
                                      "typeName": {
                                        "type": "string",
                                        "example": "example"
                                      }
                                    }
                                  }
                                }
                              },
                              "tagOptions": {
                                "items": {
                                  "description": "tag option record",
                                  "properties": {
                                    "helpText": {
                                      "type": "string",
                                      "example": "example"
                                    },
                                    "id": {
                                      "format": "int64",
                                      "type": "integer",
                                      "x-go-name": "ID",
                                      "example": 12345
                                    },
                                    "name": {
                                      "type": "string",
                                      "x-go-name": "Name",
                                      "example": "Example Name"
                                    },
                                    "tag": {
                                      "format": "int64",
                                      "type": "integer",
                                      "x-go-name": "Tag",
                                      "example": 12345
                                    },
                                    "tagName": {
                                      "type": "string",
                                      "x-go-name": "TagName",
                                      "example": "example"
                                    }
                                  },
                                  "type": "object",
                                  "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
                                },
                                "type": "array",
                                "x-go-name": "TagOptions"
                              }
                            },
                            "type": "object",
                            "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
                          }
                        },
                        "network": {
                          "type": "array",
                          "items": {
                            "description": "A company record",
                            "properties": {
                              "activeDate": {
                                "type": "string",
                                "example": "2024-01-15"
                              },
                              "aliases": {
                                "items": {
                                  "description": "An alias model, which can be associated with a series, season, movie, person, or list.",
                                  "properties": {
                                    "language": {
                                      "type": "string",
                                      "maximum": 4,
                                      "description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
                                      "example": "eng"
                                    },
                                    "name": {
                                      "type": "string",
                                      "maximum": 100,
                                      "description": "A string containing the alias itself.",
                                      "example": "Example Name"
                                    }
                                  },
                                  "type": "object"
                                },
                                "type": "array",
                                "x-go-name": "Aliases"
                              },
                              "country": {
                                "type": "string",
                                "example": "usa"
                              },
                              "id": {
                                "format": "int64",
                                "type": "integer",
                                "x-go-name": "ID",
                                "example": 12345
                              },
                              "inactiveDate": {
                                "type": "string",
                                "example": "2024-01-15"
                              },
                              "name": {
                                "type": "string",
                                "example": "Example Name"
                              },
                              "nameTranslations": {
                                "items": {
                                  "type": "string"
                                },
                                "type": "array",
                                "x-go-name": "NameTranslations",
                                "example": [
                                  "example"
                                ]
                              },
                              "overviewTranslations": {
                                "items": {
                                  "type": "string"
                                },
                                "type": "array",
                                "x-go-name": "OverviewTranslations",
                                "example": [
                                  "example"
                                ]
                              },
                              "primaryCompanyType": {
                                "format": "int64",
                                "type": "integer",
                                "x-go-name": "PrimaryCompanyType",
                                "nullable": true,
                                "example": 12345
                              },
                              "slug": {
                                "type": "string",
                                "x-go-name": "Slug",
                                "example": "example-slug"
                              },
                              "parentCompany": {
                                "type": "object",
                                "description": "A parent company record",
                                "properties": {
                                  "id": {
                                    "type": "integer",
                                    "nullable": true,
                                    "example": 12345
                                  },
                                  "name": {
                                    "type": "string",
                                    "example": "Example Name"
                                  },
                                  "relation": {
                                    "type": "object",
                                    "description": "A company relationship",
                                    "properties": {
                                      "id": {
                                        "type": "integer",
                                        "nullable": true,
                                        "example": 12345
                                      },
                                      "typeName": {
                                        "type": "string",
                                        "example": "example"
                                      }
                                    }
                                  }
                                }
                              },
                              "tagOptions": {
                                "items": {
                                  "description": "tag option record",
                                  "properties": {
                                    "helpText": {
                                      "type": "string",
                                      "example": "example"
                                    },
                                    "id": {
                                      "format": "int64",
                                      "type": "integer",
                                      "x-go-name": "ID",
                                      "example": 12345
                                    },
                                    "name": {
                                      "type": "string",
                                      "x-go-name": "Name",
                                      "example": "Example Name"
                                    },
                                    "tag": {
                                      "format": "int64",
                                      "type": "integer",
                                      "x-go-name": "Tag",
                                      "example": 12345
                                    },
                                    "tagName": {
                                      "type": "string",
                                      "x-go-name": "TagName",
                                      "example": "example"
                                    }
                                  },
                                  "type": "object",
                                  "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
                                },
                                "type": "array",
                                "x-go-name": "TagOptions"
                              }
                            },
                            "type": "object",
                            "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
                          }
                        },
                        "production": {
                          "type": "array",
                          "items": {
                            "description": "A company record",
                            "properties": {
                              "activeDate": {
                                "type": "string",
                                "example": "2024-01-15"
                              },
                              "aliases": {
                                "items": {
                                  "description": "An alias model, which can be associated with a series, season, movie, person, or list.",
                                  "properties": {
                                    "language": {
                                      "type": "string",
                                      "maximum": 4,
                                      "description": "A 3-4 character string indicating the language of the alias, as defined in Language.",
                                      "example": "eng"
                                    },
                                    "name": {
                                      "type": "string",
                                      "maximum": 100,
                                      "description": "A string containing the alias itself.",
                                      "example": "Example Name"
                                    }
                                  },
                                  "type": "object"
                                },
                                "type": "array",
                                "x-go-name": "Aliases"
                              },
                              "country": {
                                "type": "string",
                                "example": "usa"
                              },
                              "id": {
                                "format": "int64",
                                "type": "integer",
                                "x-go-name": "ID",
                                "example": 12345
                              },
                              "inactiveDate": {
                                "type": "string",
                                "example": "2024-01-15"
                              },
                              "name": {
                                "type": "string",
                                "example": "Example Name"
                              },
                              "nameTranslations": {
                                "items": {
                                  "type": "string"
                                },
                                "type": "array",
                                "x-go-name": "NameTranslations",
                                "example": [
                                  "example"
                                ]
                              },
                              "overviewTranslations": {
                                "items": {
                                  "type": "string"
                                },
                                "type": "array",
                                "x-go-name": "OverviewTranslations",
                                "example": [
                                  "example"
                          

# --- truncated at 32 KB (114 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/tvdb/refs/heads/main/json-schema/tvdb-award-category-extended-record-schema.json