[EPIC] Web API to meet radio requirements

Parent: [EPIC] Future-proof AURA API (aura#192 - closed)

List of suggestions based on requirements which popped up at the o94 Website integration. Details on implementation, naming schemes and parameters are subject to discuss -ion.

In some cases might me preferable to create relevant sub-tasks.

Episodes / Timeslots / Notes

DRAFT: These are all to be reviewed first:

  1. Optionally include note when returning timeslot
  2. Filter and pagination for episodes: a.) query by date and date range, b.) Pagination by providing a page-size, a page-number. There was an request to display "next" and "previous" buttons on the Episode Detail Page of the website. This could be realized by a page size of 1 and pagination.next/pagination.prev record references.
  3. Show details in Episode result: On Episode records provide some necessary show details, such as Show Title, Show Image and Show Slug - The most important Show details should be available on the Episode without doing an additional query
  4. Query/filter episodes with 0 results: There should be no error returned but a resultset with 0 records.
  5. Ascending order by default: The episodes should be provided ordered ascending by the API already. Allow setting different order by adding relevant parameter.
  6. Child records: "episode.note_title" should be "episode.note.title"
  7. Naming issues: Instead of episode.name, which holds the show name, it should be something like episode.show.name. Instead of episode.title, which holds the show title, it should be something like episode.show.title. Clarify the similarity of the terms, and if this field is in the AURA API at all. Maybe that's only an o94 legacy naming issue. Also check for existence of "episode.emmission_ID" - this should be "episode.timeslot_id", "episode.episode_id" or "episode.id" only.

Sub Tasks

Dependencies

Edited by David Trattnig