MXF API Use Cases

List of Use Case

  1. Retrieve the releaseId
  2. Retrieve a list of media for a release
  3. Retrieve a specific media
  4. Retrieve a list of releases for a territory
  5. Retrieve information about a release

Retrieve the releaseId.

  1. GET /v2/releases/search
  • Pass in the title in the 'titleterm' parameter.
  • This will return a list of list of possible matches.
  • Grab the Id from the best match and use that to do the following call (this will also contain a link to one of the smaller versions of the current poster)

Retrieve a list of media for a release.

  1. GET /v2/releases/search
  • Pass in the title in the 'titleterm' parameter.
  • This will return a list of list of possible matches.
  • Grab the 'Release Id' from the best match and use that to do the following call (this will also contain a link to one of the smaller versions of the current poster)
  1. GET /v2/release/{releaseId}/media
  • Use the 'Release Id'.
  • OPTIONAL: Can also specify the media roles you want back ie: poster, still, backdrop etc.
  • This will return a list of media items and you can filter the response.

Retrieve a specific media ie. poster/still/backdrop etc.

  1. GET /v2/releases/search
  • Pass in the title in the 'titleterm' parameter.
  • This will return a list of possible matches.
  • Grab the 'Release Id' from the best match and use that to do the following call (this will also contain a link to one of the smaller versions of the current poster)
  1. GET /v2/release/{releaseId}/media
  • Use the 'Release Id'.
  • OPTIONAL: Can also specify the media roles you want back ie: poster, still, backdrop etc.
  • This will return a list of media items and you can filter the response.
  • Get the 'Media Id' of the media item you want and call
  1. GET /v2/media
  • Passing in the 'Media Id' into the id parameter.
  • With this call you will be able to download the media and then host it where ever you would need to use it from.

Retrieve a list of releases for a territory.

  1. GET /v2/releases/?territory={territoryCode}
  • Pass in the 'territory code' in the territory parameter.
  • This will return a list of all releases for the territory.

Retrieve information about a release.

  1. GET /v2/releases/search
  • Pass in the title in the 'titleterm' parameter.
  • This will return a list of possible matches.
  • Grab the 'Release Id' from the best match and use that to do the following call.
  1. GET /v2/releases/{releaseId}
  • Pass in the 'Release Id' here and it will return the full release object (that will also contain all the release information).