Commit bdb9c1fe authored by David Trattnig's avatar David Trattnig
Browse files

Merge branch 'master' of gitlab.servus.at:aura/meta

parents 11e100f3 16fe2cf0
......@@ -9,13 +9,13 @@ This page gives an overview of the Aura API Endpoints.
<!-- TOC -->
1. [API Specification](#api-specification)
1. [Program Scheduler API](#program-scheduler-api)
2. [Engine API](#engine-api)
3. [Tank API](#tank-api)
1. [Main API](#main-api)
2. [Authentication and other endpoints](#authentication-and-other-endpoints)
4. [CBA (Cultural Broadcasting Archive)](#cba-cultural-broadcasting-archive)
5. [Read more](#read-more)
1. [Program Scheduler API](#program-scheduler-api)
2. [Engine API](#engine-api)
3. [Tank API](#tank-api)
1. [Main API](#main-api)
2. [Authentication and other endpoints](#authentication-and-other-endpoints)
4. [CBA (Cultural Broadcasting Archive)](#cba-cultural-broadcasting-archive)
5. [Read more](#read-more)
<!-- /TOC -->
......@@ -32,7 +32,7 @@ The scheduler API is provided by the Aura Steering component. The Aura Dashboard
| Get schedules of a show | /api/v1/shows/1/schedules | | Array of schedule objects. | X | |
| Add schedule | /api/v1/shows/1/schedules/ | byweekday (int, mon 0 - sun 6), dstart (date), tstart (time), tend (time), until (date), is_repetition (bool), default_playlist_id (int), automation_id (int, deprecated), rrule (int, 1 - 13) | Schedule object | | | X |
| Update/Delete schedule | /api/v1/shows/1/schedules/1 | byweekday (int, mon 0 - sun 6), dstart (date), tstart (time), tend (time), until (date), is_repetition (bool), default_playlist_id (int), automation_id (int, deprecated), rrule (int, 1 - 13), add_days_no (int), add_business_days_only (bool) | Schedule object | | X | | X |
| Get timeslots of a show | /api/v1/shows/1/timeslots | start (date), end (date), limit (int), offset (int) | Array of timeslots objects. If start and end not given, a default timerange will be returned. Use limit and offset for pagination. | X | |
| Get timeslots of a show | /api/v1/shows/1/timeslots | start (date), end (date), limit (int), offset (int), surrounding (bool), order (string) | Array of timeslots objects. If start and end not given, a default timerange will be returned. Use limit and offset for pagination. `order` can be used to order by a specific field, default is start date descending. `surrounding` returns the 10 nearest timeslots for the current date | X | |
| Get timeslots | /api/v1/timeslots | start (date), end (date), limit (int), offset (int) | Array of timeslots objects. If start and end not given, a default timerange will be returned. Use limit and offset for pagination. | X | |
| Get timeslots by ID | /api/v1/timeslots/1 | | Timeslot object | X | |
| Update timeslot | /api/v1/shows/1/schedules/timeslots/1 | memo (string), playlist_id (int), is_repetition (boolean) | Timeslot object | | X | |
......@@ -150,4 +150,4 @@ Aura provides connectivity to [CBA](https://cba.fro.at/), which is an audio arch
* [Installation Guide](docs/administration/installation-guide.md)
* [Maintenance Guide](docs/administration/maintenance-guide.md)
* [API Specification](docs/development/api-definition.md)
* [Conflict Resolution](docs/administration/conflict-resolution.md)
\ No newline at end of file
* [Conflict Resolution](docs/administration/conflict-resolution.md)
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment