TheTVDB · Schema

ArtworkExtendedRecord

extended artwork record

EntertainmentMoviesTelevisionMedia MetadataPublic APIsVideo

Properties

Name Type Description
episodeId integer
height integer
id integer
image string
includesText boolean
language string
movieId integer
networkId integer
peopleId integer
score number
seasonId integer
seriesId integer
seriesPeopleId integer
status object artwork status record
tagOptions array
thumbnail string
thumbnailHeight integer
thumbnailWidth integer
type integer The artwork type corresponds to the ids from the /artwork/types endpoint.
updatedAt integer
width integer
View JSON Schema on GitHub

JSON Schema

tvdb-artwork-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-artwork-extended-record-schema.json",
  "title": "ArtworkExtendedRecord",
  "description": "extended artwork record",
  "properties": {
    "episodeId": {
      "type": "integer",
      "example": 12345
    },
    "height": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Height",
      "example": 12345
    },
    "id": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "ID",
      "example": 12345
    },
    "image": {
      "type": "string",
      "x-go-name": "Image",
      "example": "https://artworks.thetvdb.com/banners/example.jpg"
    },
    "includesText": {
      "type": "boolean",
      "example": true
    },
    "language": {
      "type": "string",
      "example": "eng"
    },
    "movieId": {
      "type": "integer",
      "example": 12345
    },
    "networkId": {
      "type": "integer",
      "example": 12345
    },
    "peopleId": {
      "type": "integer",
      "example": 12345
    },
    "score": {
      "type": "number",
      "example": 100
    },
    "seasonId": {
      "type": "integer",
      "example": 12345
    },
    "seriesId": {
      "type": "integer",
      "example": 12345
    },
    "seriesPeopleId": {
      "type": "integer",
      "example": 12345
    },
    "status": {
      "description": "artwork status record",
      "properties": {
        "id": {
          "format": "int64",
          "type": "integer",
          "x-go-name": "ID",
          "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"
    },
    "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"
    },
    "thumbnail": {
      "type": "string",
      "x-go-name": "Thumbnail",
      "example": "example"
    },
    "thumbnailHeight": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "ThumbnailHeight",
      "example": 12345
    },
    "thumbnailWidth": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "ThumbnailWidth",
      "example": 12345
    },
    "type": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Type",
      "description": "The artwork type corresponds to the ids from the /artwork/types endpoint.",
      "example": 12345
    },
    "updatedAt": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "UpdatedAt",
      "example": "2024-01-15"
    },
    "width": {
      "format": "int64",
      "type": "integer",
      "x-go-name": "Width",
      "example": 12345
    }
  },
  "type": "object"
}