Public Api: Dokumentation - Versionsgeschichte

Admin am 28. Juli 2020 um 14:44 Uhr

2020-07-28T14:44:23Z

2020-03-05T16:36:41Z

Asset

2020-03-05T16:33:05Z

Genre

2020-03-05T16:30:18Z

2020-03-05T16:10:27Z

Assets / Dateianhänge

2020-03-05T16:04:44Z

2019-06-20T09:47:09Z

2019-06-20T09:38:33Z

2019-06-19T10:14:51Z

2019-06-19T09:59:52Z

@@ Zeile 148: / Zeile 148: @@
    title: Map<locale, string>
    subtitle: Map<locale, string>
-   state: 'CONFIRMED' | 'CANCELLED'
+   state: 'CONFIRMED' | 'CANCELLED' | 'RESCHEDULED'
    type: 'CLOSED' | 'RADIO' | 'TV' | 'STREAM'
    broadcastType: 'LIVE' | 'RECORDING'

@@ Zeile 71: / Zeile 71: @@
    width: integer
    height: integer
    downloadUrl: string
    tags: { tagName: string }[]

@@ Zeile 26: / Zeile 26: @@
 === localtime ===
 Zeitangaben erfolgen im ISO 8601 Format. Beispiel: <code>23:59:59</code>.
 === Arrays ===
@@ Zeile 144: / Zeile 147: @@
+ {
    id: string
-   title: Map<string, string>
+   title: Map<locale, string>
-   subtitle: Map<string, string>
+   subtitle: Map<locale, string>
    state: 'CONFIRMED' | 'CANCELLED'
    type: 'CLOSED' | 'RADIO' | 'TV' | 'STREAM'
@@ Zeile 193: / Zeile 196: @@
+ {
    id: string
-   name: any
+   name: Map<locale, string>
+ }

@@ Zeile 153: / Zeile 153: @@
    youtube: string
    miscLinks: { url: string }[]
-   genres: any[]
+   genres: Genre[]
    description: string
    hearingAssistance: boolean
@@ Zeile 160: / Zeile 160: @@
    entrance: localtime
    start: localtime
-   cast: any[]
+   cast: Cast[]
-   venue: any
+   venue: Venue
-   tickets: any
+   tickets: Tickets
-   tour: any
+   tour: Tour
    remark: string
    publication: { startAt: instant }
+ }
@@ Zeile 335: / Zeile 395: @@
    web: string
    address: Address
-   rooms: any[]
+   rooms: Room[]
    assets: Asset[]
+ }

@@ Zeile 17: / Zeile 17: @@
 === integer ===
 Beispiel: <code>?page.page=2&page.size=30</code>.
 === localdate ===
@@ Zeile 40: / Zeile 43: @@
 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 =
+== Objekttypen ==
-=== Basis URL ===
+=== Asset ===
+ {
    id: string
@@ Zeile 67: / Zeile 72: @@
    tags: { tagName: string }[]
+ }
 == Events ==
@@ Zeile 200: / Zeile 218: @@
    shortBio: string
    longBio: string
-   assets: any[]
+   assets: Asset[]
+ }
@@ Zeile 271: / Zeile 289: @@
    title: string
    description: string
-   assets: any[]
+   assets: Asset[]
+ }
@@ Zeile 316: / Zeile 334: @@
    description: string
    web: string
-   address: any
+   address: Address
    rooms: any[]
-   assets: any[]
+   assets: Asset[]
+ }

← Nächstältere Version		Version vom 20. Juni 2019, 09:47 Uhr
Zeile 41:		Zeile 41:

	= API =		= API =
		+
		+	== Assets / Dateianhänge ==
		+
		+	=== Basis URL ===
		+	<code><nowiki>https://copilot-office.de/$KUNDE/public/api/assets</nowiki></code>
		+
		+	=== By ID ===
		+	<code><nowiki>https://copilot-office.de/$KUNDE/public/api/assets/{ASSET_ID}</nowiki></code>
		+
		+	=== Download ===
		+	<code><nowiki>https://copilot-office.de/$KUNDE/public/api/assets/{ASSET_ID}/download</nowiki></code>

	== Events ==		== Events ==

@@ Zeile 3: / Zeile 3: @@
 == URL ==
 Die API ist unter <code><nowiki>https://copilot-office.de/$KUNDE/public/api</nowiki></code> zu erreichen.
 == Datentypen ==

@@ Zeile 4: / Zeile 4: @@
 Die API ist unter <code><nowiki>https://copilot-office.de/$KUNDE/public/api</nowiki></code> zu erreichen.
-== Query Parameter Typen ==
+== Datentypen ==
 === string ===
@@ Zeile 17: / Zeile 17: @@
 === localdate ===
 Datumsangaben erfolgen im ISO 8601 Format. Beispiel: <code>?from=2019-06-13</code>.
 === Arrays ===
@@ Zeile 90: / Zeile 93: @@
 === By ID ===
 <code><nowiki>https://copilot-office.de/$KUNDE/public/api/events/{EVENT_ID}</nowiki></code>
 == Künstler ==
@@ Zeile 127: / Zeile 156: @@
 === By ID ===
 <code><nowiki>https://copilot-office.de/$KUNDE/public/api/artists/{ARTIST_ID}</nowiki></code>
 === Events ===
@@ Zeile 190: / Zeile 235: @@
 |Channel
 |}
 == Venue ==
@@ Zeile 226: / Zeile 279: @@
 === By ID ===
 <code><nowiki>https://copilot-office.de/$KUNDE/public/api/venues/{VENUE_ID}</nowiki></code>

@@ Zeile 55: / Zeile 55: @@
 |ja
 |0
 |-
 |page.size
@@ Zeile 61: / Zeile 61: @@
 |ja
 |30
 |-
 |from
@@ Zeile 67: / Zeile 67: @@
 |ja
+|
 |-
 |to
@@ Zeile 73: / Zeile 73: @@
 |ja
+|
 |-
 |channel
@@ Zeile 79: / Zeile 79: @@
 |ja
+|
 |-
 |highlight
@@ Zeile 85: / Zeile 85: @@
 |ja
+|
 |}
@@ Zeile 110: / Zeile 110: @@
 |ja
 |0
 |-
 |page.size
@@ Zeile 116: / Zeile 116: @@
 |ja
 |30
 |-
 |channel
@@ Zeile 122: / Zeile 122: @@
 |ja
+|
 |}
@@ Zeile 142: / Zeile 142: @@
 |ja
 |0
 |-
 |page.size
@@ Zeile 148: / Zeile 148: @@
 |ja
 |30
 |-
 |channel
@@ Zeile 154: / Zeile 154: @@
 |ja
+|
 |}
@@ Zeile 176: / Zeile 176: @@
 |ja
 |0
 |-
 |page.size
@@ Zeile 182: / Zeile 182: @@
 |ja
 |30
 |-
 |channel
@@ Zeile 188: / Zeile 188: @@
 |ja
+|
 |}
@@ Zeile 210: / Zeile 210: @@
 |ja
 |0
 |-
 |page.size
@@ Zeile 216: / Zeile 216: @@
 |ja
 |30
 |-
 |channel
@@ Zeile 222: / Zeile 222: @@
 |ja
+|
 |}
 === By ID ===