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

{
    "call":,             // Always 'create'
    "unique_string":,    // unique identifier of type unique_string
    "timestamp":,        // The date/time the game was created (UTC)
    "arguments":         
    {
        "season":        // The season for the sports
    },
    "id":
    {
        "home":,            // The home team
        "away":,            // The away team
        "sport":,           // The sport
        "start_time":,      // The scheduled date/time for the game to start (UTC)
        "event_group_name": // The event group (league)
    },
    "provider_info":
    {
        "match_id":,        // Unique identifier for the match (game)
        "name":,            // Name of the provider
        "source":           // Always 'direct string input'
        "source_file":,     // Not used
        "pushed":           // The date/time the incident was sent (UTC)
    }
}

Example

in_progress

Schema

{
    "call":,             // Always 'in_progress'
    "unique_string":,    // unique identifier of type unique_string
    "timestamp":,        // The date/time the game was created (UTC)
    "arguments":         
    {
         "whistle_start_time": // The time the game actually started
    },
    "id":
    {
        "home":,            // The home team
        "away":,            // The away team
        "sport":,           // The sport
        "start_time":,      // The scheduled date/time for the game to start (UTC)
        "event_group_name": // The event group (league) 
    },
    "provider_info":
    {
        "match_id":,        // Unique identifier for the match (game)
        "name":,            // Name of the provider
        "source":           // Always 'direct string input'
        "source_file":,     // Not used
        "pushed":           // The date/time the incident was sent (UTC)
    }
}

Example

result

Schema

{
    "call":,             // Always 'result'
    "unique_string":,    // unique identifier of type unique_string
    "timestamp":,        // The date/time the game was created (UTC)
    "arguments":         
    {
         "home_score":,     // The home team score/result
         "away_score":,     // The away team score/result
    },
    "id":
    {
        "home":,            // The home team
        "away":,            // The away team
        "sport":,           // The sport
        "start_time":,      // The scheduled date/time for the game to start (UTC)
        "event_group_name": // The event group (league) 
    },
    "provider_info":
    {
        "match_id":,        // Unique identifier for the match (game)
        "name":,            // Name of the provider
        "source":           // Always 'direct string input'
        "source_file":,     // Not used
        "pushed":           // The date/time the incident was sent (UTC)
    }
}

Example

finish

Schema

{
    "call":,             // Always 'finish'
    "unique_string":,    // unique identifier of type unique_string
    "timestamp":,        // The date/time the game was created (UTC)
    "arguments":         
    {
         "whistle_end_time": // The time the game ended
    },
    "id":
    {
        "home":,            // The home team
        "away":,            // The away team
        "sport":,           // The sport
        "start_time":,      // The scheduled date/time for the game to start (UTC)
        "event_group_name": // The event group (league) 
    },
    "provider_info":
    {
        "match_id":,        // Unique identifier for the match (game)
        "name":,            // Name of the provider
        "source":           // Always 'direct string input'
        "source_file":,     // Not used
        "pushed":           // The date/time the incident was sent (UTC)
    }
}

Example

canceled

Schema

 {
    "call":,             // Always 'canceled'
     "unique_string":,    // unique identifier of type unique_string
    "timestamp":,        // The date/time the game was created (UTC)
    "arguments":         
    {
    },
    "id":
    {
        "home":,            // The home team
        "away":,            // The away team
        "sport":,           // The sport
        "start_time":,      // The scheduled date/time for the game to start (UTC)
        "event_group_name": // The event group (league) 
    },
    "provider_info":
    {
        "match_id":,        // Unique identifier for the match (game)
        "name":,            // Name of the provider
        "source":           // Always 'direct string input'
        "source_file":,     // Not used
        "pushed":           // The date/time the incident was sent (UTC)
    }
}

Example

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 (-).