BOS Schema

These objects are used for the five BOS incident messages. The objects are created and populated internally by the Couch Potato API.
create
Schema
Example
1
{
2
    "call":,             // Always 'create'
3
    "unique_string":,    // unique identifier of type unique_string
4
    "timestamp":,        // The date/time the game was created (UTC)
5
    "arguments":         
6
    {
7
        "season":        // The season for the sports
8
    },
9
    "id":
10
    {
11
        "home":,            // The home team
12
        "away":,            // The away team
13
        "sport":,           // The sport
14
        "start_time":,      // The scheduled date/time for the game to start (UTC)
15
        "event_group_name": // The event group (league)
16
    },
17
    "provider_info":
18
    {
19
        "match_id":,        // Unique identifier for the match (game)
20
        "name":,            // Name of the provider
21
        "source":           // Always 'direct string input'
22
        "source_file":,     // Not used
23
        "pushed":           // The date/time the incident was sent (UTC)
24
    }
25
}
Copied!
1
{
2
    "call":"create",
3
    "unique_string":"2020-05-01t01:12:00.000z__soccer__epl__leicester-city__aston-villa__create__20192020",
4
    "timestamp":"2020-01-28T14:41:13.705Z",
5
    "arguments":
6
    {
7
        "season":"2019/2020"
8
    },
9
    "id":
10
    {
11
        "home":"Leicester City",
12
        "away":"Aston Villa",
13
        "sport":"Soccer",
14
        "start_time":"2020-05-01T01:12:00Z",
15
        "event_group_name":"EPL"
16
    },
17
    "provider_info":
18
    {
19
        "match_id":"25",
20
        "name":"couch-potato",
21
        "source":
22
        "direct string input",
23
        "source_file":"",
24
        "pushed":"2020-01-28T14:41:13.705Z"
25
    }
26
}
Copied!
in_progress
Schema
Example
1
{
2
    "call":,             // Always 'in_progress'
3
    "unique_string":,    // unique identifier of type unique_string
4
    "timestamp":,        // The date/time the game was created (UTC)
5
    "arguments":         
6
    {
7
         "whistle_start_time": // The time the game actually started
8
    },
9
    "id":
10
    {
11
        "home":,            // The home team
12
        "away":,            // The away team
13
        "sport":,           // The sport
14
        "start_time":,      // The scheduled date/time for the game to start (UTC)
15
        "event_group_name": // The event group (league) 
16
    },
17
    "provider_info":
18
    {
19
        "match_id":,        // Unique identifier for the match (game)
20
        "name":,            // Name of the provider
21
        "source":           // Always 'direct string input'
22
        "source_file":,     // Not used
23
        "pushed":           // The date/time the incident was sent (UTC)
24
    }
25
}
Copied!
1
{
2
    "call":"in_progress",
3
    "unique_string":"2020-05-01t01:12:00.000z__soccer__epl__leicester-city__aston-villa__create__20192020",
4
    "timestamp":"2020-01-28T14:41:13.705Z",
5
    "arguments":
6
    {
7
        "whistle_start_time":"2020-05-01T01:15:00Z"
8
    },
9
    "id":
10
    {
11
        "home":"Leicester City",
12
        "away":"Aston Villa",
13
        "sport":"Soccer",
14
        "start_time":"2020-05-01T01:12:00Z",
15
        "event_group_name":"EPL"
16
    },
17
    "provider_info":
18
    {
19
        "match_id":"25",
20
        "name":"couch-potato",
21
        "source":
22
        "direct string input",
23
        "source_file":"",
24
        "pushed":"2020-01-28T14:41:13.705Z"
25
    }
26
}
Copied!
result
Schema
Example
1
{
2
    "call":,             // Always 'result'
3
    "unique_string":,    // unique identifier of type unique_string
4
    "timestamp":,        // The date/time the game was created (UTC)
5
    "arguments":         
6
    {
7
         "home_score":,     // The home team score/result
8
         "away_score":,     // The away team score/result
9
    },
10
    "id":
11
    {
12
        "home":,            // The home team
13
        "away":,            // The away team
14
        "sport":,           // The sport
15
        "start_time":,      // The scheduled date/time for the game to start (UTC)
16
        "event_group_name": // The event group (league) 
17
    },
18
    "provider_info":
19
    {
20
        "match_id":,        // Unique identifier for the match (game)
21
        "name":,            // Name of the provider
22
        "source":           // Always 'direct string input'
23
        "source_file":,     // Not used
24
        "pushed":           // The date/time the incident was sent (UTC)
25
    }
26
}
Copied!
1
{
2
    "call":"result",
3
    "unique_string":"2020-05-01t01:12:00.000z__soccer__epl__leicester-city__aston-villa__create__20192020",
4
    "timestamp":"2020-01-28T14:41:13.705Z",
5
    "arguments":
6
    {
7
         "home_score":4,    
8
         "away_score":2,  
9
    },
10
    "id":
11
    {
12
        "home":"Leicester City",
13
        "away":"Aston Villa",
14
        "sport":"Soccer",
15
        "start_time":"2020-05-01T01:12:00Z",
16
        "event_group_name":"EPL"
17
    },
18
    "provider_info":
19
    {
20
        "match_id":"25",
21
        "name":"couch-potato",
22
        "source":
23
        "direct string input",
24
        "source_file":"",
25
        "pushed":"2020-01-28T14:41:13.705Z"
26
    }
27
}
Copied!
finish
Schema
Example
1
{
2
    "call":,             // Always 'finish'
3
    "unique_string":,    // unique identifier of type unique_string
4
    "timestamp":,        // The date/time the game was created (UTC)
5
    "arguments":         
6
    {
7
         "whistle_end_time": // The time the game ended
8
    },
9
    "id":
10
    {
11
        "home":,            // The home team
12
        "away":,            // The away team
13
        "sport":,           // The sport
14
        "start_time":,      // The scheduled date/time for the game to start (UTC)
15
        "event_group_name": // The event group (league) 
16
    },
17
    "provider_info":
18
    {
19
        "match_id":,        // Unique identifier for the match (game)
20
        "name":,            // Name of the provider
21
        "source":           // Always 'direct string input'
22
        "source_file":,     // Not used
23
        "pushed":           // The date/time the incident was sent (UTC)
24
    }
25
}
Copied!
1
{
2
    "call":"finish",
3
    "unique_string":"2020-05-01t01:12:00.000z__soccer__epl__leicester-city__aston-villa__create__20192020",
4
    "timestamp":"2020-01-28T14:41:13.705Z",
5
    "arguments":
6
    {
7
         "whistle_start_time":"2020-05-01T01:16:00Z"
8
    },
9
    "id":
10
    {
11
        "home":"Leicester City",
12
        "away":"Aston Villa",
13
        "sport":"Soccer",
14
        "start_time":"2020-05-01T01:12:00Z",
15
        "event_group_name":"EPL"
16
    },
17
    "provider_info":
18
    {
19
        "match_id":"25",
20
        "name":"couch-potato",
21
        "source":
22
        "direct string input",
23
        "source_file":"",
24
        "pushed":"2020-01-28T14:41:13.705Z"
25
    }
26
}
Copied!
canceled
Schema
Example
1
 {
2
    "call":,             // Always 'canceled'
3
     "unique_string":,    // unique identifier of type unique_string
4
    "timestamp":,        // The date/time the game was created (UTC)
5
    "arguments":         
6
    {
7
    },
8
    "id":
9
    {
10
        "home":,            // The home team
11
        "away":,            // The away team
12
        "sport":,           // The sport
13
        "start_time":,      // The scheduled date/time for the game to start (UTC)
14
        "event_group_name": // The event group (league) 
15
    },
16
    "provider_info":
17
    {
18
        "match_id":,        // Unique identifier for the match (game)
19
        "name":,            // Name of the provider
20
        "source":           // Always 'direct string input'
21
        "source_file":,     // Not used
22
        "pushed":           // The date/time the incident was sent (UTC)
23
    }
24
}
Copied!
1
{
2
    "call":"canceled",
3
    "unique_string":"2020-05-01t01:12:00.000z__soccer__epl__leicester-city__aston-villa__create__20192020",
4
    "timestamp":"2020-01-28T14:41:13.705Z",
5
    "arguments":
6
    {
7
    },
8
    "id":
9
    {
10
        "home":"Leicester City",
11
        "away":"Aston Villa",
12
        "sport":"Soccer",
13
        "start_time":"2020-05-01T01:12:00Z",
14
        "event_group_name":"EPL"
15
    },
16
    "provider_info":
17
    {
18
        "match_id":"25",
19
        "name":"couch-potato",
20
        "source":
21
        "direct string input",
22
        "source_file":"",
23
        "pushed":"2020-01-28T14:41:13.705Z"
24
    }
25
}
Copied!
unique_string
This special attribute uniquely identifies each game to BOS. The format is as follows:
"start_time" + "__" + "sport" + "__" + "event_group_name" + "home_team" + "__" + "away_team" + "create" + "__" + "season"
Example
2020-05-01t01:12:00.000z__soccer__epl__leicester-city__aston-villa__create__20192020
Important: The string must be lowercase and any spaces in fields replaced with dashes (-).

Error Codes

Next - Couch Potato

Proxy Payment Considerations

Last modified 2yr ago

Export as PDF

Copy link

Contents