Skip to content

Latest commit

 

History

History
192 lines (139 loc) · 7.88 KB

SERVICE_AVAILABILITY.md

File metadata and controls

192 lines (139 loc) · 7.88 KB

Service availability

Integration Layer services are not available for all business units. The following document describes the availability of all services supported by the SRG Data Provider library, depending on the business unit which a data provider has been created with.

The maximum page size for all services supporting pagination is 100. The default page size is defined by the Integration Layer and is 10. A special unlimited page size is available for some requests to return all entries at once.

Services are requested with an Integration Layer vector, which can deliver an adapted content to the platform. The library uses:

  • appplay when running on iOS and watchOS.
  • tvplay when running on tvOS.

Remark

Services are currently only available for SRG SSR vendors (SRF, RTS, RSI, RTR and SWI), not for regional vendors (TVO, Canal Alpha).

TV services

Channels and livestreams

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Channels N/A
Single channel N/A
Latest programs by channel
Programs for all channels on a specific day N/A
Livestreams N/A
Scheduled livestreams

Media and episode retrieval

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Editorial medias
Hero stage medias N/A
Latest medias
Most popular medias
Soon expiring medias
Trending medias N/A
Latest episodes
Latest web first episodes
Episodes by date
Videos with tags

Topics

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Topics N/A

Shows

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
All shows
Show search
Most popular shows for topic

Remark

For SWI, shows represent content categories (Business, Culture, etc.) and search returns only exact word matches.

Radio services

Channels and livestreams

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Channels N/A
Single channel N/A
Latest programs by channel
Livestreams by channel N/A
Livestreams for content providers N/A

Remark

Regional livestreams only exist for SRF, otherwise only main livestreams are available.

Media and episode retrieval

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Latest medias
Most popular medias
Latest episodes
Episodes by date
Latest videos

Topics

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Topics N/A

Shows

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
All shows
Show search

Songs

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Recent songs ✅ (return songs for the current day)
Current song on air N/A

Live center (Sport Manager) services

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Videos

Search services

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Media search ✅ (1)
Show search (2) N/A
Most searched shows (2) N/A
Videos with tags ⚠️ (3)

(1) At the moment, SWI only supports a search term but no settings. If settings are applied the request will fail with an error. (2) Search can be optionally filtered by transmission. Only TV and radio are supported at the moment. (3) RTR only supports fullLengthExcluded = NO.

Recommendation services

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Recommended medias

Module services

Modules are collection of medias related to a specific context (e.g. an event).

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Module list N/A

Popularity services

These services can be used to increase popularity indicators.

Request SRF RTS RSI RTR SWI Pagination Unlimited page size
Increase social count for a media URN N/A
Increase show view count from search results N/A

Content services

These services return content configured by editors through the Play Application Configurator tool (PAC). They are supported by all business units.

Request Pagination Unlimited page size
Page N/A
Page for a product N/A
Page for a product name N/A
Page for a topic N/A
Page for a show in product N/A
Page for a show in product name N/A
Section N/A
Medias for a section
Shows for a section
Show with medias for a section

URN services

These services provide a way to access content from any business unit from any data provider.

Request Pagination Unlimited page size
Single media by URN N/A
List of medias by URNs ⚠️
Latest medias by topic URN
Most popular medias by topic URN
Media composition by URN N/A
Single show by URN N/A
List of shows by URNs ⚠️
Latest episodes for show with URN
Latest medias for show with URN
Latest medias for shows with URNs (10 max.)
Latest medias by module URN

⚠️ Pagination is supported, but with a limit of 50. Attempting to request larger page sizes will fail.

Image scaling service

Only predefined widths and sizes are available for scaling.

The PlaySRG image service is used for all image URLs.