← Go back

Finding the titles for a licensor using the API

September 18th, 2014 (Revision 1), download as PDF

In the Catalogue and Schedule pages it’s easy to find the Titles for a given Licensor, we’ve added that capability to BeBanjo’s Application Programming Interface (API).

This note describes what has changed in full, and as usual you can contact support or your technical account manager for further clarification.

Licensor resource

This change doesn’t affect the user interface, but will be useful if you integrate your systems (e.g. a reporting application) with BeBanjo using its API. When you retrieve a Licensor using the API you’ll notice a new titles link:

<licensor>
  <id type="integer">1781</id>
  <name>Curzon Home Cinema</name>
  <link rel="self" href="https://movida.bebanjo.net/api/licensors/1781"/>
  <link rel="titles" href="https://movida.bebanjo.net/api/licensors/1781/titles"/>
</licensor>

Following that link will retrieve all of the Titles for that Licensor. Please note that the titles resource is paginated and will return 50 results per page like this:

<titles type="array">
  <total‐entries>479</total‐entries>
  <link rel="next" href="https://movida.bebanjo.net/api/licensors/1781/titles?page=2"/>
  <title>
    <id type="integer">251272</id>
    <name>Beware of Mr. Baker</name>
    <title>Beware of Mr. Baker</title>
    <external‐id nil="true"/>
    <title‐type>feature</title‐type>
    <tags></tags>
    <link rel="self" href="https://movida.bebanjo.net/api/titles/251272"/>
    <link rel="schedule" href="https://movida.bebanjo.net/api/titles/251272/schedule"/>
    <link rel="availability_windows" href="https://movida.bebanjo.net/api/titles/251272/availability_windows"/>
    <link rel="title_groups" href="https://movida.bebanjo.net/api/titles/251272/title_groups"/>
    <link rel="licensor" href="https://movida.bebanjo.net/api/licensors/1781"/>
    <link rel="images" href="https://movida.bebanjo.net/api/titles/251272/images"/>
    <link rel="assets" href="https://movida.bebanjo.net/api/titles/251272/assets"/>
    <link rel="metadata" href="https://movida.bebanjo.net/api/titles/251272/metadata"/>
    <link rel="blackouts" href="https://movida.bebanjo.net/api/titles/251272/blackouts"/>
    <link rel="rights" href="https://movida.bebanjo.net/api/titles/251272/rights"/>
    <link rel="trailers" href="https://movida.bebanjo.net/api/titles/251272/trailers"/>
  </title>
  <!-- ... -->
</titles>

In this example you can see that there are 479 Titles in total for the Licensor, and a next link is provided to retrieve the next 50.

Reference

movida#2518 Provide an API link from Licensor to Titles