Create Liveblog
Request: POST /api/v5/write/ticker/create.json
Query Parameters: (none)
Post Document:
{
"_type": "Tik::Model::Game",
// (string) Owner Organization ID
"organization_id": "",
// (string) (Sportstype or Custom Template ID)
"template_id": "",
// Tik::Model::GameMetaInfo::TitleGameMetaInfo
"meta_info": {
"_type": "Tik::Model::GameMetaInfo::TitleGameMetaInfo",
// string, the display title of this liveblog
"title": "",
// Indicates whether new liveblog posts will be hidden by default
"editorial_publishing": false,
// Start date of the liveblog
"starts_at": 1578996000
},
// Tik::Model::Content::Scoreboard::TeamGameScoreboard|Tik::Model::Content::Scoreboard::SetBasedGameScoreboard
// Only in sports games
"scoreboard": {},
// Tik::Model::Options::BasicGameOptions|Tik::Model::Options::TimedGameOptions|
// Only in sports games, defines game options like half time length
"options": {},
// Optional: (array[String|Tik::Model::Tag])
"tags": "",
// Optional: (string) will be used to build local_id (<org_id>_<external_id>)
"external_id": "",
// Optional: (boolean) Indicates whether syndication controls in editor will be shown
"use_syndication_controls": fales,
// Optinal: (string) Locale of the liveblog ("en", "de", "en-gb", "en-ie", "en-au", "en-nz", "zh-tw", "fr-fr", "it-it", "nl-nl", "")
"locale": ""
}
Success Response: Tik::Model::Game
Object
Examples
Create a news liveblog
{
"_type": "Tik::Model::Game",
"template_id": "news",
"organization_id": "YOURID",
"meta_info": {
"_type": "Tik::Model::GameMetaInfo::TitleGameMetaInfo",
"editorial_publishing": false,
"starts_at": 1531985104,
"title": "news title"
}
}
Create a soccer liveblog with preexisting teams
{
"_type": "Tik::Model::Game",
"template_id": "soccer",
"organization_id": "YOURID",
"meta_info": {
"_type": "Tik::Model::GameMetaInfo::TitleGameMetaInfo",
"editorial_publishing": false,
"starts_at": 1531985104,
"title": "Home Team vs Away Team - Champions League"
},
"scoreboard": {
"_type": "Tik::Model::Content::Scoreboard::TeamGameScoreboard",
"home_team": {
"_type": "Tik::Model::Team",
"_id": "HOMETEAMID"
},
"away_team": {
"_type": "Tik::Model::Team",
"_id": "AWAYTEAMID"
},
"score": {
"_type": "Tik::Model::Content::Scoreboard::ScoreboardScore",
"home_score": "",
"away_score": ""
}
},
"options": {
"_type": "Tik::Model::Options::TimedGameOptions"
"timing_type": "aui",
"regular_phase_length": 45,
"num_regular_phases": 2,
"overtime_phase_length": 15,
"num_overtime_phases": 2
}
}
Create a soccer liveblog and create new teams on the fly
{
"_type": "Tik::Model::Game",
"template_id": "soccer",
"organization_id": "YOURID",
"meta_info": {
"_type": "Tik::Model::GameMetaInfo::TitleGameMetaInfo",
"editorial_publishing": false,
"starts_at": 1531985104,
"title": "Home Team vs Away Team - Champions League"
},
"scoreboard": {
"_type": "Tik::Model::Content::Scoreboard::TeamGameScoreboard",
"home_team": {
"_type": "Tik::Model::Team",
"name": "Home Team Name"
},
"away_team": {
"_type": "Tik::Model::Team",
"name": "Guest Team Name"
},
"score": {
"_type": "Tik::Model::Content::Scoreboard::ScoreboardScore",
"home_score": "",
"away_score": ""
}
},
"options": {
"_type": "Tik::Model::Options::TimedGameOptions"
"timing_type": "aui",
"regular_phase_length": 45,
"num_regular_phases": 2,
"overtime_phase_length": 15,
"num_overtime_phases": 2
}
}