v1

latestOpenAPI 3.0.12026-08-06135498863.0 KB
Films

Gets a film entity by its unique identifier

Returns a detailed film and its related data based on the provided filmId.

Licenses Required

  • Vista.Ocapi
get/ocapi/v1/films/{filmId}

Path parameters

filmIdstring required

The unique identifier of the film

Headers

Connect-Region-Codestring

Region Code

Response

Success

Example response

{
  "film": {
    "title": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    },
    "synopsis": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    },
    "shortSynopsis": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    },
    "censorRatingNote": {
      "translations": [
        {
          "languageTag": "en-US"
        }
      ]
    }
  },
  "relatedData": {
    "genres": [
      {
        "name": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        },
        "description": {
          "translations": [
            {
              "languageTag": "en-US"
            }
          ]
        }
      }
    ],
    "censorRating": {
      "classification": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "classificationDescription": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    },
    "event": {
      "name": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "shortName": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      },
      "description": {
        "translations": [
          {
            "languageTag": "en-US"
          }
        ]
      }
    }
  }
}