Overview

Retrieve a list of ladder related information per specified grade.

This includes:

  • Pool and standings information and 
  • games played and results for each team.

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

Ladder Collection 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/ladder

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 Type*

grade.id

Unique identifier for each grade

"9026440a-41e9-4c75-9eb5-7f2860f29fbb"

UUID

ladders

Array of sub objects (defined below)

 

Array

ladders.pool

Object (defined below)

 

Object

ladders.pool.id

Pool identifier - Optional grouping within each grade

null

UUID

ladders.pool.name

Pool name

Pool A

String

ladders.standings

Array of sub objects (defined below)

 

Array

ladders.standings.team

Object (defined below)

 

Object

ladders.standings.team.id

Team ID

e50b0893-f1f6-41e9-9ee5-19d6b51981cb

UUID

ladders.standings.team.name

Team Name

Keilor U12 Boys 2

String

ladders.standings.played

Number of games team played

0

Integer

ladders.standings.won

Number of points for team’s game wins

0

Integer

ladders.standings.lost

Number of points for team’s game losses

0

Integer

ladders.standings.drawn

Number of points for team’s game draws

0

Integer

ladders.standings.byes

Number of points for team’s game byes

0

Integer

ladders.standings.pointsFor

 

00.00

Integer

ladders.standings.pointsAgainst

 

00.00

Integer

ladders.standings.forfeits

Number of points for team’s game forfeits

0

Integer

ladders.standings.disqualifications

Number of points for team’s game disqualifications

0

Integer

ladders.standings.adjustments

Any point adjustments for the team

00.00

Integer

ladders.standings.percentage

 

00.00

Integer

ladders.standings.competitionPoints

 

0

Integer

ladders.standings.pointsAverage

 

null

Integer

ladders.standings.ranking

 

1

Integer

 

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