Matches

The Match is the event where the teams actually meet and compete. It occurs at a specific date/time at a specific venue.

This call allows a locked match to be unlocked for the purpose of editing.

This call allows a match video stream to be enabled.

This call allows a locked match to be reseted for the purpose of editing.

Get a list of stages and pools used by matches in the season

get
/ice3/o/{organizationId}/seasons/{seasonId}/fixtures/stages/pools

Return a list of stages and pools used by matches for a season

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
Responses
200

Successful operation

application/json
get
/ice3/o/{organizationId}/seasons/{seasonId}/fixtures/stages/pools

Get a list of matches

get
/ice3/o/{organizationId}/seasons/{seasonId}/fixtures

Return a list of matches for the season

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitorTypestring · enumOptional

The type of competitors in this fixture

  • ENTITY Entity
  • PERSON Person
Example: PERSONPossible values:
disciplinestring · enum · max: 30Optional

The discipline for a match

  • BEACH Beach
  • HOCKEY5S Hockey5s
  • INDOOR Indoor
  • OUTDOOR Outdoor
  • PARAHOCKEY Para hockey
Example: INDOORPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
featureMatchbooleanOptional

Is this match a featured match?

Example: true
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
fromTimeLocalstring · date-timeOptional

Where match start time (in local time) >= this value

Example: 2018-08-16T18:00:00
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
poolCodestring · max: 30Optional

The pool identifier within a season

Example: P1
roundCodestring · max: 30Optional

The round identifier within a season

Example: RN1
roundNumberstring · max: 30Optional

Round number

Example: 1
seriesCodestring · max: 30Optional

The series identifier within a season

Example: WC1
seriesFixtureNumberinteger · int32Optional

The number of the match in a series of matches

Example: 1
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: -startTimeUTC,fixtureNumberPattern: ^(\-?startTimeUTC|\-?fixtureNumber|\-?startTimeLocal|,)*$
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
statusstring · enum · max: 200Optional

Fixture status. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
statusNotstring · enum · max: 200Optional

Fixture status to not include. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
toTimeLocalstring · date-timeOptional

Where match start time (in local time) <= this value

Example: 2018-08-16T18:00:00
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
venueIdstring · uuidOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

application/json
get
/ice3/o/{organizationId}/seasons/{seasonId}/fixtures

Create a match

post
/ice3/o/{organizationId}/seasons/{seasonId}/fixtures

Add a new match

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidOptional

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
practiceDrillTypestring · enum | nullableOptional

Practice types

  • None None
  • DRILL Drill
  • FITNESS Fitness
  • GAME Practice Game
  • OTHER Other
Example: DRILLPossible values:
internationalReferencestring | nullableOptional

The international reference for this match given by the sport governing body

Example: CA3243-3
statusstring · enum · max: 100Optional

Match status

  • ABANDONED Abandoned - Match began but had to be stopped
  • ABOUT_TO_START About to Start - Match is about to start
  • BYE Bye - Team has 'rest'
  • CANCELLED Cancelled - Cancelled - will not be played
  • CONFIRMED Confirmed - Match officially completed
  • DRAFT Draft - Not fully scheduled
  • FINISHED Finished - Match finished by not yet 'official'
  • IF_NEEDED If Needed - Only played if needed
  • IN_PROGRESS In Progress - Currently in play
  • ON_PITCH On Pitch - Players appered on the playing field
  • PENDING Pending - Ready to start
  • POSTPONED Postponed - Will be played at a future time
  • SCHEDULED Scheduled - Yet to be played
  • WARM_UP Warm Up - Players have begun to warm up
Default: SCHEDULEDExample: SCHEDULEDPossible values:
fixtureNumberinteger · int32 | nullableOptional

Match number (range of -2147483648 to 2147483647)

Example: 123
nameLocalstring | nullableOptional

The name of the match in the local language

Example: Grand Final
nameLatinstring | nullableOptional

The name of the match in latin characters

Example: Grand Final
startTimeLocalstring · date-time | nullableOptional

Local start time

Example: 2018-08-16T18:00:00
startTimeActualUTCstring · date-time | nullableOptional

Actual start time (UTC)

Example: 2018-08-16T02:02:23
endTimeActualUTCstring · date-time | nullableOptional

Actual end time (UTC)

Example: 2018-08-16T04:02:23
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
placingIfWoninteger · int32 | nullableOptional

Place if Won?

Example: 1
placingIfLostinteger · int32 | nullableOptional

Place if Lost?

Example: 1
attendanceinteger · int32 | nullableOptional

Crowd attendance

Example: 1123
selloutbooleanOptional

Was the match a sellout?

Example: true
durationinteger · int32 | nullableOptional

Length, in minutes, of the match

Example: 48
durationFullinteger · int32 | nullableOptional

Full duration including breaks

Example: 180
ticketURLstring | nullableOptional

Ticket URL

stageCodestring | nullableOptional

A unique code for the stage. (Unique for season)

Example: ST1
seriesCodestring | nullableOptional

A unique code for the season series. (Unique for season)

Example: ST1
poolCodestring | nullableOptional

A unique code for the pool. (Unique for season)

Example: P1
roundCodestring | nullableOptional

A unique code for the round. (Unique for season)

Example: RN1
roundNumberstring | nullableOptional

The number given to the round

Example: 1
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
fixtureTypestring · enum · max: 50Optional

Type of match

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
maximumPeriodTypeUsedstring · enum | nullableOptional

Maximum Period Type Used

  • None None
  • EXTRA_TIME Extra Time
  • OVERTIME Overtime
  • REGULAR Regular
  • SHOOTOUT Shoot-Out
Example: REGULARPossible values:
competitorTypestring · enum · max: 50Required

The type of competitors in this match

  • ENTITY Entity
  • PERSON Person
Example: ENTITYPossible values:
venueIdstring · uuid | nullableOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
profileIdstring · uuid | nullableOptional

The profile that this match belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
includeInStandingsbooleanOptional

Include the match in the standings calculation?

Default: trueExample: true
featureMatchbooleanOptional

Is this match a featured match?

Example: true
seriesFixtureNumberinteger · int32 | nullableOptional

The number of the match in a series of matches

Example: 1
disciplinestring · enum | nullableOptional

match discipline

  • None None
  • INDOOR Indoor
  • OUTDOOR Outdoor
Example: INDOORPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/seasons/{seasonId}/fixtures

Get a list of matches for the organization

get
/ice3/o/{organizationId}/fixtures

Return a list of matches for the organization

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitorTypestring · enumOptional

The type of competitors in this fixture

  • ENTITY Entity
  • PERSON Person
Example: PERSONPossible values:
disciplinestring · enum · max: 30Optional

The discipline for a match

  • BEACH Beach
  • HOCKEY5S Hockey5s
  • INDOOR Indoor
  • OUTDOOR Outdoor
  • PARAHOCKEY Para hockey
Example: INDOORPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
featureMatchbooleanOptional

Is this match a featured match?

Example: true
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureIdsstring · uuidOptional

The unique identifiers of the fixtures (comma-delimited).

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc,de83c6a8-3b29-11eb-bdb7-0242ac130005
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
fromTimeLocalstring · date-timeOptional

Where match start time (in local time) >= this value

Example: 2018-08-16T18:00:00
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
poolCodestring · max: 30Optional

The pool identifier within a season

Example: P1
roundCodestring · max: 30Optional

The round identifier within a season

Example: RN1
roundNumberstring · max: 30Optional

Round number

Example: 1
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seasonIdsstring · uuidOptional

The unique identifiers of the seasons (comma-delimited).

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc,de83c6a8-3b29-11eb-bdb7-0242ac130005
seriesCodestring · max: 30Optional

The series identifier within a season

Example: WC1
seriesFixtureNumberinteger · int32Optional

The number of the match in a series of matches

Example: 1
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: -startTimeUTC,fixtureNumberPattern: ^(\-?startTimeUTC|\-?fixtureNumber|\-?startTimeLocal|,)*$
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
statusstring · enum · max: 200Optional

Fixture status. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
statusNotstring · enum · max: 200Optional

Fixture status to not include. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
toTimeLocalstring · date-timeOptional

Where match start time (in local time) <= this value

Example: 2018-08-16T18:00:00
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
venueIdstring · uuidOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

application/json
get
/ice3/o/{organizationId}/fixtures

Create a match base route

post
/ice3/o/{organizationId}/fixtures

Add a new match, allowing seasonId to be in payload

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidOptional

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
practiceDrillTypestring · enum | nullableOptional

Practice types

  • None None
  • DRILL Drill
  • FITNESS Fitness
  • GAME Practice Game
  • OTHER Other
Example: DRILLPossible values:
internationalReferencestring | nullableOptional

The international reference for this match given by the sport governing body

Example: CA3243-3
statusstring · enum · max: 100Optional

Match status

  • ABANDONED Abandoned - Match began but had to be stopped
  • ABOUT_TO_START About to Start - Match is about to start
  • BYE Bye - Team has 'rest'
  • CANCELLED Cancelled - Cancelled - will not be played
  • CONFIRMED Confirmed - Match officially completed
  • DRAFT Draft - Not fully scheduled
  • FINISHED Finished - Match finished by not yet 'official'
  • IF_NEEDED If Needed - Only played if needed
  • IN_PROGRESS In Progress - Currently in play
  • ON_PITCH On Pitch - Players appered on the playing field
  • PENDING Pending - Ready to start
  • POSTPONED Postponed - Will be played at a future time
  • SCHEDULED Scheduled - Yet to be played
  • WARM_UP Warm Up - Players have begun to warm up
Default: SCHEDULEDExample: SCHEDULEDPossible values:
fixtureNumberinteger · int32 | nullableOptional

Match number (range of -2147483648 to 2147483647)

Example: 123
nameLocalstring | nullableOptional

The name of the match in the local language

Example: Grand Final
nameLatinstring | nullableOptional

The name of the match in latin characters

Example: Grand Final
startTimeLocalstring · date-time | nullableOptional

Local start time

Example: 2018-08-16T18:00:00
startTimeActualUTCstring · date-time | nullableOptional

Actual start time (UTC)

Example: 2018-08-16T02:02:23
endTimeActualUTCstring · date-time | nullableOptional

Actual end time (UTC)

Example: 2018-08-16T04:02:23
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
placingIfWoninteger · int32 | nullableOptional

Place if Won?

Example: 1
placingIfLostinteger · int32 | nullableOptional

Place if Lost?

Example: 1
attendanceinteger · int32 | nullableOptional

Crowd attendance

Example: 1123
selloutbooleanOptional

Was the match a sellout?

Example: true
durationinteger · int32 | nullableOptional

Length, in minutes, of the match

Example: 48
durationFullinteger · int32 | nullableOptional

Full duration including breaks

Example: 180
ticketURLstring | nullableOptional

Ticket URL

stageCodestring | nullableOptional

A unique code for the stage. (Unique for season)

Example: ST1
seriesCodestring | nullableOptional

A unique code for the season series. (Unique for season)

Example: ST1
poolCodestring | nullableOptional

A unique code for the pool. (Unique for season)

Example: P1
roundCodestring | nullableOptional

A unique code for the round. (Unique for season)

Example: RN1
roundNumberstring | nullableOptional

The number given to the round

Example: 1
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
fixtureTypestring · enum · max: 50Optional

Type of match

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
maximumPeriodTypeUsedstring · enum | nullableOptional

Maximum Period Type Used

  • None None
  • EXTRA_TIME Extra Time
  • OVERTIME Overtime
  • REGULAR Regular
  • SHOOTOUT Shoot-Out
Example: REGULARPossible values:
competitorTypestring · enum · max: 50Required

The type of competitors in this match

  • ENTITY Entity
  • PERSON Person
Example: ENTITYPossible values:
venueIdstring · uuid | nullableOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
profileIdstring · uuid | nullableOptional

The profile that this match belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
includeInStandingsbooleanOptional

Include the match in the standings calculation?

Default: trueExample: true
featureMatchbooleanOptional

Is this match a featured match?

Example: true
seriesFixtureNumberinteger · int32 | nullableOptional

The number of the match in a series of matches

Example: 1
disciplinestring · enum | nullableOptional

match discipline

  • None None
  • INDOOR Indoor
  • OUTDOOR Outdoor
Example: INDOORPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures

Get a match

get
/ice3/o/{organizationId}/fixtures/{fixtureId}

Return detailed information about a specific match

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
Responses
200

Successful operation

application/json
get
/ice3/o/{organizationId}/fixtures/{fixtureId}

Update a match

put
/ice3/o/{organizationId}/fixtures/{fixtureId}

Change the information of a specific match

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
practiceDrillTypestring · enum | nullableOptional

Practice types

  • None None
  • DRILL Drill
  • FITNESS Fitness
  • GAME Practice Game
  • OTHER Other
Example: DRILLPossible values:
internationalReferencestring | nullableOptional

The international reference for this match given by the sport governing body

Example: CA3243-3
statusstring · enum · max: 100Optional

Match status

  • ABANDONED Abandoned - Match began but had to be stopped
  • ABOUT_TO_START About to Start - Match is about to start
  • BYE Bye - Team has 'rest'
  • CANCELLED Cancelled - Cancelled - will not be played
  • CONFIRMED Confirmed - Match officially completed
  • DRAFT Draft - Not fully scheduled
  • FINISHED Finished - Match finished by not yet 'official'
  • IF_NEEDED If Needed - Only played if needed
  • IN_PROGRESS In Progress - Currently in play
  • ON_PITCH On Pitch - Players appered on the playing field
  • PENDING Pending - Ready to start
  • POSTPONED Postponed - Will be played at a future time
  • SCHEDULED Scheduled - Yet to be played
  • WARM_UP Warm Up - Players have begun to warm up
Default: SCHEDULEDExample: SCHEDULEDPossible values:
fixtureNumberinteger · int32 | nullableOptional

Match number (range of -2147483648 to 2147483647)

Example: 123
nameLocalstring | nullableOptional

The name of the match in the local language

Example: Grand Final
nameLatinstring | nullableOptional

The name of the match in latin characters

Example: Grand Final
startTimeLocalstring · date-time | nullableOptional

Local start time

Example: 2018-08-16T18:00:00
startTimeActualUTCstring · date-time | nullableOptional

Actual start time (UTC)

Example: 2018-08-16T02:02:23
endTimeActualUTCstring · date-time | nullableOptional

Actual end time (UTC)

Example: 2018-08-16T04:02:23
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
placingIfWoninteger · int32 | nullableOptional

Place if Won?

Example: 1
placingIfLostinteger · int32 | nullableOptional

Place if Lost?

Example: 1
attendanceinteger · int32 | nullableOptional

Crowd attendance

Example: 1123
selloutbooleanOptional

Was the match a sellout?

Example: true
durationinteger · int32 | nullableOptional

Length, in minutes, of the match

Example: 48
durationFullinteger · int32 | nullableOptional

Full duration including breaks

Example: 180
ticketURLstring | nullableOptional

Ticket URL

stageCodestring | nullableOptional

A unique code for the stage. (Unique for season)

Example: ST1
seriesCodestring | nullableOptional

A unique code for the season series. (Unique for season)

Example: ST1
poolCodestring | nullableOptional

A unique code for the pool. (Unique for season)

Example: P1
roundCodestring | nullableOptional

A unique code for the round. (Unique for season)

Example: RN1
roundNumberstring | nullableOptional

The number given to the round

Example: 1
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
fixtureTypestring · enum · max: 50Optional

Type of match

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
maximumPeriodTypeUsedstring · enum | nullableOptional

Maximum Period Type Used

  • None None
  • EXTRA_TIME Extra Time
  • OVERTIME Overtime
  • REGULAR Regular
  • SHOOTOUT Shoot-Out
Example: REGULARPossible values:
competitorTypestring · enum · max: 50Optional

The type of competitors in this match

  • ENTITY Entity
  • PERSON Person
Example: ENTITYPossible values:
venueIdstring · uuid | nullableOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
externalIdstring | nullableOptional

The Id of the data as set by the provider of the data

Example: A123Pattern: ^[0-9A-Za-z/_-]+$
profileIdstring · uuid | nullableOptional

The profile that this match belongs to

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
includeInStandingsbooleanOptional

Include the match in the standings calculation?

Default: trueExample: true
featureMatchbooleanOptional

Is this match a featured match?

Example: true
seriesFixtureNumberinteger · int32 | nullableOptional

The number of the match in a series of matches

Example: 1
disciplinestring · enum | nullableOptional

match discipline

  • None None
  • INDOOR Indoor
  • OUTDOOR Outdoor
Example: INDOORPossible values:
Responses
200

Successful operation

application/json
put
/ice3/o/{organizationId}/fixtures/{fixtureId}

Delete a match

delete
/ice3/o/{organizationId}/fixtures/{fixtureId}

Delete a specific match

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
200

Successful operation

application/json
delete
/ice3/o/{organizationId}/fixtures/{fixtureId}

Trigger EMR merge process for the match

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/trigger

Triggers match EMR merge process.

Required scopes
This endpoint requires the following scopes:
  • : Perform administration API calls
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/trigger

Get a list of matches for a Team

get
/ice3/o/{organizationId}/seasons/{seasonId}/entities/{entityId}/fixtures

Return a list of matches, within seasonprefix season, for a specific Team

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
entityIdstring · uuidRequired

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitorTypestring · enumOptional

The type of competitors in this fixture

  • ENTITY Entity
  • PERSON Person
Example: PERSONPossible values:
disciplinestring · enum · max: 30Optional

The discipline for a match

  • BEACH Beach
  • HOCKEY5S Hockey5s
  • INDOOR Indoor
  • OUTDOOR Outdoor
  • PARAHOCKEY Para hockey
Example: INDOORPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
fromTimeLocalstring · date-timeOptional

Where match start time (in local time) >= this value

Example: 2018-08-16T18:00:00
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
isHomebooleanOptional

Is competitor the home team ?

limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
poolCodestring · max: 30Optional

The pool identifier within a season

Example: P1
roundCodestring · max: 30Optional

The round identifier within a season

Example: RN1
roundNumberstring · max: 30Optional

Round number

Example: 1
seriesCodestring · max: 30Optional

The series identifier within a season

Example: WC1
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: -startTimeUTCPattern: ^(\-?startTimeUTC|,)*$
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
statusstring · enum · max: 200Optional

Fixture status. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
toTimeLocalstring · date-timeOptional

Where match start time (in local time) <= this value

Example: 2018-08-16T18:00:00
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
venueIdstring · uuidOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

application/json
get
/ice3/o/{organizationId}/seasons/{seasonId}/entities/{entityId}/fixtures

Get a list of matches for a Team

get
/ice3/o/{organizationId}/entities/{entityId}/fixtures

Return a list of matches, for a specific Team

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
entityIdstring · uuidRequired

The unique identifier of the entity

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitorTypestring · enumOptional

The type of competitors in this fixture

  • ENTITY Entity
  • PERSON Person
Example: PERSONPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
fromTimeLocalstring · date-timeOptional

Where match start time (in local time) >= this value

Example: 2018-08-16T18:00:00
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
isHomebooleanOptional

Is competitor the home team ?

limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
poolCodestring · max: 30Optional

The pool identifier within a season

Example: P1
roundCodestring · max: 30Optional

The round identifier within a season

Example: RN1
roundNumberstring · max: 30Optional

Round number

Example: 1
seasonIdstring · uuidOptional

The unique identifiers of the seasons (comma-delimited).

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc,de83c6a8-3b29-11eb-bdb7-0242ac130005
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: -startTimeUTCPattern: ^(\-?startTimeUTC|,)*$
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
statusstring · enum · max: 200Optional

Fixture status. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
toTimeLocalstring · date-timeOptional

Where match start time (in local time) <= this value

Example: 2018-08-16T18:00:00
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
venueIdstring · uuidOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

application/json
get
/ice3/o/{organizationId}/entities/{entityId}/fixtures

Get a list of matches for a Competition

get
/ice3/o/{organizationId}/competitions/{competitionId}/fixtures

Return a list of matches, for a specific Competition

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
competitionIdstring · uuidRequired

The unique identifier of the competition

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitorTypestring · enumOptional

The type of competitors in this fixture

  • ENTITY Entity
  • PERSON Person
Example: PERSONPossible values:
disciplinestring · enum · max: 30Optional

The discipline for a match

  • BEACH Beach
  • HOCKEY5S Hockey5s
  • INDOOR Indoor
  • OUTDOOR Outdoor
  • PARAHOCKEY Para hockey
Example: INDOORPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureIdstring · uuidOptional

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
fromTimeLocalstring · date-timeOptional

Where match start time (in local time) >= this value

Example: 2018-08-16T18:00:00
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
poolCodestring · max: 30Optional

The pool identifier within a season

Example: P1
roundCodestring · max: 30Optional

The round identifier within a season

Example: RN1
roundNumberstring · max: 30Optional

Round number

Example: 1
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: -startTimeUTCPattern: ^(\-?startTimeUTC|,)*$
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
statusstring · enum · max: 200Optional

Fixture status. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
toTimeLocalstring · date-timeOptional

Where match start time (in local time) <= this value

Example: 2018-08-16T18:00:00
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
venueIdstring · uuidOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

application/json
get
/ice3/o/{organizationId}/competitions/{competitionId}/fixtures

Locking match

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/lock

Locking a specific match record

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
object · fixture_lockingpostbodyOptional
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/lock

Unlock match

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/unlock

Unlock a specific match record

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
object · fixture_lockingpostbodyOptional
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/unlock

Enable a match live video stream

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/enable

Enable a specific match live video stream

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/enable

Enable season live video streams for all matches

post
/ice3/o/{organizationId}/seasons/{seasonId}/video/streams/enable

Enable live video stream for all matches in season

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/seasons/{seasonId}/video/streams/enable

Enable season live video streams for all matches for a venue

post
/ice3/o/{organizationId}/seasons/{seasonId}/venues/{venueId}/video/streams/enable

Enable live video stream for all matches in season for a venue

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
venueIdstring · uuidRequired

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/seasons/{seasonId}/venues/{venueId}/video/streams/enable

Disable season live video streams for all matches

post
/ice3/o/{organizationId}/seasons/{seasonId}/video/streams/disable

Disable live video stream for all matches in season

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/seasons/{seasonId}/video/streams/disable

Disable a match live video stream

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/disable

Disable a specific match live video stream

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/disable

Disable season live video streams for all matches for a venue

post
/ice3/o/{organizationId}/seasons/{seasonId}/venues/{venueId}/video/streams/disable

Disable live video stream for all matches in season for a venue

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
seasonIdstring · uuidRequired

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
venueIdstring · uuidRequired

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/seasons/{seasonId}/venues/{venueId}/video/streams/disable

Start a match live video stream recording

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/start

Start a specific match live video stream recording

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/start

Stop a match live video stream recording

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/stop

Stop a specific match live video stream recording

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/stop

Resets a match live video stream recording

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/reset

Ressets a specific match live video stream recording

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
fixtureIdstring · uuidRequired

The unique identifier of the match

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr-FRPattern: ^[a-z]{2,2}-[A-Z]{2,2}$
platformProviderstring · enum · max: 30Optional

Video Provider platform

  • 5STREAM 5Stream
  • AV_SPORTRADAR AV Sportradar
Default: 5STREAMExample: 5STREAMPossible values:
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/video/streams/reset

Reset match

post
/ice3/o/{organizationId}/fixtures/{fixtureId}/reset

Reset a specific match record. Removes statistics, events and PLAY-BY-PLAY records

Required scopes
This endpoint requires the following scopes:
  • : Write/Update any data from below the organization
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
forceDeletebooleanOptional

Force a delete command to run and delete child records as well if there are existing records depending on the record.

Example: true
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
Body
object · fixture_resetpostbodyOptional
Responses
200

Successful operation

application/json
post
/ice3/o/{organizationId}/fixtures/{fixtureId}/reset

Get a list of matches for the organization group

get
/ice3/orgGroup/{organizationGroupCode}/fixtures

Return a list of matches for the organization group

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationGroupCodestring · min: 3 · max: 150Required

The unique identifier of the organization group

Example: aubb
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitorTypestring · enumOptional

The type of competitors in this fixture

  • ENTITY Entity
  • PERSON Person
Example: PERSONPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fixtureTypestring · enum · max: 50Optional

Type of Fixture

  • ALL_STAR All Star
  • DEMONSTRATION Demonstration
  • FINAL Final
  • FRIENDLY Friendly
  • PLAYOFF Playoff
  • PRESEASON Pre Season
  • REGULAR Regular
Example: REGULARPossible values:
fromTimeLocalstring · date-timeOptional

Where match start time (in local time) >= this value

Example: 2018-08-16T18:00:00
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
liveDataAvailablebooleanOptional

Is live data available?

Example: true
liveVideoAvailablebooleanOptional

Is live video available ?

Example: true
lockedbooleanOptional

Is the match locked (to prevent editing)?

Example: true
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
poolCodestring · max: 30Optional

The pool identifier within a season

Example: P1
roundCodestring · max: 30Optional

The round identifier within a season

Example: RN1
roundNumberstring · max: 30Optional

Round number

Example: 1
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
sortBystringOptional

Comma-delimited list of one or more fields to sort by. Each field can have '-' as prefix to sort in descending order and no prefix to sort in ascending order.

Example: -startTimeUTC,fixtureNumberPattern: ^(\-?startTimeUTC|\-?fixtureNumber|\-?startTimeLocal|\-?fixtureId|,)*$
stageCodestring · max: 30Optional

The stage identifier within a season

Example: ST1
statusstring · enum · max: 200Optional

Fixture status. Can specify multiple, delimited by comma.

  • ABANDONED Abandoned
  • ABOUT_TO_START About to Start
  • BYE Bye
  • CANCELLED Cancelled
  • CONFIRMED Confirmed
  • DRAFT Draft
  • FINISHED Finished
  • IF_NEEDED If Needed
  • IN_PROGRESS In Progress
  • ON_PITCH On Pitch
  • PENDING Pending
  • POSTPONED Postponed
  • SCHEDULED Scheduled
  • WARM_UP Warm Up
Example: SCHEDULEDPossible values:
timesUnconfirmedbooleanOptional

Is the match time yet to be confirmed ?

Example: true
toTimeLocalstring · date-timeOptional

Where match start time (in local time) <= this value

Example: 2018-08-16T18:00:00
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
venueIdstring · uuidOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
200

Successful operation

application/json
get
/ice3/orgGroup/{organizationGroupCode}/fixtures

Get a single match for the organization group

get
/ice3/orgGroup/{organizationGroupCode}/fixtures/{fixtureId}

Return detailed information about a specific match for the organization group

Required scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationGroupCodestring · min: 3 · max: 150Required

The unique identifier of the organization group

Example: aubb
Query parameters
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
Responses
200

Successful operation

application/json
get
/ice3/orgGroup/{organizationGroupCode}/fixtures/{fixtureId}

Last updated

Was this helpful?