Skip to content
Snippets Groups Projects
Commit adcd6751 authored by David Trattnig's avatar David Trattnig
Browse files

API Documentation.

parent 222fa269
No related branches found
No related tags found
No related merge requests found
......@@ -50,14 +50,14 @@ fallback handling scenarios. The available fallbacks are evaluated in following
Note: All filenames in the music folder should be ASCII encoded, otherwise this may cause engine failures.
# Track-Service API
## API Endpoints
The Track Service API provides following endpoints:
**Track Service API**: These endpoints provide information on the played tracks, their schedules and shows.
* `/api/v1/` ............. Returns all Track Service entries for the last three hours
* `/api/v1/` ............. Returns all Track Service entries for the current day
* `/api/v1/$ID` .......... Returns a Track Service entry by ID
* `/api/v1/current` ...... Returns the currently playing track
* `/api/v1/day/$DAY` ..... Returns the tracks for a given day formated as `YYYY-MM-DD`
* `/api/v1/current` ...... Returns the track currently playing
* `/api/v1/day/$DAY` ..... Returns all tracks for a given day formated as `YYYY-MM-DD`
The Swagger Specification of a Track Service entry as YAML looks like this:
......@@ -82,4 +82,6 @@ The Swagger Specification of a Track Service entry as YAML looks like this:
paths: {}
```
# Programme API
\ No newline at end of file
**Reporting API**: Create monthly reports using this endpoint.
* `api/v1/report/$MONTH` ...... Returns all playout details for the given month in the format `YYYY-MM`
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment