Datenformat Event-/Titelanlieferung

[frytg]

Zur Diskussion steht noch das finale Dateiformat zur Anlieferung und Verteilung von Live-Titelinformationen (s.u.)

[frytg]

Subscription management

GET /subscription
Fetch list of subscriptions (for the currently authenticated user)

POST /subscription
Create a new subscription

Body

{
  "type": "pubsub",
  "url": "https://example.com/my/webhook/for/this/subscription",
  "email": "[email protected]",
  "topic": "topic-name-to-subscribe-to"
}

Returns

201 Created

{
  "id": "abc-123-def"
}

GET /subscription/:id
Get details about a specific subscription

DELETE /subscription/:id
Remove a specific subscription

[frytg]

Changes:
pubsub -> PUBSUB
add method: PUSH

[frytg]

Changes II: Return wird viel mehr Informationen und gleich das komplette subscription Objekt enthalten. id ist dort auch name

[frytg]

Title Demo

POST /event?publisherId=swr-987

{
  "event": "de.ard.eventhub.v1.radio.track.playing"
  "id": "abc-1234", /* string - unique and generated by exchange service */

  "epgId": "28468",
  "station": /* not required for POST, looked up by epgId */
  {
    "name": "SWR3",
    ...
  },

  "start": "2020-01-19T06:00:00+01:00", /* ISO 8601 */
  "length": 240000, /* duration in MS */
  "artist": "Herbert Grönemeyer",
  "title": "Was soll das",
  "type": "music", /* enum see below */

  "media": [
    {
      "type": "cover",
      "url": "https://www.example.com/cover.jpg",
      "templateUrl": "https://www.example.com/cover.jpg?width={width}", /* dynamic sizing if supported */
      "description": "Cover Herbert Grönemeyer",
      "attribution": "Fotograf XYZ"
    },
    {
      "type": "artist",
      "url": "https://www.example.com/herbert.jpg",
      "templateUrl": null,
      "description": "Künstlerbild Herbert Grönemeyer",
      "attribution": "Fotograf ABC"
    },
  ],

  "externalId": "1234B", /* not unique and provided by broadcaster */
  "ardConfId": "98765", /* nullable */
  "isrc": "U12345", /* nullable */
  "upc": "DE67890", /* nullable */
  "mpn": "98765", /* nullable */

  /* Privacy Flag */
  "isInternal": false /* nullable */
}

[saerdnaer]

Welche ISO 8601 Variante soll es bei start genau sein? Nur 2020-01-19T06:00:00+01:00 oder wäre dort 2020-01-19T05:00:00Z auch erlaubt?

[frytg]

@saerdnaer Das könnten wir handhaben wir ihr wollt, könnten es ungeprüft weitergeben, oder ein Regex hinterlegen.

[frytg]

Neue Version mit dynamischen contributors für composer & Co:

{
  "event": "de.ard.eventhub.v1.radio.track.playing",
  "type": "music",
  "start": "2020-01-19T06:00:00+01:00",
  "length": 240,
  "title": "Song name",
  "artist": "Sam Feldt feat. Someone Else",
  "contributors": [
    {
      "name": "Sam Feldt",
      "role": "artist",
      "normDb": {
        "type": "Person",
        "id": "1641010"
      },
      "isni": "string",
      "url": "string"
    },
    {
      "name": "BRSO",
      "role": "performer",
      "normDb": null,
      "isni": null,
      "url": null
    },
    {
      "name": "Claude Debussy (1862-1918)",
      "role": "composer",
      "normDb": null,
      "isni": null,
      "url": null
    }
  ],
  "serviceId": "1234",
  "playlistId": "swr3-1234",
  "externalId": "M012345.001",
  "confId": "ardhfdb1.KONF.12345",
  "isrc": "DE012345678",
  "upc": "string",
  "mpn": "string",
  "isInternal": false,
  "media": [
    {
      "type": "cover",
      "url": "https://example.com/cover.jpg",
      "templateUrl": "https://example.com/cover.jpg?width={width}",
      "description": "Cover Demo Artist",
      "attribution": "Photographer XYZ"
    }
  ],
  "plugins": [
    {
      "type": "postToThirdPartyPlatformXYZ"
    }
  ],
  "id": "1234567890"
}

[frytg]

Please note that the current format is available here: https://ard-eventhub-ingest-dev-qfzxbu3hya-ew.a.run.app/openapi/

[frytg]

ENUM type

music
news
audio
live
weather
traffic
commercial
jingle