Grade Fixture Collection

Overview

Retrieve a list of games and related fixture information under a specified grade.

This includes:

  • Status of the game;
  • round, pool and schedule information for each game;
  • teams involved in the game; 
  • and finalised game scores.

All data can be retrieved in real time but certain information may not be available until the fixture or game has been finalised.

Play HQ Terminology


Terms of use

https://www.playhq.com/terms


Play HQ API credentials

The Grade Fixture Collection API uses API keys to authenticate requests. To request API credentials please contact support@playhq.com

Once you have received your credentials from Play HQ you will be able to generate an authentication token. More information on how to do this can be found here.


Resources

Get Request

GET v1/grades/:id/games
Information on Path and Header parameters can be found here.

Data included in a successful response

Field Name in File

Field Description

Sample Data (or picklist values, if appropriate)

Database Field Typ

id

Game UUID

88a5b302-f71f-11ea-adc1-0242ac120002

UUID

status

Status of game

UPCOMING

String

url

URL to Game Centre on PlayHQ

https://www.playhq.com/basketball-victoria/org/jg_association2/domestic-winter-2021/monday-u10-mixed/game-centre/91e4cde3

 

createdAt

Game Created At timestamp

2015-08-05T08:40:51.620Z

String

updatedAt

Game last updated at timestamp

2015-08-05T08:40:51.620Z

String

round

Object (defined below)

 

Object

round.id

Round Id

a93c2389-b361-4af1-95f1-a758900fb018

UUID

round.name

Round Name

Round 1

String

round.abbreviatedName

Short name for round

R1

String 

round.isFinalRound

Flag to determine if round is final in grade

false

Boolean

pool

Object (defined below)

 

Object

pool.id

Pool identifier - Optional grouping within each grade

null

UUID

pool.name

Pool name

Pool A

String

schedule

Object (defined below)

 

Object

schedule.date

Schedule date

2015-08-05

String

schedule.time

Schedule time

08:40:51

String

schedule.timezone

Schedule Timezone

Australia/Melbourne

String

competitors

Array of sub objects (defined below)

 

Array

competitors.id

Competitors Id

95c446ef-dea5-486e-96bb-1bb24a609177

UUID

competitors.name

Competitors Name

Keilor U12 Boys 2

String

competitors.isHomeTeam

Flag to determine which team is home team per game

true

Boolean

competitors.outcome

Game outcome for specified team

i.e. Won or Lost

String

competitors.scoreTotal

Competitors Score Total

40

Number

competitors.scoreSubtotals.type

Game subtotals score type for specified team and game

i.e. Behinds Total or Goals Total

2_POINTER

String

competitors.scoreSubtotals.count

Game subtotal count for specified team and game

2

Number

competitors.scoreSubtotals.value

Game subtotals total value for each score type, specified team and game

4

Number

competitors.scoreSubtotals.value

Game subtotals for specified team and game

4

Number

venue

Object (defined below)

 

Object

venue.id

Id of Venue

eccf8810-7d57-4ffd-bb48-9418e3eb93ac

UUID

venue.name

Name of venue game is held

Keilor Basketball Netball Stadium

String

venue.surfaceName

Name of court/playing surface game is held

Court 1

String

venue.surfaceNameAbbreviation

Short name for court game is held

CRT1

String

venue.address

Object (defined below)

 

Object

venue.address.line1

Venue Address Line 1

Stadium Dr

String

venue.address.suburb

Venue Address Suburb

Keilor Park

String

venue.address.postcode

Venue Address Postcode

3042

Number

venue.address.state

Venue Address Stat

VIC

String

venue.address.country

Venue Address Country

AU

String

venue.address.longitude

Venue Address Longitude

-37.713286

Number

venue.address.latitude

Venue Address Latitude

144.848203

Number

metadata

Object (defined below)

 

Object

metadata.hasMore

 

true

Boolean

metadata.nextCursor

 

dXNlcjpXMDdRQ1JQQTQ=

 

 

Errors

Scenario

Error Response

Submit an invalid grade ID

400 - Bad Request

Submit multiple grade IDs

400 - Bad Request

 

Sample Response

PlayHQ External API

Was this article helpful?
0 out of 0 found this helpful