Scoreboard

Every game can have one main scoreboard in it’s scoreboard field. The scoreboard data structures can also be used in events.

Scores and Teams

All scoreboards use scores and teams as it’s basic data structures

Score

This data structure holds a score pair for home and away team

"score": {
  "_type": "Tik::Model::Content::Scoreboard::ScoreboardScore",

  // The sore of the home team to display. 
  // This field is a string not a number on purpose! It can display any content desired
  "home_score": "",

  // The sore of the away/guest team to display. 
  // This field is a string not a number on purpose! It can display any content desired
  "away_score": "",

  // The title of this score. This field is only used in SetBasedScoreboard right now
  "title": ""
}

Team

All socreboards use team objects to display home and away teams OR players. For the pupose of a scoreboard, single players for example in a tennis game are also treated as teams.

While the actual team object has more fields, only the following are used for scoreboards:

"team": {
  "_type": "Tik::Model::Team",

  // The id of the team, if it already exists
  "_id": "",

  // The display name of the team
  "name": "",

  // Optional: The team logo to display, either a http or imageservice link. 
  // For creating teams, can also be a data: url
  "image": ""
}

Teams can either be precreated or added on-the-fly.

Using a predefined team

Only _type and _id need to be set

"team": {
  "_type": "Tik::Model::Team",
  "_id": ""
}

After the scoreboard object has been created, the response will contain the full team information.

For more information on creating teams before using them please refer to the Teams API Documentation.

Creating a team on the fly

Only _type and name need to be set. image is optional

"team": {
  "_type": "Tik::Model::Team",
  "name": ""
}

The team will be created with the specified name (and optional image) and assigned an _id. The response, after the scorebaord has been created, will contain a full team object including the new id.

Types of Scoreboards

TeamGameScoreboard

Used in sports types like soccer, icehockey, basketball, etc.

"scoreboard" {
  "_type": "Tik::Model::Content::Scoreboard::TeamGameScoreboard",
  
  // The home team. See above for possible values
  "home_team": {}

  // The away/guest team. See above for possible values
  "away_team": {}
  
  // the current score, see above
  "score": {
    "_type": "Tik::Model::Content::Scoreboard::ScoreboardScore",
    "home_score": "",
    "away_score": "",
  },

  // Optional: The Game Phase to display
  "phase": {
    "_type": "Tik::Model::Content::SportPhase"
    "name": ""
  }

  // Optional: text to display representing the current time or game phase 
  // for example "32'" to signify 32. Minute of the game
  "time_of_play": "",

  // How the scorebaord is displayed. Possible options:
  // "default": Shows the home team left, away team right. Both with name and image
  // "default_logo": Shows the home team left, away team right. Only the image, not the name
  // "default_text": Shows the home team left, away team right. Only the name, not the image
  // "table": Shows the home team top, away team below. Both with name and image
  // "table_text": Shows the home team top, away team below. Only the name, not the image
  "display_type": "",
}

SetBasedScoreboard

Used in sports types like tennis, volleyball etc.

"scorebaord": {
  "_type": "Tik::Model::Content::Scoreboard::SetBasedScoreboard"

  // The home team. See above for possible values
  "home_team": {}

  // The away/guest team. See above for possible values
  "away_team": {}

  // array of scores representing sets, legs, innings, etc
  "scores": [
    {
      "_type": "Tik::Model::Content::Scoreboard::ScoreboardScore",
      "home_score": "",
      "away_score": ""
    }
  ],

  // How the scoreboard is displayed. Shows the home team top, away team below. 
  // Possible options:
  // "default": Teams with name and image. Shows the number of won sets
  // "default_only_scores": Teams with name and image. Doesn't show the number of won sets
  // "thumb": Teams with image only. Shows the number of won sets
  // "thumb_only_scores": Teams with image only. Doesn't show the number of won sets
  "display_type": ""
}