swagger: '2.0'
info:
description: 'This is Genius Sports Services Fixture API.
Changelog resume
- 2.0.261 - Ability to filter
by WELL-KNOWN external system identifiers e.g optaId, vesselId, fibaId, etc.
- 2.0.196 - Added the ability
to retrieve deleted fixtures
- 2.0.193 - Expose outright fixtures with an extra query param (eventTypes)
on GET and (eventType) on GetById for fixtures.
- 2.0.107 - Made fixtures round optional for POST and PUT.
Authentication
You
need to provide two tokens in every API call. The access_token for Auth0 client AND your API key
- In
order to get Auth0 client and API-KEY contact the SBOT team.
- Once you have the client you can make a request
to Auth0 to get a token by:
curl --request POST --url https://{env or nothing for prod}.auth.geniussports.com/oauth/token --header
''content-type: application/json'' --data ''{''client_id'':''4Ew9c8DX58O1i0zsrTW9DlLSlDg9Rrt7'',''client_secret'':''client-secret'',''audience'':''https://api.geniussports.com'',''grant_type'':''client_credentials''}'' - Once
you the get the response you would need to take the value from the ''access_token'' property. At this point you
are ready to get started!
-
- Use the
sports/10 call to retrieve Football (sport ID = 10)
curl https://{env
or nothing for prod}fixtures.api.geniussports.com/v2/sports?filter=id[equals]:10 -H ''Content-Type: application/json''
-H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ACCESS_TOKEN''
What
is new in Fixtures API v2.
- Consistent pagination with up to 200 items per page
- Consistent
response using HATEOAS model
wrapper (when listing items)
- Sorting by specific field(s) (see each endpoint details for fore info, about
which fields you can sort by)
- in order to sort just pass ''sortBy'' query param, example:
sortBy=id
- then by sorting, example: sortBy=id,name
- sort
by descending: example: sortBy=id:desc,name
- Powerful
filter by specific field (see each endpoint details for fore info, about which fields you can filter by)
- in
order to filter just pass ''filter'' query param, example: filter=id[equals]:1
- multiple IDs filtering, example: filter=id[in]:1,2,3
- Filter
stacking (separate them with ~), example: filter=id[in]:1,2,3~sportId[in]:1,2,3,4,5
- different
filter comparators: equals, in, gte, lte, contains, startsWith, notequals, nin:
- filter=id[equals]:1
- Equals comparator works with all data type
- filter=id[notequals]:1
- Not Equals comparator works with all data type
- filter=id[in]:1,2,3
- In comparator works only with integer and decimal values
- filter=id[nin]:1,2,3
- NIN comparator works only with integer and decimal values
- filter=startDate[gte]:2021-07-28~startDate[lte]:2021-07-29 -
duplications of filter property allowed only in this ''range'' case
- filter=name[contains]:test
- filter=name[startsWith]:test
- filter=cityName[equals]:null
- filter=cityName[notequals]:null
- Filter
by external id. Filter works only the Fixtures system has external provider and have explicitly allowed
persisting external ids fir tat source. example: filter=externalIds.optaId[equals]:12345
- Imporoved
and consistent structure of the API endpoints
- Each endpoint (which needs) from the hierarchy
has exactly 2 endpoints:
- One for listing multiple items - the filtering
sorting are implemented by query params
- One for single item by id
- No
deleted fixtures by default
- Does not use SpoCoSy database (Party), but the Proposal API database (therefore
there is Eventual consistency, and not everything is available right away)
Fixture
Tree Structure
- organisations
- venue
- locality
- sports
- competitions
- seasons
- rounds
(competitionPhase)
- fixture
- fixturecompetitors
- competitor
(team, player, doubles, horse, etc)
Examples
I
am interested in round 2 fixtures for the English Premier League
- Use sports
call to retrieve the relevant sport ID - in this case ID 10 for Football
curl https://ci.fixtures.api.geniussports.com/v2/sports
-H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Use
competitions call to see competitions for your sport - in this case ID 36 for ''England Premier League''
curl
https://ci.fixtures.api.geniussports.com/v2/competitions?filter=sportId[equals]:10~name[contains]:Premier -H ''Content-Type:
application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Use
seasons call to see seasons for your competition - in this case you will see the 2017/2018 season as ID 64525
curl
https://ci.fixtures.api.geniussports.com/v2/seasons?filter=competitionId[equals]:36 -H ''Content-Type: application/json''
-H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Use rounds call to see
rounds for your season - Find Round 2 with ID 338088
curl https://ci.fixtures.api.geniussports.com/v2/rounds?filter=seasonId[equals]:64525
-H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Use
fixtures call to get all fixtures we have for Round 2
curl https://ci.fixtures.api.geniussports.com/v2/fixtures?filter=roundId[equals]:338088
-H ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN''
I
am interested in Arsenal and their players
- You can re-use the 2017/2018 EPL
season ID from the example above, ID 64525 to get Season Details
curl https://ci.fixtures.api.geniussports.com/v2/seasons/64525
- ''Content-Type: application/json'' -H ''x-api-key: YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN'' - Find
Arsenal in the response with competitor ID 10025 and use this ID to get all Arsenal contracts
curl
https://ci.fixtures.api.geniussports.com/v2/competitors/teams/10025 -H ''Content-Type: application/json'' -H ''x-api-key:
YOUR_API_KEY'' -H ''Authorization: Bearer YOUR_ID_TOKEN''
'
version: 2.0.280
title: Fixtures-v2
contact:
email: sbonboarding@geniussports.com
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
host: fixtures.api.geniussports.com
basePath: /v2
tags:
- name: sports
description: Sport is the top level in the hierarchy and allows us to group competitions that share governing rules or customs
with the purpose to minimise the exceptions that apply to the entities that are below sport in the hierarchy, mainly the
competition
- name: organizations
description: Organization is the top level in the hierarchy and allows us to group competitions in order to apply permissions
rules over them.
- name: localities
description: This can include a country, continent, administrative region, game map, etc
- name: competitions
description: The competition groups the past and present seasons together. A competition is unique and remains the same
throughout its lifetime. The competition provides the base exceptions to the sport rules and customs that are defined
by the governing body
- name: seasons
description: In a sport, a season is a certain time period over which games of that sport are played. Typically a season
lasts a part of a year. Seasons sit within a competition and have a defined list of competitors and typically there is
an overall winner per season. A season consists of rounds, phases and series
- name: rounds
description: A round is a group of fixtures within a season e.g. Premier League 2021/2022 Round 1
- name: fixtures
description: A fixture is an entity that contains the information that is required to define a particular sporting event.
- name: competitors
description: The competitors are generalized term for a team, player, double partnership, horse, dog or any entity that
can participate in a Fixture
- name: competitors/teams
description: Groups the operations related to competitors of type Team
- name: competitors/players
description: Groups the operations related to competitors of type Player
- name: competitors/doubles
description: Groups the operations related to competitors of type Double partnership. When creating a double partnership
the competitors must be of the same sport, and the sport should allow creation of double partnerships. e.g tennis, beach
volleyball and similar
- name: competitors/horses
description: Groups the operations related to competitors of type Horse
- name: competitors/tbds
description: Groups the operations related to to-be-determined competitors.
- name: groups
description: The group is a wrapper of competitors that is connected to a season and a round. Currently used for Divisions
and Conferences.
- name: venues
description: A sports venue is a building, structure, or place in which a sporting fixture is held.
- name: contracts
description: The contract is relation between one competitor of one type and another competitor of another type representing
a real world relation between two competitors.
- name: persons
description: The person represents a real live person and it's basic properties
- name: sourcerequests
description: Source requests for clients using Genius Sports structured requests (not raw data but using Genius sports Id
references).
- name: ingestion
description: Ingesting raw data gets matched and then proposed for potential update or create to the SOT data.
schemes:
- https
paths:
/competitions:
get:
tags:
- competitions
summary: Retrieve competition by ID/s. MAX 200 per page.
description: Returns competitions wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, sportId, genderType, localityId)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, sportId, genderType, localityId)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitionResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- competitions
summary: Create new competition
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateCompetition
required: true
schema:
$ref: '#/definitions/CreateCompetition'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/CompetitionResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- competitions
summary: Update existing competition
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateCompetition
required: true
schema:
$ref: '#/definitions/UpdateCompetition'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/CompetitionResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
patch:
tags:
- competitions
summary: Patch existing competition
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: PatchCompetition
required: true
schema:
$ref: '#/definitions/PatchCompetition'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/CompetitionResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
/competitions/{id}:
get:
tags:
- competitions
summary: Retrieve competition details by ID.
description: Returns competition details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single competition ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitionResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- competitions
summary: Delete existing competition
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors:
get:
tags:
- competitors
summary: Retrieve competitors basic info regardless their type with reference to the detailed endpoint. MAX 200 per
page.
description: Retrieve competitors basic info regardless their type with reference to the detailed endpoint wrapped inside
a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType, competitorType)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/GeneralCompetitorResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/doubles:
get:
tags:
- competitors/doubles
summary: Retrieve competitors (doubles) by ID/s. MAX 200 per page.
description: Returns competitors (doubles) wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/DoublesPartnershipCompetitorResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- competitors/doubles
summary: Create new double partnership
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateDoublePartnership
required: true
schema:
$ref: '#/definitions/CreateDoublePartnership'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/DoublesPartnershipCompetitorResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- competitors/doubles
summary: Update existing double partnership
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateDoublePartnership
required: true
schema:
$ref: '#/definitions/UpdateDoublePartnership'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/DoublesPartnershipCompetitorResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/doubles/{id}:
get:
tags:
- competitors/doubles
summary: Retrieve competitors (doubles) details by ID.
description: Returns competitors (doubles) details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single competitors (doubles) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/DoublesPartnershipCompetitorResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/doubles/{id}/contracts:
get:
tags:
- contracts
summary: Retrieve persons which are part of the doubles partnership by Doubles Partnership ID/s. MAX 200 per page.
description: Returns the persons which are part of the doubles partnership by GSS Doubles Partnership Id in the path,
wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(competitorfromname, competitorfromid, competitorfromcompetitortype, createdon, modifiedon, updatedcount, from,
to)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (competitorfromname, competitorfromid, competitorfromcompetitortype, createdon, modifiedon, updatedcount,
from, to, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (doubles) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitorContractResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/doubles/{id}/rounds:
get:
tags:
- competitors/doubles
summary: Retrieve rounds in which the Doubles Partnership will take part by Team ID/s. MAX 200 per page.
description: Returns the rounds in which the doubles partnership will take part by GSS Doubles Partnership Id in the
path, wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (doubles) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitorRoundsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/doubles/{id}/seasons:
get:
tags:
- competitors/doubles
summary: Retrieve seasons in which the Doubles Partnership will take part by Team ID/s. MAX 200 per page.
description: Returns the seasons in which the Doubles Partnership will take part by GSS Doubles Partnership Id in the
path, wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (doubles) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitorSeasonsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/horses:
get:
tags:
- competitors/horses
summary: Retrieve competitors (horses) by ID/s. MAX 200 per page.
description: Returns competitors (horses) wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/HorseCompetitorResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/horses/{id}:
get:
tags:
- competitors/horses
summary: Retrieve competitors (horses) details by ID.
description: Returns competitors (horses) details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single competitors (horses) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/HorseCompetitorResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/players:
get:
tags:
- competitors/players
summary: Retrieve competitors (players) by ID/s. MAX 200 per page.
description: Returns competitors (players) wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PlayerCompetitorResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- competitors/players
summary: Create new player
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreatePlayerCompetitor
required: true
schema:
$ref: '#/definitions/CreatePlayerCompetitor'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/PlayerCompetitorResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- competitors/players
summary: Update existing player
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdatePlayerCompetitor
required: true
schema:
$ref: '#/definitions/UpdatePlayerCompetitor'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PlayerCompetitorResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/players/{id}:
get:
tags:
- competitors/players
summary: Retrieve competitors (players) details by ID.
description: Returns competitors (players) details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single competitors (players) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PlayerCompetitorResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/players/{id}/contracts:
get:
tags:
- contracts
summary: Retrieve persons which are associated with the current player (e.g. coaches) by Player ID/s. MAX 200 per page.
description: Returns the persons which are associated with the current player (e.g. coaches) by GSS Player Id in the
path, wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(competitortoname, competitortoid, competitortocompetitortype, createdon, modifiedon, updatedcount, from, to)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (competitortoname, competitortoid, competitortocompetitortype, createdon, modifiedon, updatedcount, from,
to, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (players) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PersonContractResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/players/{id}/rounds:
get:
tags:
- competitors/players
summary: Retrieve rounds in which the Player will take part by Team ID/s. MAX 200 per page.
description: Returns the rounds in which the player will take part by GSS Player Id in the path, wrapped inside a HATEOAS
model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (players) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitorRoundsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/players/{id}/seasons:
get:
tags:
- competitors/players
summary: Retrieve seasons in which the Player will take part by Team ID/s. MAX 200 per page.
description: Returns the seasons in which the player will take part by GSS Player Id in the path, wrapped inside a HATEOAS
model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (players) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitorSeasonsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/tbds:
get:
tags:
- competitors/tbds
summary: Retrieve competitors (TBD) by ID/s. MAX 200 per page.
description: Returns competitors (TBD) wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PlayerCompetitorResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- competitors/tbds
summary: Create new TBD competitor
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateTBDCompetitor
required: true
schema:
$ref: '#/definitions/CreateTBDCompetitor'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/TBDCompetitorResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- competitors/tbds
summary: Update existing TBD
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateTBDCompetitor
required: true
schema:
$ref: '#/definitions/UpdateTBDCompetitor'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/TBDCompetitorResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/tbds/{id}:
get:
tags:
- competitors/tbds
summary: Retrieve competitors (TBD) details by ID.
description: Returns competitors (TBD) details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single competitors (TBD) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/TBDCompetitorResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/teams:
get:
tags:
- competitors/teams
summary: Retrieve competitors (teams) by ID/s. MAX 200 per page.
description: Returns competitors (teams) wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/TeamCompetitorResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- competitors/teams
summary: Create new team
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateTeamCompetitor
required: true
schema:
$ref: '#/definitions/CreateTeamCompetitor'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/TeamCompetitorResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- competitors/teams
summary: Update existing team
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateTeamCompetitor
required: true
schema:
$ref: '#/definitions/UpdateTeamCompetitor'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/TeamCompetitorResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/teams/{id}:
get:
tags:
- competitors/teams
summary: Retrieve competitors (teams) details by ID.
description: Returns competitors (teams) details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single competitors (teams) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/TeamCompetitorResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/teams/{id}/contracts:
get:
tags:
- contracts
summary: Retrieve persons which are part of the team (a.k.a. Rosters) or persons which were part of the team by Team
ID/s. MAX 200 per page.
description: Returns the persons which were or are part of the team by GSS Team Id in the path, wrapped inside a HATEOAS
model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(competitorfromname, competitorfromid, competitorfromcompetitortype, createdon, modifiedon, updatedcount, from,
to)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (competitorfromname, competitorfromid, competitorfromcompetitortype, createdon, modifiedon, updatedcount,
from, to, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (teams) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitorContractResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/teams/{id}/rounds:
get:
tags:
- competitors/teams
summary: Retrieve rounds in which the Team will take part by Team ID/s. MAX 200 per page.
description: Returns the rounds in which the team will take part by GSS Team Id in the path, wrapped inside a HATEOAS
model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (teams) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitorRoundsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/teams/{id}/seasons:
get:
tags:
- competitors/teams
summary: Retrieve seasons in which the Team will take part by Team ID/s. MAX 200 per page.
description: Returns the seasons in which the team will take part by GSS Team Id in the path, wrapped inside a HATEOAS
model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single competitors (teams) ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/CompetitorSeasonsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/competitors/{id}:
get:
tags:
- competitors
summary: Retrieve competitors basic info regardless their type with reference to the detailed endpoint by ID.
description: Retrieve competitors basic info regardless their type with reference to the detailed endpoint by ID.
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single competitors ID to return information for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/GeneralCompetitorResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- competitors
summary: Delete existing existing competitor of any type - Team, Player, Double partnership etc
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/contracts:
get:
tags:
- contracts
summary: Retrieve contracts between person and different types of competitors.
description: Returns the persons, the corresponding player and the competitor with which the person has contract of
wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(competitor.Id, competitor.Name, person.Id, person.Name, player.Id, player.Name, createdon, modifiedon, updatedcount,
startDate, endDate, isactive)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (competitor.Id, competitor.Name, person.Id, person.Name, player.Id, player.Name, createdon, modifiedon,
updatedcount, startDate, endDate, isactive)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ContractResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- contracts
summary: Create new contract between competitor of any type and person
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateContract
required: true
schema:
$ref: '#/definitions/CreateContract'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/CompetitorContractResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- contracts
summary: Update existing contract between competitor of any type and person
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateContract
required: true
schema:
$ref: '#/definitions/UpdateContract'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/CompetitorContractResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/contracts/officials:
post:
tags:
- contracts
summary: Create new contract between competitor and person who has a team official role
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateCompetitorOfficialContract
required: true
schema:
$ref: '#/definitions/CreateCompetitorOfficialContract'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/CompetitorContractResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
/contracts/team/{teamId}/person/{personId}:
delete:
tags:
- contracts
summary: Delete existing contract by team and person Ids
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: teamId
in: path
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
- name: personId
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/contracts/team/{teamId}/player/{playerId}:
delete:
tags:
- contracts
summary: Delete existing contract by team and player Ids
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: playerId
in: path
required: true
type: string
- name: teamId
in: path
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/contracts/{id}:
delete:
tags:
- contracts
summary: Delete existing contract by id
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/fixtures:
get:
tags:
- fixtures
summary: Retrieve fixtures by ID/s. MAX 200 per page.
description: Returns fixtures wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: deleted
in: query
description: 'This field specifies whether to include deleted, not deleted, or both. Possible values: False, True,
or All.'
required: false
type: string
- name: eventTypes
in: query
description: This field specifies the event type to be returned (Match, SeasonOutright, PartialOutright, AggregateEvent).
By default, if not provided, 'Match' is returned. Multiple types can be combined in a single request, separated
by commas.
required: false
type: string
- name: withCompetitors
in: query
description: This field specifies whether when set to true to return fixtures without any TBD competitors or false
for all fixtures
required: false
type: string
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, roundId, seasonId, competitionId, sportId, eventStatusType, localityId, timezoneId, venueId, startDate)'
required: false
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, roundId, seasonId, competitionId, sportId, eventStatusType, localityId, timezoneId, venueId, startDate)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/FixtureResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
x-gs-attr-oldnewentityidssmap:
type: string
description: 'oldId=newId separated by semicolon '';'' e.g.: 1=2;3=4;...'
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- fixtures
summary: Create new fixture
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateFixture
required: true
schema:
$ref: '#/definitions/CreateFixture'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/FixtureResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- fixtures
summary: Update existing fixture
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateFixture
required: true
schema:
$ref: '#/definitions/UpdateFixture'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/FixtureResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
patch:
tags:
- fixtures
summary: Patch existing fixture
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: PatchFixture
required: true
schema:
$ref: '#/definitions/PatchFixture'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/FixtureResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
/fixtures/refdata:
get:
tags:
- fixtures
summary: Retrieve fixtures refdata by filter. MAX 200 per page.
description: Returns fixtures refdata wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, roundId, seasonId, competitionId, sportId, eventStatusType, localityId, timezoneId, venueId, startDate)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, roundId, seasonId, competitionId, sportId, eventStatusType, localityId, timezoneId, venueId, startDate)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/FixtureRefdataResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
x-gs-attr-oldnewentityidssmap:
type: string
description: 'oldId=newId separated by semicolon '';'' e.g.: 1=2;3=4;...'
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/fixtures/{id}:
get:
tags:
- fixtures
summary: Retrieve fixtures details by ID.
description: Returns fixtures details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: deleted
in: query
description: 'This field specifies whether to include deleted, not deleted, or both. Possible values: False, True,
or All.'
required: false
type: string
- name: eventType
in: query
description: The field specifies the type of event to return (Match, SeasonOutright, PartialOutright, AggregateEvent).
If not provided, the search defaults to fixtures of type 'Match'.
required: false
type: string
- name: id
in: path
description: Single fixtures ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/FixtureResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- fixtures
summary: Delete existing fixture
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/fixtures/{id}/contracts:
get:
tags:
- contracts
summary: Retrieve a snapshot of the contracts that were active for the competitors which were part of the fixture when
the fixture took place.
description: Returns the competitor, the person and the corresponding player
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: The field to 'order by' by. Descending ordering also allowed.
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: The field to 'filter' by. Check main description for filter comparators.
required: false
type: string
- name: id
in: path
description: Single fixture ID to return officials for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ContractResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/fixtures/{id}/lineups:
get:
tags:
- fixtures
summary: 'Retrieve whole fixture''s lineups by fixture ID for both teams '
description: Lineup availability may vary depending on the sport and specific fixture. In certain sports, lineups are
provided only for selected competitions only. When lineup data is not available, the API will return an empty response.
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single fixture ID to return lineups for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/FixtureLineupsResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/fixtures/{id}/officials:
get:
tags:
- fixtures
summary: Retrieve fixture's officials by fixture ID. MAX 200 per page.
description: Returns fixture's officials wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: The field to 'order by' by. Descending ordering also allowed.
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: The field to 'filter' by. Check main description for filter comparators.
required: false
type: string
- name: id
in: path
description: Single fixture ID to return officials for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/FixtureOfficialResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- fixtures
summary: Adds new official to the fixture
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
description: Single fixture ID to create official for
required: true
type: string
- in: body
name: CreateFixtureOfficial
required: true
schema:
$ref: '#/definitions/CreateFixtureOfficial'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/FixtureOfficialResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- fixtures
summary: Update existing fixture official
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
description: Single fixture ID to update official for
required: true
type: string
- in: body
name: CreateFixtureOfficial
required: true
schema:
$ref: '#/definitions/CreateFixtureOfficial'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/FixtureOfficialResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/fixtures/{id}/officials/{personId}:
delete:
tags:
- fixtures
summary: Removes official added to fixture
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
required: true
type: string
- name: personId
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: personId
in: path
required: true
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/groups:
get:
tags:
- groups
summary: Retrieve groups by ID/s. MAX 200 per page.
description: Returns groups wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, seasonId, competitionId, sportId, type)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, seasonId, competitionId, sportId, type)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/GroupResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- groups
summary: Create new group
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateGroup
required: true
schema:
$ref: '#/definitions/CreateGroup'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/GroupResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- groups
summary: Update existing group
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateGroup
required: true
schema:
$ref: '#/definitions/UpdateGroup'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/GroupResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/groups/{id}:
get:
tags:
- groups
summary: Retrieve groups details by ID.
description: Returns groups details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single groups ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/GroupResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- rounds
summary: Delete existing round
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/competitions:
post:
tags:
- ingestion
summary: Ingest competition data for update or create
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: competitionIngestion
required: true
schema:
$ref: '#/definitions/competitionIngestion'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/trackingRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/ingestion/competitions/searchById:
get:
tags:
- ingestion
summary: Search for ingestion proposals by competition Id.
description: Search for ingestion proposals by competition Id.
produces:
- application/json
parameters:
- name: onlyOwned
in: query
description: Indicates whether proposals from other sources should be included.
required: false
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: ids
in: query
description: A list of competition Ids
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ArrayOfproposalCompetition'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/competitions/searchBySourceEntityId:
get:
tags:
- ingestion
summary: Search for ingestion proposals by source entity Id.
description: Search for ingestion proposals by source entity Id.
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: sourceEntityIds
in: query
description: A list of source entity Ids
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
- name: source
in: query
description: The source that ingested the proposals.
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ArrayOfproposalCompetition'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/competitions/{trackingRequestId}/status:
get:
tags:
- ingestion
summary: Tracking the progress of the asynchronous execution.
description: Returns the current state of the ingestion request
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: trackingRequestId
in: path
description: GUID returned from an ingestion request
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/competitionTrackingStatusResponse'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: trackingRequestId
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/fixtures:
post:
tags:
- ingestion
summary: Ingest fixture data for update or create
description: 'Ingesting competitors requires indicating the competitor type. There are 3 options: Specify competitionType
on competition level. Specify competitorType on competitor level. Include one of the teamPropertiesModel/playerPropertiesModel/doublesPropertiesModel
fields on a competitor level.'
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: fixtureIngestion
required: true
schema:
$ref: '#/definitions/fixtureIngestion'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/trackingRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
patch:
tags:
- ingestion
summary: Patch existing fixture request. Currently support only lineups patch by sourceEntityId of the fixture.
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: fixtureIngestionPatch
required: true
schema:
$ref: '#/definitions/fixtureIngestionPatch'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/trackingRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/ingestion/fixtures/searchById:
get:
tags:
- ingestion
summary: Search for ingestion proposals by fixture Id.
description: Search for ingestion proposals by fixture Id.
produces:
- application/json
parameters:
- name: onlyOwned
in: query
description: Indicates whether proposals from other sources should be included.
required: false
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: ids
in: query
description: A list of fixture Ids
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ArrayOfproposalFixture'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/fixtures/searchBySourceEntityId:
get:
tags:
- ingestion
summary: Search for ingestion proposals by source entity Id.
description: Search for ingestion proposals by source entity Id.
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: sourceEntityIds
in: query
description: A list of source entity Ids
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
- name: source
in: query
description: The source that ingested the proposals.
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ArrayOfproposalFixture'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/fixtures/{trackingRequestId}/status:
get:
tags:
- ingestion
summary: Tracking the progress of the asynchronous execution.
description: Returns the current state of the ingestion request
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: trackingRequestId
in: path
description: GUID returned from an ingestion request
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/fixtureTrackingStatusResponse'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: trackingRequestId
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/squads:
post:
tags:
- ingestion
summary: Ingest team squad players data for update or create
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: squadIngestion
required: true
schema:
$ref: '#/definitions/squadIngestion'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/trackingRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/ingestion/squads/searchById:
get:
tags:
- ingestion
summary: Search for ingestion proposals by squad Id.
description: Search for ingestion proposals by squad Id.
produces:
- application/json
parameters:
- name: onlyOwned
in: query
description: Indicates whether proposals from other sources should be included.
required: false
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: ids
in: query
description: A list of squad Ids
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ArrayOfproposalSquad'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/squads/searchBySourceEntityId:
get:
tags:
- ingestion
summary: Search for ingestion proposals by source entity Id.
description: Search for ingestion proposals by source entity Id.
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: sourceEntityIds
in: query
description: A list of source entity Ids
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
- name: source
in: query
description: The source that ingested the proposals.
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ArrayOfproposalSquad'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/ingestion/squads/{trackingRequestId}/status:
get:
tags:
- ingestion
summary: Tracking the progress of the asynchronous execution.
description: Returns the current state of the ingestion request
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: trackingRequestId
in: path
description: GUID returned from an ingestion request
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/squadTrackingStatusResponse'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: trackingRequestId
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/localities:
get:
tags:
- localities
summary: Retrieve localities (old regions) by ID/s. MAX 200 per page.
description: Returns localities (old regions) wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, localityType)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, localityType)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/LocalityResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/localities/{id}:
get:
tags:
- localities
summary: Retrieve locality details by ID.
description: Returns locality details by ID
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single locality ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/LocalityResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/organizations:
get:
tags:
- organizations
summary: Retrieve organizations data. MAX 200 per page.
description: Returns organizations wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/OrganizationResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- organizations
summary: Create new organization
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateOrganization
required: true
schema:
$ref: '#/definitions/CreateOrganization'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/OrganizationResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- organizations
summary: Update existing organization
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateOrganization
required: true
schema:
$ref: '#/definitions/UpdateOrganization'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/OrganizationResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/organizations/{id}:
get:
tags:
- organizations
summary: Retrieve organization details by ID.
description: Returns organization details.
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single organization ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/OrganizationResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- organizations
summary: Delete existing organization
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/persons:
get:
tags:
- persons
summary: Retrieve persons by ID/s. MAX 200 per page. (Not available yet)
description: Returns persons wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PersonsListResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- persons
summary: Create new person
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreatePersonViewModel
required: true
schema:
$ref: '#/definitions/CreatePersonViewModel'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/PersonResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- persons
summary: Update existing person
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdatePersonViewModel
required: true
schema:
$ref: '#/definitions/UpdatePersonViewModel'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/PersonResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/persons/coaches:
get:
tags:
- persons
summary: Retrieve persons which were in the past or are currently coaches by ID/s. MAX 200 per page. (Not available
yet)
description: Returns persons wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PersonsListResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/persons/{id}:
get:
tags:
- persons
summary: Retrieve persons details by ID. (not available yet)
description: Returns persons details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single person ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PersonResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- persons
summary: Delete existing person
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/persons/{id}/contracts:
get:
tags:
- contracts
summary: Retrieve teams/doubles partnerships/players/etc in which the person takes (as coach, player in team, owner
etc.) part by Person ID/s. MAX 200 per page.
description: Returns the teams/doubles partnership/players/etc in which the person takes part by GSS Person Id in the
path, wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(competitortoname, competitortoid, competitortocompetitortype, createdon, modifiedon, updatedcount, from, to)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (competitortoname, competitortoid, competitortocompetitortype, createdon, modifiedon, updatedcount, from,
to, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single person ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PersonContractResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/persons/{id}/officials:
get:
tags:
- persons
summary: Retrieve person's officials by person ID. MAX 200 per page.
description: Returns person's officials wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: The field to 'order by' by. Descending ordering also allowed.
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: The field to 'filter' by. Check main description for filter comparators.
required: false
type: string
- name: id
in: path
description: Single person ID to return officials for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/PersonOfficialResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'301':
description: redirect operation
headers:
Location:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/rounds:
get:
tags:
- rounds
summary: Retrieve rounds by ID/s. MAX 200 per page.
description: Returns rounds wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, seasonId, competitionId, sportId, type)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, seasonId, competitionId, sportId, type)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RoundResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- rounds
summary: Create new round
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateRound
required: true
schema:
$ref: '#/definitions/CreateRound'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/RoundResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- rounds
summary: Update existing round
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateRound
required: true
schema:
$ref: '#/definitions/UpdateRound'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RoundResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
patch:
tags:
- rounds
summary: Patch existing round
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: PatchRound
required: true
schema:
$ref: '#/definitions/PatchRound'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/RoundResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
/rounds/{id}:
get:
tags:
- rounds
summary: Retrieve rounds details by ID.
description: Returns rounds details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single rounds ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RoundResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- rounds
summary: Delete existing round
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/rounds/{id}/competitors:
get:
tags:
- rounds
summary: Retrieve round competitors by Round ID/s. MAX 200 per page.
description: Returns the competitors which will take part in the round related to the GSS Round Id in the path, wrapped
inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single rounds ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/RoundCompetitorsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- rounds
summary: Adds new competitor to the round
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
- in: body
name: CreateRoundCompetitor
required: true
schema:
$ref: '#/definitions/CreateRoundCompetitor'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/RoundResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/rounds/{id}/competitors/{competitorId}:
delete:
tags:
- rounds
summary: Removes competitor added to round
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: competitorId
in: path
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/seasons:
get:
tags:
- seasons
summary: Retrieve seasons by ID/s. MAX 200 per page.
description: Returns seasons wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, competitionId, sportId, genderType, localityId)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, competitionId, sportId, genderType, localityId)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/SeasonResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- seasons
summary: Create new season
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateSeason
required: true
schema:
$ref: '#/definitions/CreateSeason'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/SeasonResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- seasons
summary: Update existing season
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateSeason
required: true
schema:
$ref: '#/definitions/UpdateSeason'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/SeasonResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
patch:
tags:
- seasons
summary: Patch existing season
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: PatchSeason
required: true
schema:
$ref: '#/definitions/PatchSeason'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/SeasonResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
/seasons/{id}:
get:
tags:
- seasons
summary: Retrieve seasons details by ID.
description: Returns seasons details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single season ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/SeasonResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- seasons
summary: Delete existing season
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/seasons/{id}/competitors:
get:
tags:
- seasons
summary: Retrieve season competitors by Season ID/s. MAX 200 per page.
description: Returns the competitors which will take part in the season related to the GSS Season Id in the path, wrapped
inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name, competitortype)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name, competitortype, isactive (default = true))'
required: false
type: string
- name: id
in: path
description: Single season ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/SeasonCompetitorsResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- seasons
summary: Adds new competitor to the season
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
- in: body
name: CreateSeasonCompetitor
required: true
schema:
$ref: '#/definitions/CreateSeasonCompetitor'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/SeasonResponseModel'
headers:
gs-duplicate-entity-replaced:
type: string
description: Returned when a duplicate entity has been replaced. Value is the 'duplicateEntityId' and the 'originalEntityId'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/seasons/{id}/competitors/{competitorId}:
delete:
tags:
- seasons
summary: Removes competitor added to season
produces:
- application/json
parameters:
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: competitorId
in: path
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
/sourcerequests/{requestId}/status:
get:
tags:
- sourcerequests
summary: Retrieves info about the status of a Source Request, given its Request Id.
description: Retrieves info about the status of a Source Request, given its Request Id.
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: requestId
in: path
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/SourceRequestStatusInfoModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: requestId
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/sports:
get:
tags:
- sports
summary: Retrieve sports by ID/s. MAX 200 per page.
description: Returns sports wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/SportResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/sports/{id}/{entityType}/metadata:
get:
tags:
- sports
summary: Retrieve allowed properties per entity type name and per sport.
description: Retrieve allowed properties per entity type name and per sport.
produces:
- application/json
parameters:
- name: entityType
in: path
description: 'Entity type is the name of the entity for which the allowed properties will be retrieved. Entity types:
competition, competitor, contract, fixture, round, season, venue, fixtureperson, player, team'
required: true
type: string
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: The sport for which the allowed properties will be retrieved.
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/ArrayOfMetadataPropertyTypesResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: entityType
in: path
required: true
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/venues:
get:
tags:
- venues
summary: Retrieve venues by ID/s. MAX 200 per page.
description: Returns venues wrapped inside a HATEOAS model
produces:
- application/json
parameters:
- name: page
in: query
description: The number of page to be returned. The default value is 1.
required: false
type: string
- name: pageSize
in: query
description: The size of the page to be returned. The default value is 10.
required: false
type: string
- name: sortBy
in: query
description: 'The field to ''order by'' by. Descending ordering also allowed. Fields to order by for this endpoint:
(id, name)'
required: false
type: string
- name: x-api-key
in: header
required: true
type: string
- name: filter
in: query
description: 'The field to ''filter'' by. Check main description for filter comparators. Fields to filter by for this
endpoint: (id, name)'
required: false
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/VenueResponseModelHATEOASReponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
post:
tags:
- venues
summary: Create new venue
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: CreateVenue
required: true
schema:
$ref: '#/definitions/CreateVenue'
responses:
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'201':
description: Created
schema:
$ref: '#/definitions/VenueResponseModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
put:
tags:
- venues
summary: Update existing venue
consumes:
- application/json
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- in: body
name: UpdateVenue
required: true
schema:
$ref: '#/definitions/UpdateVenue'
responses:
'200':
description: Success
schema:
$ref: '#/definitions/VenueResponseModel'
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'409':
description: Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!
schema:
$ref: '#/definitions/ErrorDuplicateModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
/venues/{id}:
get:
tags:
- venues
summary: Retrieve venues details by ID.
description: Returns venues details including sport specific details (metadata properties)
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: id
in: path
description: Single venues ID to return details for
required: true
type: string
responses:
'200':
description: successful operation
schema:
$ref: '#/definitions/VenueResponseModel'
headers:
Access-Control-Allow-Origin:
type: string
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'401':
description: Unauthorized
schema:
$ref: '#/definitions/ErrorModel'
'413':
description: Payload Too Large
schema:
$ref: '#/definitions/ErrorModel'
'403':
description: Forbidden
schema:
$ref: '#/definitions/ErrorModel'
'415':
description: Unsupported Media Type
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
'429':
description: Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit
Exceeded that does not help you
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
delete:
tags:
- venues
summary: Delete existing venue
produces:
- application/json
parameters:
- name: x-api-key
in: header
required: true
type: string
- name: gs-fixtures-api-sub-source
in: header
description: Sub Source Name
required: false
type: string
- name: id
in: path
required: true
type: string
responses:
'200':
description: Success
'520':
description: Unknown error
schema:
$ref: '#/definitions/ErrorModel'
'400':
description: Bad request
schema:
$ref: '#/definitions/BadRequestModel'
'202':
description: Accepted
schema:
$ref: '#/definitions/AcceptedModel'
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/ErrorModel'
'404':
description: Not found
schema:
$ref: '#/definitions/ErrorModel'
'504':
description: Gateway Timeout
schema:
$ref: '#/definitions/ErrorModel'
security:
- Auth0: []
- api_key: []
options:
consumes:
- application/json
produces:
- application/json
parameters:
- name: id
in: path
required: true
type: string
responses:
'200':
description: 200 response
schema:
$ref: '#/definitions/Empty'
headers:
Access-Control-Allow-Origin:
type: string
Access-Control-Allow-Methods:
type: string
Access-Control-Allow-Headers:
type: string
securityDefinitions:
Auth0:
type: apiKey
name: Authorization
in: header
x-amazon-apigateway-authtype: oauth2
api_key:
type: apiKey
name: x-api-key
in: header
definitions:
competitionPhaseMatchModel:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
startDate:
type: string
format: date-time
description: The start date of the competition phase in UTC ISO-8601 format. (yyyy-MM-ddTHH:mmZ)
title: Start Date
endDate:
type: string
format: date-time
description: The end date of the competition phase in UTC ISO-8601 format. (yyyy-MM-ddTHH:mmZ)
title: End Date
SimplifiedTrackingStatus:
type: integer
format: int32
description: 'Status of the proposal request: Accepted = 0, AwaitingMatching = 1, MatchedAndProposed = 3, ProposedAndApproved
= 5, InvalidProposal = 7, Matched = 8, FailedToProcess = 9, ProposedAndWaitingCuration = 10, EnrichingProposal = 12,
Suspended = 14, Ignored = 15, Inconsistent = 16'
enum:
- '0'
- '1'
- '3'
- '5'
- '7'
- '8'
- '9'
- '10'
- '12'
- '14'
- '15'
- '16'
RoundResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/RoundResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
PersonResponseModel:
type: object
required:
- createdOn
- firstName
- fullName
- genderType
- id
- isActive
- lastName
- locality
- updatesCount
- useNickname
properties:
id:
type: integer
format: int64
fullName:
type: string
firstName:
type: string
lastName:
type: string
genderType:
type: string
description: Undefined, Male, Female, Mixed.
dateOfBirth:
type: string
format: date-time
isActive:
type: boolean
nickName:
type: string
useNickname:
type: boolean
locality:
$ref: '#/definitions/HALEmbededResponse'
sports:
type: array
items:
$ref: '#/definitions/HALEmbededResponse'
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
ageCategory:
type: string
title: Age Category
description: 'Default is Senior. One of: U5, U6, U7, U8, U9, U10, U11, U12, U13, U14, U15, U16, U17, U18, U19, U20, U21,
U22, U23, Senior'
CreateFixture:
type: object
required:
- competitors
- seasonId
- startDate
properties:
seasonId:
type: integer
format: int64
description: The ID of the season to fixture belongs to.
title: Season Id
competitors:
type: array
description: Array of competitors to be added to the fixture.
title: Competitors
items:
type: integer
description: Competitors which belong to the fixture.
title: Competitors
homeCompetitorId:
type: integer
format: int64
description: 'The ID of the competitor from the competitors list to be marked as home competitor of the fixture. Can
only be updated if set to TBD competitor. By default if home competitor is not sent, the competitor which is first
in the competitors list will be marked as home competitor. E.g. If you send competitors: [3,2,1], competitor with
id 3 will be set as home competitor. If you send competitors: [1, 2, 3], competitor with id 1 will be marked as
home competitor'
title: Home Competitor Id
startDate:
type: string
format: date-time
description: The start date of the fixture in UTC ISO-8601 format
title: Start Date
roundId:
type: integer
format: int64
description: The ID of the round the fixture belongs to.
title: Round ID
venueId:
type: integer
format: int64
description: The ID of the venue the fixture is played at.
title: Venue ID
localityId:
type: integer
format: int64
description: The ID of the country/region/administrative zone the fixture is played at.
title: Locality ID
name:
type: string
description: Optionally a name can be posted, which will override the default Competitor one V Competitor two logic.
It's applicable for non two competitor sports
title: Name
maxLength: 250
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/fixture/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
matchDay:
type: integer
format: int32
attendance:
type: integer
format: int32
title: Create Fixture Model
description: This model should be used to propose a new fixture.
ContractResponseModel:
type: object
required:
- competitor
- createdOn
- id
- isActive
- person
- personRole
- player
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
person:
$ref: '#/definitions/PersonHALEmbededResponse'
sport:
$ref: '#/definitions/HALEmbededResponse'
player:
$ref: '#/definitions/HALEmbededResponse'
competitor:
$ref: '#/definitions/CompetitorHALEmbededResponse'
personRole:
type: string
isActive:
type: boolean
description: Whether the relation between the person and the competitor is active
title: Is Active
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/contract/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
FixtureRefdataResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/FixtureRefdataResponse'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
UpdateTeamCompetitor:
type: object
required:
- competitorStatusType
- id
- localityId
- name
properties:
id:
type: integer
format: int64
name:
type: string
description: The name of the competitor. It must be unique for the provided sport, locality, gender and type! It must
contain Women as name postfix when competitor is of CompetitorType Team (0) and gender is Female (2)! In any other
case the Women postfix is forbidden!
title: Competitor name
maxLength: 50
abbreviation:
type: string
description: An abbreviation for the competitor
title: Competitor sabbreviation
maxLength: 125
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. of the competitor!
title: Locality Id
venueId:
type: integer
format: int64
description: Id of the home venue of the competitor. The venue must be associated with the same sport as the competitor!
title: Venue Id
competitorStatusType:
$ref: '#/definitions/CompetitorStatusType'
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competitor/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
competitionResponseMatchModel:
type: object
required:
- competition
- sport
properties:
sport:
$ref: '#/definitions/baseResponseMatchModel'
organization:
$ref: '#/definitions/organizationReadonlyResponseModel'
competition:
$ref: '#/definitions/competitionReadonlyResponseModel'
season:
$ref: '#/definitions/baseResponseMatchModel'
competitionPhases:
type: array
items:
$ref: '#/definitions/competitionPhaseReadonlyResponseModel'
CompetitorSeasonsResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/CompetitorSeasonsResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
FixtureResponseModel:
type: object
required:
- competition
- createdOn
- eventStatusType
- eventType
- genderType
- id
- name
- sport
- startDate
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/fixture/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
startDate:
type: string
format: date-time
name:
type: string
season:
$ref: '#/definitions/HALEmbededResponse'
eventStatusType:
type: string
description: Notstarted, Inprogress, Finished, Cancelled, Postponed.
locality:
$ref: '#/definitions/HALEmbededResponse'
timezone:
$ref: '#/definitions/HALEmbededResponse'
venue:
$ref: '#/definitions/HALEmbededResponse'
sport:
$ref: '#/definitions/HALEmbededResponse'
competition:
$ref: '#/definitions/HALEmbededResponse'
round:
$ref: '#/definitions/HALEmbededResponse'
homeCompetitor:
description: Id of the competitor marked as home competitor
$ref: '#/definitions/CompetitorHALEmbededResponse'
genderType:
type: string
description: Undefined, Male, Female, Mixed.
ageCategory:
$ref: '#/definitions/ageCategory'
competitors:
type: array
items:
$ref: '#/definitions/FixtureCompetitorHALEmbededResponse'
fixtureLink:
$ref: '#/definitions/HALEmbededResponse'
eventType:
type: string
description: Match, VirtualMatch, SeasonOutright, PartialOutright, AggregateEvent
matchDay:
type: integer
format: int32
attendance:
type: integer
format: int32
SportResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/SportResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
proposalSeasonData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
UpdatePersonViewModel:
type: object
required:
- firstName
- genderType
- id
- isActive
- lastName
- localityId
- useNickname
properties:
firstName:
type: string
description: The first name of the person
title: First Name
maxLength: 256
lastName:
type: string
description: The last name of the person
title: Last Name
maxLength: 256
nickName:
type: string
description: The nickname of the person
title: Nickname
maxLength: 128
useNickname:
type: boolean
description: Whether the nickname should be used instead of the name of the person when displaying the person. If
the useNickname property is set to true nickname is required!
title: Is active
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. of the person!
title: Locality Id
dateOfBirth:
type: string
format: date-time
description: The date of birth of the person
title: Date of birth
genderType:
description: 'This property defines the possible gender types which can be set as integer values. Each integer value
is associated with relevant gender type as follows: 0 - Undefined; 1 - Male; 2 - Female; 3 - Mixed. It can only
be updated if the person does not have active relations to the any competitor'
$ref: '#/definitions/PersonGenderType'
id:
type: integer
format: int64
description: The ID of the person.
title: Id
isActive:
type: boolean
description: Whether the person can be used as fixture official or as part of a competitor. Setting this to false
will deactivate all relations of a person to fixtures as fixture official or to competitor as coach/player or any
other type of relation between person and competitor. It will also prevent using the person in future competitor/
fixture relations
title: Is Active
sports:
type: array
description: Array of sport Ids to be added to the person.
title: Sports
items:
type: integer
description: Sports to which the person belongs to.
title: Sports
doublesPropertiesModel:
type: object
properties:
firstCompetitor:
$ref: '#/definitions/playerPropertiesModel'
secondCompetitor:
$ref: '#/definitions/playerPropertiesModel'
PersonGenderType:
type: integer
title: Gender Type
format: int32
description: 'This property defines the possible person gender types which can be set as integer values. Each integer
value is associated with relevant gender type as follows: 0 - Undefined; 1 - Male; 2 - Female;'
enum:
- '0'
- '1'
- '2'
basePlayerPropertiesModel:
allOf:
- $ref: '#/definitions/firstLastNameModel'
- properties:
birthDate:
type: string
format: date-time
description: Player birthdate in format - full-date notation, for example, 2017-07-21
title: Birth Date
officials:
type: array
items:
$ref: '#/definitions/official'
LineupPlayerResponseModel:
type: object
properties:
player:
$ref: '#/definitions/CompetitorHALEmbededResponse'
shirtNumber:
type: string
position:
type: string
formationPosition:
type: string
formationPositionName:
type: string
isHome:
type: boolean
order:
type: integer
format: int32
isStarter:
type: boolean
PersonsListResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/PersonResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
coverageData:
type: object
properties:
type:
type: string
description: The coverage source.
liveData:
type: boolean
description: Whether the entity has live data coverage.
liveVideo:
type: boolean
description: Whether the entity has live video coverage.
proposalCompetition:
type: object
properties:
id:
type: string
sourceEntityId:
type: string
sourceName:
type: string
status:
type: string
data:
$ref: '#/definitions/proposalCompetitionIngestionData'
fixtureTrackingStatusResponse:
type: object
properties:
requestCuratedValue:
$ref: '#/definitions/fixtureResponseMatchModel'
status:
$ref: '#/definitions/SimplifiedTrackingStatus'
trackingRequestId:
type: string
description: Tracking Id of the progress of the asynchronous execution.
title: GUID value
BadRequestModel:
type: object
properties:
messages:
type: array
items:
type: string
RoundResponseModel:
type: object
required:
- competition
- createdOn
- endDate
- id
- name
- season
- sport
- startDate
- type
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/round/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
type:
type: string
description: Phase, Round, AggregateEvent
season:
$ref: '#/definitions/HALEmbededResponse'
sport:
$ref: '#/definitions/HALEmbededResponse'
competition:
$ref: '#/definitions/HALEmbededResponse'
parentRound:
$ref: '#/definitions/HALEmbededResponse'
timezone:
$ref: '#/definitions/HALEmbededResponse'
competitionTrackingStatusResponse:
type: object
properties:
requestCuratedValue:
$ref: '#/definitions/competitionResponseMatchModel'
status:
$ref: '#/definitions/SimplifiedTrackingStatus'
trackingRequestId:
type: string
description: Tracking Id of the progress of the asynchronous execution.
title: GUID value
FixtureRefdataVenue:
type: object
properties:
id:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
fixtureIngestion:
type: object
required:
- competition
- competitors
- fixture
- sport
properties:
organization:
$ref: '#/definitions/organizationMatchModel'
competition:
$ref: '#/definitions/competitionMatchModel'
sport:
$ref: '#/definitions/baseMatchModel'
fixture:
$ref: '#/definitions/fixtureMatchModel'
venue:
$ref: '#/definitions/venueMatchModel'
competitors:
type: array
items:
$ref: '#/definitions/fixtureCompetitorMatchModel'
competitionPhase:
$ref: '#/definitions/competitionPhaseMatchModel'
officials:
$ref: '#/definitions/officials'
sourceCoverage:
$ref: '#/definitions/sourceCoverage'
coverage:
$ref: '#/definitions/coverage'
locality:
type: string
title: 'Accepts either the 3 letter country code (ISO 3166-1 alpha-3 codes), the country name or the name of Continets,
Administrive region, etc.. If a code is sent an EXACT match is made on the enum, excluding all non-matching entities.
If the country is sent as string name a FUZZY match is made on the value and the similarity score is contributing to
the end match score. The name of the country in free text form or one of: AFG, ALB, ALG, AND, ANG, ANT, ARG, ARM, ARU,
ASA, AUS, AUT, AZE, BAH, BAN, BAR, BDI, BEL, BEN, BER, BHU, BIH, BIZ, BLR, BOL, BOT, BRA, BRN, BUL, BUR, CAF, CAM, CAN,
CAY, CGO, CHA, CHI, CHN, CIV, CMR, COD, COK, COL, COM, CPV, CRC, CRO, CUB, CYP, CZE, DEN, DJI, DMA, DOM, ECU, EGY, ERI,
ESA, ESP, EST, ETH, FIJ, FIN, FRA, FSM, GAB, GAM, GBR, GBS, GEO, GEQ, GER, GHA, GRE, GRN, GUA, GUI, GUM, GUY, HAI, HKG,
HON, HUN, INA, IND, IRI, IRL, IRQ, ISL, ISR, ITA, IVB, JAM, JOR, JPN, KAZ, KEN, KGZ, KIR, KOR, KOS, KSA, KUW, LAO, LAT,
LBA, LBN, LBR, LCA, LES, LIE, LTU, LUX, MAD, MAR, MAS, MAW, MDA, MDV, MEX, MGL, MHL, MKD, MLI, MLT, MNE, MON, MOZ, MRI,
MTN, MYA, NAM, NCA, NED, NEP, NGR, NIG, NOR, NRU, NZL, OMA, PAK, PAN, PAR, PER, PHI, PLE, PLW, PNG, POL, POR, PUR, QAT,
ROU, RSA, RUS, RWA, SAM, SEN, SEY, SGP, SKN, SLE, SLO, SMR, SOL, SOM, SRB, SRI, SSD, STP, SUD, SUI, SUR, SVK, SWE, SYR,
TAN, TGA, THA, TJK, TKM, TOG, TTO, TUN, TUR, TUV, UAE, UGA, UKR, URU, USA, UZB, VAN, VEN, VIE, VIN, YEM, ZAM, ZIM'
description: If sent а FUZZY match is made on the value and the similarity score is contributing to the end match score.
proposalSportData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
CreateCompetitorOfficialContract:
type: object
required:
- competitorId
- personRole
properties:
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/contract/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
personId:
type: integer
format: int64
minimum: 1.0
person:
description: Person information if not been created early, if the person already exists - leave empty.
$ref: '#/definitions/CreatePersonViewModel'
isActive:
type: boolean
description: Whether the contract is active or not. When lineups are added this will define whether the person can
be part of the lineup.
title: Is Active
competitorId:
type: integer
format: int64
minimum: 1.0
personRole:
$ref: '#/definitions/CompetitorPersonRoleType'
startDate:
type: string
format: date-time
description: When the contract was activated.
endDate:
type: string
format: date-time
description: When the contract was deactivated.
CreateFixtureOfficial:
type: object
properties:
personId:
type: integer
format: int64
description: Id of the person which will be added as fixture official
minimum: 1.0
person:
description: Person information if not been created early, if the person already exists - leave empty.
$ref: '#/definitions/CreatePersonViewModel'
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/fixtureperson/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
proposalVenueData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
locality:
type: string
city:
type: string
CreateContract:
type: object
required:
- competitorId
- personId
- personRole
properties:
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/contract/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
personId:
type: integer
format: int64
minimum: 1.0
isActive:
type: boolean
description: Whether the contract is active or not. When lineups are added this will define whether the person can
be part of the lineup.
title: Is Active
competitorId:
type: integer
format: int64
minimum: 1.0
personRole:
$ref: '#/definitions/CompetitorPersonRoleType'
startDate:
type: string
format: date-time
description: When the contract was activated.
endDate:
type: string
format: date-time
description: When the contract was deactivated.
CreateRoundCompetitor:
type: object
properties:
competitorId:
type: integer
format: int64
description: The id of the competitor which will be added in the round
title: Competitor Id
FixtureLineupsResponseModel:
type: object
required:
- confirmed
- createdOn
- id
- lineupPlayers
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
fixture:
$ref: '#/definitions/HALEmbededResponse'
confirmed:
type: boolean
homeTeam:
$ref: '#/definitions/LineupTeamResponseModel'
awayTeam:
$ref: '#/definitions/LineupTeamResponseModel'
lineupPlayers:
type: array
items:
$ref: '#/definitions/LineupPlayerResponseModel'
fixtureReadonlyResponseModel:
allOf:
- $ref: '#/definitions/baseResponseMatchModel'
- properties:
matchNumber:
type: string
atNeutralVenue:
type: boolean
sportSpecificRules:
$ref: '#/definitions/sportSpecificRules'
FixtureOfficialResponseModel:
type: object
required:
- createdOn
- id
- person
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
person:
$ref: '#/definitions/PersonHALEmbededResponse'
sport:
$ref: '#/definitions/HALEmbededResponse'
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModel'
proposalCompetitionIngestionData:
type: object
properties:
sport:
$ref: '#/definitions/proposalSportData'
organization:
$ref: '#/definitions/proposalOrganizationData'
season:
$ref: '#/definitions/proposalSeasonData'
competition:
$ref: '#/definitions/proposalCompetitionData'
competitionPhases:
type: array
items:
$ref: '#/definitions/proposalCompetitionPhaseData'
SeasonCompetitorsResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/SeasonCompetitorsResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
teamMatchModel:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
gender:
$ref: '#/definitions/gender'
ageCategory:
$ref: '#/definitions/ageCategory'
locality:
$ref: '#/definitions/locality'
teamPropertiesModel:
$ref: '#/definitions/teamPropertiesModel'
HALEmbededResponse:
type: object
required:
- id
- name
- ref
properties:
id:
type: integer
format: int64
name:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
ref:
type: string
UpdateContract:
type: object
required:
- id
- isActive
properties:
id:
type: integer
format: int64
description: The id of the contract which will be updated.
title: Id
isActive:
type: boolean
description: Whether the contract is active or not. When lineups are added this will define whether the person can
be part of the lineup.
title: Is Active
startDate:
type: string
format: date-time
description: When the contract was activated.
endDate:
type: string
format: date-time
description: When the contract was deactivated.
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/contract/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
proposalDataBase:
type: object
properties:
id:
type: string
name:
type: string
sourceEntityId:
type: string
sourceMetadata:
type: object
description: Source metadata
title: An additional collection of metadata supplied by the source.
additionalProperties:
type: string
gender:
type: string
title: 'One of: Male, Female, Mixed. If the entity is neither Male, nor Female use Mixed.'
description: If sent an EXACT match is made on the enum, excluding all non-matching entities.
proposalSquadPlayerData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
gender:
type: string
person:
$ref: '#/definitions/proposalPersonData'
locality:
$ref: '#/definitions/proposalLocalityData'
contractStartDate:
type: string
format: date-time
contractEndDate:
type: string
format: date-time
birthDate:
type: string
format: date-time
position:
type: string
shirtNumber:
type: string
isPartOfTeam:
type: boolean
ArrayOfproposalFixture:
type: array
items:
$ref: '#/definitions/proposalFixture'
fixtureCompetitorMatchModel:
allOf:
- $ref: '#/definitions/competitorMatchModel'
- properties:
lineup:
$ref: '#/definitions/lineup'
preserveLineup:
type: boolean
description: Default value false, if set to true, it prevent accidental clearing of previously ingested lineups
when subsequent proposals deliberately or incidentally omit the lineups field.
title: Preserve Lineup
ContractResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/ContractResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
competitorReadonlyResponseModel:
allOf:
- $ref: '#/definitions/baseResponseMatchModel'
- properties:
lineup:
$ref: '#/definitions/lineupReadonlyResponseModel'
PersonHALEmbededResponse:
type: object
required:
- firstName
- fullName
- genderType
- id
- lastName
- locality
- ref
properties:
id:
type: integer
format: int64
dateOfBirth:
type: string
format: date-time
firstName:
type: string
lastName:
type: string
fullName:
type: string
nickName:
type: string
genderType:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
locality:
$ref: '#/definitions/HALEmbededResponse'
ref:
type: string
PersonOfficialResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/PersonOfficialResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
CreatePersonViewModel:
type: object
required:
- firstName
- genderType
- lastName
- localityId
- useNickname
properties:
firstName:
type: string
description: The first name of the person
title: First Name
maxLength: 256
lastName:
type: string
description: The last name of the person
title: Last Name
maxLength: 256
nickName:
type: string
description: The nickname of the person
title: Nickname
maxLength: 128
useNickname:
type: boolean
description: Whether the nickname should be used instead of the name of the person when displaying the person. If
the useNickname property is set to true nickname is required!
title: Is active
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. of the person!
title: Locality Id
dateOfBirth:
type: string
format: date-time
description: The date of birth of the person
title: Date of birth
genderType:
$ref: '#/definitions/PersonGenderType'
sports:
type: array
description: Array of sport Ids to be added to the person.
title: Sports
items:
type: integer
description: Sports to which the person belongs to.
title: Sports
OrganizationResponseModel:
type: object
required:
- code
- createdOn
- id
- name
- updatesCount
properties:
id:
type: integer
format: int64
title: Id of the organization
createdOn:
type: string
format: date-time
title: The date on which the organization was created
modifiedOn:
type: string
format: date-time
title: The date on which the organization was modified
updatesCount:
type: integer
format: int32
title: The number of times the organization was modified
name:
type: string
description: Unique name of the organization
code:
type: string
description: Unique code of the organization
SourceRequestStatusInfoModel:
type: object
required:
- entityName
- gssId
- gssName
- status
properties:
status:
type: string
description: 'Status of the source request. All statuses: Pending, Accepted, Rejected, Approved, Outdated.'
entityName:
type: string
description: Name of the entity
gssId:
type: string
description: Id of the response data
gssName:
type: string
description: Name of the response data
ArrayOfproposalSquad:
type: array
items:
$ref: '#/definitions/proposalSquad'
competitionReadonlyResponseModel:
allOf:
- $ref: '#/definitions/baseResponseMatchModel'
- properties:
sportSpecificRules:
$ref: '#/definitions/sportSpecificRules'
CreatePlayerCompetitor:
type: object
required:
- sportId
properties:
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModelViewModel'
personId:
type: integer
format: int64
description: If the person is already existing set its Id, otherwise leave it empty and populate the person object
minimum: 1.0
sportId:
type: integer
format: int64
description: Id of the sport in which the competitor can be used
minimum: 1.0
person:
description: Person information if not been created early, if the person already exists - leave empty.
$ref: '#/definitions/CreatePersonViewModel'
VenueResponseModel:
type: object
required:
- createdOn
- id
- latitude
- longitude
- name
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/venue/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
latitude:
type: number
format: double
longitude:
type: number
format: double
locality:
$ref: '#/definitions/HALEmbededResponse'
capacity:
type: integer
format: int32
cityName:
type: string
sports:
type: array
items:
$ref: '#/definitions/HALEmbededResponse'
parentVenue:
$ref: '#/definitions/HALEmbededResponse'
FixtureRefdataSeason:
type: object
properties:
id:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
PatchCompetition:
type: object
required:
- id
properties:
id:
type: integer
format: int64
description: The ID of the season.
title: Id
name:
type: string
description: The name of the competition. It must be unique for the given sport context!
title: Competition name
maxLength: 250
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. where the competition will be held!
title: Locality Id
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competition/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
title: Patch Competition Model
description: This model should be used to propose a partial patch to a competition. Keep in mind that updating the name
of competition will update future season names as well. Also updating the locality will update future season localities
as well. Updating metadata properties will update future fixture and round metadata properties as well, which are considered
inheritable.
CreateTBDCompetitor:
type: object
required:
- name
- sportId
properties:
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModelViewModel'
name:
type: string
description: The name of the competitor. It must be unique for the provided sport!
title: Competitor name
maxLength: 50
sportId:
type: integer
format: int64
description: Id of the sport in which the competitor can be used
minimum: 1.0
fixtureMatchModel:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
startDate:
type: string
format: date-time
description: The start date of the fixture in UTC ISO-8601 format. (yyyy-MM-ddTHH:mmZ)
title: Start Date
startDateUnreliable:
type: boolean
description: Whether the start date is unreliable or not. If true, the start date is not reliable and it will be
ignored for updates.
title: Start Date Unreliable
locality:
$ref: '#/definitions/locality'
eventStatus:
type: string
description: Notstarted, Inprogress, Finished, Cancelled, Postponed.
sportSpecificRules:
$ref: '#/definitions/sportSpecificRules'
matchNumber:
type: string
atNeutralVenue:
type: boolean
LineupTeamResponseModel:
allOf:
- $ref: '#/definitions/CompetitorHALEmbededResponse'
- properties:
formation:
type: string
description: The team formation for the current lineup
title: Team formation in the lineup, e.g. 4-4-2
GeneralCompetitorResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/GeneralCompetitorResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
PatchSeason:
type: object
required:
- id
properties:
id:
type: integer
format: int64
description: The ID of the season.
title: Id
startDate:
type: string
format: date-time
description: The start date of the season in UTC ISO-8601 format
title: Start Date
endDate:
type: string
format: date-time
description: The end date of the season in UTC ISO-8601 format
title: End Date
title: Patch Season Model
description: This model should be used to propose a partial update/patch to a season.
playerMatchModel:
type: object
properties:
birthDate:
type: string
format: date-time
description: Player birthdate in format - full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21
title: Birth Date
sourceEntityId:
type: string
description: Source entity unique Id
title: The external id from Genius Sports perspective and the internal for the source. By sending this param the backtracking
capabilities improved, via push & pull.
position:
type: string
description: The playing position, depending on the sport.
shirtNumber:
type: number
description: The number of the Shirt for the player
locality:
$ref: '#/definitions/locality'
playerPropertiesModel:
$ref: '#/definitions/firstLastNameModel'
gender:
$ref: '#/definitions/gender'
name:
type: string
description: The full name of the player
sourceMetadata:
type: object
description: Source metadata
title: An additional collection of metadata supplied by the source.
additionalProperties:
type: string
id:
type: string
description: Genius Sport Id
title: If client has the Genius Sport Id it can be sent to improve overall matching capabilities and certainty or
the results.
PatchRound:
type: object
required:
- id
properties:
id:
type: integer
format: int64
description: The ID of the round.
title: Id
startDate:
type: string
format: date-time
description: The start date of the round in UTC ISO-8601 format
title: Start Date
endDate:
type: string
format: date-time
description: The end date of the round in UTC ISO-8601 format
title: End Date
title: Patch Round Model
description: This model should be used to propose a partial update/patch to a round.
CreateSeason:
type: object
required:
- competitionId
- endDate
- startDate
properties:
name:
type: string
description: Default season name will be generated by the competition if no name is provided
title: Season Name
startDate:
type: string
format: date-time
description: The start date of the season in UTC ISO-8601 format
title: Start Date
endDate:
type: string
format: date-time
description: The end date of the season in UTC ISO-8601 format
title: End Date
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. where the season will be held. Competition's Locality will be set
if this is not passed on request!
title: Locality Id
competitionId:
type: integer
format: int64
description: Id of the competition to which the season will be associated!
title: Competition Id
competitors:
type: array
description: Array of competitors to be added to the season.
title: Competitors
items:
type: integer
description: Competitors which are associated with the season.
title: Competitors
timezone:
type: string
description: 'The timezone which will be set as default timezone for the season''s fixtures if timezone is not specified.
Possible timezones (splited by '',''): Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anguilla,America/Antigua,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Aruba,America/Asuncion,America/Bahia,America/Barbados,America/Belem,America/Belize,America/Bogota,America/Boise,America/Buenos_Aires,America/Campo_Grande,America/Cancun,America/Caracas,America/Chicago,America/Chihuahua,America/Costa_Rica,America/Cuiaba,America/Curacao,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/El_Salvador,America/Fortaleza,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Petersburg,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indianapolis,America/Jamaica,America/Kentucky/Louisville,America/Kentucky/Monticello,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Managua,America/Manaus,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Mexico_City,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Nassau,America/New_York,America/Panama,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Porto_Velho,America/Port_of_Spain,America/Puerto_Rico,America/Recife,America/Rio_Branco,America/Rosario,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/Tegucigalpa,America/Tijuana,America/Toronto,America/Vancouver,America/Whitehorse,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dubai,Asia/Dushanbe,Asia/Gaza,Asia/Harbin,Asia/Hong_Kong,Asia/Hovd,Asia/Ho_Chi_Minh,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Katmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pyongyang,Asia/Qatar,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimphu,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Madeira,Atlantic/Reykjavik,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Hobart,Australia/Melbourne,Australia/North,Australia/NSW,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,CET,Chile/Continental,CST6CDT,Cuba,EET,Egypt,EST,Etc/GMT,Etc/GMT+1,Etc/GMT+12,Etc/GMT+2,Etc/GMT+3,Etc/GMT+4,Etc/GMT+5,Etc/GMT+6,Etc/GMT+7,Etc/GMT+8,Etc/GMT+9,Etc/GMT-0,Etc/GMT-1,Etc/GMT-2,Etc/GMT-3,Etc/GMT-4,Etc/GMT-5,Etc/GMT-7,Etc/GMT-8,Etc/Greenwich,Etc/UTC,Europe/Amsterdam,Europe/Andorra,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Kaliningrad,Europe/Kiev,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,GB,GB-Eire,GMT,GMT0,Hongkong,Iceland,Indian/Cocos,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Reunion,Iran,Israel,Jamaica,Japan,Libya,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,MST,MST7MDT,NZ,Pacific/Apia,Pacific/Auckland,Pacific/Easter,Pacific/Fiji,Pacific/Guadalcanal,Pacific/Kosrae,Pacific/Noumea,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Tahiti,Poland,Portugal,Singapore,Turkey,UCT,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,UTC,WET'
title: Competition timezone
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/season/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
FixtureRefdataCompetitor:
type: object
properties:
id:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
isHome:
type: boolean
formation:
type: string
lineup:
type: array
items:
$ref: '#/definitions/FixtureRefdataLineupPlayer'
officialsReadonlyResponseModel:
type: array
items:
$ref: '#/definitions/officialReadonlyResponseModel'
ErrorDuplicateModel:
type: object
properties:
messages:
type: array
items:
type: string
geniusSportsConflictId:
type: string
description: This is the official genius sports ID, which you have conflict with.
CompetitorRoundsResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/CompetitorRoundsResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
CreateGroup:
type: object
required:
- name
- seasonId
- type
properties:
name:
type: string
description: Name of the group.
title: Group name
competitors:
type: array
description: Array of competitors to be added to the group.
title: Competitors
items:
type: integer
description: Competitors which are associated with the group.
title: Competitors
type:
type: string
description: "The type of group. 0 = Conference \n1 = Division"
title: Type
seasonId:
type: integer
format: int64
description: The ID of the season the group belongs to.
title: Season Id
parentGroupId:
type: integer
format: int64
description: The ID of the parent group to which posted group belongs.
title: Parent Group Id
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/group/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
title: Create Group Model
description: This model should be used to create a group object.
venueMatchModel:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
locality:
$ref: '#/definitions/locality'
city:
type: string
description: The city of the venue
parentVenue:
$ref: '#/definitions/baseMatchModel'
proposalCompetitorData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
gender:
type: string
locality:
$ref: '#/definitions/proposalLocalityData'
competitorType:
type: string
isHome:
type: boolean
competitorTypeSpecificData:
type: object
properties: {}
lineup:
$ref: '#/definitions/proposalLineupData'
HorseCompetitorResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/HorseCompetitorResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
GenderType:
type: integer
title: Gender Type
format: int32
description: 'This property defines the possible gender types which can be set as integer values. Each integer value is
associated with relevant gender type as follows: 0 - Undefined; 1 - Male; 2 - Female; 3 - Mixed.'
enum:
- '0'
- '1'
- '2'
- '3'
LocalityResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/LocalityResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
competitorType:
type: string
title: 'One of: Team, Player, DoublePartnership'
description: Defines the type of the competitor to increase chances of correct matching
teamPropertiesModel:
type: object
properties:
isNationalTeam:
type: boolean
description: Is it a national team
isYouth:
type: boolean
description: Is it a youth team
abbreviation:
type: string
description: An abbreviation of the team name
shortName:
type: string
description: Short name of the team
DoublesPartnershipCompetitorResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/DoublesPartnershipCompetitorResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
GroupResponseModel:
type: object
required:
- createdOn
- id
- name
- season
- type
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/group/metadata
items:
$ref: '#/definitions/JsonbModel'
name:
type: string
type:
type: string
description: Conference = 0, Division = 1
season:
$ref: '#/definitions/HALEmbededResponse'
round:
$ref: '#/definitions/HALEmbededResponse'
parentGroup:
$ref: '#/definitions/HALEmbededResponse'
CompetitorPersonRoleType:
type: integer
format: int32
description: 0 - Owned By (e.g. Competitor Horse owned by Person, Competitor Team owned by Person); 1 - PlaysFor (e.g.
Person plays for Competitor Team); 3 - Trained By (e.g. Competitor is trained by Person); 5 - RiddenBy (e.g. Competitor
Horse is ridden by Person (the person is the jockey); 6 - BredBy (e.g. Competitor Horse is bred by Person))
enum:
- '0'
- '1'
- '3'
- '5'
- '6'
proposalSquadIngestionData:
type: object
properties:
sport:
$ref: '#/definitions/proposalSportData'
organization:
$ref: '#/definitions/proposalOrganizationData'
team:
$ref: '#/definitions/proposalSquadTeamData'
players:
type: array
items:
$ref: '#/definitions/proposalSquadPlayerData'
officials:
type: array
items:
$ref: '#/definitions/proposalOfficialData'
VenueResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/VenueResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
lineupReadonlyResponseModel:
type: object
required:
- status
properties:
id:
type: string
description: Genius Sport Id
title: If client has the Genius Sport Id it can be sent to improve overall matching capabilities and certainty or
the results.
status:
$ref: '#/definitions/SimplifiedTrackingStatus'
message:
type: string
description: Addional message regarding the status of the proposal
title: Meaningful message for potential problems with the request.
matchingId:
type: string
description: Tracking Id of the matching request that was made for the entity
title: Tracking Id of the matching request.
sourceEntityId:
type: string
description: Source entity unique Id
title: The external id from Genius Sports perspective and the internal for the source. By sending this param the backtracking
capabilities improved, via push & pull.
sourceMetadata:
type: object
description: Source metadata
title: An additional collection of metadata supplied by the source.
additionalProperties:
type: string
players:
type: array
description: List of players in the lineup.
items:
$ref: '#/definitions/baseResponseMatchModel'
ErrorModel:
type: object
properties:
code:
type: integer
format: int32
message:
type: string
error:
$ref: '#/definitions/Error'
CompetitorContractResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/CompetitorContractResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
proposalLocalityData:
type: object
properties:
id:
type: string
name:
type: string
proposalCompetitionPhaseData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
CompetitionResponseModel:
type: object
required:
- createdOn
- genderType
- id
- locality
- name
- sport
- timezone
- updatesCount
properties:
id:
type: integer
format: int64
title: Id of the competition
createdOn:
type: string
format: date-time
title: The date on which the competition was created
modifiedOn:
type: string
format: date-time
title: The date on which the competition was modified
updatesCount:
type: integer
format: int32
title: The number of times the competition was modified
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competition/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
sport:
$ref: '#/definitions/HALEmbededResponse'
organization:
$ref: '#/definitions/HALEmbededResponse'
name:
type: string
locality:
$ref: '#/definitions/HALEmbededResponse'
timezone:
$ref: '#/definitions/HALEmbededResponse'
genderType:
type: string
description: Undefined, Male, Female, Mixed.
ageCategory:
$ref: '#/definitions/ageCategory'
tier:
$ref: '#/definitions/tier'
shortName:
type: string
longName:
type: string
sponsorName:
type: string
youth:
type: boolean
isProtected:
type: boolean
description: Whether the competition is protected or not. If the competition is protected, it means that it is usually
a high-level competition.
organizationReadonlyResponseModel:
allOf:
- $ref: '#/definitions/baseResponseMatchModel'
- properties:
code:
type: string
proposalOrganizationData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
code:
type: string
GroupResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/GroupResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
HorseCompetitorResponseModel:
type: object
required:
- competitorStatusType
- createdOn
- genderType
- id
- name
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competitor/metadata
items:
$ref: '#/definitions/JsonbModel'
name:
type: string
sport:
$ref: '#/definitions/HALEmbededResponse'
genderType:
type: string
description: Undefined, Male, Female, Mixed.
locality:
$ref: '#/definitions/HALEmbededResponse'
competitorStatusType:
type: string
description: Active, Retired, Unattached
proposalLineupData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
players:
type: array
items:
$ref: '#/definitions/proposalDataBase'
squadResponseMatchModel:
type: object
required:
- players
- sport
- team
properties:
team:
$ref: '#/definitions/baseResponseMatchModel'
sport:
$ref: '#/definitions/baseResponseMatchModel'
organization:
$ref: '#/definitions/organizationReadonlyResponseModel'
players:
type: array
description: The result of the squad ingestion.
items:
$ref: '#/definitions/baseResponseMatchModel'
officials:
$ref: '#/definitions/officialsReadonlyResponseModel'
baseMatchModel:
allOf:
- $ref: '#/definitions/baseDbModel'
- properties:
sourceEntityId:
type: string
description: Source entity unique Id
title: The external id from Genius Sports perspective and the internal for the source. By sending this param the
backtracking capabilities improved, via push & pull.
sourceMetadata:
type: object
description: Source metadata
title: An additional collection of metadata supplied by the source.
additionalProperties:
type: string
proposalOfficialData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
firstName:
type: string
lastName:
type: string
role:
type: string
RoundCompetitorsResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/RoundCompetitorsResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
official:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
gender:
$ref: '#/definitions/gender'
firstName:
type: string
lastName:
type: string
role:
type: string
description: The role of the official
birthDate:
type: string
format: date-time
description: Official birthdate in format - full-date notation, for example, 2017-07-21
title: Birth Date
locality:
$ref: '#/definitions/locality'
officialReadonlyResponseModel:
allOf:
- $ref: '#/definitions/baseResponseMatchModel'
- properties:
firstName:
type: string
lastName:
type: string
Role:
type: string
person:
$ref: '#/definitions/baseResponseMatchModel'
proposalFixtureData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
startDate:
type: string
locality:
$ref: '#/definitions/proposalLocalityData'
eventStatus:
type: string
description: Notstarted, Inprogress, Finished, Cancelled, Postponed.
matchNumber:
type: string
atNeutralVenue:
type: boolean
squadTrackingStatusResponse:
type: object
properties:
requestCuratedValue:
$ref: '#/definitions/squadResponseMatchModel'
status:
$ref: '#/definitions/SimplifiedTrackingStatus'
trackingRequestId:
type: string
description: Tracking Id of the progress of the asynchronous execution.
title: GUID value
trackingRequestModel:
type: object
required:
- trackingRequestId
properties:
trackingRequestId:
type: string
description: Tracking Id of the progress of the asynchronous execution.
title: GUID value
title: GUID value
description: Tracking Id of the progress of the asynchronous execution.
SeasonResponseModel:
type: object
required:
- competition
- createdOn
- endDate
- genderType
- id
- name
- sport
- startDate
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/season/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
locality:
$ref: '#/definitions/HALEmbededResponse'
timezone:
$ref: '#/definitions/HALEmbededResponse'
genderType:
type: string
description: Undefined, Male, Female, Mixed.
sport:
$ref: '#/definitions/HALEmbededResponse'
competition:
$ref: '#/definitions/HALEmbededResponse'
CreateRound:
type: object
required:
- competitors
- enddate
- name
- seasonId
- startdate
- type
properties:
name:
type: string
description: Name of the round.
title: Round name
competitors:
type: array
description: Array of competitors to be added to the round. Competitors are mandatory for rounds of type `Phase` and
`Aggregate`. Rounds of type `Round` cannot have competitors
title: Competitors
items:
type: integer
description: Competitors which are associated with the round.
title: Competitors
startdate:
type: string
format: date-time
description: The start date of the round in UTC ISO-8601 format
title: 'Start Date '
enddate:
type: string
format: date-time
description: The end date of the fixture in UTC ISO-8601 format
title: End Date
type:
type: string
description: "The type of round. 0 = Phase \n1 = Round \n2 = AggregateEvent"
title: Type
seasonId:
type: integer
format: int64
description: The ID of the season the round belongs to.
title: Season Id
parentRoundId:
type: integer
format: int64
description: The ID of the parent round to which posted round belongs.
title: Parent Round Id
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/round/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
timezone:
type: string
description: 'The timezone which will be set as default timezone for the competition''s fixtures if timezone is not
specified. Possible timezones (splited by '',''): Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anguilla,America/Antigua,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Aruba,America/Asuncion,America/Bahia,America/Barbados,America/Belem,America/Belize,America/Bogota,America/Boise,America/Buenos_Aires,America/Campo_Grande,America/Cancun,America/Caracas,America/Chicago,America/Chihuahua,America/Costa_Rica,America/Cuiaba,America/Curacao,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/El_Salvador,America/Fortaleza,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Petersburg,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indianapolis,America/Jamaica,America/Kentucky/Louisville,America/Kentucky/Monticello,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Managua,America/Manaus,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Mexico_City,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Nassau,America/New_York,America/Panama,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Porto_Velho,America/Port_of_Spain,America/Puerto_Rico,America/Recife,America/Rio_Branco,America/Rosario,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/Tegucigalpa,America/Tijuana,America/Toronto,America/Vancouver,America/Whitehorse,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dubai,Asia/Dushanbe,Asia/Gaza,Asia/Harbin,Asia/Hong_Kong,Asia/Hovd,Asia/Ho_Chi_Minh,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Katmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pyongyang,Asia/Qatar,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimphu,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Madeira,Atlantic/Reykjavik,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Hobart,Australia/Melbourne,Australia/North,Australia/NSW,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,CET,Chile/Continental,CST6CDT,Cuba,EET,Egypt,EST,Etc/GMT,Etc/GMT+1,Etc/GMT+12,Etc/GMT+2,Etc/GMT+3,Etc/GMT+4,Etc/GMT+5,Etc/GMT+6,Etc/GMT+7,Etc/GMT+8,Etc/GMT+9,Etc/GMT-0,Etc/GMT-1,Etc/GMT-2,Etc/GMT-3,Etc/GMT-4,Etc/GMT-5,Etc/GMT-7,Etc/GMT-8,Etc/Greenwich,Etc/UTC,Europe/Amsterdam,Europe/Andorra,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Kaliningrad,Europe/Kiev,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,GB,GB-Eire,GMT,GMT0,Hongkong,Iceland,Indian/Cocos,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Reunion,Iran,Israel,Jamaica,Japan,Libya,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,MST,MST7MDT,NZ,Pacific/Apia,Pacific/Auckland,Pacific/Easter,Pacific/Fiji,Pacific/Guadalcanal,Pacific/Kosrae,Pacific/Noumea,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Tahiti,Poland,Portugal,Singapore,Turkey,UCT,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,UTC,WET'
title: Round timezone
title: Create Round Model
description: This model should be used to create a round object.
PatchFixture:
type: object
required:
- id
properties:
id:
type: integer
format: int64
description: The ID of the fixture.
title: Id
startDate:
type: string
format: date-time
description: The start date of the fixture in UTC ISO-8601 format
title: Start Date
venueId:
type: integer
format: int64
description: The ID of the venue the fixture is played at.
title: Venue ID
roundId:
type: integer
format: int64
description: The ID of the round the fixture is for.
title: Round ID
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competition/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
title: Patch Fixture Model
description: This model should be used to propose a partial update/patch to a fixture.
PlayerCompetitorResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/PlayerCompetitorResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
TeamCompetitorResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/TeamCompetitorResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
PersonContractResponseModel:
type: object
required:
- competitor
- createdOn
- id
- isActive
- personRole
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
competitor:
$ref: '#/definitions/CompetitorHALEmbededResponse'
sport:
$ref: '#/definitions/HALEmbededResponse'
personRole:
type: string
isActive:
type: boolean
description: Whether the relation between the person and the competitor is active
title: Is Active
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
CreateCompetition:
type: object
required:
- localityId
- name
- sportId
properties:
sportId:
type: integer
format: int64
description: Id of the sport to which the competition will be associated. This id will restrict the possible metadataProperties
and values which can be set to the competition! Also it will restrict the fixtures and seasons associated with this
competition to be only for this sport!
title: Sport Id
organizationId:
type: integer
format: int64
description: Id of the organization to which the competition will be associated. This id will update the permissions
which will be needed in order to update/delete the competition! Once set this property cannot be updated!
title: Organization Id
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. where the competition will be held!
title: Locality Id
genderType:
$ref: '#/definitions/GenderType'
ageCategory:
$ref: '#/definitions/ageCategory'
tier:
$ref: '#/definitions/tier'
name:
type: string
description: The name of the competition. It must be unique for the given sport context!
title: Competition name
maxLength: 250
timezone:
type: string
description: 'The timezone which will be set as default timezone for the competition''s fixtures if timezone is not
specified. Possible timezones (splited by '',''): Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anguilla,America/Antigua,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Aruba,America/Asuncion,America/Bahia,America/Barbados,America/Belem,America/Belize,America/Bogota,America/Boise,America/Buenos_Aires,America/Campo_Grande,America/Cancun,America/Caracas,America/Chicago,America/Chihuahua,America/Costa_Rica,America/Cuiaba,America/Curacao,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/El_Salvador,America/Fortaleza,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Petersburg,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indianapolis,America/Jamaica,America/Kentucky/Louisville,America/Kentucky/Monticello,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Managua,America/Manaus,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Mexico_City,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Nassau,America/New_York,America/Panama,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Porto_Velho,America/Port_of_Spain,America/Puerto_Rico,America/Recife,America/Rio_Branco,America/Rosario,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/Tegucigalpa,America/Tijuana,America/Toronto,America/Vancouver,America/Whitehorse,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dubai,Asia/Dushanbe,Asia/Gaza,Asia/Harbin,Asia/Hong_Kong,Asia/Hovd,Asia/Ho_Chi_Minh,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Katmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pyongyang,Asia/Qatar,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimphu,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Madeira,Atlantic/Reykjavik,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Hobart,Australia/Melbourne,Australia/North,Australia/NSW,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,CET,Chile/Continental,CST6CDT,Cuba,EET,Egypt,EST,Etc/GMT,Etc/GMT+1,Etc/GMT+12,Etc/GMT+2,Etc/GMT+3,Etc/GMT+4,Etc/GMT+5,Etc/GMT+6,Etc/GMT+7,Etc/GMT+8,Etc/GMT+9,Etc/GMT-0,Etc/GMT-1,Etc/GMT-2,Etc/GMT-3,Etc/GMT-4,Etc/GMT-5,Etc/GMT-7,Etc/GMT-8,Etc/Greenwich,Etc/UTC,Europe/Amsterdam,Europe/Andorra,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Kaliningrad,Europe/Kiev,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,GB,GB-Eire,GMT,GMT0,Hongkong,Iceland,Indian/Cocos,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Reunion,Iran,Israel,Jamaica,Japan,Libya,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,MST,MST7MDT,NZ,Pacific/Apia,Pacific/Auckland,Pacific/Easter,Pacific/Fiji,Pacific/Guadalcanal,Pacific/Kosrae,Pacific/Noumea,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Tahiti,Poland,Portugal,Singapore,Turkey,UCT,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,UTC,WET'
title: Competition timezone
shortName:
type: string
description: A short name for the competition
title: Competition short name
maxLength: 250
longName:
type: string
description: A long name for the competition
title: Competition long name
maxLength: 500
sponsorName:
type: string
description: The sponsor name of the competition
title: Competition sponsor name
maxLength: 250
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competition/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
youth:
type: boolean
FixtureRefdataFixture:
type: object
properties:
id:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
startDate:
type: string
format: date-time
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModel'
competitors:
type: array
items:
$ref: '#/definitions/FixtureRefdataCompetitor'
season:
$ref: '#/definitions/FixtureRefdataSeason'
venue:
$ref: '#/definitions/FixtureRefdataVenue'
competition:
$ref: '#/definitions/FixtureRefdataCompetition'
UpdateOrganization:
type: object
properties:
id:
type: integer
format: int64
title: Id of the organization
name:
type: string
description: Unique name of the organization
proposalFixtureIngestionData:
type: object
properties:
sport:
$ref: '#/definitions/proposalSportData'
venue:
$ref: '#/definitions/proposalVenueData'
organization:
$ref: '#/definitions/proposalOrganizationData'
season:
$ref: '#/definitions/proposalSeasonData'
fixture:
$ref: '#/definitions/proposalFixtureData'
competition:
$ref: '#/definitions/proposalCompetitionData'
competitors:
type: array
items:
$ref: '#/definitions/proposalCompetitorData'
competitionPhase:
$ref: '#/definitions/proposalCompetitionPhaseData'
officials:
type: array
items:
$ref: '#/definitions/proposalOfficialData'
sourceCoverage:
$ref: '#/definitions/sourceCoverage'
coverage:
type: array
items:
$ref: '#/definitions/coverageData'
UpdateCompetition:
type: object
required:
- id
- localityId
- name
properties:
id:
type: integer
format: int64
name:
type: string
description: The name of the competition. It must be unique for the given sport context!
title: Competition name
maxLength: 250
organizationId:
type: integer
format: int64
description: Id of the organization to which the competition will be associated. This id will update the permissions
which will be needed in order to update/delete the competition! Once set this property cannot be updated!
title: Organization Id
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. where the competition will be held!
title: Locality Id
timezone:
type: string
description: 'The timezone which will be set as default timezone for the competition''s fixtures if timezone is not
specified. Possible timezones (splited by '',''): Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anguilla,America/Antigua,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Aruba,America/Asuncion,America/Bahia,America/Barbados,America/Belem,America/Belize,America/Bogota,America/Boise,America/Buenos_Aires,America/Campo_Grande,America/Cancun,America/Caracas,America/Chicago,America/Chihuahua,America/Costa_Rica,America/Cuiaba,America/Curacao,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/El_Salvador,America/Fortaleza,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Petersburg,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indianapolis,America/Jamaica,America/Kentucky/Louisville,America/Kentucky/Monticello,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Managua,America/Manaus,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Mexico_City,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Nassau,America/New_York,America/Panama,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Porto_Velho,America/Port_of_Spain,America/Puerto_Rico,America/Recife,America/Rio_Branco,America/Rosario,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/Tegucigalpa,America/Tijuana,America/Toronto,America/Vancouver,America/Whitehorse,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dubai,Asia/Dushanbe,Asia/Gaza,Asia/Harbin,Asia/Hong_Kong,Asia/Hovd,Asia/Ho_Chi_Minh,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Katmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pyongyang,Asia/Qatar,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimphu,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Madeira,Atlantic/Reykjavik,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Hobart,Australia/Melbourne,Australia/North,Australia/NSW,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,CET,Chile/Continental,CST6CDT,Cuba,EET,Egypt,EST,Etc/GMT,Etc/GMT+1,Etc/GMT+12,Etc/GMT+2,Etc/GMT+3,Etc/GMT+4,Etc/GMT+5,Etc/GMT+6,Etc/GMT+7,Etc/GMT+8,Etc/GMT+9,Etc/GMT-0,Etc/GMT-1,Etc/GMT-2,Etc/GMT-3,Etc/GMT-4,Etc/GMT-5,Etc/GMT-7,Etc/GMT-8,Etc/Greenwich,Etc/UTC,Europe/Amsterdam,Europe/Andorra,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Kaliningrad,Europe/Kiev,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,GB,GB-Eire,GMT,GMT0,Hongkong,Iceland,Indian/Cocos,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Reunion,Iran,Israel,Jamaica,Japan,Libya,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,MST,MST7MDT,NZ,Pacific/Apia,Pacific/Auckland,Pacific/Easter,Pacific/Fiji,Pacific/Guadalcanal,Pacific/Kosrae,Pacific/Noumea,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Tahiti,Poland,Portugal,Singapore,Turkey,UCT,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,UTC,WET'
title: Competition timezone
shortName:
type: string
description: A short name for the competition
title: Competition short name
maxLength: 250
longName:
type: string
description: A long name for the competition
title: Competition long name
maxLength: 500
sponsorName:
type: string
description: The sponsor name of the competition
title: Competition sponsor name
maxLength: 250
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competition/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
youth:
type: boolean
firstLastNameModel:
type: object
properties:
firstName:
type: string
description: The first name of the competitor
lastName:
type: string
description: The last name of the competitor
CompetitorHALEmbededResponse:
type: object
required:
- competitorType
- id
- name
- ref
properties:
id:
type: integer
format: int64
name:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
competitorType:
type: string
description: Team, Player, Horse, Jockey, HorseOwner, Dog, Breeder, DoublesPartnership, Other, TBD
ref:
type: string
CreateTeamCompetitor:
type: object
required:
- genderType
- localityId
- name
- sportId
properties:
name:
type: string
description: The name of the competitor. It must be unique for the provided sport, locality, gender and type! It must
contain Women as name postfix when competitor is of CompetitorType Team (0) and gender is Female (2)! In any other
case the Women postfix is forbidden!
title: Competitor name
maxLength: 50
abbreviation:
type: string
description: An abbreviation for the competitor
title: Competitor abbreviation
maxLength: 125
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. of the competitor!
title: Locality Id
venueId:
type: integer
format: int64
description: Id of the home venue of the competitor. The venue must be associated with the same sport as the competitor!
title: Venue Id
sportId:
type: integer
format: int64
description: Id of the sport to which the competitor will be associated. This id will restrict the possible metadataProperties
and values which can be set to the competitor! Also it will restrict the competitors, rounds, fixtures and seasons
associated with this competitor to be only for this sport!
title: Sport Id
genderType:
$ref: '#/definitions/GenderType'
ageCategory:
$ref: '#/definitions/ageCategory'
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competitor/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
UpdatePlayerCompetitor:
type: object
required:
- competitorStatusType
- id
properties:
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModelViewModel'
id:
type: integer
format: int64
minimum: 1.0
competitorStatusType:
$ref: '#/definitions/CompetitorStatusType'
TBDCompetitorResponseModel:
type: object
required:
- competitorStatusType
- createdOn
- genderType
- id
- name
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competitor/metadata
items:
$ref: '#/definitions/JsonbModel'
name:
type: string
sport:
$ref: '#/definitions/HALEmbededResponse'
genderType:
type: string
description: Undefined, Male, Female, Mixed.
locality:
$ref: '#/definitions/HALEmbededResponse'
competitorStatusType:
type: string
description: Active, Retired, Unattached
isProtected:
type: boolean
description: Whether the competitor is protected or not.
UpdateRound:
type: object
required:
- competitors
- enddate
- id
- name
- seasonId
- startdate
- type
properties:
id:
type: integer
format: int64
description: The ID of the round.
title: Round Id
name:
type: string
description: Name of the round.
title: Round name
competitors:
type: array
description: Array of competitors to be added to the round. Competitors are mandatory for rounds of type `Phase` and
`Aggregate`. Rounds of type `Round` cannot have competitors
title: Competitors
items:
type: integer
description: Competitors which are associated with the round.
title: Competitors
startdate:
type: string
format: date-time
description: The start date of the round in UTC ISO-8601 format
title: 'Start Date '
enddate:
type: string
format: date-time
description: The end date of the fixture in UTC ISO-8601 format
title: End Date
type:
type: string
description: "The type of round. 0 = Phase \n1 = Round \n2 = AggregateEvent"
title: Type
seasonId:
type: integer
format: int64
description: The ID of the season the round belongs to.
title: Season Id
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/round/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
timezone:
type: string
description: 'The timezone which will be set as default timezone for the competition''s fixtures if timezone is not
specified. Possible timezones (splited by '',''): Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anguilla,America/Antigua,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Aruba,America/Asuncion,America/Bahia,America/Barbados,America/Belem,America/Belize,America/Bogota,America/Boise,America/Buenos_Aires,America/Campo_Grande,America/Cancun,America/Caracas,America/Chicago,America/Chihuahua,America/Costa_Rica,America/Cuiaba,America/Curacao,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/El_Salvador,America/Fortaleza,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Petersburg,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indianapolis,America/Jamaica,America/Kentucky/Louisville,America/Kentucky/Monticello,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Managua,America/Manaus,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Mexico_City,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Nassau,America/New_York,America/Panama,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Porto_Velho,America/Port_of_Spain,America/Puerto_Rico,America/Recife,America/Rio_Branco,America/Rosario,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/Tegucigalpa,America/Tijuana,America/Toronto,America/Vancouver,America/Whitehorse,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dubai,Asia/Dushanbe,Asia/Gaza,Asia/Harbin,Asia/Hong_Kong,Asia/Hovd,Asia/Ho_Chi_Minh,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Katmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pyongyang,Asia/Qatar,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimphu,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Madeira,Atlantic/Reykjavik,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Hobart,Australia/Melbourne,Australia/North,Australia/NSW,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,CET,Chile/Continental,CST6CDT,Cuba,EET,Egypt,EST,Etc/GMT,Etc/GMT+1,Etc/GMT+12,Etc/GMT+2,Etc/GMT+3,Etc/GMT+4,Etc/GMT+5,Etc/GMT+6,Etc/GMT+7,Etc/GMT+8,Etc/GMT+9,Etc/GMT-0,Etc/GMT-1,Etc/GMT-2,Etc/GMT-3,Etc/GMT-4,Etc/GMT-5,Etc/GMT-7,Etc/GMT-8,Etc/Greenwich,Etc/UTC,Europe/Amsterdam,Europe/Andorra,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Kaliningrad,Europe/Kiev,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,GB,GB-Eire,GMT,GMT0,Hongkong,Iceland,Indian/Cocos,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Reunion,Iran,Israel,Jamaica,Japan,Libya,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,MST,MST7MDT,NZ,Pacific/Apia,Pacific/Auckland,Pacific/Easter,Pacific/Fiji,Pacific/Guadalcanal,Pacific/Kosrae,Pacific/Noumea,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Tahiti,Poland,Portugal,Singapore,Turkey,UCT,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,UTC,WET'
title: Round timezone
title: Update Round Model
description: This model should be used to update a round object.
CompetitorStatusType:
type: integer
title: Competitor Status Type
format: int32
description: 'This property defines the possible status types which can be set as integer values. Each integer value is
associated with relevant status type as follows: 0 - Active; 1 - Retired; 2 - Unattached.'
enum:
- '0'
- '1'
- '2'
competitionType:
type: string
title: 'One of: TeamsCompetition, PlayersCompetition, DoublePartnershipsCompetition'
description: Defines the type of the competition to increase chances of correct matching
CreateOrganization:
type: object
properties:
name:
type: string
description: Unique name of the organization
code:
type: string
description: Unique code of the organization
LocalityResponseModel:
type: object
required:
- createdOn
- id
- localityType
- name
- updatesCount
properties:
id:
type: integer
format: int64
name:
type: string
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
localityType:
type: string
description: ConstituentCountry, Continent, Country, FirstOrderAdministrativeRegion, NonGeographic, World, Game.
code:
type: string
FixtureCompetitorHALEmbededResponse:
type: object
required:
- competitorType
- id
- name
- ref
properties:
id:
type: integer
format: int64
name:
type: string
competitorType:
type: string
description: Team, Player, Horse, Jockey, HorseOwner, Dog, Breeder, DoublesPartnership, Other, TBD
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModelViewModel'
ref:
type: string
competitionIngestion:
type: object
required:
- competition
- sport
properties:
organization:
$ref: '#/definitions/organizationMatchModel'
competition:
$ref: '#/definitions/competitionMatchModel'
sport:
$ref: '#/definitions/baseMatchModel'
competitionPhases:
type: array
items:
$ref: '#/definitions/competitionPhaseMatchModel'
UpdateVenue:
type: object
required:
- name
- sports
properties:
id:
type: integer
format: int64
name:
type: string
description: The name of the venue
title: Venue name
maxLength: 250
cityName:
type: string
description: Name of the city where the Venue is
title: City name
maxLength: 256
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. where the venue is located.
title: Locality Id
sports:
type: array
description: Array of sport Ids which can be played on this venue
title: Sports
items:
type: integer
description: Sports ids which can be played on the venue.
title: Sport ids
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/venue/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
proposalSquad:
type: object
properties:
id:
type: string
sourceEntityId:
type: string
sourceName:
type: string
status:
type: string
data:
$ref: '#/definitions/proposalSquadIngestionData'
CompetitionResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/CompetitionResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
organizationMatchModel:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
code:
type: string
description: The code of the organization
sportSpecificRule:
type: object
properties:
name:
type: string
value:
type: string
JsonbModelViewModel:
type: object
required:
- name
properties:
name:
type: string
description: Name of the property.
title: Property name
value:
type: string
description: Value of the property.
title: Property value
title: Create/Update Property Model
description: This model should be used to create or update single property value for specific property name for specific
model.
PersonOfficialResponseModel:
type: object
required:
- createdOn
- fixture
- id
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
fixture:
$ref: '#/definitions/HALEmbededResponse'
sport:
$ref: '#/definitions/HALEmbededResponse'
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModel'
RoundCompetitorsResponseModel:
type: object
required:
- competitorType
- genderType
- id
- locality
- name
- ref
properties:
id:
type: integer
format: int64
description: Id of the competitor
name:
type: string
description: Name of the competitor
competitorType:
type: string
description: Type of the competitor
ref:
type: string
description: Endpoint to competitor
genderType:
type: string
description: Gender of the competitor
locality:
$ref: '#/definitions/HALEmbededResponse'
competitorMatchModel:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
competitorType:
$ref: '#/definitions/competitorType'
locality:
$ref: '#/definitions/locality'
playerPropertiesModel:
$ref: '#/definitions/playerPropertiesModel'
doublesPropertiesModel:
$ref: '#/definitions/doublesPropertiesModel'
teamPropertiesModel:
$ref: '#/definitions/teamPropertiesModel'
gender:
$ref: '#/definitions/gender'
isHome:
type: boolean
description: Is this competitor the home competitor for the fixture
fixtureIngestionPatch:
type: object
required:
- competitors
- fixture
properties:
competitors:
type: array
items:
$ref: '#/definitions/fixtureCompetitorMatchModel'
fixture:
type: object
properties:
sourceEntityId:
type: string
description: Source entity unique Id
title: The external id from Genius Sports perspective and the internal for the source. By sending this param the
backtracking capabilities improved, via push & pull.
required:
- sourceEntityId
fixtureResponseMatchModel:
type: object
required:
- competition
- fixture
- sport
properties:
sport:
$ref: '#/definitions/baseResponseMatchModel'
organization:
$ref: '#/definitions/organizationReadonlyResponseModel'
competition:
$ref: '#/definitions/competitionReadonlyResponseModel'
season:
$ref: '#/definitions/baseResponseMatchModel'
competitionPhase:
$ref: '#/definitions/competitionPhaseReadonlyResponseModel'
fixture:
$ref: '#/definitions/fixtureReadonlyResponseModel'
competitors:
type: array
description: Client might send competitors separately to try to improve matching capabilities.
items:
$ref: '#/definitions/competitorReadonlyResponseModel'
officials:
$ref: '#/definitions/officialsReadonlyResponseModel'
sourceCoverage:
$ref: '#/definitions/sourceCoverage'
coverage:
$ref: '#/definitions/coverage'
squadIngestion:
type: object
required:
- players
- sport
- team
properties:
organization:
$ref: '#/definitions/organizationMatchModel'
team:
$ref: '#/definitions/teamMatchModel'
sport:
$ref: '#/definitions/baseMatchModel'
players:
type: array
description: Client might send competitors separately to try to improve matching capabilities.
items:
$ref: '#/definitions/playerMatchModel'
officials:
$ref: '#/definitions/officials'
skipContractDeactivation:
type: boolean
description: This flag indicates whether to skip deactivation of player contracts that are not present in the current
squad ingestion. If set to true, existing contracts will remain active even if the players are not included in the
current ingestion.
UpdateDoublePartnership:
type: object
required:
- competitorStatusType
- id
properties:
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModelViewModel'
id:
type: integer
format: int64
description: The id of the double partnership which will be updated
minimum: 1.0
competitorStatusType:
$ref: '#/definitions/CompetitorStatusType'
lineupPlayer:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
gender:
$ref: '#/definitions/gender'
locality:
$ref: '#/definitions/locality'
playerPropertiesModel:
$ref: '#/definitions/basePlayerPropertiesModel'
isStarter:
type: boolean
description: Indicates if the player is a starter in the lineup.
order:
type: integer
description: The order of the player in the lineup, starting from 0.
position:
type: string
description: The position of the player in the lineup, e.g., 'Forward', 'Keeper'.
shirtNumber:
type: string
description: The shirt number of the player in the lineup.
proposalSquadTeamData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
gender:
type: string
abbreviation:
type: string
isNationalTeam:
type: boolean
isYouth:
type: boolean
locality:
$ref: '#/definitions/proposalLocalityData'
CompetitorSeasonsResponseModel:
type: object
required:
- id
- name
- ref
properties:
id:
type: integer
format: int64
description: Id of the season
name:
type: string
description: Name of the season
ref:
type: string
description: Endpoint to season
FixtureRefdataCompetition:
type: object
properties:
id:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
CreateDoublePartnership:
type: object
required:
- sportId
properties:
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModelViewModel'
firstPersonId:
type: integer
format: int64
description: Id of one of the persons which will take part in the double partnership
minimum: 1.0
secondPersonId:
type: integer
format: int64
description: Id of the other person which will take part in the double partnership
minimum: 1.0
sportId:
type: integer
format: int64
description: Id of the sport in which the doubles partnership can be used as competitor
minimum: 1.0
firstPerson:
description: Person information if not been created early, if the person already exists - leave empty.
$ref: '#/definitions/CreatePersonViewModel'
secondPerson:
description: Person information if not been created early, if the person already exists - leave empty.
$ref: '#/definitions/CreatePersonViewModel'
SeasonCompetitorsResponseModel:
type: object
required:
- competitorType
- genderType
- id
- locality
- name
- ref
properties:
id:
type: integer
format: int64
description: Id of the competitor
name:
type: string
description: Name of the competitor
competitorType:
type: string
description: Type of the competitor
ref:
type: string
description: Endpoint to competitor
genderType:
type: string
description: Gender of the competitor
locality:
$ref: '#/definitions/HALEmbededResponse'
confirmed:
type: boolean
description: Indicates if the competitor is confirmed for the season
CompetitorContractResponseModel:
type: object
required:
- createdOn
- id
- isActive
- person
- personRole
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
person:
$ref: '#/definitions/PersonHALEmbededResponse'
sport:
$ref: '#/definitions/HALEmbededResponse'
player:
$ref: '#/definitions/HALEmbededResponse'
personRole:
type: string
isActive:
type: boolean
description: Whether the relation between the person and the competitor is active
title: Is Active
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/contract/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
UpdateSeason:
type: object
required:
- endDate
- id
- startDate
properties:
name:
type: string
description: Default season name will be generated by the competition if no name is provided
title: Season Name
startDate:
type: string
format: date-time
description: The start date of the season in UTC ISO-8601 format
title: Start Date
endDate:
type: string
format: date-time
description: The end date of the season in UTC ISO-8601 format
title: End Date
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. where the season will be held. Competition's Locality will be set
if this is not passed on request!
title: Locality Id
id:
type: integer
format: int64
description: Id of the season which will be updated!
title: Season Id
competitors:
type: array
description: Array of competitors to be added to the season.
title: Competitors
items:
type: integer
description: Competitors which are associated with the season.
title: Competitors
timezone:
type: string
description: 'The timezone which will be set as default timezone for the season''s fixtures if timezone is not specified.
Possible timezones (splited by '',''): Africa/Abidjan,Africa/Accra,Africa/Addis_Ababa,Africa/Algiers,Africa/Bamako,Africa/Bangui,Africa/Banjul,Africa/Bissau,Africa/Blantyre,Africa/Brazzaville,Africa/Bujumbura,Africa/Cairo,Africa/Casablanca,Africa/Ceuta,Africa/Conakry,Africa/Dakar,Africa/Dar_es_Salaam,Africa/Djibouti,Africa/Douala,Africa/Freetown,Africa/Gaborone,Africa/Harare,Africa/Johannesburg,Africa/Juba,Africa/Kampala,Africa/Khartoum,Africa/Kigali,Africa/Kinshasa,Africa/Lagos,Africa/Libreville,Africa/Lome,Africa/Luanda,Africa/Lubumbashi,Africa/Lusaka,Africa/Malabo,Africa/Maputo,Africa/Maseru,Africa/Mbabane,Africa/Mogadishu,Africa/Monrovia,Africa/Nairobi,Africa/Ndjamena,Africa/Niamey,Africa/Nouakchott,Africa/Ouagadougou,Africa/Porto-Novo,Africa/Sao_Tome,Africa/Tripoli,Africa/Tunis,Africa/Windhoek,America/Adak,America/Anguilla,America/Antigua,America/Argentina/Buenos_Aires,America/Argentina/Catamarca,America/Argentina/Cordoba,America/Argentina/Jujuy,America/Argentina/Mendoza,America/Argentina/Rio_Gallegos,America/Argentina/Salta,America/Argentina/San_Juan,America/Argentina/San_Luis,America/Argentina/Tucuman,America/Aruba,America/Asuncion,America/Bahia,America/Barbados,America/Belem,America/Belize,America/Bogota,America/Boise,America/Buenos_Aires,America/Campo_Grande,America/Cancun,America/Caracas,America/Chicago,America/Chihuahua,America/Costa_Rica,America/Cuiaba,America/Curacao,America/Denver,America/Detroit,America/Dominica,America/Edmonton,America/El_Salvador,America/Fortaleza,America/Grenada,America/Guadeloupe,America/Guatemala,America/Guayaquil,America/Guyana,America/Halifax,America/Havana,America/Hermosillo,America/Indiana/Indianapolis,America/Indiana/Petersburg,America/Indiana/Vevay,America/Indiana/Vincennes,America/Indianapolis,America/Jamaica,America/Kentucky/Louisville,America/Kentucky/Monticello,America/La_Paz,America/Lima,America/Los_Angeles,America/Louisville,America/Managua,America/Manaus,America/Mazatlan,America/Mendoza,America/Menominee,America/Merida,America/Mexico_City,America/Moncton,America/Monterrey,America/Montevideo,America/Montreal,America/Nassau,America/New_York,America/Panama,America/Paramaribo,America/Phoenix,America/Port-au-Prince,America/Porto_Velho,America/Port_of_Spain,America/Puerto_Rico,America/Recife,America/Rio_Branco,America/Rosario,America/Santiago,America/Santo_Domingo,America/Sao_Paulo,America/Scoresbysund,America/St_Johns,America/St_Kitts,America/St_Lucia,America/St_Thomas,America/Tegucigalpa,America/Tijuana,America/Toronto,America/Vancouver,America/Whitehorse,Asia/Aden,Asia/Almaty,Asia/Amman,Asia/Aqtobe,Asia/Ashgabat,Asia/Ashkhabad,Asia/Baghdad,Asia/Bahrain,Asia/Baku,Asia/Bangkok,Asia/Beirut,Asia/Bishkek,Asia/Brunei,Asia/Calcutta,Asia/Chita,Asia/Chongqing,Asia/Chungking,Asia/Colombo,Asia/Dacca,Asia/Damascus,Asia/Dhaka,Asia/Dubai,Asia/Dushanbe,Asia/Gaza,Asia/Harbin,Asia/Hong_Kong,Asia/Hovd,Asia/Ho_Chi_Minh,Asia/Irkutsk,Asia/Istanbul,Asia/Jakarta,Asia/Jayapura,Asia/Jerusalem,Asia/Kabul,Asia/Karachi,Asia/Kathmandu,Asia/Katmandu,Asia/Kolkata,Asia/Krasnoyarsk,Asia/Kuala_Lumpur,Asia/Kuching,Asia/Kuwait,Asia/Macao,Asia/Macau,Asia/Makassar,Asia/Manila,Asia/Muscat,Asia/Nicosia,Asia/Novokuznetsk,Asia/Novosibirsk,Asia/Omsk,Asia/Oral,Asia/Phnom_Penh,Asia/Pyongyang,Asia/Qatar,Asia/Rangoon,Asia/Riyadh,Asia/Saigon,Asia/Sakhalin,Asia/Samarkand,Asia/Seoul,Asia/Shanghai,Asia/Singapore,Asia/Taipei,Asia/Tashkent,Asia/Tbilisi,Asia/Tehran,Asia/Tel_Aviv,Asia/Thimphu,Asia/Tokyo,Asia/Ulaanbaatar,Asia/Vientiane,Asia/Vladivostok,Asia/Yakutsk,Asia/Yekaterinburg,Asia/Yerevan,Atlantic/Azores,Atlantic/Bermuda,Atlantic/Canary,Atlantic/Cape_Verde,Atlantic/Faeroe,Atlantic/Faroe,Atlantic/Madeira,Atlantic/Reykjavik,Australia/ACT,Australia/Adelaide,Australia/Brisbane,Australia/Canberra,Australia/Currie,Australia/Darwin,Australia/Hobart,Australia/Melbourne,Australia/North,Australia/NSW,Australia/Perth,Australia/Queensland,Australia/South,Australia/Sydney,Australia/Tasmania,Australia/Victoria,Australia/West,Brazil/Acre,Brazil/DeNoronha,Brazil/East,Brazil/West,Canada/Atlantic,Canada/Central,Canada/Eastern,Canada/Mountain,Canada/Newfoundland,Canada/Pacific,CET,Chile/Continental,CST6CDT,Cuba,EET,Egypt,EST,Etc/GMT,Etc/GMT+1,Etc/GMT+12,Etc/GMT+2,Etc/GMT+3,Etc/GMT+4,Etc/GMT+5,Etc/GMT+6,Etc/GMT+7,Etc/GMT+8,Etc/GMT+9,Etc/GMT-0,Etc/GMT-1,Etc/GMT-2,Etc/GMT-3,Etc/GMT-4,Etc/GMT-5,Etc/GMT-7,Etc/GMT-8,Etc/Greenwich,Etc/UTC,Europe/Amsterdam,Europe/Andorra,Europe/Athens,Europe/Belfast,Europe/Belgrade,Europe/Berlin,Europe/Bratislava,Europe/Brussels,Europe/Bucharest,Europe/Budapest,Europe/Chisinau,Europe/Copenhagen,Europe/Dublin,Europe/Gibraltar,Europe/Helsinki,Europe/Isle_of_Man,Europe/Istanbul,Europe/Kaliningrad,Europe/Kiev,Europe/Lisbon,Europe/Ljubljana,Europe/London,Europe/Luxembourg,Europe/Madrid,Europe/Malta,Europe/Minsk,Europe/Monaco,Europe/Moscow,Europe/Nicosia,Europe/Oslo,Europe/Paris,Europe/Podgorica,Europe/Prague,Europe/Riga,Europe/Rome,Europe/Samara,Europe/San_Marino,Europe/Sarajevo,Europe/Skopje,Europe/Sofia,Europe/Stockholm,Europe/Tallinn,Europe/Tirane,Europe/Tiraspol,Europe/Uzhgorod,Europe/Vaduz,Europe/Vatican,Europe/Vienna,Europe/Vilnius,Europe/Volgograd,Europe/Warsaw,Europe/Zagreb,Europe/Zaporozhye,Europe/Zurich,GB,GB-Eire,GMT,GMT0,Hongkong,Iceland,Indian/Cocos,Indian/Kerguelen,Indian/Mahe,Indian/Maldives,Indian/Mauritius,Indian/Reunion,Iran,Israel,Jamaica,Japan,Libya,Mexico/BajaNorte,Mexico/BajaSur,Mexico/General,MST,MST7MDT,NZ,Pacific/Apia,Pacific/Auckland,Pacific/Easter,Pacific/Fiji,Pacific/Guadalcanal,Pacific/Kosrae,Pacific/Noumea,Pacific/Ponape,Pacific/Port_Moresby,Pacific/Tahiti,Poland,Portugal,Singapore,Turkey,UCT,US/Arizona,US/Central,US/East-Indiana,US/Eastern,US/Hawaii,US/Indiana-Starke,US/Michigan,US/Mountain,US/Pacific,US/Pacific-New,UTC,WET'
title: Competition timezone
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/season/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
lineup:
properties:
formation:
type: string
description: The formation code of the team for the given lineup. E.g. 442
players:
type: array
description: List of players in the lineup.
items:
$ref: '#/definitions/lineupPlayer'
CreateVenue:
type: object
required:
- name
- sports
properties:
name:
type: string
description: The name of the venue
title: Venue name
maxLength: 250
cityName:
type: string
description: Name of the city where the Venue is
title: City name
maxLength: 256
longitude:
type: number
format: double
description: Longitude of the city where the Venue is
title: Longitude
latitude:
type: number
format: double
description: Latitude of the city where the Venue is
title: Latitude
localityId:
type: integer
format: int64
description: Id of the country,virtual place, etc. where the venue is located.
title: Locality Id
parentVenueId:
type: integer
format: int64
description: The id of the parent venue
title: Parent Venue Id
sports:
type: array
description: Array of sport Ids which can be played on this venue
title: Sports
items:
type: integer
description: Sports ids which can be played on the venue.
title: Sport ids
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/venue/metadata
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
OrganizationResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/OrganizationResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
FixtureOfficialResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/FixtureOfficialResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
UpdateFixture:
type: object
required:
- competitors
- startDate
properties:
id:
type: integer
format: int64
description: The ID of the fixture.
title: Id
competitors:
type: array
description: Array of competitors to be added to the fixture.
title: Competitors
items:
type: integer
description: Competitors which belong to the fixture.
title: Competitors
homeCompetitorId:
type: integer
format: int64
description: 'The ID of the competitor from the competitors list to be marked as home competitor of the fixture. Can
only be updated if set to TBD competitor. By default if home competitor is not sent, the competitor which is first
in the competitors list will be marked as home competitor. E.g. If you send competitors: [3,2,1], competitor with
id 3 will be set as home competitor. If you send competitors: [1, 2, 3], competitor with id 1 will be marked as
home competitor'
title: Home Competitor Id
startDate:
type: string
format: date-time
description: The start date of the fixture in UTC ISO-8601 format
title: Start Date
roundId:
type: integer
format: int64
description: The ID of the round the fixture belongs to.
title: Round ID
venueId:
type: integer
format: int64
description: The ID of the venue the fixture is played at.
title: Venue ID
localityId:
type: integer
format: int64
description: The ID of the country/region/administrative zone the fixture is played at.
title: Locality ID
EventStatusType:
type: integer
format: int32
description: 0 - Notstarted; 1 - Inprogress; 2 - Finished; 3 - Cancelled; 4 - Postponed
enum:
- 0
- 1
- 2
- 3
- 4
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/fixture/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
matchDay:
type: integer
format: int32
attendance:
type: integer
format: int32
title: Update Fixture Model
description: This model should be used to propose an update to a fixture.
playerPropertiesModel:
allOf:
- $ref: '#/definitions/basePlayerPropertiesModel'
- properties:
sourceEntityId:
type: string
description: Source entity unique Id
title: The external id from Genius Sports perspective and the internal for the source. By sending this param the
backtracking capabilities improved, via push & pull.
id:
type: string
description: Genius Sport Id
title: If client has the Genius Sport Id it can be sent to improve overall matching capabilities and certainty or
the results.
DoublesPartnershipCompetitorResponseModel:
type: object
required:
- competitorStatusType
- createdOn
- genderType
- id
- name
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competitor/metadata
items:
$ref: '#/definitions/JsonbModel'
name:
type: string
sport:
$ref: '#/definitions/HALEmbededResponse'
genderType:
type: string
description: Undefined, Male, Female, Mixed.
locality:
$ref: '#/definitions/HALEmbededResponse'
competitorStatusType:
type: string
description: Active, Retired, Unattached
isProtected:
type: boolean
description: Whether the competitor is protected or not.
UpdateTBDCompetitor:
type: object
required:
- competitorStatusType
- id
- name
properties:
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModelViewModel'
id:
type: integer
format: int64
minimum: 1.0
name:
type: string
description: The name of the competitor. It must be unique for the provided sport!
title: Competitor name
maxLength: 50
competitorStatusType:
$ref: '#/definitions/CompetitorStatusType'
Empty:
type: object
FixtureResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/FixtureResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
tier:
type: string
title: Tier
description: 'Default is null. One of: 1, 2, 3, 4, 5. Value is based on competition playing level, utilization, marketing
and general popularity, but also taking our restrictions into account such as underaged players or amateur level.'
ArrayOfMetadataPropertyTypesResponseModel:
type: array
items:
$ref: '#/definitions/MetadataPropertyTypesResponseModel'
SportResponseModel:
type: object
required:
- allowsDoubles
- allowsPlayers
- createdOn
- id
- name
- updatesCount
properties:
id:
type: integer
format: int64
title: Id of the sport
name:
type: string
title: Name of the sport
allowsPlayers:
type: boolean
description: Whether players can be proposed for the specific sport. True when Players can be proposed
title: Can Players be proposed for the specific sport
allowsDoubles:
type: boolean
description: Whether players can be proposed for the specific sport. True when Doubles can be proposed
title: Can Doubles be proposed for the specific sport
maxNumberOfCompetitorsInFixture:
type: integer
format: int32
description: The maximum number of competitors which can take part in a fixture for the specific sport. The minimum
is 2. The maximum depends on this number. The maximum is inclusive e.g. number of competitors <= maxNumberOfCompetitorsInFixture.
When maxNumberOfCompetitorsInFixture is set to null this means that there is no upper limit of the number of competitors
which can take part in the fixtures for the specific sport.
title: The maximum number of competitors which can take part in a fixture for the specific sport
createdOn:
type: string
format: date-time
title: The date on which the sport was created
modifiedOn:
type: string
format: date-time
title: The date on which the sport was modified
updatesCount:
type: integer
format: int32
title: The number of updates made to the sport
sportSpecificRules:
type: array
items:
$ref: '#/definitions/sportSpecificRule'
CreateSeasonCompetitor:
type: object
properties:
competitorId:
type: integer
format: int64
description: The id of the competitor which will be added in the season
title: Competitor Id
competitionMatchModel:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
gender:
$ref: '#/definitions/gender'
ageCategory:
$ref: '#/definitions/ageCategory'
startDate:
type: string
format: date-time
description: The date on which the competition starts in format - full-date notation as defined by RFC 3339, section
5.6, for example, 2017-07-21
title: Start Date
endDate:
type: string
format: date-time
description: The date on which the competition ends in format - full-date notation as defined by RFC 3339, section
5.6, for example, 2017-07-21
title: End Date
sponsorName:
type: string
description: The name of the competition sponsor
title: Sponsor Name
longName:
type: string
description: The long name of the competition
title: Long Name
shortName:
type: string
description: The short name of the competition
title: Short Name
locality:
$ref: '#/definitions/locality'
competitionType:
$ref: '#/definitions/competitionType'
sportSpecificRules:
$ref: '#/definitions/sportSpecificRules'
JsonbModel:
type: object
properties:
name:
type: string
value:
type: string
isDeleted:
type: boolean
proposalCompetitionData:
allOf:
- $ref: '#/definitions/proposalDataBase'
- type: object
properties:
gender:
type: string
competitionType:
type: string
startDate:
type: string
endDate:
type: string
locality:
$ref: '#/definitions/proposalLocalityData'
coverage:
type: array
items:
$ref: '#/definitions/coverageData'
sourceCoverage:
type: object
properties:
liveData:
type: boolean
description: Whether the entity has live data coverage.
liveVideo:
type: boolean
description: Whether the entity has live video coverage.
baseResponseMatchModel:
allOf:
- $ref: '#/definitions/baseMatchModel'
- properties:
status:
$ref: '#/definitions/SimplifiedTrackingStatus'
message:
type: string
description: Addional message regarding the status of the proposal
title: Meaningful message for potential problems with the request.
matchingId:
type: string
description: Tracking Id of the matching request that was made for the entity
title: Tracking Id of the matching request.
AcceptedModel:
type: object
properties:
messages:
type: array
items:
type: string
ExternalIdsViewModel:
type: object
properties:
optaId:
type: string
optaLegacyId:
type: string
fibaId:
type: string
vesselId:
type: string
statsEngineId:
type: string
description: External system identifiers. Key represents the external system name (e.g., 'optaId', 'optaLegacyId', 'fibaId',
'vesselId','statsEngineId'), value represents the identifier. The property also allows filtering by specific external
system identifiers. For example '?filter=externalIds.optaId[equals]:12345' to filter entities with a specific Opta ID.
PersonForPlayerResponseModel:
type: object
required:
- createdOn
- firstName
- fullName
- genderType
- id
- isActive
- lastName
- locality
- ref
- updatesCount
- useNickname
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
fullName:
type: string
nickName:
type: string
useNickname:
type: boolean
firstName:
type: string
lastName:
type: string
genderType:
type: string
dateOfBirth:
type: string
format: date-time
isActive:
type: boolean
locality:
$ref: '#/definitions/HALEmbededResponse'
sports:
type: array
items:
$ref: '#/definitions/HALEmbededResponse'
ref:
type: string
proposalFixture:
type: object
properties:
id:
type: string
sourceEntityId:
type: string
sourceName:
type: string
status:
type: string
data:
$ref: '#/definitions/proposalFixtureIngestionData'
Error:
type: object
required:
- domain
- message
- reason
properties:
reason:
type: string
domain:
type: string
locationType:
type: string
location:
type: string
message:
type: string
competitionPhaseReadonlyResponseModel:
allOf:
- $ref: '#/definitions/baseResponseMatchModel'
- properties:
startDate:
type: string
format: date-time
endDate:
type: string
format: date-time
PersonContractResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/PersonContractResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
SeasonResponseModelHATEOASReponseModel:
type: object
properties:
page:
type: integer
format: int32
pageSize:
type: integer
format: int32
totalItems:
type: integer
format: int64
items:
type: array
items:
$ref: '#/definitions/SeasonResponseModel'
self:
type: string
previous:
type: string
next:
type: string
first:
type: string
last:
type: string
CompetitorRoundsResponseModel:
type: object
required:
- genderType
- id
- name
- ref
properties:
id:
type: integer
format: int64
description: Id of the round
name:
type: string
description: Name of the round
ref:
type: string
description: Endpoint to round
genderType:
type: string
description: Gender of the competitor
locality:
$ref: '#/definitions/HALEmbededResponse'
PlayerCompetitorResponseModel:
type: object
required:
- competitorStatusType
- createdOn
- id
- name
- person
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
sport:
$ref: '#/definitions/HALEmbededResponse'
genderType:
type: string
locality:
$ref: '#/definitions/HALEmbededResponse'
competitorStatusType:
type: string
person:
$ref: '#/definitions/PersonForPlayerResponseModel'
isProtected:
type: boolean
description: Whether the competitor is protected or not.
GeneralCompetitorResponseModel:
type: object
required:
- competitorStatusType
- competitorType
- createdOn
- genderType
- id
- name
- ref
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competitor/metadata
items:
$ref: '#/definitions/JsonbModel'
name:
type: string
sport:
$ref: '#/definitions/HALEmbededResponse'
genderType:
type: string
description: Undefined, Male, Female, Mixed.
locality:
$ref: '#/definitions/HALEmbededResponse'
competitorStatusType:
type: string
description: Active, Retired, Unattached
venue:
$ref: '#/definitions/HALEmbededResponse'
competitorType:
type: string
description: Team, Player, Horse, Jockey, HorseOwner, Dog, Breeder, DoublesPartnership, Other, TBD
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
ref:
type: string
description: Reference to the detailed response for the competitor
baseDbModel:
type: object
required:
- name
properties:
name:
type: string
description: The name of the entity to be matched to Genius Sports name. Fuzzy matching is executed upon the official
Genius Sports name. If this does not return result exact match is attempted on the aliases.
id:
type: string
description: Genius Sport Id
title: If client has the Genius Sport Id it can be sent to improve overall matching capabilities and certainty or
the results.
proposalPersonData:
type: object
properties:
id:
type: string
name:
type: string
FixtureRefdataResponse:
type: object
properties:
fixture:
$ref: '#/definitions/FixtureRefdataFixture'
MetadataPropertyTypesResponseModel:
type: object
required:
- allowNonPredefinedValues
- id
- isRequired
- name
properties:
id:
type: integer
format: int64
title: Id of the property type
name:
type: string
title: Name of the property type
allowNonPredefinedValues:
type: boolean
title: True or false value. Defines whether you can use any value or you should use value from the list below.
isRequired:
type: boolean
description: Is property required for the specific entity for the specific sport
title: Is property required for the specific entity for the specific sport
values:
type: array
items:
type: string
ArrayOfproposalCompetition:
type: array
items:
$ref: '#/definitions/proposalCompetition'
FixtureRefdataLineupPlayer:
type: object
properties:
id:
type: string
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
order:
type: integer
format: int32
isStarter:
type: boolean
name:
type: string
shirtNumber:
type: string
position:
type: string
formationPosition:
type: string
formationPositionName:
type: string
TeamCompetitorResponseModel:
type: object
required:
- competitorStatusType
- createdOn
- genderType
- id
- name
- sport
- updatesCount
properties:
id:
type: integer
format: int64
createdOn:
type: string
format: date-time
modifiedOn:
type: string
format: date-time
updatesCount:
type: integer
format: int32
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/competitor/metadata
items:
$ref: '#/definitions/JsonbModel'
externalIds:
$ref: '#/definitions/ExternalIdsViewModel'
name:
type: string
abbreviation:
type: string
sport:
$ref: '#/definitions/HALEmbededResponse'
genderType:
type: string
description: Undefined, Male, Female, Mixed.
ageCategory:
$ref: '#/definitions/ageCategory'
locality:
$ref: '#/definitions/HALEmbededResponse'
competitorStatusType:
type: string
description: Active, Retired, Unattached
venue:
$ref: '#/definitions/HALEmbededResponse'
isProtected:
type: boolean
description: Whether the competitor is protected or not.
UpdateGroup:
type: object
required:
- competitors
- id
- name
- seasonId
- type
properties:
id:
type: integer
format: int64
description: The ID of the group.
title: Group Id
name:
type: string
description: Name of the group.
title: Group name
competitors:
type: array
description: Array of competitors to be added to the group.
title: Competitors
items:
type: integer
description: Competitors which are associated with the round.
title: Competitors
type:
type: string
description: "The type of group. 0 = Conference \n1 = Division"
title: Type
seasonId:
type: integer
format: int64
description: The ID of the season the group belongs to.
title: Season Id
metadataProperties:
type: array
description: In order to retrieve allowed metadata properties with their values execute get request on this path -
/sports/{id}/group/metadata
title: metadataProperties
items:
$ref: '#/definitions/JsonbModelViewModel'
title: Update Group Model
description: This model should be used to update a group object.
x-amazon-apigateway-security-policy: TLS_1_0