Public Api: Dokumentation: Unterschied zwischen den Versionen

Aus co*pilot Wiki
Zur Navigation springen Zur Suche springen
Zeile 1: Zeile 1:
  +
= Basics =
  +
 
== URL ==
  
== URL ==
 
Die API ist unter <code><nowiki>https://copilot-office.de/$KUNDE/public/api</nowiki></code> zu erreichen.
 
Die API ist unter <code><nowiki>https://copilot-office.de/$KUNDE/public/api</nowiki></code> zu erreichen.
Zeile 12: Zeile 14:
 
=== integer ===
  
=== integer ===
 
Beispiel: <code>?page.page=2&page.size=30</code>.
  
Beispiel: <code>?page.page=2&page.size=30</code>.
  +
  +
=== localdate ===
  +
Datumsangaben erfolgen im ISO 8601 Format. Beispiel: <code>2019-06-13</code>.
   
 
=== Arrays ===
  
=== Arrays ===
−
Bei der Verwendung von Arrays kann der Query Parameter mehrfach angegeben werden. Beispiel: <code>?channel=A&channgel=B</code>.
 +
Bei der Verwendung von Arrays kann der Query Parameter mehrfach angegeben werden. Beispiel: <code>?channel=A&channel=B</code>.
   
 
== Pagination ==
  
== Pagination ==
Zeile 25: Zeile 30:
 
"totalPages":313
  
"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 ==
  
== Events ==
Zeile 105: Zeile 115:
 
=== By ID ===
  
=== By ID ===
 
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}</nowiki></code>
  
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}</nowiki></code>
  +
  +
=== Events ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}/events</nowiki></code>
  +
{| class="wikitable"
  +
|+Query Parameter
  +
!Parameter
  +
!Typ
  +
!Optional
  +
!Default
  +
!Beschreibung
  +
|-
  +
|page.page
  +
|integer
  +
|ja
  +
|0
  +
|
  +
|-
  +
|page.size
  +
|integer
  +
|ja
  +
|30
  +
|
  +
|-
  +
|channel
  +
|string[]
  +
|ja
  +
|
  +
|
  +
|}
  +
  +
== Tour ==
  +
  +
=== Basis URL ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/tours</nowiki></code>
  +
  +
=== Liste ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/tours</nowiki></code>
  +
{| class="wikitable"
  +
|+Query Parameter
  +
!Parameter
  +
!Typ
  +
!Optional
  +
!Default
  +
!Beschreibung
  +
|-
  +
|page.page
  +
|integer
  +
|ja
  +
|0
  +
|
  +
|-
  +
|page.size
  +
|integer
  +
|ja
  +
|30
  +
|
  +
|-
  +
|channel
  +
|string[]
  +
|ja
  +
|
  +
|
  +
|}

Version vom 19. Juni 2019, 11:39 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: 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/

Query Parameter
Parameter Typ Optional Default Beschreibung
page.page integer ja 0
page.size integer ja 30
channel string[] ja
highlight boolean ja

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

Query Parameter
Parameter Typ Optional Default Beschreibung
page.page integer ja 0
page.size integer ja 30
channel string[] ja

By ID

https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}

Events

https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}/events

Query Parameter
Parameter Typ Optional Default Beschreibung
page.page integer ja 0
page.size integer ja 30
channel string[] ja

Tour

Basis URL

https://copilot-office.de/$KUNDE/public/api/tours

Liste

https://copilot-office.de/$KUNDE/public/api/tours

Query Parameter
Parameter Typ Optional Default Beschreibung
page.page integer ja 0
page.size integer ja 30
channel string[] ja
Abgerufen von „https://wiki.copilot-office.de/index.php?title=Public_Api:_Dokumentation&oldid=578“