Public Api: Dokumentation: Unterschied zwischen den Versionen
| Zeile 55: | Zeile 55: | ||
|ja |
|ja |
||
|0 |
|0 |
||
| + | |Seitennummer |
||
| − | | |
||
|- |
|- |
||
|page.size |
|page.size |
||
| Zeile 61: | Zeile 61: | ||
|ja |
|ja |
||
|30 |
|30 |
||
| + | |Seitengröße |
||
| − | | |
||
|- |
|- |
||
|from |
|from |
||
| Zeile 67: | Zeile 67: | ||
|ja |
|ja |
||
| |
| |
||
| + | |Eventdatum von |
||
| − | | |
||
|- |
|- |
||
|to |
|to |
||
| Zeile 73: | Zeile 73: | ||
|ja |
|ja |
||
| |
| |
||
| + | |Eventdatum bis |
||
| − | | |
||
|- |
|- |
||
|channel |
|channel |
||
| Zeile 79: | Zeile 79: | ||
|ja |
|ja |
||
| |
| |
||
| + | |Channel |
||
| − | | |
||
|- |
|- |
||
|highlight |
|highlight |
||
| Zeile 85: | Zeile 85: | ||
|ja |
|ja |
||
| |
| |
||
| + | |Highlight |
||
| − | | |
||
|} |
|} |
||
| Zeile 110: | Zeile 110: | ||
|ja |
|ja |
||
|0 |
|0 |
||
| + | |Seitennummer |
||
| − | | |
||
|- |
|- |
||
|page.size |
|page.size |
||
| Zeile 116: | Zeile 116: | ||
|ja |
|ja |
||
|30 |
|30 |
||
| + | |Seitengröße |
||
| − | | |
||
|- |
|- |
||
|channel |
|channel |
||
| Zeile 122: | Zeile 122: | ||
|ja |
|ja |
||
| |
| |
||
| + | |Channel |
||
| − | | |
||
|} |
|} |
||
| Zeile 142: | Zeile 142: | ||
|ja |
|ja |
||
|0 |
|0 |
||
| + | |Seitennummer |
||
| − | | |
||
|- |
|- |
||
|page.size |
|page.size |
||
| Zeile 148: | Zeile 148: | ||
|ja |
|ja |
||
|30 |
|30 |
||
| + | |Seitengröße |
||
| − | | |
||
|- |
|- |
||
|channel |
|channel |
||
| Zeile 154: | Zeile 154: | ||
|ja |
|ja |
||
| |
| |
||
| + | |Channel |
||
| − | | |
||
|} |
|} |
||
| Zeile 176: | Zeile 176: | ||
|ja |
|ja |
||
|0 |
|0 |
||
| + | |Seitennummer |
||
| − | | |
||
|- |
|- |
||
|page.size |
|page.size |
||
| Zeile 182: | Zeile 182: | ||
|ja |
|ja |
||
|30 |
|30 |
||
| + | |Seitengröße |
||
| − | | |
||
|- |
|- |
||
|channel |
|channel |
||
| Zeile 188: | Zeile 188: | ||
|ja |
|ja |
||
| |
| |
||
| + | |Channel |
||
| − | | |
||
|} |
|} |
||
| Zeile 210: | Zeile 210: | ||
|ja |
|ja |
||
|0 |
|0 |
||
| + | |Seitennummer |
||
| − | | |
||
|- |
|- |
||
|page.size |
|page.size |
||
| Zeile 216: | Zeile 216: | ||
|ja |
|ja |
||
|30 |
|30 |
||
| + | |Seitengröße |
||
| − | | |
||
|- |
|- |
||
|channel |
|channel |
||
| Zeile 222: | Zeile 222: | ||
|ja |
|ja |
||
| |
| |
||
| + | |Channel |
||
| − | | |
||
|} |
|} |
||
=== By ID === |
=== By ID === |
||
Version vom 19. Juni 2019, 10:59 Uhr
Basics
URL
Die API ist unter https://copilot-office.de/$KUNDE/public/api zu erreichen.
Query Parameter Typen
string
Strings werden als Strings interpretiert. Beispiel: ?channel=A.
boolean
Es werden die Strings true und false unterstützt. Beispiel: ?highlight=false.
integer
Beispiel: ?page.page=2&page.size=30.
localdate
Datumsangaben erfolgen im ISO 8601 Format. Beispiel: ?from=2019-06-13.
Arrays
Bei der Verwendung von Arrays kann der Query Parameter mehrfach angegeben werden. Beispiel: ?channel=A&channel=B.
Pagination
Pagination funktioniert bei allen Endpunkten mit den Query Parametern page.page und page.size. Beispiel: https://copilot-office.de/$KUNDE/public/api/artists?page.page=2&page.size=30
Response
{
"content": [ ELEMENT1, ELEMENT2, ELEMENT3, ... ],
"totalElements":9386,
"totalPages":313
}
Channel
Bei der Verwendung von mehreren Webseiten können sog. Channels verwendet werden, um z.B. Künstler und Events auf mehrere Webseiten verteilt anzuzeigen.
API
Events
Basis URL
https://copilot-office.de/$KUNDE/public/api/events
Liste
https://copilot-office.de/$KUNDE/public/api/events/
| Parameter | Typ | Optional | Default | Beschreibung |
|---|---|---|---|---|
| page.page | integer | ja | 0 | Seitennummer |
| page.size | integer | ja | 30 | Seitengröße |
| from | localdate | ja | Eventdatum von | |
| to | localdate | ja | Eventdatum bis | |
| channel | string[] | ja | Channel | |
| highlight | boolean | ja | Highlight |
By ID
https://copilot-office.de/$KUNDE/public/api/events/{EVENT_ID}
Künstler
Basis URL
https://copilot-office.de/$KUNDE/public/api/artists
Liste
https://copilot-office.de/$KUNDE/public/api/artists/search
| Parameter | Typ | Optional | Default | Beschreibung |
|---|---|---|---|---|
| page.page | integer | ja | 0 | Seitennummer |
| page.size | integer | ja | 30 | Seitengröße |
| channel | string[] | ja | Channel |
By ID
https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}
Events
https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}/events
| Parameter | Typ | Optional | Default | Beschreibung |
|---|---|---|---|---|
| page.page | integer | ja | 0 | Seitennummer |
| page.size | integer | ja | 30 | Seitengröße |
| channel | string[] | ja | Channel |
Tour
Basis URL
https://copilot-office.de/$KUNDE/public/api/tours
Liste
https://copilot-office.de/$KUNDE/public/api/tours
| Parameter | Typ | Optional | Default | Beschreibung |
|---|---|---|---|---|
| page.page | integer | ja | 0 | Seitennummer |
| page.size | integer | ja | 30 | Seitengröße |
| channel | string[] | ja | Channel |
Venue
Basis URL
https://copilot-office.de/$KUNDE/public/api/venues
Liste
https://copilot-office.de/$KUNDE/public/api/venues
| Parameter | Typ | Optional | Default | Beschreibung |
|---|---|---|---|---|
| page.page | integer | ja | 0 | Seitennummer |
| page.size | integer | ja | 30 | Seitengröße |
| channel | string[] | ja | Channel |
By ID
https://copilot-office.de/$KUNDE/public/api/venues/{VENUE_ID}