TheTVDB · JSON Structure

Tvdb List Extended Record Structure

extended list record

Type: object Properties: 12
EntertainmentMoviesTelevisionMedia MetadataPublic APIsVideo

ListExtendedRecord is a JSON Structure definition published by TheTVDB, describing 12 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

aliases entities id image imageIsFallback isOfficial name nameTranslations overview overviewTranslations score url

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tvdb/refs/heads/main/json-structure/tvdb-list-extended-record-structure.json",
  "name": "ListExtendedRecord",
  "description": "extended list 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"
    },
    "entities": {
      "items": {
        "description": "Entity record",
        "properties": {
          "movieId": {
            "type": "int32",
            "example": 12345
          },
          "order": {
            "type": "int64",
            "x-go-name": "Order",
            "example": 12345
          },
          "seriesId": {
            "type": "int32",
            "example": 12345
          }
        },
        "type": "object",
        "x-go-package": "github.com/whip-networks/tvdb-api-v4-core/tvdb-api-v4-core/pkg/model"
      },
      "type": "array",
      "x-go-name": "Entities"
    },
    "id": {
      "type": "int64",
      "x-go-name": "ID",
      "example": 12345
    },
    "image": {
      "type": "string",
      "example": "https://artworks.thetvdb.com/banners/example.jpg"
    },
    "imageIsFallback": {
      "type": "boolean",
      "example": true
    },
    "isOfficial": {
      "type": "boolean",
      "x-go-name": "IsOfficial",
      "example": true
    },
    "name": {
      "type": "string",
      "example": "Example Name"
    },
    "nameTranslations": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "NameTranslations",
      "example": [
        "example"
      ]
    },
    "overview": {
      "type": "string",
      "example": "A descriptive paragraph of text."
    },
    "overviewTranslations": {
      "items": {
        "type": "string"
      },
      "type": "array",
      "x-go-name": "OverviewTranslations",
      "example": [
        "example"
      ]
    },
    "score": {
      "type": "int64",
      "x-go-name": "Score",
      "example": 100
    },
    "url": {
      "type": "string",
      "example": "https://artworks.thetvdb.com/banners/example.jpg"
    }
  },
  "type": "object"
}