|
**PV Scheduler**
|
|
**PV Scheduler**
|
|
|
|
|
|
| Purpose | Endpoint | Variables | Return value | GET | PUT | POST |
|
|
| Purpose | Endpoint | Variables | Return value | GET | PUT | POST | DELETE |
|
|
| ------- | -------- | --------- | ------------ | :------: | :------: | :-------: |
|
|
| ------- | -------- | --------- | ------------ | :------: | :------: | :-------: | :-------: |
|
|
| Get all shows of a user | /api/v1/shows/ | active (bool) | Array of show objects. If active is true, only currently running shows will be returned. | X | |
|
|
| Get shows | /api/v1/shows/ | active (bool) | Array of show objects. If active is true, only currently running shows will be returned. | X | | | |
|
|
| Get show by ID | /api/v1/shows/1 | | Show object | X | |
|
|
| Get show by ID | /api/v1/shows/1 | | Show object | X | |
|
|
| Add show | /api/v1/shows/ | name, slug, image, logo, short_description, description, email, website, cba_series_id, fallback_id, type_id (int), rtrcategory_id (int), predecessor_id (int), cba_series_id (int), category (array), hosts (array), language (array), topic (array), musicfocus (array), owners (array) | | | | X |
|
|
| Add show | /api/v1/shows/ | name, slug, image, logo, short_description, description, email, website, cba_series_id, fallback_id, type_id (int), rtrcategory_id (int), predecessor_id (int), cba_series_id (int), category (array), hosts (array), language (array), topic (array), musicfocus (array), owners (array) | | | | X |
|
|
| Update show | /api/v1/shows/1 | name, slug, image, logo, short_description, description, email, website, cba_series_id, fallback_id, type_id (int), rtrcategory_id (int), predecessor_id (int), cba_series_id (int), category (array), hosts (array), language (array), topic (array), musicfocus (array), owners (array) | | | X |
|
|
| Update/Delete show | /api/v1/shows/1 | name, slug, image, logo, short_description, description, email, website, cba_series_id, fallback_id, type_id (int), rtrcategory_id (int), predecessor_id (int), cba_series_id (int), category (array), hosts (array), language (array), topic (array), musicfocus (array), owners (array) | | | X | | X |
|
|
| Get schedules of a show | /api/v1/shows/1/schedules | | Array of schedule objects. | X | |
|
|
| 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), fallback_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), fallback_id (int), automation_id (int, deprecated), rrule (int, 1 - 13) | Schedule object | | X | | X |
|
|
| Get timeslots of a show | /api/v1/shows/1/timeslots | start (date), end (date) | Array of timeslots objects. If start and end not given, a default timerange will be returned. | X | |
|
|
| Get timeslots of a show | /api/v1/shows/1/timeslots | start (date), end (date) | Array of timeslots objects. If start and end not given, a default timerange will be returned. | X | |
|
|
| Get timeslots of a show | /api/v1/timeslots | show_id (int), start (date), end (date) | Array of timeslots objects. If start and end not given, a default timerange will be returned. | X | |
|
|
| Get timeslots | /api/v1/timeslots | start (date), end (date) | Array of timeslots objects. If start and end not given, a default timerange will be returned. | X | |
|
|
| Get timeslots by ID | /api/v1/timeslots/1 | | Timeslot object | X | |
|
|
| Get timeslots by ID | /api/v1/timeslots/1 | | Timeslot object | X | |
|
|
| Update timeslot | /api/v1/timeslots/1 | id (int), memo (string), playlist_id (int), is_repetition (boolean) | Timeslot object | | X |
|
|
| Update timeslot | /api/v1/shows/1/schedules/timeslots/1 | memo (string), playlist_id (int), is_repetition (boolean) | Timeslot object | | X | |
|
|
| Get notes by ID | /api/v1/notes/1 | ids (comma separated integer values) | Array of note objects | X | |
|
|
| Get notes by ID | /api/v1/notes/1 | ids (comma separated integer values) | Array of note objects | X | |
|
|
| Add note | /api/v1/notes | show (int), timeslot (int), title, slug, summary, content, image, status (0 = cancellation, 1 = recommendation, 2 = repetition), cba_id (int) | | | | X |
|
|
| Get notes by show | /api/v1/shows/1/notes/ | ids (comma separated integer values) | Array of note objects | X | |
|
|
| Update note | /api/v1/notes/1 | show (int), timeslot (int), title, slug, summary, content, image, status (0 = cancellation, 1 = recommendation, 2 = repetition), cba_id (int) | Note object | | X |
|
|
| Get note by timeslot | /api/v1/shows/1/schedules/1/timeslots/1/notes/ | | Array of note objects | X | |
|
|
|
|
| Add note | /api/v1/shows/1/schedules/1/timeslots/1/notes | title, slug, summary, content, image, status (0 = cancellation, 1 = recommendation, 2 = repetition), cba_id (int) | | | | X |
|
|
|
|
| Update/Delete note | /api/v1/shows/1/schedules/1/timeslots/1/notes/1 | title, slug, summary, content, image, status (0 = cancellation, 1 = recommendation, 2 = repetition), cba_id (int) | Note object | | X | | X |
|
|
| Get user | /api/v1/users/1 | | User object | X | |
|
|
| Get user | /api/v1/users/1 | | User object | X | |
|
|
| Add user | /api/v1/users/1 | | first_name (str), last_name (str), email (str), cba_username (str), cba_user_token (str), is_superuser (bool), is_staff (bool), is_active (bool), groups (array), user_permissions (array) | | | X |
|
|
| Add user | /api/v1/users/1 | | first_name (str), last_name (str), email (str), cba_username (str), cba_user_token (str), is_superuser (bool), is_staff (bool), is_active (bool), groups (array), user_permissions (array) | | | X |
|
|
| Update user | /api/v1/users/1 | first_name (str), last_name (str), email (str), cba_username (str), cba_user_token (str), is_superuser (bool), is_staff (bool), is_active (bool), groups (array), user_permissions (array) | User object | | X |
|
|
| Update user | /api/v1/users/1 | first_name (str), last_name (str), email (str), cba_username (str), cba_user_token (str), is_superuser (bool), is_staff (bool), is_active (bool), groups (array), user_permissions (array) | User object | | X |
|
... | @@ -24,27 +28,27 @@ |
... | @@ -24,27 +28,27 @@ |
|
| Get types | /api/v1/types | | Array of type objects | X | | |
|
|
| Get types | /api/v1/types | | Array of type objects | X | | |
|
|
| Get type by ID | /api/v1/types/1 | | Type object | X | | |
|
|
| Get type by ID | /api/v1/types/1 | | Type object | X | | |
|
|
| Add type | /api/v1/types | type (str), slug (str), color (str), text_color (str), enabled (int) | | | | X
|
|
| Add type | /api/v1/types | type (str), slug (str), color (str), text_color (str), enabled (int) | | | | X
|
|
| Update type | /api/v1/types/1 | type (str), slug (str), color (str, e.g. '#FFFFFF'), text_color (str, e.g. '#000000'), enabled (bool) | | | X | |
|
|
| Update type | /api/v1/types/1 | type (str), slug (str), color (str, e.g. '#FFFFFF'), text_color (str, e.g. '#000000'), enabled (bool) | | | X | | X |
|
|
| Get topics | /api/v1/topics | | Array of topic objects | X | | |
|
|
| Get topics | /api/v1/topics | | Array of topic objects | X | | |
|
|
| Get topic by ID | /api/v1/topics/1 | | Topic object | X | | |
|
|
| Get topic by ID | /api/v1/topics/1 | | Topic object | X | | |
|
|
| Add topic | /api/v1/topics | topic (str), abbrev (str), slug (str) | | | | X
|
|
| Add topic | /api/v1/topics | topic (str), abbrev (str), slug (str) | | | | X
|
|
| Update topic | /api/v1/topics/1 | topic (str), abbrev (str), slug (str) | | | X | |
|
|
| Update/Delete topic | /api/v1/topics/1 | topic (str), abbrev (str), slug (str) | | | X | | X |
|
|
| Get music focuses | /api/v1/musicfocus | | Array of musicfocus objects | X | | |
|
|
| Get music focuses | /api/v1/musicfocus | | Array of musicfocus objects | X | | |
|
|
| Get music focus by ID | /api/v1/musicfocus/1 | | Musicfocus object | X | | |
|
|
| Get music focus by ID | /api/v1/musicfocus/1 | | Musicfocus object | X | | |
|
|
| Add music focus | /api/v1/musicfocus | focus (str), abbrev (str), slug (str) | | | | X
|
|
| Add music focus | /api/v1/musicfocus | focus (str), abbrev (str), slug (str) | | | | X
|
|
| Update music focus | /api/v1/musicfocus/1 | focus (str), abbrev (str), slug (str) | | | X | |
|
|
| Update/Delete music focus | /api/v1/musicfocus/1 | focus (str), abbrev (str), slug (str) | | | X | | X |
|
|
| Get RTR categories | /api/v1/rtrcategories | | Array of rtrcategory objects | X | | |
|
|
| Get RTR categories | /api/v1/rtrcategories | | Array of rtrcategory objects | X | | |
|
|
| Get RTR category by ID | /api/v1/rtrcategories/1 | | RTRCategory object | X | | |
|
|
| Get RTR category by ID | /api/v1/rtrcategories/1 | | RTRCategory object | X | | |
|
|
| Add RTR category | /api/v1/rtrcategories | rtrcategory (str), abbrev (str), slug (str) | | | | X
|
|
| Add RTR category | /api/v1/rtrcategories | rtrcategory (str), abbrev (str), slug (str) | | | | X
|
|
| Update RTR category | /api/v1/rtrcategories/1 | rtrcategory (str), abbrev (str), slug (str) | | | X | |
|
|
| Update RTR category | /api/v1/rtrcategories/1 | rtrcategory (str), abbrev (str), slug (str) | | | X | | X |
|
|
| Get languages | /api/v1/languages | | Array of language objects | X | | |
|
|
| Get languages | /api/v1/languages | | Array of language objects | X | | |
|
|
| Get language by ID | /api/v1/languages/1 | | Language object | X | | |
|
|
| Get language by ID | /api/v1/languages/1 | | Language object | X | | |
|
|
| Add language | /api/v1/topics | name (str), abbrev (str), slug (str) | | | | X
|
|
| Add language | /api/v1/topics | name (str), abbrev (str), slug (str) | | | | X
|
|
| Update language | /api/v1/languages/1 | name (str), abbrev (str), slug (str) | | | X | |
|
|
| Update language | /api/v1/languages/1 | name (str), abbrev (str), slug (str) | | | X | | X |
|
|
| Get hosts | /api/v1/hosts | | Array of host objects | X | | |
|
|
| Get hosts | /api/v1/hosts | | Array of host objects | X | | |
|
|
| Get host by ID | /api/v1/hosts/1 | | Host object | X | | |
|
|
| Get host by ID | /api/v1/hosts/1 | | Host object | X | | |
|
|
| Add host | /api/v1/hosts | name (str), email (str), website (str), biography (str), googleplus_url (str), facebook_url (str), twitter_url (str), linkedin_url (str), youtube_url (str), dorftv_url (str), cba_url (str), image | | | | X
|
|
| Add host | /api/v1/hosts | name (str), email (str), website (str), biography (str), googleplus_url (str), facebook_url (str), twitter_url (str), linkedin_url (str), youtube_url (str), dorftv_url (str), cba_url (str), image | | | | X
|
|
| Update host | /api/v1/hosts/1 | name (str), email (str), website (str), biography (str), googleplus_url (str), facebook_url (str), twitter_url (str), linkedin_url (str), youtube_url (str), dorftv_url (str), cba_url (str), image | | | X | |
|
|
| Update/Delete host | /api/v1/hosts/1 | name (str), email (str), website (str), biography (str), googleplus_url (str), facebook_url (str), twitter_url (str), linkedin_url (str), youtube_url (str), dorftv_url (str), cba_url (str), image | | | X | | X |
|
|
| Get daily program | /api/v1/program/ | date (date) | If date is not given, today will be returned. Array of objects | X | |
|
|
| Get daily program | /api/v1/program/ | date (date) | If date is not given, today will be returned. Array of objects | X | |
|
|
| Playout API | /api/v1/playout | start (date), end (date) | If start and end not given, the next 24 hours will be returned. Array of objects. Fields: timeslot_id (int), timeslot_start (datetime), timeslot_end (datetime), show_id (string), show_name (string), show_hosts (string), rtrcategory (string), playlist_id (int), schedule_fallback_id (int), show_fallback_id (int), station_fallback_id (int), is_repetition (bool), memo (string), languages (string), type (string), category (string), topic (string), music_focus (string) | X | |
|
|
| Playout API | /api/v1/playout | start (date), end (date) | If start and end not given, the next 24 hours will be returned. Array of objects. Fields: timeslot_id (int), timeslot_start (datetime), timeslot_end (datetime), show_id (string), show_name (string), show_hosts (string), rtrcategory (string), playlist_id (int), schedule_fallback_id (int), show_fallback_id (int), station_fallback_id (int), is_repetition (bool), memo (string), languages (string), type (string), category (string), topic (string), music_focus (string) | X | |
|
|
| FRAPP API | /api/frapp/ | date (date) | If date not given, today will be returned. Array of objects | X | |
|
|
| FRAPP API | /api/frapp/ | date (date) | If date not given, today will be returned. Array of objects | X | |
|
... | | ... | |