We use cookies (just for analytics) on this website. If you continue we will assume you are happy with it. ok

BeBanjo

Back to index

Schedule

Note: This resource links can be expanded using the expand option

The schedule contains all the scheduled titles for a given title, title_group or platform.

This is how the schedule, as seen from a platform looks:

<?xml version='1.0' encoding='utf-8' ?>
<schedule>
  <link href="https://movida.bebanjo.net/api/platforms/1/schedule/schedulings" rel="schedulings"></link>
  <link href="https://movida.bebanjo.net/api/platforms/1" rel="platform"></link>
</schedule>

This is how it would look, if you would access the schedule of a title group:

<?xml version='1.0' encoding='utf-8' ?>
<schedule>
  <link href="https://movida.bebanjo.net/api/title_groups/181/schedule/schedulings" rel="schedulings"></link>
  <link href="https://movida.bebanjo.net/api/title_groups/181" rel="title_group"></link>
</schedule>

And finally, from a title:

<?xml version='1.0' encoding='utf-8' ?>
<schedule>
  <link href="https://movida.bebanjo.net/api/titles/578/schedule/schedulings" rel="schedulings"></link>
  <link href="https://movida.bebanjo.net/api/titles/578" rel="title"></link>
</schedule>

Notice how, in each case, it references its scope; whether you are looking at the schedule of a platform, a title or a title group.

Most of the time you access the schedule it will be to take a look at its schedulings. Remember you can use the expand parameter in the same request to obtain the schedulings in the same response.

$ curl --digest -u bapi https://movida.bebanjo.net/api/titles/578/schedule?expand=schedulings

Would yield something like:

<?xml version='1.0' encoding='utf-8' ?>
<schedule>
  <link href="https://movida.bebanjo.net/api/titles/578/schedule/schedulings" rel="schedulings">
    <schedulings type="array">
    ...
    </schedulings>
  </link>
  <link href="https://movida.bebanjo.net/api/titles/578" rel="title"></link>
</schedule>

Browsing all schedules at once

Also if you would want to browse the whole schedule for many platforms at once, you would be able to do it from the root resource (https://movida.bebanjo.net/api/schedule). This time, the schedule is not scoped like in the examples above.

<?xml version="1.0" encoding="UTF-8"?>
<schedule>
  <link rel="schedulings" href="https://staging-movida.bebanjo.net/api/schedule/schedulings"/>
</schedule>

However, when browsing the schedule, it’s not possibe to expand in the same request its schedulings.

<link href="https://staging-movida.bebanjo.net/api/schedule/schedulings" rel="schedulings"/>

To see all the schedule’s schedulings, you would to issue a new request to the schedulings link. And its response, unlike with titles, title_groups, or platforms’ schedules, will be paginated:

$ curl --digest -u bapi https://movida.bebanjo.net/api/schedule/schedulings
<?xml version="1.0" encoding="UTF-8"?>
<schedulings type="array">
  <total-entries>125000</total-entries>
  <link href="https://staging-movida.bebanjo.net/api/schedule/schedulings?after=12345" rel="next"/>
  <scheduling>
    ...
  </scheduling>
  ...
</schedulings>

Last updated September 19th, 2017.