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
Example
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
1
{
2
  "sport": "Soccer",
3
  "league": "EPL",
4
  "home": "Norwich City",
5
  "away": "Manchester City",
6
  "start_time": "2020-02-04T18:33:00Z",
7
  "user": 35,
8
  "match_id": 60
9
}
Copied!
in_progress
Parameters for new BOS incident message to start a game and add to Couch Potato database.
Object
Example
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
1
{
2
  "sport": "Soccer",
3
  "league": "EPL",
4
  "home": "Norwich City",
5
  "away": "Manchester City",
6
  "start_time": "2020-02-04T18:33:00Z",
7
  "match_id": 60,
8
  "whistle_start_time": "2020-02-04T18:40:00Z"
9
}
Copied!
result 
Parameters for new BOS incident message to set the score of a game and add to Couch Potato database.
Object
Example
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
1
{
2
  "sport": "Soccer",
3
  "league": "EPL",
4
  "home": "Norwich City",
5
  "away": "Manchester City",
6
  "start_time": "2020-02-04T18:33:00Z",
7
  "home_score": 1,
8
  "away_score": 4,
9
  "match_id": 60
10
}
Copied!
finish 
Parameters for new BOS incident message to finish/complete a game and add to Couch Potato database.
Object
Example
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
1
{
2
  "sport": "Soccer",
3
  "league": "EPL",
4
  "home": "Norwich City",
5
  "away": "Manchester City",
6
  "start_time": "2020-02-04T18:33:00Z",
7
  "match_id": 60,
8
  "whistle_end_time": "2020-02-04T20:30:00Z"
9
}
Copied!
canceled
Parameters for new BOS incident message to cancel a game and add to Couch Potato database.
Object
Example
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
1
{
2
  "sport": "Soccer",
3
  "league": "EPL",
4
  "home": "Norwich City",
5
  "away": "Manchester City",
6
  "start_time": "2020-02-04T18:33:00Z",
7
  "match_id": 60,
8
}
Copied!
Success Response Objects
Add Game Success Response 
Object attributes for a 200 response from an add_game call.
Attributes
Example
Name
Text
status
Always 200
title
Game added
message
[home ] v [away ] - [start_time]
1
{
2
    "status":"200",
3
    "title":"Game added",
4
    "message":"Arsenal v Liverpool - 2020-02-25T01:33:00.000Z"
5
}
Copied!
Start Game Success Response 
Object attributes for a 200 response from an start_game call.
Attributes
Example
Name
Text
status
Always 200
title
Game started
message
[home ] v [away ] - [whistle_start_time]
1
{
2
    "status":"200",
3
    "title":"Game started",
4
    "message":"Chelsea v Chelsea - [whistle_start_time]2020-02-04T18:05:47.736Z"
5
}
Copied!
Add Score Success Response 
Object attributes for a 200 response from an add_score call.
Attributes
Example
Name
Text
status
Always 200
title
Scores added
message
[home ] [home_score]v [away ][away_score] 
1
{
2
    "status":"200",
3
    "title":"Scores added",
4
    "message":"Chelsea 4 v Arsenal 2"
5
}
Copied!
Finish Game Success Response 
Object attributes for a 200 response from an finish_game call.
Attributes
Example
Name
Text
status
Always 200
title
Game finished
message
[home ] v [away ] - [whistle_end_time]
1
{
2
    "status":"200",
3
    "title":"Game finished",
4
    "message":"Liverpool v Arsenal - [whistle_end_time]2020-02-03T22:45:00.000Z"
5
}
Copied!
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 ]

API Reference

Error Codes

Last modified 2yr ago

Export as PDF

Copy link

Contents

Success Response Objects

Add Game Success Response

Start Game Success Response

Add Score Success Response

Finish Game Success Response

Cancel Game Success Response