Objects

BOS Objects

The following objects are used to pass data to, or objects from response messages, the five API endpoints:

• add_game

• start_game

• add_Score

• finish_Game

• cancel_Game

create

Parameters for new BOS incident message to create a game and add to Couch Potato database.

Object

Parameter	Description	Type	Required
sport	Sport name	String	Yes
league	League (Event Group) of sport	String	Yes
home	Home team name	String	Yes
away	Away team name	String	Yes
start_time	Start date/time of game	Date	Yes
user	Current user id	Number	Yes

Example

in_progress

Parameters for new BOS incident message to start a game and add to Couch Potato database.

Object

Parameter	Description	Type	Required
sport	Sport name	String	Yes
league	League (Event Group) of sport	String	Yes
home	Home team name	String	Yes
away	Away team name	String	Yes
start_time	Start date/time of game	Date	Yes
whistle_start_time	Actual time the game started	Date	Yes
match_id	Unique match identifier	Number	Yes

Example

result

Parameters for new BOS incident message to set the score of a game and add to Couch Potato database.

Object

Parameter	Description	Type	Required
sport	Sport name	String	Yes
league	League (Event Group) of sport	String	Yes
home	Home team name	String	Yes
away	Away team name	String	Yes
start_time	Start date/time of game	Date	Yes
home_score	The score for the home team	Number	Yes
away_score	The score for the away team	Number	Yes
match_id	Unique match identifier	Number	Yes

Example

finish

Parameters for new BOS incident message to finish/complete a game and add to Couch Potato database.

Object

Parameter	Description	Type	Required
sport	Sport name	String	Yes
league	League (Event Group) of sport	String	Yes
home	Home team name	String	Yes
away	Away team name	String	Yes
start_time	Start date/time of game	Date	Yes
whistle_end_time	The time the game ended	Date	Yes
away_score	The score for the away team	Number	Yes
match_id	Unique match identifier	Number	Yes

Example

canceled

Parameters for new BOS incident message to cancel a game and add to Couch Potato database.

Object

Parameter	Description	Type	Required
sport	Sport name	String	Yes
league	League (Event Group) of sport	String	Yes
home	Home team name	String	Yes
away	Away team name	String	Yes
start_time	Start date/time of game	Date	Yes
match_id	Unique match identifier	Number	Yes

Example

Success Response Objects

Add Game Success Response

Object attributes for a 200 response from an add_game call.

Attributes

Name	Text
status	Always 200
title	Game added
message	[home ] v [away ] - [start_time]

Example

Start Game Success Response

Object attributes for a 200 response from an start_game call.

Attributes

Name	Text
status	Always 200
title	Game started
message	[home ] v [away ] - [whistle_start_time]

Example

Add Score Success Response

Object attributes for a 200 response from an add_score call.

Attributes

Name	Text
status	Always 200
title	Scores added
message	[home ] [home_score]v [away ][away_score]

Example

Finish Game Success Response

Object attributes for a 200 response from an finish_game call.

Attributes

Name	Text
status	Always 200
title	Game finished
message	[home ] v [away ] - [whistle_end_time]

Example

Cancel Game Success Response

Object attributes for a 200 response from an cancel_game call.

Attributes

Name	Text
status	Always 200
title	Game canceled
message	[home ] v [away ]