Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
aura-engine
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Lars Kruse
aura-engine
Commits
adcd6751
Commit
adcd6751
authored
5 years ago
by
David Trattnig
Browse files
Options
Downloads
Patches
Plain Diff
API Documentation.
parent
222fa269
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/engine-features.md
+8
-6
8 additions, 6 deletions
docs/engine-features.md
with
8 additions
and
6 deletions
docs/engine-features.md
+
8
−
6
View file @
adcd6751
...
...
@@ -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
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment