Liveblog Sports Event

Sport liveblogs have special data structures to:

• display events like goals, penalties, etc.
• connect those events to teams and plays
• display the time of play the event occured

SportEventContentBlock

To describe all those purposes, the sport_event field of an Event must be filled with a Tik::Model::Content::SportEventContentBlock object.

"sport_event": {
  "_type": "Tik::Model::Content::SportEventContentBlock",
  // ID of the content block
  // since there is only one sport_event per event it can be any value
  "local_id": "",
  
  // the sportstype this event is for (soccer, icehockey)
  "sportstype": "",
  
  // the event type that happened 
  "event_type": "",
  
  // Optional: a title displayed along the event
  "title": "",
  
  // Optional: the team this event refers to
  "team": {},
  
  // Optional: Tik::Model::Content::SportEventPlayer[] 
  // players invovled in this event
  "players": [],

  // 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": "",
}

Specifying sportstype and event_type

The sportstype must be set to a valid sports type (Appendix A).

The event type must be set to a valid event type (Appendix B), for all types are listed at the end of this document. The specified event_type will in most cases match the sportstype, but in practice any event type can be used in any sports allowing for great flexibility of our templates.

Depending on the event_type, other fields can be set:

• team: Some events allow to specify which team is affected or. Refer to the event types table to see which event allows for that.
• players: Some events allow to specify one or multiple players involved in this event. Refer to the event types table to see which events allow players to be specified

Adding the team

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

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

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

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

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 event 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.

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

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

Adding involved players

Players will be displayed in the order they are specified in the array. Each entry is wrapped in a Tik::Model::Content::SportEventPlayer object.

{
  "_type": "Tik::Model::Content::SportEventPlayer",

  // The type of the involvement of the player in the event (example 'scorer')
  // Valid types for each event can be found in the Appendix B Table
  "event_player_type": "",

  // Displayed type of the involvement of the player in the event (example 'Scorer')
  "event_player_title": "",

  // The actual Tik::Model::Player object
  "player": {}
}

Using a predefined player

Only _type and _id need to be set

"player": {
  "_type": "Tik::Model::Player",
  "_id": ""
}

After the event object has been created, the response will contain the full player information.

For more information on creating players before using them please refer to the Player API Documentation.

Creating a player on the fly

Only _type and name need to be set.

"player": {
  "_type": "Tik::Model::Player",
  "name": ""
}

The player will be created with the specified name and assigned an _id. The response, after the event has been created, will contain a full player object including the new id.

Appendix A: Sportstype Table

Appendix B: Event Types Table