Public Api: Dokumentation: Unterschied zwischen den Versionen

Aus co*pilot Wiki
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „Test“)
 
Zeile 1: Zeile 1:
  +
== URL ==
−
Test
  
  +
Die API ist unter <code><nowiki>https://copilot-office.de/$KUNDE/public/api</nowiki></code> zu erreichen.
  +
  +
== Query Parameter Typen ==
  +
  +
=== string ===
  +
Strings werden als Strings interpretiert. Beispiel: <code>?channel=A</code>.
  +
  +
=== boolean ===
  +
Es werden die Strings <code>true</code> und <code>false</code> unterstützt. Beispiel: <code>?highlight=false</code>.
  +
  +
=== integer ===
  +
Beispiel: <code>?page.page=2&page.size=30</code>.
  +
  +
=== Arrays ===
  +
Bei der Verwendung von Arrays kann der Query Parameter mehrfach angegeben werden. Beispiel: <code>?channel=A&channgel=B</code>.
  +
  +
== Pagination ==
  +
Pagination funktioniert bei allen Endpunkten mit den Query Parametern <code>page.page</code> und <code>page.size</code>. Beispiel: <code><nowiki>https://copilot-office.de/$KUNDE/public/api/artists?page.page=2&page.size=30</nowiki></code>
  +
  +
=== Response ===
  +
{
  +
"content": [ ELEMENT1, ELEMENT2, ELEMENT3, ... ],
  +
"totalElements":9386,
  +
"totalPages":313
  +
}
  +
  +
== Events ==
  +
  +
=== Basis URL ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/events</nowiki></code>
  +
  +
=== Liste ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/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
  +
|
  +
|
  +
|-
  +
|highlight
  +
|boolean
  +
|ja
  +
|
  +
|
  +
|}
  +
  +
=== By ID ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/events/{EVENT_ID}</nowiki></code>
  +
  +
== Künstler ==
  +
  +
=== Basis URL ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/artists</nowiki></code>
  +
  +
=== Liste ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/artists/search</nowiki></code>
  +
{| class="wikitable"
  +
|+Query Parameter
  +
!Parameter
  +
!Typ
  +
!Optional
  +
!Default
  +
!Beschreibung
  +
|-
  +
|page.page
  +
|integer
  +
|ja
  +
|0
  +
|
  +
|-
  +
|page.size
  +
|integer
  +
|ja
  +
|30
  +
|
  +
|-
  +
|channel
  +
|string[]
  +
|ja
  +
|
  +
|
  +
|}
  +
  +
=== By ID ===
  +
<code><nowiki>https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}</nowiki></code>

Version vom 19. Juni 2019, 11:30 Uhr

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.

Arrays

Bei der Verwendung von Arrays kann der Query Parameter mehrfach angegeben werden. Beispiel: ?channel=A&channgel=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
}

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}

Abgerufen von „https://wiki.copilot-office.de/index.php?title=Public_Api:_Dokumentation&oldid=577“