Varsity schedule card

Upcoming fixtures, live games and recent results for the school’s teams.

School athletics come from supplied games or the scores feed. Team codes tie each game to its sport and squad. Scores stay unknown until supplied, with finals shown only when marked final. In compact views, one game leads.

Live card

This card is drawn in your browser by the same code the Players run, with sample data.

Category: Schools. Tags: Schools and campuses, Team sports, Schedules, Scoreboards.

Layouts

This fullscreen card fills the whole screen in landscape or portrait and is not placed as a corner, chip, or strip.

Layouts: full. Forms: landscape, portrait.

Card layouts, themes and publishing. Browse the cards.

Data and privacy

Feed: screenrig.scores/v1.

Feed documents carry source attribution. The Player supplies the feed to the card.

Properties

For theme, background, accent and position, see Common properties.

Set static properties in params. Bind data to a project card data key for live values; that document holds only dynamic properties. Without a data key, put the complete configuration in params. Nested rows describe the contents of their parent property.

Static properties

NameTypeDefaultValues and limitsDescription
teamCodestring""maxLength: 12
hour12booleanfalse
staleMinutesinteger180minimum: 1; maximum: 10080
teamsarray[]maxItems: 24
teams[].codestringminLength: 1; maxLength: 12; Required
teams[].namestringminLength: 1; maxLength: 80; Required
teams[].sportstring""maxLength: 40
teams[].levelstring""maxLength: 40
countinteger5minimum: 2; maximum: 6
pageSecondsinteger12minimum: 8; maximum: 120

Dynamic properties

NameTypeDefaultValues and limitsDescription
titlestring"Varsity athletics"maxLength: 80
schoolstring""maxLength: 80
footnotestring""maxLength: 240
updatedAtstring""maxLength: 40
gamesarray[]maxItems: 100Supplied school games. The existing screenrig.scores/v1 feed wins when present; team codes match its home/away short codes.
games[].idstring""maxLength: 60
games[].teamCodestring""maxLength: 12
games[].teamstring""maxLength: 80
games[].opponentstringminLength: 1; maxLength: 80; Required
games[].sportstring""maxLength: 40
games[].levelstring""maxLength: 40
games[].homebooleantrue
games[].statusstring"scheduled""scheduled", "live", "final", "postponed", "cancelled"
games[].startstringmaxLength: 40; Required
games[].teamScorenumber, nullnullminimum: 0; maximum: 100000
games[].opponentScorenumber, nullnullminimum: 0; maximum: 100000
games[].venuestring""maxLength: 100
games[].clockstring""maxLength: 40
games[].finalAtstring""maxLength: 40Actual final-result instant, for the synchronized Primetime result moment.

Canvas example

Add this item to a playlist page’s primitives. Publish the playlist and assign a screen.

{
  "id": "varsity-schedule",
  "primitive": "card",
  "card": "varsity-schedule",
  "major": 1,
  "params": {
    "theme": "neomustard"
  },
  "rect": {
    "x": 0,
    "y": 0,
    "width": 1920,
    "height": 1080
  },
  "layer": 0,
  "content_fit": "fill",
  "data": "example-key"
}

Write live data

The canvas example binds its data field to example-key. That value is a data key: a name this canvas item chooses, not the name of the card. Give each canvas item its own key when items should show different data, or share one key when they should show the same data. Keys are scoped to the project, follow the K/V key grammar, and cannot start with feed:.

Create this document before showing the card, then replace it to update the screen without republishing. Writes to a key that live canvas items bind are checked against each bound card’s dynamic properties. Use the same project as the playlist.

Save the document as card-data.json. The CLI reads the document itself, with no wrapper:

{
  "title": "Varsity athletics",
  "school": "",
  "footnote": "",
  "updatedAt": "",
  "games": []
}
screenrig card-data put example-key --file card-data.json

Or call the API directly. The API wraps the same document in a document field. An agent token already names its project, so no project header is sent; if you send ScreenRig-Project, it must match the token’s project. Supply your API authorization through the environment; see API authentication.

curl --request PUT "https://api.screenrig.ai/api/card-data/example-key" \
  --header "Authorization: Bearer $SCREENRIG_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{"document":{"title":"Varsity athletics","school":"","footnote":"","updatedAt":"","games":[]}}'