Český rozhlas - online-reportage (1.0.5)

Download OpenAPI specification:Download

REST API documentation for CRo online-reportage project.

Feed items

Operations related to loading feed items. The response for all operations has the same JSON structure.

Load feed items with offset and count

Responses

200

Feed items and metadata

Response Schema: application/json
timestamp
required
number <int>

Timestamp

feedTotalCount
required
number <int>

The number of all feed items for current filter (or total number of all feed items).

sortedAt
required
number <int>

sortedAt Timestamp

articleUrl
required
string

Url to redirect to article

title
required
string

Article title

isOnline
required
boolean

Is Reportage online?

feeds
required
Array of objects (schema5)

Array of feed items

filters
required
Array of objects (schema3)

Filters

get/{reportageId}/feed/{offset}-{count}.json

QA server

http://d7-cesky-rozhlas-online-reportage.test.proofreason.com/sites/default/files/online_reportage/{reportageId}/feed/{offset}-{count}.json

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}

Load feed items with offset and count by filter

Responses

200

Feed items and metadata

Response Schema: application/json
timestamp
required
number <int>

Timestamp

feedTotalCount
required
number <int>

The number of all feed items for current filter (or total number of all feed items).

sortedAt
required
number <int>

sortedAt Timestamp

articleUrl
required
string

Url to redirect to article

title
required
string

Article title

isOnline
required
boolean

Is Reportage online?

feeds
required
Array of objects (schema5)

Array of feed items

filters
required
Array of objects (schema3)

Filters

get/{reportageId}/feed/{offset}-{count}-{filterId}.json

QA server

http://d7-cesky-rozhlas-online-reportage.test.proofreason.com/sites/default/files/online_reportage/{reportageId}/feed/{offset}-{count}-{filterId}.json

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}

Polling

Polling request

Load new/edited feed items and metadata by timestamp

Responses

200

Feed item and metadata

Response Schema: application/json
timestamp
required
number <int>

Timestamp

feedTotalCount
required
any Nullable

FeedTotalCount is always null for polling response

sortedAt
required
number <int>

sortedAt Timestamp

articleUrl
required
string

Url to redirect to article

title
required
string

Article title

isOnline
required
boolean

Is Reportage online?

feeds
required
Array of objects (schema5)

Array of feed items

filters
required
Array of objects (schema3)

Filters

get/{reportageId}/update/{timestamp}.json

QA server

http://d7-cesky-rozhlas-online-reportage.test.proofreason.com/sites/default/files/online_reportage/{reportageId}/update/{timestamp}.json

Response samples

Content type
application/json
Copy
Expand all Collapse all
{}

The Feed Item Model

weight
required
string <number>

The feed item position

feedId
required
string <number>

The feed item ID

time
required
string <Date>

Displaying time in timeline

timestamp
required
number <int>

Displaying time in timeline timestamp

filter
required
object (schema3)
content
required
Array of any

The feed item Content Row

Copy
Expand all Collapse all
{}

The Filter Model

filterId
required
string <number>

The filter ID

imageUrl
required
string

URL to filter icon image

title
required
string

Image Title

Copy
Expand all Collapse all

The Feed Item Content Row Model

type
required
string

The feed row type must be one of these string: article, markup, image, youtube, twitter, facebook, instagram, gmaps

content
required
string Nullable

Text for type article (short description) or raw HTML for type markup

url
required
string Nullable

URL for type youtube, twitter, facebook, instagram, gmaps or article

title
string

Title for type article

image
string

Image URL for type image or article

width
string Nullable

Width for type image

height
string Nullable

Width for type image

Copy
Expand all Collapse all
[]