Fixtures-v2 API Reference

This is Genius Sports Services Fixture API.

Changelog resume

  • 2.0.107 - Made fixtures round optional for POST DESC_HTML_FILE 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 OTF 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,3sportId[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
  • 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
  • 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

  • sports (sportproperty)
    • competitions (competitionproperty)
      • seasons (seasonproperty)
        • rounds (roundproperty)
          • fixtures (fixtureproperty) (venue)
            • fixturecompetitors (fixturecompetitorproperty)
              • competitor (teamproperty OR playerproperty)

Examples

I am interested in round 2 fixtures for the English Premier League


I am interested in Arsenal and their players

API Endpoint
https://ci.fixtures.api.geniussports.com/v2
Contact: OTF@geniussports.com
Schemes: https
Version: 2.0.145

Authentication

Auth0

type
apiKey
name
Authorization
in
header
x-amazon-apigateway-authtype
oauth2

api_key

type
apiKey
name
x-api-key
in
header

sports

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

Retrieve sports by ID/s. MAX 200 per page.

GET /sports

Returns sports wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "allowsPlayers": "boolean",
      "allowsDoubles": "boolean",
      "maxNumberOfCompetitorsInFixture": "integer (int32)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve allowed properties per entity type name and per sport.

GET /sports/{id}/{entityType}/metadata

Retrieve allowed properties per entity type name and per sport.

entityType: string
in path

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

x-api-key: string
in header

(no description)

id: string
in path

The sport for which the allowed properties will be retrieved.

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
[
  {
    "id": "integer (int64)",
    "name": "string",
    "allowNonPredefinedValues": "boolean",
    "isRequired": "boolean",
    "values": [
      "string"
    ]
  }
]
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

organizations

Organization is the top level in the hierarchy and allows us to group competitions in order to apply permissions rules over them.

Retrieve organizations data. MAX 200 per page.

GET /organizations

Returns organizations wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "name": "string",
      "code": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new organization

POST /organizations

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "code": "string"
}

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "name": "string",
  "code": "string"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing organization

PUT /organizations

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "name": "string"
}

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "name": "string",
  "code": "string"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve organization details by ID.

GET /organizations/{id}

Returns organization details.

x-api-key: string
in header

(no description)

id: string
in path

Single organization ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "name": "string",
  "code": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Delete existing organization

DELETE /organizations/{id}
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

localities

This can include a country, continent, administrative region, game map, etc

Retrieve localities (old regions) by ID/s. MAX 200 per page.

GET /localities

Returns localities (old regions) wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, localityType)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, localityType)

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "localityType": "string",
      "code": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve locality details by ID.

GET /localities/{id}

Returns locality details by ID

x-api-key: string
in header

(no description)

id: string
in path

Single locality ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "name": "string",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "localityType": "string",
  "code": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

competitions

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

Retrieve competition by ID/s. MAX 200 per page.

GET /competitions

Returns competitions wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, sportId, genderType, localityId)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "organization": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "name": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "timezone": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "shortName": "string",
      "longName": "string",
      "sponsorName": "string",
      "youth": "boolean"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new competition

POST /competitions

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "sportId": "integer (int64)",
  "organizationId": "integer (int64)",
  "localityId": "integer (int64)",
  "genderType": "integer (int32)",
  "name": "string",
  "timezone": "string",
  "shortName": "string",
  "longName": "string",
  "sponsorName": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "youth": "boolean"
}

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "organization": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "name": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "shortName": "string",
  "longName": "string",
  "sponsorName": "string",
  "youth": "boolean"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing competition

PUT /competitions

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "name": "string",
  "organizationId": "integer (int64)",
  "localityId": "integer (int64)",
  "timezone": "string",
  "shortName": "string",
  "longName": "string",
  "sponsorName": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "youth": "boolean"
}

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "organization": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "name": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "shortName": "string",
  "longName": "string",
  "sponsorName": "string",
  "youth": "boolean"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve competition details by ID.

GET /competitions/{id}

Returns competition details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single competition ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "organization": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "name": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "shortName": "string",
  "longName": "string",
  "sponsorName": "string",
  "youth": "boolean"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Delete existing competition

DELETE /competitions/{id}
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

seasons

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

Retrieve seasons by ID/s. MAX 200 per page.

GET /seasons

Returns seasons wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, competitionId, sportId, genderType, localityId)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, competitionId, sportId, genderType, localityId)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "timezone": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competition": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new season

POST /seasons

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "localityId": "integer (int64)",
  "competitionId": "integer (int64)",
  "competitors": [
    "integer"
  ],
  "timezone": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}
201 Created

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing season

PUT /seasons

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "localityId": "integer (int64)",
  "id": "integer (int64)",
  "competitors": [
    "integer"
  ],
  "timezone": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve seasons details by ID.

GET /seasons/{id}

Returns seasons details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single season ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Delete existing season

DELETE /seasons/{id}
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve season competitors by Season ID/s. MAX 200 per page.

GET /seasons/{id}/competitors

Returns the competitors which will take part in the season related to the GSS Season Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, competitortype)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, competitortype, isactive (default = true))

id: string
in path

Single season ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "ref": "string",
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Adds new competitor to the season

POST /seasons/{id}/competitors
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "competitorId": "integer (int64)"
}
201 Created

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Removes competitor added to season

DELETE /seasons/{id}/competitors/{competitorId}
gs-fixtures-api-sub-source: string
in header

Sub Source Name

competitorId: string
in path

(no description)

x-api-key: string
in header

(no description)

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

rounds

A round is a group of fixtures within a season e.g. Premier League 2021/2022 Round 1

Retrieve rounds by ID/s. MAX 200 per page.

GET /rounds

Returns rounds wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, seasonId, competitionId, sportId, type)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, seasonId, competitionId, sportId, type)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "type": "string",
      "season": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competition": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "parentRound": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "timezone": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new round

POST /rounds

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "competitors": [
    "integer"
  ],
  "startdate": "string (date-time)",
  "enddate": "string (date-time)",
  "type": "string",
  "seasonId": "integer (int64)",
  "parentRoundId": "integer (int64)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "timezone": "string"
}
201 Created

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "type": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "parentRound": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing round

PUT /rounds

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "name": "string",
  "competitors": [
    "integer"
  ],
  "startdate": "string (date-time)",
  "enddate": "string (date-time)",
  "type": "string",
  "seasonId": "integer (int64)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "timezone": "string"
}

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "type": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "parentRound": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve rounds details by ID.

GET /rounds/{id}

Returns rounds details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single rounds ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "type": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "parentRound": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Delete existing round

DELETE /rounds/{id}
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve round competitors by Round ID/s. MAX 200 per page.

GET /rounds/{id}/competitors

Returns the competitors which will take part in the round related to the GSS Round Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))

id: string
in path

Single rounds ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "ref": "string",
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Adds new competitor to the round

POST /rounds/{id}/competitors
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

Request Content-Types: application/json
Request Example
{
  "competitorId": "integer (int64)"
}
201 Created

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "type": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "parentRound": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Removes competitor added to round

DELETE /rounds/{id}/competitors/{competitorId}
gs-fixtures-api-sub-source: string
in header

Sub Source Name

competitorId: string
in path

(no description)

x-api-key: string
in header

(no description)

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

fixtures

A fixture is an entity that contains the information that is required to define a particular sporting event.

Retrieve fixtures by ID/s. MAX 200 per page.

GET /fixtures

Returns fixtures wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

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)

x-api-key: string
in header

(no description)

filter: string
in query

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)

successful operation

301 Moved Permanently

redirect operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "startDate": "string (date-time)",
      "name": "string",
      "season": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "eventStatusType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "timezone": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "venue": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competition": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "round": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "homeCompetitor": {
        "id": "integer (int64)",
        "name": "string",
        "competitorType": "string",
        "ref": "string"
      },
      "genderType": "string",
      "competitors": [
        {
          "id": "integer (int64)",
          "name": "string",
          "competitorType": "string",
          "metadataProperties": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "ref": "string"
        }
      ],
      "fixtureLink": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "eventType": "string",
      "matchDay": "integer (int32)",
      "attendance": "integer (int32)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Headers (301 Moved Permanently)
x-gs-attr-oldnewentityidssmap

oldId=newId separated by semicolon ';' e.g.: 1=2;3=4;...

string
Location

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new fixture

POST /fixtures

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "seasonId": "integer (int64)",
  "competitors": [
    "integer"
  ],
  "homeCompetitorId": "integer (int64)",
  "startDate": "string (date-time)",
  "roundId": "integer (int64)",
  "venueId": "integer (int64)",
  "localityId": "integer (int64)",
  "name": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}
201 Created

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "startDate": "string (date-time)",
  "name": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventStatusType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "round": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "homeCompetitor": {
    "id": "integer (int64)",
    "name": "string",
    "competitorType": "string",
    "ref": "string"
  },
  "genderType": "string",
  "competitors": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "ref": "string"
    }
  ],
  "fixtureLink": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventType": "string",
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing fixture

PUT /fixtures

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "competitors": [
    "integer"
  ],
  "homeCompetitorId": "integer (int64)",
  "startDate": "string (date-time)",
  "roundId": "integer (int64)",
  "venueId": "integer (int64)",
  "localityId": "integer (int64)",
  "EventStatusType": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "startDate": "string (date-time)",
  "name": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventStatusType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "round": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "homeCompetitor": {
    "id": "integer (int64)",
    "name": "string",
    "competitorType": "string",
    "ref": "string"
  },
  "genderType": "string",
  "competitors": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "ref": "string"
    }
  ],
  "fixtureLink": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventType": "string",
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Patch existing fixture

PATCH /fixtures

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "startDate": "string (date-time)",
  "venueId": "integer (int64)",
  "roundId": "integer (int64)"
}

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "startDate": "string (date-time)",
  "name": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventStatusType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "round": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "homeCompetitor": {
    "id": "integer (int64)",
    "name": "string",
    "competitorType": "string",
    "ref": "string"
  },
  "genderType": "string",
  "competitors": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "ref": "string"
    }
  ],
  "fixtureLink": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventType": "string",
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve fixtures details by ID.

GET /fixtures/{id}

Returns fixtures details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single fixtures ID to return details for

successful operation

202 Accepted

Accepted

301 Moved Permanently

redirect operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "startDate": "string (date-time)",
  "name": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventStatusType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "round": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "homeCompetitor": {
    "id": "integer (int64)",
    "name": "string",
    "competitorType": "string",
    "ref": "string"
  },
  "genderType": "string",
  "competitors": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "ref": "string"
    }
  ],
  "fixtureLink": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventType": "string",
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Headers (301 Moved Permanently)
Location

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Delete existing fixture

DELETE /fixtures/{id}
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve fixture's officials by fixture ID. MAX 200 per page.

GET /fixtures/{id}/officials

Returns fixture's officials wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed.

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators.

id: string
in path

Single fixture ID to return officials for

301 Moved Permanently

redirect operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "person": {
        "id": "integer (int64)",
        "dateOfBirth": "string (date-time)",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "nickName": "string",
        "genderType": "string",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "ref": "string"
      },
      "personRole": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Headers (301 Moved Permanently)
Location

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Adds new official to the fixture

POST /fixtures/{id}/officials
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

Single fixture ID to create official for

Request Content-Types: application/json
Request Example
{
  "personId": "integer (int64)",
  "personRole": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "person": {
    "id": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "nickName": "string",
    "genderType": "string",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "ref": "string"
  },
  "personRole": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ]
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing fixture official

PUT /fixtures/{id}/officials
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

Single fixture ID to update official for

Request Content-Types: application/json
Request Example
{
  "personId": "integer (int64)",
  "personRole": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "person": {
    "id": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "nickName": "string",
    "genderType": "string",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "ref": "string"
  },
  "personRole": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ]
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Removes official added to fixture

DELETE /fixtures/{id}/officials/{personId}
gs-fixtures-api-sub-source: string
in header

Sub Source Name

x-api-key: string
in header

(no description)

id: string
in path

(no description)

personId: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

competitors

The competitors are generalized term for a team, player, double partnership, horse, dog or any entity that can participate in a Fixture

Retrieve competitors basic info regardless their type with reference to the detailed endpoint. MAX 200 per page.

GET /competitors

Retrieve competitors basic info regardless their type with reference to the detailed endpoint wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)

x-api-key: string
in header

(no description)

filter: string
in query

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)

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string",
      "venue": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorType": "string",
      "ref": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve competitors basic info regardless their type with reference to the detailed endpoint by ID.

GET /competitors/{id}

Retrieve competitors basic info regardless their type with reference to the detailed endpoint by ID.

x-api-key: string
in header

(no description)

id: string
in path

Single competitors ID to return information for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorType": "string",
  "ref": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Delete existing existing competitor of any type - Team, Player, Double partnership etc

DELETE /competitors/{id}
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

competitors/teams

Groups the operations related to competitors of type Team

Retrieve competitors (teams) by ID/s. MAX 200 per page.

GET /competitors/teams

Returns competitors (teams) wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)

x-api-key: string
in header

(no description)

filter: string
in query

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)

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "abbreviation": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string",
      "venue": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new team

POST /competitors/teams
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "abbreviation": "string",
  "localityId": "integer (int64)",
  "venueId": "integer (int64)",
  "sportId": "integer (int64)",
  "genderType": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "abbreviation": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing team

PUT /competitors/teams
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "name": "string",
  "abbreviation": "string",
  "localityId": "integer (int64)",
  "venueId": "integer (int64)",
  "competitorStatusType": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "abbreviation": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve competitors (teams) details by ID.

GET /competitors/teams/{id}

Returns competitors (teams) details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single competitors (teams) ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "abbreviation": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve rounds in which the Team will take part by Team ID/s. MAX 200 per page.

GET /competitors/teams/{id}/rounds

Returns the rounds in which the team will take part by GSS Team Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))

id: string
in path

Single competitors (teams) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string",
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve seasons in which the Team will take part by Team ID/s. MAX 200 per page.

GET /competitors/teams/{id}/seasons

Returns the seasons in which the team will take part by GSS Team Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))

id: string
in path

Single competitors (teams) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

competitors/players

Groups the operations related to competitors of type Player

Retrieve competitors (players) by ID/s. MAX 200 per page.

GET /competitors/players

Returns competitors (players) wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)

x-api-key: string
in header

(no description)

filter: string
in query

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)

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string",
      "person": {
        "id": "integer (int64)",
        "createdOn": "string (date-time)",
        "modifiedOn": "string (date-time)",
        "updatesCount": "integer (int32)",
        "fullName": "string",
        "nickName": "string",
        "useNickname": "boolean",
        "firstName": "string",
        "lastName": "string",
        "genderType": "string",
        "dateOfBirth": "string (date-time)",
        "isActive": "boolean",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "sports": [
          {
            "id": "integer (int64)",
            "name": "string",
            "ref": "string"
          }
        ],
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new player

POST /competitors/players
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "personId": "integer (int64)",
  "sportId": "integer (int64)",
  "person": {
    "firstName": "string",
    "lastName": "string",
    "nickName": "string",
    "useNickname": "boolean",
    "localityId": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "genderType": "integer (int32)",
    "sports": [
      "integer"
    ]
  }
}

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "person": {
    "id": "integer (int64)",
    "createdOn": "string (date-time)",
    "modifiedOn": "string (date-time)",
    "updatesCount": "integer (int32)",
    "fullName": "string",
    "nickName": "string",
    "useNickname": "boolean",
    "firstName": "string",
    "lastName": "string",
    "genderType": "string",
    "dateOfBirth": "string (date-time)",
    "isActive": "boolean",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "sports": [
      {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    ],
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing player

PUT /competitors/players
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "id": "integer (int64)",
  "competitorStatusType": "integer (int32)"
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "person": {
    "id": "integer (int64)",
    "createdOn": "string (date-time)",
    "modifiedOn": "string (date-time)",
    "updatesCount": "integer (int32)",
    "fullName": "string",
    "nickName": "string",
    "useNickname": "boolean",
    "firstName": "string",
    "lastName": "string",
    "genderType": "string",
    "dateOfBirth": "string (date-time)",
    "isActive": "boolean",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "sports": [
      {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    ],
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve competitors (players) details by ID.

GET /competitors/players/{id}

Returns competitors (players) details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single competitors (players) ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "person": {
    "id": "integer (int64)",
    "createdOn": "string (date-time)",
    "modifiedOn": "string (date-time)",
    "updatesCount": "integer (int32)",
    "fullName": "string",
    "nickName": "string",
    "useNickname": "boolean",
    "firstName": "string",
    "lastName": "string",
    "genderType": "string",
    "dateOfBirth": "string (date-time)",
    "isActive": "boolean",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "sports": [
      {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    ],
    "ref": "string"
  }
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve rounds in which the Player will take part by Team ID/s. MAX 200 per page.

GET /competitors/players/{id}/rounds

Returns the rounds in which the player will take part by GSS Player Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))

id: string
in path

Single competitors (players) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string",
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve seasons in which the Player will take part by Team ID/s. MAX 200 per page.

GET /competitors/players/{id}/seasons

Returns the seasons in which the player will take part by GSS Player Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))

id: string
in path

Single competitors (players) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

competitors/doubles

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

Retrieve competitors (doubles) by ID/s. MAX 200 per page.

GET /competitors/doubles

Returns competitors (doubles) wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)

x-api-key: string
in header

(no description)

filter: string
in query

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)

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new double partnership

POST /competitors/doubles
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "firstPersonId": "integer (int64)",
  "secondPersonId": "integer (int64)",
  "sportId": "integer (int64)"
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing double partnership

PUT /competitors/doubles
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "id": "integer (int64)",
  "competitorStatusType": "integer (int32)"
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve competitors (doubles) details by ID.

GET /competitors/doubles/{id}

Returns competitors (doubles) details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single competitors (doubles) ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve rounds in which the Doubles Partnership will take part by Team ID/s. MAX 200 per page.

GET /competitors/doubles/{id}/rounds

Returns the rounds in which the doubles partnership will take part by GSS Doubles Partnership Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))

id: string
in path

Single competitors (doubles) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string",
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve seasons in which the Doubles Partnership will take part by Team ID/s. MAX 200 per page.

GET /competitors/doubles/{id}/seasons

Returns the seasons in which the Doubles Partnership will take part by GSS Doubles Partnership Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name, isactive (default = true))

id: string
in path

Single competitors (doubles) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

competitors/horses

Groups the operations related to competitors of type Horse

Retrieve competitors (horses) by ID/s. MAX 200 per page.

GET /competitors/horses

Returns competitors (horses) wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)

x-api-key: string
in header

(no description)

filter: string
in query

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)

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve competitors (horses) details by ID.

GET /competitors/horses/{id}

Returns competitors (horses) details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single competitors (horses) ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

competitors/tbds

Groups the operations related to to-be-determined competitors.

Retrieve competitors (TBD) by ID/s. MAX 200 per page.

GET /competitors/tbds

Returns competitors (TBD) wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name, sportId, genderType, localityId, venueId, competitorStatusType)

x-api-key: string
in header

(no description)

filter: string
in query

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)

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string",
      "person": {
        "id": "integer (int64)",
        "createdOn": "string (date-time)",
        "modifiedOn": "string (date-time)",
        "updatesCount": "integer (int32)",
        "fullName": "string",
        "nickName": "string",
        "useNickname": "boolean",
        "firstName": "string",
        "lastName": "string",
        "genderType": "string",
        "dateOfBirth": "string (date-time)",
        "isActive": "boolean",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "sports": [
          {
            "id": "integer (int64)",
            "name": "string",
            "ref": "string"
          }
        ],
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new TBD competitor

POST /competitors/tbds
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "name": "string",
  "sportId": "integer (int64)"
}

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing TBD

PUT /competitors/tbds
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "id": "integer (int64)",
  "name": "string",
  "competitorStatusType": "integer (int32)"
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve competitors (TBD) details by ID.

GET /competitors/tbds/{id}

Returns competitors (TBD) details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single competitors (TBD) ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

venues

A sports venue is a building, structure, or place in which a sporting fixture is held.

Retrieve venues by ID/s. MAX 200 per page.

GET /venues

Returns venues wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "latitude": "number (double)",
      "longitude": "number (double)",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "capacity": "integer (int32)",
      "cityName": "string",
      "sports": [
        {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        }
      ],
      "parentVenue": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new venue

POST /venues

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "name": "string",
  "localityId": "integer (int64)",
  "parentVenueId": "integer (int64)",
  "sports": [
    "integer"
  ],
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}
201 Created

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "latitude": "number (double)",
  "longitude": "number (double)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "capacity": "integer (int32)",
  "cityName": "string",
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "parentVenue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing venue

PUT /venues

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "name": "string",
  "localityId": "integer (int64)",
  "sports": [
    "integer"
  ],
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "latitude": "number (double)",
  "longitude": "number (double)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "capacity": "integer (int32)",
  "cityName": "string",
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "parentVenue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve venues details by ID.

GET /venues/{id}

Returns venues details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single venues ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "latitude": "number (double)",
  "longitude": "number (double)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "capacity": "integer (int32)",
  "cityName": "string",
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "parentVenue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Delete existing venue

DELETE /venues/{id}
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

contracts

The contract is relation between one competitor of one type and another competitor of another type representing a real world relation between two competitors.

Retrieve persons which are part of the doubles partnership by Doubles Partnership ID/s. MAX 200 per page.

GET /competitors/doubles/{id}/contracts

Returns the persons which are part of the doubles partnership by GSS Doubles Partnership Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

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)

x-api-key: string
in header

(no description)

filter: string
in query

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))

id: string
in path

Single competitors (doubles) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "person": {
        "id": "integer (int64)",
        "dateOfBirth": "string (date-time)",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "nickName": "string",
        "genderType": "string",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "player": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve persons which are associated with the current player (e.g. coaches) by Player ID/s. MAX 200 per page.

GET /competitors/players/{id}/contracts

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

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

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)

x-api-key: string
in header

(no description)

filter: string
in query

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))

id: string
in path

Single competitors (players) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "competitor": {
        "id": "integer (int64)",
        "name": "string",
        "competitorType": "string",
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

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.

GET /competitors/teams/{id}/contracts

Returns the persons which were or are part of the team by GSS Team Id in the path, wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

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)

x-api-key: string
in header

(no description)

filter: string
in query

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))

id: string
in path

Single competitors (teams) ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "person": {
        "id": "integer (int64)",
        "dateOfBirth": "string (date-time)",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "nickName": "string",
        "genderType": "string",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "player": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve contracts between person and different types of competitors.

GET /contracts

Returns the persons, the corresponding player and the competitor with which the person has contract of wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

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)

x-api-key: string
in header

(no description)

filter: string
in query

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)

id: string
in path

(no description)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "person": {
        "id": "integer (int64)",
        "dateOfBirth": "string (date-time)",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "nickName": "string",
        "genderType": "string",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "player": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitor": {
        "id": "integer (int64)",
        "name": "string",
        "competitorType": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new contract between competitor of any type and person

POST /contracts

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "personId": "integer (int64)",
  "isActive": "boolean",
  "competitorId": "integer (int64)",
  "personRole": "integer (int32)",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)"
}

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "person": {
    "id": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "nickName": "string",
    "genderType": "string",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "player": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "personRole": "string",
  "isActive": "boolean",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ]
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing contract between competitor of any type and person

PUT /contracts

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "id": "integer (int64)",
  "isActive": "boolean",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "person": {
    "id": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "nickName": "string",
    "genderType": "string",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "player": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "personRole": "string",
  "isActive": "boolean",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ]
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve a snapshot of the contracts that were active for the competitors which were part of the fixture when the fixture took place.

GET /fixtures/{id}/contracts

Returns the competitor, the person and the corresponding player

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed.

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators.

id: string
in path

Single fixture ID to return officials for

successful operation

301 Moved Permanently

redirect operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "person": {
        "id": "integer (int64)",
        "dateOfBirth": "string (date-time)",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "nickName": "string",
        "genderType": "string",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "player": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitor": {
        "id": "integer (int64)",
        "name": "string",
        "competitorType": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Headers (301 Moved Permanently)
Location

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

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.

GET /persons/{id}/contracts

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

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

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)

x-api-key: string
in header

(no description)

filter: string
in query

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))

id: string
in path

Single person ID to return details for

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "competitor": {
        "id": "integer (int64)",
        "name": "string",
        "competitorType": "string",
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

persons

The person represents a real live person and it's basic properties

Retrieve persons by ID/s. MAX 200 per page. (Not available yet)

GET /persons

Returns persons wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "genderType": "string",
      "dateOfBirth": "string (date-time)",
      "isActive": "boolean",
      "nickName": "string",
      "useNickname": "boolean",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "sports": [
        {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        }
      ],
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Create new person

POST /persons
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "useNickname": "boolean",
  "localityId": "integer (int64)",
  "dateOfBirth": "string (date-time)",
  "genderType": "integer (int32)",
  "sports": [
    "integer"
  ]
}
201 Created

Created

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (201 Created)
{
  "id": "integer (int64)",
  "fullName": "string",
  "firstName": "string",
  "lastName": "string",
  "genderType": "string",
  "dateOfBirth": "string (date-time)",
  "isActive": "boolean",
  "nickName": "string",
  "useNickname": "boolean",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Update existing person

PUT /persons
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "useNickname": "boolean",
  "localityId": "integer (int64)",
  "dateOfBirth": "string (date-time)",
  "genderType": "integer (int32)",
  "id": "integer (int64)",
  "isActive": "boolean",
  "sports": [
    "integer"
  ]
}

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

409 Conflict

Conflict, see the response message or the 'geniussports-conflict-id' header to see the ID of the conflict!

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "fullName": "string",
  "firstName": "string",
  "lastName": "string",
  "genderType": "string",
  "dateOfBirth": "string (date-time)",
  "isActive": "boolean",
  "nickName": "string",
  "useNickname": "boolean",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)"
}
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (409 Conflict)
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve persons which were in the past or are currently coaches by ID/s. MAX 200 per page. (Not available yet)

GET /persons/coaches

Returns persons wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "genderType": "string",
      "dateOfBirth": "string (date-time)",
      "isActive": "boolean",
      "nickName": "string",
      "useNickname": "boolean",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "sports": [
        {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        }
      ],
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve persons which were in the past or are currently referees by ID/s. MAX 200 per page. (Not available yet)

GET /persons/referees

Returns persons wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed. Fields to order by for this endpoint: (id, name)

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators. Fields to filter by for this endpoint: (id, name)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "genderType": "string",
      "dateOfBirth": "string (date-time)",
      "isActive": "boolean",
      "nickName": "string",
      "useNickname": "boolean",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "sports": [
        {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        }
      ],
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve persons details by ID. (not available yet)

GET /persons/{id}

Returns persons details including sport specific details (metadata properties)

x-api-key: string
in header

(no description)

id: string
in path

Single person ID to return details for

successful operation

202 Accepted

Accepted

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "id": "integer (int64)",
  "fullName": "string",
  "firstName": "string",
  "lastName": "string",
  "genderType": "string",
  "dateOfBirth": "string (date-time)",
  "isActive": "boolean",
  "nickName": "string",
  "useNickname": "boolean",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Delete existing person

DELETE /persons/{id}
x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

id: string
in path

(no description)

200 OK

Success

202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "messages": [
    "string"
  ]
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Retrieve person's officials by person ID. MAX 200 per page.

GET /persons/{id}/officials

Returns person's officials wrapped inside a HATEOAS model

page: string
in query

The number of page to be returned. The default value is 1.

pageSize: string
in query

The size of the page to be returned. The default value is 10.

sortBy: string
in query

The field to 'order by' by. Descending ordering also allowed.

x-api-key: string
in header

(no description)

filter: string
in query

The field to 'filter' by. Check main description for filter comparators.

id: string
in path

Single person ID to return officials for

301 Moved Permanently

redirect operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "fixture": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "personRole": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Headers (301 Moved Permanently)
Location

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

sourcerequests

Source requests for clients using Genius Sports structured requests (not raw data but using Genius sports Id references).

Retrieves info about the status of a Source Request, given its Request Id.

GET /sourcerequests/{requestId}/status

Retrieves info about the status of a Source Request, given its Request Id.

x-api-key: string
in header

(no description)

requestId: string
in path

(no description)

successful operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "status": "string",
  "entityName": "string",
  "gssId": "string",
  "gssName": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

ingestion

Ingesting raw data gets matched and then proposed for potential update or create to the SOT data.

Ingest fixture data for update or create

POST /ingestion/fixtures

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "competition": {
    "gender": "string",
    "startDate": "string (date-time)",
    "endDate": "string (date-time)",
    "locality": "string",
    "competitionType": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "sport": {
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "fixture": {
    "startDate": "string (date-time)",
    "locality": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "venue": {
    "locality": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "competitors": [
    {
      "competitorType": "string",
      "locality": "string",
      "gender": "string",
      "name": "string",
      "id": "string",
      "sourceEntityId": "string"
    }
  ],
  "competitionPhase": {
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  }
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "trackingRequestId": "string"
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Tracking the progress of the asynchronous execution.

GET /ingestion/fixtures/{trackingRequestId}/status

Returns the current state of the ingestion request

x-api-key: string
in header

(no description)

trackingRequestId: string
in path

GUID returned from an ingestion request

successful operation

301 Moved Permanently

redirect operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "competition": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "season": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "sport": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "fixture": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "competitors": [
    {
      "status": "string",
      "message": "string",
      "name": "string",
      "id": "string",
      "sourceEntityId": "string"
    }
  ]
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Headers (301 Moved Permanently)
Location

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Tracking the progress of the asynchronous execution on a single entity by external source entity Id

GET /ingestion/mappings

Returns the status of a given entity mapping. It is useful if the client does not want or have an option to persint tracking Id.

gs-fixtures-api-sub-source: string
in header

Sub Source Name

x-api-key: string
in header

(no description)

entity: string
in query

Expandable enumeration, having of of: competition, fixture, sport, team, player. New values are possible to be added!

sourceEntityId: string
in query

The id of the source from the client perspective.

successful operation

301 Moved Permanently

redirect operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "entity": "string",
  "status": "string",
  "message": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Headers (301 Moved Permanently)
Location

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Ingest team squad players data for update or create

POST /ingestion/squads

undefined

x-api-key: string
in header

(no description)

gs-fixtures-api-sub-source: string
in header

Sub Source Name

Request Content-Types: application/json
Request Example
{
  "team": {
    "gender": "string",
    "locality": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "sport": {
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "players": [
    {
      "birthDate": "string (date-time)",
      "position": "string",
      "shirtNumber": "number",
      "competitorType": "string",
      "locality": "string",
      "gender": "string",
      "name": "string",
      "id": "string",
      "sourceEntityId": "string"
    }
  ]
}
202 Accepted

Accepted

400 Bad Request

Bad request

404 Not Found

Not found

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal server error

Response Content-Types: application/json
Response Example (202 Accepted)
{
  "trackingRequestId": "string"
}
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

Tracking the progress of the asynchronous execution.

GET /ingestion/squads/{trackingRequestId}/status

Returns the current state of the ingestion request

x-api-key: string
in header

(no description)

trackingRequestId: string
in path

GUID returned from an ingestion request

successful operation

301 Moved Permanently

redirect operation

400 Bad Request

Bad request

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not found

413 Request Entity Too Large

Payload Too Large

415 Unsupported Media Type

Unsupported Media Type

429 Too Many Requests

Too Many Requests OR Limit Exceeded - On reason = Too Many requests one should re-try, for Limit Exceeded that does not help you

500 Internal Server Error

Internal Server Error

504 Gateway Timeout

Gateway Timeout

Unknown error

Response Content-Types: application/json
Response Example (200 OK)
{
  "team": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "sport": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "players": [
    {
      "status": "string",
      "message": "string",
      "name": "string",
      "id": "string",
      "sourceEntityId": "string"
    }
  ]
}
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Response Headers (301 Moved Permanently)
Location

undefined

string
Response Example (400 Bad Request)
{
  "messages": [
    "string"
  ]
}
Response Example (401 Unauthorized)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (403 Forbidden)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (404 Not Found)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (413 Request Entity Too Large)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (415 Unsupported Media Type)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (429 Too Many Requests)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (500 Internal Server Error)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (504 Gateway Timeout)
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}
Response Example (520 )
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

default

OPTIONS /competitions

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitions/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/doubles

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/doubles/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/doubles/{id}/contracts

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/doubles/{id}/rounds

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/doubles/{id}/seasons

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/horses

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/horses/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/players

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/players/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/players/{id}/contracts

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/players/{id}/rounds

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/players/{id}/seasons

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/tbds

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/tbds/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/teams

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/teams/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/teams/{id}/contracts

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/teams/{id}/rounds

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/teams/{id}/seasons

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /competitors/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /contracts

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /fixtures

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /fixtures/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /fixtures/{id}/contracts

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /fixtures/{id}/officials

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /fixtures/{id}/officials/{personId}

personId: string
in path

(no description)

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /ingestion/fixtures/{trackingRequestId}/status

trackingRequestId: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /ingestion/mappings

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /ingestion/squads/{trackingRequestId}/status

trackingRequestId: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /localities

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /localities/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /organizations

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /organizations/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /persons

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /persons/coaches

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /persons/referees

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /persons/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /persons/{id}/contracts

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /persons/{id}/officials

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /rounds

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /rounds/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /rounds/{id}/competitors

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /seasons

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /seasons/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /seasons/{id}/competitors

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /sourcerequests/{requestId}/status

requestId: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /sports

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /sports/{id}/{entityType}/metadata

entityType: string
in path

(no description)

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /venues

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

OPTIONS /venues/{id}

id: string
in path

(no description)

200 OK

200 response

Response Content-Types: application/json
Response Example (200 OK)
"object"
Response Headers (200 OK)
Access-Control-Allow-Origin

undefined

string
Access-Control-Allow-Methods

undefined

string
Access-Control-Allow-Headers

undefined

string

Schema Definitions

RoundResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: RoundResponseModel
RoundResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "type": "string",
      "season": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competition": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "parentRound": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "timezone": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

PersonResponseModel: object

id: integer (int64)
fullName: string
firstName: string
lastName: string
genderType: string

Undefined, Male, Female, Mixed.

dateOfBirth: string (date-time)
isActive: boolean
nickName: string
useNickname: boolean
locality: HALEmbededResponse
sports: HALEmbededResponse
HALEmbededResponse
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
Example
{
  "id": "integer (int64)",
  "fullName": "string",
  "firstName": "string",
  "lastName": "string",
  "genderType": "string",
  "dateOfBirth": "string (date-time)",
  "isActive": "boolean",
  "nickName": "string",
  "useNickname": "boolean",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)"
}

CreateFixture: object

This model should be used to propose a new fixture.

seasonId: integer (int64)

The ID of the season to fixture belongs to.

competitors: integer[]

Array of competitors to be added to the fixture.

integer

Competitors which belong to the fixture.

homeCompetitorId: integer (int64)

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

startDate: string (date-time)

The start date of the fixture in UTC ISO-8601 format

roundId: integer (int64)

The ID of the round the fixture belongs to.

venueId: integer (int64)

The ID of the venue the fixture is played at.

localityId: integer (int64)

The ID of the country/region/administrative zone the fixture is played at.

name: string (up to 250 chars)

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

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/fixture/metadata

JsonbModelViewModel
matchDay: integer (int32)
attendance: integer (int32)
Example
{
  "seasonId": "integer (int64)",
  "competitors": [
    "integer"
  ],
  "homeCompetitorId": "integer (int64)",
  "startDate": "string (date-time)",
  "roundId": "integer (int64)",
  "venueId": "integer (int64)",
  "localityId": "integer (int64)",
  "name": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}

ContractResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
person: PersonHALEmbededResponse
sport: HALEmbededResponse
player: HALEmbededResponse
competitor: CompetitorHALEmbededResponse
personRole: string
isActive: boolean

Whether the relation between the person and the competitor is active

startDate: string (date-time)
endDate: string (date-time)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/contract/metadata

JsonbModel
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "person": {
    "id": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "nickName": "string",
    "genderType": "string",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "player": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitor": {
    "id": "integer (int64)",
    "name": "string",
    "competitorType": "string",
    "ref": "string"
  },
  "personRole": "string",
  "isActive": "boolean",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ]
}

UpdateTeamCompetitor: object

id: integer (int64)
name: string (up to 50 chars)

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!

abbreviation: string (up to 125 chars)

An abbreviation for the competitor

localityId: integer (int64)

Id of the country,virtual place, etc. of the competitor!

venueId: integer (int64)

Id of the home venue of the competitor. The venue must be associated with the same sport as the competitor!

competitorStatusType: CompetitorStatusType
metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competitor/metadata

JsonbModelViewModel
Example
{
  "id": "integer (int64)",
  "name": "string",
  "abbreviation": "string",
  "localityId": "integer (int64)",
  "venueId": "integer (int64)",
  "competitorStatusType": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

CompetitorSeasonsResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: CompetitorSeasonsResponseModel
CompetitorSeasonsResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

FixtureResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/fixture/metadata

JsonbModel
startDate: string (date-time)
name: string
season: HALEmbededResponse
eventStatusType: string

Notstarted, Inprogress, Finished, Cancelled, Postponed.

locality: HALEmbededResponse
timezone: HALEmbededResponse
venue: HALEmbededResponse
sport: HALEmbededResponse
competition: HALEmbededResponse
round: HALEmbededResponse
homeCompetitor: CompetitorHALEmbededResponse

Id of the competitor marked as home competitor

genderType: string

Undefined, Male, Female, Mixed.

competitors: FixtureCompetitorHALEmbededResponse
FixtureCompetitorHALEmbededResponse
fixtureLink: HALEmbededResponse
eventType: string

Match, VirtualMatch, SeasonOutright, PartialOutright, AggregateEvent

matchDay: integer (int32)
attendance: integer (int32)
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "startDate": "string (date-time)",
  "name": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventStatusType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "round": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "homeCompetitor": {
    "id": "integer (int64)",
    "name": "string",
    "competitorType": "string",
    "ref": "string"
  },
  "genderType": "string",
  "competitors": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "ref": "string"
    }
  ],
  "fixtureLink": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "eventType": "string",
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}

SportResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: SportResponseModel
SportResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "allowsPlayers": "boolean",
      "allowsDoubles": "boolean",
      "maxNumberOfCompetitorsInFixture": "integer (int32)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

UpdatePersonViewModel: object

firstName: string (up to 256 chars)

The first name of the person

lastName: string (up to 256 chars)

The last name of the person

nickName: string (up to 128 chars)

The nickname of the person

useNickname: boolean

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!

localityId: integer (int64)

Id of the country,virtual place, etc. of the person!

dateOfBirth: string (date-time)

The date of birth of the person

genderType: PersonGenderType

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

id: integer (int64)

The ID of the person.

isActive: boolean

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

sports: integer[]

Array of sport Ids to be added to the person.

integer

Sports to which the person belongs to.

Example
{
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "useNickname": "boolean",
  "localityId": "integer (int64)",
  "dateOfBirth": "string (date-time)",
  "genderType": "integer (int32)",
  "id": "integer (int64)",
  "isActive": "boolean",
  "sports": [
    "integer"
  ]
}

PersonGenderType: integer

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;

integer (int32) 0, 1, 2
Example
"integer (int32)"

PersonsListResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: PersonResponseModel
PersonResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "genderType": "string",
      "dateOfBirth": "string (date-time)",
      "isActive": "boolean",
      "nickName": "string",
      "useNickname": "boolean",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "sports": [
        {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        }
      ],
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

BadRequestModel: object

messages: string[]
string
Example
{
  "messages": [
    "string"
  ]
}

RoundResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/round/metadata

JsonbModel
name: string
startDate: string (date-time)
endDate: string (date-time)
type: string

Phase, Round, AggregateEvent

season: HALEmbededResponse
sport: HALEmbededResponse
competition: HALEmbededResponse
parentRound: HALEmbededResponse
timezone: HALEmbededResponse
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "type": "string",
  "season": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "parentRound": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}

fixtureIngestion: object

competition: competitionMatchModel
sport: baseMatchModel
fixture: fixtureMatchModel
venue: venueMatchModel
competitors: competitorMatchModel

Client might send competitors separately to try to improve matching capabilities.

competitorMatchModel
competitionPhase: baseMatchModel
Example
{
  "competition": {
    "gender": "string",
    "startDate": "string (date-time)",
    "endDate": "string (date-time)",
    "locality": "string",
    "competitionType": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "sport": {
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "fixture": {
    "startDate": "string (date-time)",
    "locality": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "venue": {
    "locality": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "competitors": [
    {
      "competitorType": "string",
      "locality": "string",
      "gender": "string",
      "name": "string",
      "id": "string",
      "sourceEntityId": "string"
    }
  ],
  "competitionPhase": {
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  }
}

locality: string

If sent а FUZZY match is made on the value and the similarity score is contributing to the end match score.

CreateFixtureOfficial: object

personId: integer (int64) x ≥ 1

Id of the person which will be added as fixture official

personRole: FixturePersonRoleType
metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/fixtureperson/metadata

JsonbModelViewModel
Example
{
  "personId": "integer (int64)",
  "personRole": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

CreateContract: object

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/contract/metadata

JsonbModelViewModel
personId: integer (int64) x ≥ 1
isActive: boolean

Whether the contract is active or not. When lineups are added this will define whether the person can be part of the lineup.

competitorId: integer (int64) x ≥ 1
personRole: CompetitorPersonRoleType
startDate: string (date-time)

When the contract was activated.

endDate: string (date-time)

When the contract was deactivated.

Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "personId": "integer (int64)",
  "isActive": "boolean",
  "competitorId": "integer (int64)",
  "personRole": "integer (int32)",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)"
}

CreateRoundCompetitor: object

competitorId: integer (int64)

The id of the competitor which will be added in the round

Example
{
  "competitorId": "integer (int64)"
}

FixtureOfficialResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
person: PersonHALEmbededResponse
personRole: string
sport: HALEmbededResponse
metadataProperties: JsonbModel
JsonbModel
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "person": {
    "id": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "nickName": "string",
    "genderType": "string",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "ref": "string"
  },
  "personRole": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ]
}

SeasonCompetitorsResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: SeasonCompetitorsResponseModel
SeasonCompetitorsResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "ref": "string",
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

teamMatchModel:

gender: gender
locality: locality
Example
{
  "gender": "string",
  "locality": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

HALEmbededResponse: object

id: integer (int64)
name: string
ref: string
Example
{
  "id": "integer (int64)",
  "name": "string",
  "ref": "string"
}

UpdateContract: object

id: integer (int64)

The id of the contract which will be updated.

isActive: boolean

Whether the contract is active or not. When lineups are added this will define whether the person can be part of the lineup.

startDate: string (date-time)

When the contract was activated.

endDate: string (date-time)

When the contract was deactivated.

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/contract/metadata

JsonbModelViewModel
Example
{
  "id": "integer (int64)",
  "isActive": "boolean",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

gender: string

If sent an EXACT match is made on the enum, excluding all non-matching entities.

ContractResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: ContractResponseModel
ContractResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "person": {
        "id": "integer (int64)",
        "dateOfBirth": "string (date-time)",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "nickName": "string",
        "genderType": "string",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "player": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitor": {
        "id": "integer (int64)",
        "name": "string",
        "competitorType": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

PersonHALEmbededResponse: object

id: integer (int64)
dateOfBirth: string (date-time)
firstName: string
lastName: string
fullName: string
nickName: string
genderType: string
locality: HALEmbededResponse
ref: string
Example
{
  "id": "integer (int64)",
  "dateOfBirth": "string (date-time)",
  "firstName": "string",
  "lastName": "string",
  "fullName": "string",
  "nickName": "string",
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "ref": "string"
}

PersonOfficialResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: PersonOfficialResponseModel
PersonOfficialResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "fixture": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "personRole": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

CreatePersonViewModel: object

firstName: string (up to 256 chars)

The first name of the person

lastName: string (up to 256 chars)

The last name of the person

nickName: string (up to 128 chars)

The nickname of the person

useNickname: boolean

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!

localityId: integer (int64)

Id of the country,virtual place, etc. of the person!

dateOfBirth: string (date-time)

The date of birth of the person

genderType: PersonGenderType
sports: integer[]

Array of sport Ids to be added to the person.

integer

Sports to which the person belongs to.

Example
{
  "firstName": "string",
  "lastName": "string",
  "nickName": "string",
  "useNickname": "boolean",
  "localityId": "integer (int64)",
  "dateOfBirth": "string (date-time)",
  "genderType": "integer (int32)",
  "sports": [
    "integer"
  ]
}

OrganizationResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
name: string

Unique name of the organization

code: string

Unique code of the organization

Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "name": "string",
  "code": "string"
}

SourceRequestStatusInfoModel: object

status: string

Status of the source request. All statuses: Pending, Accepted, Rejected, Approved, Outdated.

entityName: string

Name of the entity

gssId: string

Id of the response data

gssName: string

Name of the response data

Example
{
  "status": "string",
  "entityName": "string",
  "gssId": "string",
  "gssName": "string"
}

CreatePlayerCompetitor: object

metadataProperties: JsonbModelViewModel
JsonbModelViewModel
personId: integer (int64) x ≥ 1

If the person is already existing set its Id, otherwise leave it empty and populate the person object

sportId: integer (int64) x ≥ 1

Id of the sport in which the competitor can be used

person: CreatePersonViewModel

Person information if not been created early, if the person already exists - leave empty.

Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "personId": "integer (int64)",
  "sportId": "integer (int64)",
  "person": {
    "firstName": "string",
    "lastName": "string",
    "nickName": "string",
    "useNickname": "boolean",
    "localityId": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "genderType": "integer (int32)",
    "sports": [
      "integer"
    ]
  }
}

VenueResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/venue/metadata

JsonbModel
name: string
latitude: number (double)
longitude: number (double)
locality: HALEmbededResponse
capacity: integer (int32)
cityName: string
sports: HALEmbededResponse
HALEmbededResponse
parentVenue: HALEmbededResponse
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "latitude": "number (double)",
  "longitude": "number (double)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "capacity": "integer (int32)",
  "cityName": "string",
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "parentVenue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}

CreateTBDCompetitor: object

metadataProperties: JsonbModelViewModel
JsonbModelViewModel
name: string (up to 50 chars)

The name of the competitor. It must be unique for the provided sport!

sportId: integer (int64) x ≥ 1

Id of the sport in which the competitor can be used

Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "name": "string",
  "sportId": "integer (int64)"
}

fixtureMatchModel:

startDate: string (date-time)

The start date of the fixture in UTC ISO-8601 format. (yyyy-MM-ddTHH:mmZ)

locality: locality
Example
{
  "startDate": "string (date-time)",
  "locality": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

GeneralCompetitorResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: GeneralCompetitorResponseModel
GeneralCompetitorResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string",
      "venue": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorType": "string",
      "ref": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

playerMatchModel:

birthDate: string (date-time)

Player birthdate in format - full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

position: string

The playing position, depending on the sport.

shirtNumber: number

The number of the Shirt for the player

Example
{
  "birthDate": "string (date-time)",
  "position": "string",
  "shirtNumber": "number",
  "competitorType": "string",
  "locality": "string",
  "gender": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

CreateSeason: object

startDate: string (date-time)

The start date of the season in UTC ISO-8601 format

endDate: string (date-time)

The end date of the season in UTC ISO-8601 format

localityId: integer (int64)

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!

competitionId: integer (int64)

Id of the competition to which the season will be associated!

competitors: integer[]

Array of competitors to be added to the season.

integer

Competitors which are associated with the season.

timezone: string

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

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/season/metadata

JsonbModelViewModel
Example
{
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "localityId": "integer (int64)",
  "competitionId": "integer (int64)",
  "competitors": [
    "integer"
  ],
  "timezone": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

ErrorDuplicateModel: object

messages: string[]
string
geniusSportsConflictId: string

This is the official genius sports ID, which you have conflict with.

Example
{
  "messages": [
    "string"
  ],
  "geniusSportsConflictId": "string"
}

CompetitorRoundsResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: CompetitorRoundsResponseModel
CompetitorRoundsResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string",
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

venueMatchModel:

Example
{
  "locality": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

HorseCompetitorResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: HorseCompetitorResponseModel
HorseCompetitorResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

GenderType: integer

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.

integer (int32) 0, 1, 2, 3
Example
"integer (int32)"

LocalityResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: LocalityResponseModel
LocalityResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "localityType": "string",
      "code": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

competitorType: string

Defines the type of the competitor to increase chances of correct matching

DoublesPartnershipCompetitorResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: DoublesPartnershipCompetitorResponseModel
DoublesPartnershipCompetitorResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

CompetitorPersonRoleType: integer

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))

integer (int32) 0, 1, 3, 5, 6
Example
"integer (int32)"

VenueResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: VenueResponseModel
VenueResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "latitude": "number (double)",
      "longitude": "number (double)",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "capacity": "integer (int32)",
      "cityName": "string",
      "sports": [
        {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        }
      ],
      "parentVenue": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

ErrorModel: object

code: integer (int32)
message: string
error: Error
Example
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

CompetitorContractResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: CompetitorContractResponseModel
CompetitorContractResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "person": {
        "id": "integer (int64)",
        "dateOfBirth": "string (date-time)",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "nickName": "string",
        "genderType": "string",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "player": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

CompetitionResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competition/metadata

JsonbModel
sport: HALEmbededResponse
organization: HALEmbededResponse
name: string
locality: HALEmbededResponse
timezone: HALEmbededResponse
genderType: string

Undefined, Male, Female, Mixed.

shortName: string
longName: string
sponsorName: string
youth: boolean
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "organization": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "name": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "shortName": "string",
  "longName": "string",
  "sponsorName": "string",
  "youth": "boolean"
}

HorseCompetitorResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competitor/metadata

JsonbModel
name: string
sport: HALEmbededResponse
genderType: string

Undefined, Male, Female, Mixed.

locality: HALEmbededResponse
competitorStatusType: string

Active, Retired, Unattached

Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}

squadResponseMatchModel: object

team: baseResponseMatchModel
sport: baseResponseMatchModel
players: baseResponseMatchModel

The result of the squad ingestion.

baseResponseMatchModel
Example
{
  "team": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "sport": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "players": [
    {
      "status": "string",
      "message": "string",
      "name": "string",
      "id": "string",
      "sourceEntityId": "string"
    }
  ]
}

baseMatchModel: object

name: string

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: string

Genius Sport Id

sourceEntityId: string

Source entity unique Id

Example
{
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

RoundCompetitorsResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: RoundCompetitorsResponseModel
RoundCompetitorsResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "name": "string",
      "competitorType": "string",
      "ref": "string",
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

trackingRequestModel: object

Tracking Id of the progress of the asynchronous execution.

trackingRequestId: string

Tracking Id of the progress of the asynchronous execution.

Example
{
  "trackingRequestId": "string"
}

InternalServerErrorModel: object

code: integer (int32)
message: string
error: Error
Example
{
  "code": "integer (int32)",
  "message": "string",
  "error": {
    "reason": "string",
    "domain": "string",
    "locationType": "string",
    "location": "string",
    "message": "string"
  }
}

SeasonResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/season/metadata

JsonbModel
name: string
startDate: string (date-time)
endDate: string (date-time)
locality: HALEmbededResponse
timezone: HALEmbededResponse
genderType: string

Undefined, Male, Female, Mixed.

sport: HALEmbededResponse
competition: HALEmbededResponse
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "timezone": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competition": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}

CreateRound: object

This model should be used to create a round object.

name: string

Name of the round.

competitors: integer[]

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

integer

Competitors which are associated with the round.

startdate: string (date-time)

The start date of the round in UTC ISO-8601 format

enddate: string (date-time)

The end date of the fixture in UTC ISO-8601 format

type: string

The type of round. 0 = Phase 1 = Round 2 = AggregateEvent

seasonId: integer (int64)

The ID of the season the round belongs to.

parentRoundId: integer (int64)

The ID of the parent round to which posted round belongs.

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/round/metadata

JsonbModelViewModel
timezone: string

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

Example
{
  "name": "string",
  "competitors": [
    "integer"
  ],
  "startdate": "string (date-time)",
  "enddate": "string (date-time)",
  "type": "string",
  "seasonId": "integer (int64)",
  "parentRoundId": "integer (int64)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "timezone": "string"
}

PatchFixture: object

This model should be used to propose a partial update/patch to a fixture.

id: integer (int64)

The ID of the fixture.

startDate: string (date-time)

The start date of the fixture in UTC ISO-8601 format

venueId: integer (int64)

The ID of the venue the fixture is played at.

roundId: integer (int64)

The ID of the round the fixture is for.

Example
{
  "id": "integer (int64)",
  "startDate": "string (date-time)",
  "venueId": "integer (int64)",
  "roundId": "integer (int64)"
}

PlayerCompetitorResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: PlayerCompetitorResponseModel
PlayerCompetitorResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string",
      "person": {
        "id": "integer (int64)",
        "createdOn": "string (date-time)",
        "modifiedOn": "string (date-time)",
        "updatesCount": "integer (int32)",
        "fullName": "string",
        "nickName": "string",
        "useNickname": "boolean",
        "firstName": "string",
        "lastName": "string",
        "genderType": "string",
        "dateOfBirth": "string (date-time)",
        "isActive": "boolean",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "sports": [
          {
            "id": "integer (int64)",
            "name": "string",
            "ref": "string"
          }
        ],
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

TeamCompetitorResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: TeamCompetitorResponseModel
TeamCompetitorResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "abbreviation": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competitorStatusType": "string",
      "venue": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

PersonContractResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
competitor: CompetitorHALEmbededResponse
sport: HALEmbededResponse
personRole: string
isActive: boolean

Whether the relation between the person and the competitor is active

startDate: string (date-time)
endDate: string (date-time)
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "competitor": {
    "id": "integer (int64)",
    "name": "string",
    "competitorType": "string",
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "personRole": "string",
  "isActive": "boolean",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)"
}

CreateCompetition: object

sportId: integer (int64)

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!

organizationId: integer (int64)

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!

localityId: integer (int64)

Id of the country,virtual place, etc. where the competition will be held!

genderType: GenderType
name: string (up to 250 chars)

The name of the competition. It must be unique! It must contain gender info postfix! Possible postfixes are: When gender is Male - Do not place postfix; When gender is Female - Women; When gender is Undefined or Mixed - Mixed

timezone: string

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

shortName: string (up to 250 chars)

A short name for the competition

longName: string (up to 500 chars)

A long name for the competition

sponsorName: string (up to 250 chars)

The sponsor name of the competition

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competition/metadata

JsonbModelViewModel
youth: boolean
Example
{
  "sportId": "integer (int64)",
  "organizationId": "integer (int64)",
  "localityId": "integer (int64)",
  "genderType": "integer (int32)",
  "name": "string",
  "timezone": "string",
  "shortName": "string",
  "longName": "string",
  "sponsorName": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "youth": "boolean"
}

UpdateOrganization: object

id: integer (int64)
name: string

Unique name of the organization

Example
{
  "id": "integer (int64)",
  "name": "string"
}

UpdateCompetition: object

id: integer (int64)
name: string (up to 250 chars)

The name of the competition. It must be unique! It must contain gender info postfix! Possible postfixes are: When gender is Male - Do not place postfix; When gender is Female - Women; When gender is Undefined or Mixed - Mixed

organizationId: integer (int64)

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!

localityId: integer (int64)

Id of the country,virtual place, etc. where the competition will be held!

timezone: string

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

shortName: string (up to 250 chars)

A short name for the competition

longName: string (up to 500 chars)

A long name for the competition

sponsorName: string (up to 250 chars)

The sponsor name of the competition

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competition/metadata

JsonbModelViewModel
youth: boolean
Example
{
  "id": "integer (int64)",
  "name": "string",
  "organizationId": "integer (int64)",
  "localityId": "integer (int64)",
  "timezone": "string",
  "shortName": "string",
  "longName": "string",
  "sponsorName": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "youth": "boolean"
}

CompetitorHALEmbededResponse: object

id: integer (int64)
name: string
competitorType: string

Team, Player, Horse, Jockey, HorseOwner, Dog, Breeder, DoublesPartnership, Other, TBD

ref: string
Example
{
  "id": "integer (int64)",
  "name": "string",
  "competitorType": "string",
  "ref": "string"
}

CreateTeamCompetitor: object

name: string (up to 50 chars)

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!

abbreviation: string (up to 125 chars)

An abbreviation for the competitor

localityId: integer (int64)

Id of the country,virtual place, etc. of the competitor!

venueId: integer (int64)

Id of the home venue of the competitor. The venue must be associated with the same sport as the competitor!

sportId: integer (int64)

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!

genderType: GenderType
metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competitor/metadata

JsonbModelViewModel
Example
{
  "name": "string",
  "abbreviation": "string",
  "localityId": "integer (int64)",
  "venueId": "integer (int64)",
  "sportId": "integer (int64)",
  "genderType": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

UpdatePlayerCompetitor: object

metadataProperties: JsonbModelViewModel
JsonbModelViewModel
id: integer (int64) x ≥ 1
competitorStatusType: CompetitorStatusType
Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "id": "integer (int64)",
  "competitorStatusType": "integer (int32)"
}

TBDCompetitorResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competitor/metadata

JsonbModel
name: string
sport: HALEmbededResponse
genderType: string

Undefined, Male, Female, Mixed.

locality: HALEmbededResponse
competitorStatusType: string

Active, Retired, Unattached

Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}

UpdateRound: object

This model should be used to update a round object.

id: integer (int64)

The ID of the round.

name: string

Name of the round.

competitors: integer[]

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

integer

Competitors which are associated with the round.

startdate: string (date-time)

The start date of the round in UTC ISO-8601 format

enddate: string (date-time)

The end date of the fixture in UTC ISO-8601 format

type: string

The type of round. 0 = Phase 1 = Round 2 = AggregateEvent

seasonId: integer (int64)

The ID of the season the round belongs to.

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/round/metadata

JsonbModelViewModel
timezone: string

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

Example
{
  "id": "integer (int64)",
  "name": "string",
  "competitors": [
    "integer"
  ],
  "startdate": "string (date-time)",
  "enddate": "string (date-time)",
  "type": "string",
  "seasonId": "integer (int64)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "timezone": "string"
}

CompetitorStatusType: integer

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.

integer (int32) 0, 1, 2
Example
"integer (int32)"

competitionType: string

Defines the type of the competition to increase chances of correct matching

CreateOrganization: object

name: string

Unique name of the organization

code: string

Unique code of the organization

Example
{
  "name": "string",
  "code": "string"
}

LocalityResponseModel: object

id: integer (int64)
name: string
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
localityType: string

ConstituentCountry, Continent, Country, FirstOrderAdministrativeRegion, NonGeographic, World, Game.

code: string
Example
{
  "id": "integer (int64)",
  "name": "string",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "localityType": "string",
  "code": "string"
}

FixtureCompetitorHALEmbededResponse: object

id: integer (int64)
name: string
competitorType: string

Team, Player, Horse, Jockey, HorseOwner, Dog, Breeder, DoublesPartnership, Other, TBD

metadataProperties: JsonbModelViewModel
JsonbModelViewModel
ref: string
Example
{
  "id": "integer (int64)",
  "name": "string",
  "competitorType": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "ref": "string"
}

UpdateVenue: object

id: integer (int64)
name: string (up to 250 chars)

The name of the venue

localityId: integer (int64)

Id of the country,virtual place, etc. where the venue is located.

sports: integer[]

Array of sport Ids which can be played on this venue

integer

Sports ids which can be played on the venue.

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/venue/metadata

JsonbModelViewModel
Example
{
  "id": "integer (int64)",
  "name": "string",
  "localityId": "integer (int64)",
  "sports": [
    "integer"
  ],
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

CompetitionResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: CompetitionResponseModel
CompetitionResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "organization": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "name": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "timezone": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "shortName": "string",
      "longName": "string",
      "sponsorName": "string",
      "youth": "boolean"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

JsonbModelViewModel: object

This model should be used to create or update single property value for specific property name for specific model.

name: string

Name of the property.

value: string

Value of the property.

Example
{
  "name": "string",
  "value": "string"
}

PersonOfficialResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
fixture: HALEmbededResponse
personRole: string
sport: HALEmbededResponse
metadataProperties: JsonbModel
JsonbModel
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "fixture": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "personRole": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ]
}

RoundCompetitorsResponseModel: object

id: integer (int64)

Id of the competitor

name: string

Name of the competitor

competitorType: string

Type of the competitor

ref: string

Endpoint to competitor

genderType: string

Gender of the competitor

locality: HALEmbededResponse
Example
{
  "id": "integer (int64)",
  "name": "string",
  "competitorType": "string",
  "ref": "string",
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}

competitorMatchModel:

competitorType: competitorType
locality: locality
gender: gender
Example
{
  "competitorType": "string",
  "locality": "string",
  "gender": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

fixtureResponseMatchModel: object

competition: baseResponseMatchModel
season: baseResponseMatchModel
sport: baseResponseMatchModel
fixture: baseResponseMatchModel
competitors: baseResponseMatchModel

Client might send competitors separately to try to improve matching capabilities.

baseResponseMatchModel
Example
{
  "competition": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "season": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "sport": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "fixture": {
    "status": "string",
    "message": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "competitors": [
    {
      "status": "string",
      "message": "string",
      "name": "string",
      "id": "string",
      "sourceEntityId": "string"
    }
  ]
}

squadIngestion: object

team: teamMatchModel
sport: baseMatchModel
players: playerMatchModel

Client might send competitors separately to try to improve matching capabilities.

playerMatchModel
Example
{
  "team": {
    "gender": "string",
    "locality": "string",
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "sport": {
    "name": "string",
    "id": "string",
    "sourceEntityId": "string"
  },
  "players": [
    {
      "birthDate": "string (date-time)",
      "position": "string",
      "shirtNumber": "number",
      "competitorType": "string",
      "locality": "string",
      "gender": "string",
      "name": "string",
      "id": "string",
      "sourceEntityId": "string"
    }
  ]
}

UpdateDoublePartnership: object

metadataProperties: JsonbModelViewModel
JsonbModelViewModel
id: integer (int64) x ≥ 1

The id of the double partnership which will be updated

competitorStatusType: CompetitorStatusType
Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "id": "integer (int64)",
  "competitorStatusType": "integer (int32)"
}

CompetitorSeasonsResponseModel: object

id: integer (int64)

Id of the season

name: string

Name of the season

ref: string

Endpoint to season

Example
{
  "id": "integer (int64)",
  "name": "string",
  "ref": "string"
}

CreateDoublePartnership: object

metadataProperties: JsonbModelViewModel
JsonbModelViewModel
firstPersonId: integer (int64) x ≥ 1

Id of one of the persons which will take part in the double partnership

secondPersonId: integer (int64) x ≥ 1

Id of the other person which will take part in the double partnership

sportId: integer (int64) x ≥ 1

Id of the sport in which the doubles partnership can be used as competitor

Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "firstPersonId": "integer (int64)",
  "secondPersonId": "integer (int64)",
  "sportId": "integer (int64)"
}

SeasonCompetitorsResponseModel: object

id: integer (int64)

Id of the competitor

name: string

Name of the competitor

competitorType: string

Type of the competitor

ref: string

Endpoint to competitor

genderType: string

Gender of the competitor

locality: HALEmbededResponse
Example
{
  "id": "integer (int64)",
  "name": "string",
  "competitorType": "string",
  "ref": "string",
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}

CompetitorContractResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
person: PersonHALEmbededResponse
sport: HALEmbededResponse
player: HALEmbededResponse
personRole: string
isActive: boolean

Whether the relation between the person and the competitor is active

startDate: string (date-time)
endDate: string (date-time)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/contract/metadata

JsonbModel
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "person": {
    "id": "integer (int64)",
    "dateOfBirth": "string (date-time)",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "nickName": "string",
    "genderType": "string",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "ref": "string"
  },
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "player": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "personRole": "string",
  "isActive": "boolean",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ]
}

UpdateSeason: object

startDate: string (date-time)

The start date of the season in UTC ISO-8601 format

endDate: string (date-time)

The end date of the season in UTC ISO-8601 format

localityId: integer (int64)

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!

id: integer (int64)

Id of the season which will be updated!

competitors: integer[]

Array of competitors to be added to the season.

integer

Competitors which are associated with the season.

timezone: string

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

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/season/metadata

JsonbModelViewModel
Example
{
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "localityId": "integer (int64)",
  "id": "integer (int64)",
  "competitors": [
    "integer"
  ],
  "timezone": "string",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

CreateVenue: object

name: string (up to 250 chars)

The name of the venue

localityId: integer (int64)

Id of the country,virtual place, etc. where the venue is located.

parentVenueId: integer (int64)

The id of the parent venue

sports: integer[]

Array of sport Ids which can be played on this venue

integer

Sports ids which can be played on the venue.

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/venue/metadata

JsonbModelViewModel
Example
{
  "name": "string",
  "localityId": "integer (int64)",
  "parentVenueId": "integer (int64)",
  "sports": [
    "integer"
  ],
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

OrganizationResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: OrganizationResponseModel
OrganizationResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "name": "string",
      "code": "string"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

FixtureOfficialResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: FixtureOfficialResponseModel
FixtureOfficialResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "person": {
        "id": "integer (int64)",
        "dateOfBirth": "string (date-time)",
        "firstName": "string",
        "lastName": "string",
        "fullName": "string",
        "nickName": "string",
        "genderType": "string",
        "locality": {
          "id": "integer (int64)",
          "name": "string",
          "ref": "string"
        },
        "ref": "string"
      },
      "personRole": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ]
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

UpdateFixture: object

This model should be used to propose an update to a fixture.

id: integer (int64)

The ID of the fixture.

competitors: integer[]

Array of competitors to be added to the fixture.

integer

Competitors which belong to the fixture.

homeCompetitorId: integer (int64)

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

startDate: string (date-time)

The start date of the fixture in UTC ISO-8601 format

roundId: integer (int64)

The ID of the round the fixture belongs to.

venueId: integer (int64)

The ID of the venue the fixture is played at.

localityId: integer (int64)

The ID of the country/region/administrative zone the fixture is played at.

EventStatusType: integer (int32) 0, 1, 2, 3, 4

0 - Notstarted; 1 - Inprogress; 2 - Finished; 3 - Cancelled; 4 - Postponed

metadataProperties: JsonbModelViewModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/fixture/metadata

JsonbModelViewModel
matchDay: integer (int32)
attendance: integer (int32)
Example
{
  "id": "integer (int64)",
  "competitors": [
    "integer"
  ],
  "homeCompetitorId": "integer (int64)",
  "startDate": "string (date-time)",
  "roundId": "integer (int64)",
  "venueId": "integer (int64)",
  "localityId": "integer (int64)",
  "EventStatusType": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "matchDay": "integer (int32)",
  "attendance": "integer (int32)"
}

DoublesPartnershipCompetitorResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competitor/metadata

JsonbModel
name: string
sport: HALEmbededResponse
genderType: string

Undefined, Male, Female, Mixed.

locality: HALEmbededResponse
competitorStatusType: string

Active, Retired, Unattached

Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string"
}

UpdateTBDCompetitor: object

metadataProperties: JsonbModelViewModel
JsonbModelViewModel
id: integer (int64) x ≥ 1
name: string (up to 50 chars)

The name of the competitor. It must be unique for the provided sport!

competitorStatusType: CompetitorStatusType
Example
{
  "metadataProperties": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "id": "integer (int64)",
  "name": "string",
  "competitorStatusType": "integer (int32)"
}

Empty: object

Example
"object"

FixtureResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: FixtureResponseModel
FixtureResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "startDate": "string (date-time)",
      "name": "string",
      "season": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "eventStatusType": "string",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "timezone": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "venue": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competition": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "round": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "homeCompetitor": {
        "id": "integer (int64)",
        "name": "string",
        "competitorType": "string",
        "ref": "string"
      },
      "genderType": "string",
      "competitors": [
        {
          "id": "integer (int64)",
          "name": "string",
          "competitorType": "string",
          "metadataProperties": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "ref": "string"
        }
      ],
      "fixtureLink": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "eventType": "string",
      "matchDay": "integer (int32)",
      "attendance": "integer (int32)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

ArrayOfMetadataPropertyTypesResponseModel: array

Example
[
  {
    "id": "integer (int64)",
    "name": "string",
    "allowNonPredefinedValues": "boolean",
    "isRequired": "boolean",
    "values": [
      "string"
    ]
  }
]

SportResponseModel: object

id: integer (int64)
name: string
allowsPlayers: boolean

Whether players can be proposed for the specific sport. True when Players can be proposed

allowsDoubles: boolean

Whether players can be proposed for the specific sport. True when Doubles can be proposed

maxNumberOfCompetitorsInFixture: integer (int32)

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.

createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
Example
{
  "id": "integer (int64)",
  "name": "string",
  "allowsPlayers": "boolean",
  "allowsDoubles": "boolean",
  "maxNumberOfCompetitorsInFixture": "integer (int32)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)"
}

CreateSeasonCompetitor: object

competitorId: integer (int64)

The id of the competitor which will be added in the season

Example
{
  "competitorId": "integer (int64)"
}

competitionMatchModel:

gender: gender
startDate: string (date-time)

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

endDate: string (date-time)

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

locality: locality
competitionType: competitionType
Example
{
  "gender": "string",
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "locality": "string",
  "competitionType": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

JsonbModel: object

name: string
value: string
isDeleted: boolean
Example
{
  "name": "string",
  "value": "string",
  "isDeleted": "boolean"
}

baseResponseMatchModel:

status: string

The status of the proposal request

message: string

Addional message regarding the status of the proposal

Example
{
  "status": "string",
  "message": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

AcceptedModel: object

messages: string[]
string
Example
{
  "messages": [
    "string"
  ]
}

PersonForPlayerResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
fullName: string
nickName: string
useNickname: boolean
firstName: string
lastName: string
genderType: string
dateOfBirth: string (date-time)
isActive: boolean
locality: HALEmbededResponse
sports: HALEmbededResponse
HALEmbededResponse
ref: string
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "fullName": "string",
  "nickName": "string",
  "useNickname": "boolean",
  "firstName": "string",
  "lastName": "string",
  "genderType": "string",
  "dateOfBirth": "string (date-time)",
  "isActive": "boolean",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "sports": [
    {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    }
  ],
  "ref": "string"
}

Error: object

reason: string
domain: string
locationType: string
location: string
message: string
Example
{
  "reason": "string",
  "domain": "string",
  "locationType": "string",
  "location": "string",
  "message": "string"
}

FixturePersonRoleType: integer

0 - Referee, 1 - Official

integer (int32) 0, 1
Example
"integer (int32)"

PersonContractResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: PersonContractResponseModel
PersonContractResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "competitor": {
        "id": "integer (int64)",
        "name": "string",
        "competitorType": "string",
        "ref": "string"
      },
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "personRole": "string",
      "isActive": "boolean",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)"
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

SeasonResponseModelHATEOASReponseModel: object

page: integer (int32)
pageSize: integer (int32)
totalItems: integer (int64)
items: SeasonResponseModel
SeasonResponseModel
self: string
previous: string
next: string
first: string
last: string
Example
{
  "page": "integer (int32)",
  "pageSize": "integer (int32)",
  "totalItems": "integer (int64)",
  "items": [
    {
      "id": "integer (int64)",
      "createdOn": "string (date-time)",
      "modifiedOn": "string (date-time)",
      "updatesCount": "integer (int32)",
      "metadataProperties": [
        {
          "name": "string",
          "value": "string",
          "isDeleted": "boolean"
        }
      ],
      "name": "string",
      "startDate": "string (date-time)",
      "endDate": "string (date-time)",
      "locality": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "timezone": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "genderType": "string",
      "sport": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      },
      "competition": {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    }
  ],
  "self": "string",
  "previous": "string",
  "next": "string",
  "first": "string",
  "last": "string"
}

CompetitorRoundsResponseModel: object

id: integer (int64)

Id of the round

name: string

Name of the round

ref: string

Endpoint to round

genderType: string

Gender of the competitor

locality: HALEmbededResponse
Example
{
  "id": "integer (int64)",
  "name": "string",
  "ref": "string",
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}

PlayerCompetitorResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel
JsonbModel
name: string
sport: HALEmbededResponse
genderType: string
locality: HALEmbededResponse
competitorStatusType: string
person: PersonForPlayerResponseModel
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "person": {
    "id": "integer (int64)",
    "createdOn": "string (date-time)",
    "modifiedOn": "string (date-time)",
    "updatesCount": "integer (int32)",
    "fullName": "string",
    "nickName": "string",
    "useNickname": "boolean",
    "firstName": "string",
    "lastName": "string",
    "genderType": "string",
    "dateOfBirth": "string (date-time)",
    "isActive": "boolean",
    "locality": {
      "id": "integer (int64)",
      "name": "string",
      "ref": "string"
    },
    "sports": [
      {
        "id": "integer (int64)",
        "name": "string",
        "ref": "string"
      }
    ],
    "ref": "string"
  }
}

GeneralCompetitorResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competitor/metadata

JsonbModel
name: string
sport: HALEmbededResponse
genderType: string

Undefined, Male, Female, Mixed.

locality: HALEmbededResponse
competitorStatusType: string

Active, Retired, Unattached

venue: HALEmbededResponse
competitorType: string

Team, Player, Horse, Jockey, HorseOwner, Dog, Breeder, DoublesPartnership, Other, TBD

ref: string

Reference to the detailed response for the competitor

Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorType": "string",
  "ref": "string"
}

baseMappingResponseMatchModel:

entity: string

The status of the proposal request

Example
{
  "entity": "string",
  "status": "string",
  "message": "string",
  "name": "string",
  "id": "string",
  "sourceEntityId": "string"
}

MetadataPropertyTypesResponseModel: object

id: integer (int64)
name: string
allowNonPredefinedValues: boolean
isRequired: boolean

Is property required for the specific entity for the specific sport

values: string[]
string
Example
{
  "id": "integer (int64)",
  "name": "string",
  "allowNonPredefinedValues": "boolean",
  "isRequired": "boolean",
  "values": [
    "string"
  ]
}

TeamCompetitorResponseModel: object

id: integer (int64)
createdOn: string (date-time)
modifiedOn: string (date-time)
updatesCount: integer (int32)
metadataProperties: JsonbModel

In order to retrieve allowed metadata properties with their values execute get request on this path - /sports/{id}/competitor/metadata

JsonbModel
name: string
abbreviation: string
sport: HALEmbededResponse
genderType: string

Undefined, Male, Female, Mixed.

locality: HALEmbededResponse
competitorStatusType: string

Active, Retired, Unattached

venue: HALEmbededResponse
Example
{
  "id": "integer (int64)",
  "createdOn": "string (date-time)",
  "modifiedOn": "string (date-time)",
  "updatesCount": "integer (int32)",
  "metadataProperties": [
    {
      "name": "string",
      "value": "string",
      "isDeleted": "boolean"
    }
  ],
  "name": "string",
  "abbreviation": "string",
  "sport": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "genderType": "string",
  "locality": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  },
  "competitorStatusType": "string",
  "venue": {
    "id": "integer (int64)",
    "name": "string",
    "ref": "string"
  }
}