Pre-Match

Load data about an upcoming game to be streamed.

This call allows the courtside system to prepopulate information about the match and teams/players.

HTTP Request


			GET /v1/{sport}/stream/prematch/{streamKey}

Parameters

Parameter Name	Value	Description
Required Parameters
`sport`	`string`	The sport for which you are making the request
`streamKey`	`string`	The unique authorisation key that allows the streaming of the match
Optional Parameters
`format`	`string`	The format the data is being sent in. Options are `json` (Default) `xml`

Request Body

Do not send a Request body with this call.

Response

On success this method returns a series of blocks of data. While the blocks are all part of one data structure they are documented in separate blocks.

Example

            {
                "setup" : {
                    ...
                },
                "matchInformation" : {
                    ...
                },
                "teams" : {
                    ...
                },
                "officials" : {
                    ...
                }
          }

setup

This message type has information about the how the match will be run.

`periods`
	`numberofPeriods`	The number of periods
	`periodLength`	The length of the periods
	`extraTime`	Is extra time available
	`extraTimeLength`	The length of the extra time periods
	`breakPeriod`	The length (in minutes) between periods
	`breakHalfTime`	The length (in minutes) at half time
`sinBinTime`		The length of time a player must be in the sin bin
`warmupTime`		The length of time to allow the players to warmup
`shotClock`		The length of time (in seconds) for the shotclock
`foulsBeforeBonus`		The number of fouls before free throws are given
`foulsPersonal`		The maximum number of fouls (personal) allowed
`foulsTechnical`		The maximum number of fouls (technical) allowed
`customEfficiencyFormula`		The forumula for a custom efficiency statistic
`timeouts`
	`timeoutsStyle`	How are timeouts counted, by period or half
	`timeoutsPeriod1`	The maximum number of timeouts allowed in period 1
	`timeoutsPeriod2`	The maximum number of timeouts allowed in period 2
	`timeoutsPeriod3`	The maximum number of timeouts allowed in period 3
	`timeoutsPeriod4`	The maximum number of timeouts allowed in period 4
	`timeoutsHalf1`	The maximum number of timeouts allowed in the first half
	`timeoutsHalf2`	The maximum number of timeouts allowed in the second half
	`timeoutsExtraTime`	The maximum number of timeouts allowed in extraTime

Example

          "setup": {
            "periods": {
                "numberofPeriods":2,
                "periodLength" : 20,
                "extraTimeLength" : 5,
                "breakPeriod" : 2,
                "breakHalftime" : 2,
                "extraTime: 1
            },
            "foulsPersonal": "5",
            "foulsTechnical": "5",
            "sinBinTime": "300",
            "warmupTime": "300",
            "foulsBeforeBonus": "5",
            "shotClock": "25",
            "timeouts" : {
                "timeoutsStyle": "period",
                "timeoutsHalf1": "2",
                "timeoutsHalf2": "3",
                "timeoutsPeriod1": "2",
                "timeoutsPeriod2": "2",
                "timeoutsPeriod3": "2",
                "timeoutsPeriod4": "2",
                "timeoutsExtraTime": "1"
            }
          }

matchInformation

This message type has setup information about the match.

On Publish this message type is optional.

`competition`
	`competitionName`
	`competitionAbbrev`
	`standard`
	`competitionId`
	`externalId`
	`twitter`
	`gender`
	`year`
	`ageGroup`
`venue`
	`venueName`
	`venueCode`
	`locationName`
	`venueId`
	`externalId`
	`countryCode`
	`countryCodeIOC`
	`country`
	`venueNickname`
	`venueNicknameInternational`
	`venueCodeInternational`
	`venueNameInternational`
	`suburb`
	`latitude`
	`longitude`
	`surfaceName`
	`seatingCapacity`
	`timezone`
`league`
	`leagueName`
	`leagueAbbrev`
	`leagueId`
	`geographicRegion`
	`externalId`
	`countryCode`
	`countryCodeIOC`
	`country`
	`logo`	The files sub-structure from the Upload Resource. Only present if this league has a logo that has been uploaded.
`match`
	`matchTime`
	`matchName`
	`matchNumber`
	`phaseName`
	`poolName`
	`roundDescription`
	`roundNumber`
	`matchType`
	`twitterHashtag`
	`matchId`
	`externalId`

Example

        "matchInformation" : {
            "competition": {
              "competitionName": "National Basketball League 2014",
              "competitionAbbrev": "NBL2014",
              "standard": "ELITE",
              "competitionId": 2045,
              "externalId": "23",
              "twitter": "nbl",
              "gender": "MALE",
              "year": 2014,
              "ageGroup": "SENIOR"
            },
            "venue": {
              "venueName": "Maximum Stadium",
              "venueCode": "MAX",
              "locationName": "National Sports Complex",
              "venueId": 2045,
              "externalId": "23",
              "countryCode": "AU",
              "countryCodeIOC": "AU",
              "country": "Australia",
              "latitude": "-34.567",
              "longitude": "-30.347",
              "surfaceName": "Court 1",
              "venueNickname": "MAXIS",
              "seatingCapacity": 90000,
              "timeZone": "Australia/Melbourne"
            },
            "league": {
              "leagueName": "National Basketball League",
              "leagueAbbrev": "NBL",
              "leagueId": 20,
              "externalId": "2",
              "geographicRegion": "NATIONAL",
              "countryCode": "AU",
              "countryCodeIOC": "AU",
              "country": "Australia"
            },
            "match": {
              "matchName": "Preliminary Final 3 v 4 ",
              "matchTime": "2013-06-07 19:30:00",
              "matchNumber": 45,
              "phaseName": "Preliminary Round - A",
              "poolName": "Finals",
              "roundDescription": "Preliminary Finals",
              "roundNumber": 4,
              "matchType": "FINALS',
              "twitterHashtag": "nbl14m45',
              "matchId": 2065,
              "externalId": "243"
            }
        }

teams

This message type defines the teams and players for the match.

If no players are assigned to a team in the match, all players assigned to the team regardless of match will be returned.

It is compulsory to send at least one of these messages.

`teams`			An array of team records
	`teamNumber`		The number of the team in the match, 1 or 2.
	`detail`
		`teamName`
		`teamId`
		`externalId`
		`internationalReference`
		`teamNickname`
		`teamCode`
		`countryCode`
		`countryCodeIOC`
		`country`
		`website`
		`logo`	The files sub-structure from the Upload Resource. Only present if this team has a logo that has been uploaded.
	`competitionStatistics`		Returns a key/value structure consisting of the team's statisics for this competition in this team. The actual statistics returned depend on sport: Basketball
	`players`		A list of players
		`pno`	The number of the player in the match. This is a sequence number not a jumper number.
		`firstName`
		`familyName`
		`TVName`
		`internationalFirstName`
		`internationalFamilyName`
		`namePronunciation`
		`nickName`
		`personId`
		`externalId`
		`internationalReference`
		`nationalityCode`
		`nationalityCodeIOC`
		`nationality`
		`website`
		`profileURL`
		`isStarter`
		`shirtNumber`
		`playingPosition`
		`gender`
		`dob`
		`height`
		`photo`	The files sub-structure from the Upload Resource. Only present if this person has a photo that has been uploaded.
		`competitionStatistics`	Returns a key/value structure consisting of the person's statisics for this competition in this team. The actual statistics returned depend on sport: Basketball
	`staff`
		`staffType`
		`subStaffType`
		`isCoach`
		`isOfficial`
		`shirtNumber`
		`firstName`
		`familyName`
		`TVName`
		`internationalFirstName`
		`internationalFamilyName`
		`nationalityCode`
		`nationalityCodeIOC`
		`nationality`
		`namePronunciation`
		`nickName`
		`personId`
		`externalId`

Example

              "teams": {
                "teams": [
                  {
                    "teamNumber": 1,
                    "detail": {
                      "teamName": "Rotherberg Raiders",
                      "teamId": 2065,
                      "externalId": "243",
                      "internationalReference": "T1234",
                      "teamNickname": "Raiders",
                      "teamCode": "RRD",
                      "countryCode": "AU",
                      "countryCodeIOC": "AU",
                      "country": "Australia",
                      "website": "http://www.rrd.com",
                    },
                    "players": [
                      {
                        "pno": 1,
                        "firstName": "John",
                        "familyName": "Smith",
                        "personId": 3456,
                        "isStarter" : 1,
                        "website": "http://www.johnsmith.com",
                        "profileURL": "http://www.rrd.com/players/johnsmith.html",
                      },
                      {
                        "pno": 2,
                        "firstName": "Aaron",
                        "familyName": "Person",
                        "isStarter" : 1,
                        "personId": 57564,
                        "profileURL": "http://www.rrd.com/players/aaronperson.html"
                      }
                    ],
                    "staff": [
                      {
                        "staffType": "COACH",
                        "subStaffType": "Defensive Coach",
                        "isCoach": "1",
                        "firstName": "John",
                        "familyName": "Richardson",
                        "personId": 57564,
                        "externalId": "98"
                      }
                    ],
                  },
                  {
                    "teamNumber": 2,
                    "detail": {
                      "teamName": "Sackville Hawks",
                      "teamId": 2066,
                      "externalId": "248",
                      "internationalReference": "T1238",
                      "teamNickname": "Hawks",
                      "teamCode": "SVH",
                      "countryCode": "AU",
                      "countryCodeIOC": "AU",
                      "country": "Australia",
                      "website": "http://www.svh.com",
                    },
                    "players": [
                      {
                        "pno": 1,
                        "firstName": "Martin",
                        "familyName": "Mann",
                        "personId": 3458,
                        "isStarter" : 1,
                        "profileURL": "http://www.svh.com/players/mm.html",
                      },
                      {
                        "pno": 2,
                        "firstName": "Archie",
                        "familyName": "Person",
                        "personId": 57544,
                        "profileURL": "http://www.svh.com/players/ap.html"
                      }
                    ],
                  }
                ]
            }

officials

This message type contains the information about the match officials assigned to the match.

On Publish this message type is optional.

`message`
	`type`		`officials`
		`staffType`
		`subStaffType`
		`isCoach`
		`isOfficial`
		`shirtNumber`
		`firstName`
		`familyName`
		`TVName`
		`internationalFirstName`
		`internationalFamilyName`
		`nationalityCode`
		`nationalityCodeIOC`
		`nationality`
		`namePronunciation`
		`nickName`
		`personId`
		`externalId`

Example

          "officials": [
                {
                    "staffType" : "REFEREE",
                    "subStaffType" : "Head Referee",
                    "isOfficial" : 1,
                    "shirtNumber" : "34",
                    "personId" : 2345,
                    "firstName" : "John",
                    "familyName" : "Smith",
                    "externalId" : "HY3434"
                },
                {
                    "staffType" : "STATISTICIAN",
                    "subStaffType" : "Head Referee",
                    "isOfficial" : 1,
                    "personId" : 3875,
                    "firstName" : "David",
                    "familyName" : "Johns",
                    "externalId" : "JI3455"
                },
         ],