### List Players Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example response for a collection of players. ```json [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ] ``` -------------------------------- ### Create Player Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example response after successfully creating a player resource. ```json { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ``` -------------------------------- ### Created Team Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example response after successfully creating a team resource. ```json { "id": 0, "name": "Команда Губанова", "town": { "id": 0, "name": "string", "region": { "id": 0, "name": "string", "country": { "id": 0, "name": "string" } }, "country": { "id": 0, "name": "string" } } } ``` -------------------------------- ### Team Collection Response Sample Source: https://api.rating.chgk.info/index.yamlopenapi Example response for a collection of teams. ```json [ { "id": 0, "name": "Команда Губанова", "town": { "id": 0, "name": "string", "region": { "id": 0, "name": "string", "country": { "id": 0, "name": "string" } }, "country": { "id": 0, "name": "string" } } ] ``` -------------------------------- ### Player Patch Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example JSON response for a successful player update (200 OK). ```json { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ``` -------------------------------- ### Updated Country Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example response after successfully updating a country resource. ```json { "id": 0, "name": "string" } ``` -------------------------------- ### Updated Season Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example of a successful response after updating a season resource. ```json { "id": 0, "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z" } ``` -------------------------------- ### Get Player Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific player resource by their ID. ```APIDOC ## Игрок ### Description Retrieves a specific player resource by their ID. ### Method GET ### Endpoint `get/players/{id}` ### Parameters #### Path Parameters - **id** (string) - Required - Player identifier ### Responses - **200** - Player resource - **404** - Not found ### Response Example ```json { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ``` ``` -------------------------------- ### Player Tournaments Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example JSON response for a player's tournaments resource. ```json { "idplayer": 0, "idteam": 0, "idtournament": 0 } ``` -------------------------------- ### Get Release by ID Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific release by its unique identifier. ```APIDOC ## Get Release by ID ### Description Retrieves a specific release by its unique identifier. ### Method GET ### Endpoint /releases/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Release identifier ### Responses #### Success Response (200) - **Release resource** #### Error Response (404) - **Not found** ### Response Example (200) ```json { "id": 0, "date": "2019-08-24T14:15:22Z", "realDate": "2019-08-24T14:15:22Z", "lastRunRefresh": "2019-08-24T14:15:22Z" } ``` ``` -------------------------------- ### Get Tournament Applications Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a list of applications for a synchronous or asynchronous tournament. ```APIDOC ## GET /tournaments/{id}/applications ### Description Lists applications for a specified tournament, which can be synchronous or asynchronous. ### Method GET ### Endpoint /tournaments/{id}/applications ### Parameters #### Path Parameters - **id** (string) - Required - SynchTournament identifier ``` -------------------------------- ### Problem JSON Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example of a problem response in JSON format, often used for errors. ```json { "@context": "string", "@id": "string", "@type": "string", "title": "string", "detail": "string", "status": 404, "instance": "string", "type": "string", "description": "string" } ``` -------------------------------- ### Get Player Tournaments Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a list of tournaments a player has participated in. ```APIDOC ## GET /players/{id}/tournaments ### Description Retrieves a list of tournaments a player has participated in. ### Method GET ### Endpoint /players/{id}/tournaments ### Parameters #### Path Parameters - **id** (string) - Required - player_tournaments identifier ### Responses #### Success Response (200) player_tournaments resource #### Error Response (404) Not found ### Response Example ```json { "idplayer": 0, "idteam": 0, "idtournament": 0 } ``` ``` -------------------------------- ### Player Seasons Collection Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example JSON response for a player's seasons collection. ```json [ { "idplayer": 0, "idseason": 0, "idteam": 0, "dateAdded": "2019-08-24T14:15:22Z", "dateRemoved": "2019-08-24T14:15:22Z", "playerNumber": 0 } ] ``` -------------------------------- ### Get Tournament Appeals Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a list of appeals for a specific tournament. ```APIDOC ## GET /tournaments/{id}/appeals ### Description Lists appeals for a given tournament. ### Method GET ### Endpoint https://api.rating.chgk.info/tournaments/{id}/appeals ### Parameters #### Path Parameters - **id** (string) - Required - Tournament appeals identifier ### Responses #### Success Response (200) Returns a tournament_appeals resource. #### Error Response (404) Returns Not found if the tournament ID is invalid. ### Response Example (200) ```json { "id": 0, "idtournament": 0, "type": "string", "issuedAt": "2019-08-24T14:15:22Z", "status": "string", "appeal": "string", "comment": "string", "answer": "", "questionNumber": 0, "overriddenById": 0 } ``` ``` -------------------------------- ### Get Tournament by ID Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific tournament resource by its unique identifier. ```APIDOC ## Get Tournament by ID ### Description Retrieves a specific tournament resource by its unique identifier. ### Method GET ### Endpoint /tournaments/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Tournament identifier. ### Responses #### Success Response (200) Tournament resource #### Error Response (404) Not found ``` -------------------------------- ### Get Tournaments Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a collection of tournaments with various filtering and sorting options. ```APIDOC ## Get Tournaments ### Description Retrieves a collection of tournaments. Supports filtering by name, language, town, dates, rating systems, and more. Allows sorting by tournament ID or last edit date. ### Method GET ### Endpoint /tournaments ### Parameters #### Query Parameters - **page** (integer) - Optional - The collection page number. Default: 1 - **itemsPerPage** (integer) - Optional - The number of items per page. Default: 30. Range: [0 .. 512] - **name** (string) - Optional - Search by tournament name. - **name[]** (Array of strings) - Optional - Search by tournament name. - **language** (string) - Optional - Tournament language. - **language[]** (Array of strings) - Optional - Tournament language. - **town** (string) - Optional - City where the in-person tournament was held. - **town[]** (Array of strings) - Optional - City where the in-person tournament was held. - **town.region** (string) - Optional - Region where the in-person tournament was held. - **town.region[]** (Array of strings) - Optional - Region where the in-person tournament was held. - **town.country** (string) - Optional - Country where the in-person tournament was held. - **town.country[]** (Array of strings) - Optional - Country where the in-person tournament was held. - **editor** (number) - Optional - Filter by editor ID. - **ggRating** (boolean) - Optional - Filter by rating from rating.chgk.gg. - **ratingSystems** (string) - Optional - Filter by rating system (mak or chgkgg). - **ratingSystems[]** (Array of strings) - Optional - Filter by rating system (mak or chgkgg). - **maiiRating** (boolean) - Optional - Filter by rating from rating.chgk.gg. Deprecated in favor of ggRating. - **type** (integer) - Optional - Tournament type: 2 - in-person, 3 - synchronous, 6 - strict synchronous, 8 - asynchronous. - **archive** (boolean) - Optional - Whether the tournament is in the archive. - **lastEditDate[after]** (string) - Optional - Filter by last rating edit date (after). - **lastEditDate[before]** (string) - Optional - Filter by last rating edit date (before). - **lastEditDate[strictly_after]** (string) - Optional - Filter by last rating edit date (strictly after). - **lastEditDate[strictly_before]** (string) - Optional - Filter by last rating edit date (strictly before). - **dateStart[after]** (string) - Optional - Filter by start date (after). - **dateStart[before]** (string) - Optional - Filter by start date (before). - **dateStart[strictly_after]** (string) - Optional - Filter by start date (strictly after). - **dateStart[strictly_before]** (string) - Optional - Filter by start date (strictly before). - **dateEnd[after]** (string) - Optional - Filter by end date (after). - **dateEnd[before]** (string) - Optional - Filter by end date (before). - **dateEnd[strictly_after]** (string) - Optional - Filter by end date (strictly after). - **dateEnd[strictly_before]** (string) - Optional - Filter by end date (strictly before). - **order[id]** (string) - Optional - Order by tournament ID. Enum: "asc", "desc", "ASC", "DESC". - **order[lastEditDate]** (string) - Optional - Order by last edit date. Enum: "asc", "desc", "ASC", "DESC". ### Response #### Success Response (200) Tournament collection #### Response Example ```json [ { "type": 2, "id": 0, "name": "", "longName": "string", "lastEditDate": "2019-08-24T14:15:22Z", "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z", "paymentCategories": [ { "amount": 0, "currency": "string", "reason": "string" } ], "idseason": 0, "orgcommittee": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "languages": [ "string" ], "editors": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "gameJury": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "appealJury": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "trueDL": 0, "difficultyForecast": 0, "ratingSystems": [ "string" ], "maiiRating": false, "regulationsUrl": "", "rating": true, "questionQty": [ "string" ] } ] ``` ``` -------------------------------- ### Get Player Seasons Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a list of seasons a player has participated in. ```APIDOC ## GET /players/{id}/seasons ### Description Retrieves a collection of seasons a player has participated in. ### Method GET ### Endpoint /players/{id}/seasons ### Parameters #### Path Parameters - **id** (string) - Required - Player identifier #### Query Parameters - **page** (integer) - Optional - The collection page number, Default: 1 - **itemsPerPage** (integer) - Optional - The number of items per page, between 0 and 30, Default: 30 - **pagination** (boolean) - Optional - Enable or disable pagination - **idseason** (integer) - Optional - **idseason[]** (Array of integers) - Optional - **idplayer** (integer) - Optional - **idplayer[]** (Array of integers) - Optional - **idteam** (integer) - Optional - **idteam[]** (Array of integers) - Optional ### Responses #### Success Response (200) player_seasons collection ### Response Example ```json [ { "idplayer": 0, "idseason": 0, "idteam": 0, "dateAdded": "2019-08-24T14:15:22Z", "dateRemoved": "2019-08-24T14:15:22Z", "playerNumber": 0 } ] ``` ``` -------------------------------- ### Get Team Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific team resource by its ID. Requires an API key for authorization. ```APIDOC ## Команда ##### Authorizations: _apiKey_ ##### path Parameters idrequired| string Team identifier ---|--- ### Responses **200** Team resource **404** Not found get/teams/{id} https://api.rating.chgk.info/teams/{id} ``` -------------------------------- ### Team Collection Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Example response for a collection of teams, including nested town and region data. ```json [ { "id": 0, "name": "Команда Губанова", "town": { "id": 0, "name": "string", "region": { "id": 0, "name": "string", "country": { "id": 0, "name": "string" } }, "country": { "id": 0, "name": "string" } } }] ``` -------------------------------- ### Get Tournament Synch Request by ID Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific tournament synch request by its unique identifier. ```APIDOC ## GET /tournament_synch_requests/{id} ### Description Retrieves a specific tournament synch request by its unique identifier. ### Method GET ### Endpoint https://api.rating.chgk.info/tournament_synch_requests/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier for the tournament synch request. ### Responses #### Success Response (200) - Returns the TournamentSynchRequest resource. #### Error Response (404) - Not found. ``` -------------------------------- ### Get Player by ID Source: https://api.rating.chgk.info/index.yamlopenapi Retrieves a specific player resource by their unique identifier. Requires an API key for authorization. ```APIDOC ## Игрок ### Description Retrieves a specific player resource by their unique identifier. ### Method GET ### Endpoint `/players/{id}` ### Parameters #### Path Parameters - **id** (string) - Required - Player identifier ### Responses #### Success Response (200) - **id** (integer) - Player's unique identifier. - **name** (string) - Player's first name. - **patronymic** (string) - Player's patronymic name. - **surname** (string) - Player's surname. - **gotQuestionsTag** (integer) - Tag indicating if the player has questions. - **dateDied** (string) - Date of death in ISO 8601 format. - **comment** (string) - Additional comments about the player. #### Response Example ```json { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ``` ``` -------------------------------- ### Get Tournament Synch Appeals by ID Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific tournament synch appeal by its unique identifier. ```APIDOC ## GET /tournament_synch_appeals/{id} ### Description Retrieves a specific tournament synch appeal by its unique identifier. ### Method GET ### Endpoint https://api.rating.chgk.info/tournament_synch_appeals/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier for the tournament synch appeal. ### Responses #### Success Response (200) - Returns the tournament_synch_appeals resource. #### Error Response (404) - Not found. ``` -------------------------------- ### Get Tournament Synch Appeals by ID Source: https://api.rating.chgk.info/index.yamlopenapi Retrieves a specific tournament synch appeals resource by its unique identifier. ```APIDOC ## GET /tournament_synch_appeals/{id} ### Description Retrieves a specific tournament synch appeals resource by its unique identifier. ### Method GET ### Endpoint /tournament_synch_appeals/{id} ### Parameters #### Path Parameters - **id** (string) - Required - tournament_synch_appeals identifier ### Responses #### Success Response (200) - **tournament_synch_appeals resource** (object) - Description of the tournament synch appeals resource #### Error Response (404) - **Not found** ### Request Example (No request body example provided) ### Response Example (200) ```json { "id": 0, "idtournament": 0, "type": "string", "issuedAt": "2019-08-24T14:15:22Z", "status": "string", "appeal": "string", "comment": "string", "answer": "", "questionNumber": 0, "overriddenById": 0 } ``` ``` -------------------------------- ### Get Tournaments with Intersecting Questions Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a list of tournaments that have questions intersecting with a given tournament. ```APIDOC ## GET /tournaments/{id}/intersections ### Description Lists tournaments that share questions with the specified tournament. ### Method GET ### Endpoint https://api.rating.chgk.info/tournaments/{id}/intersections ### Parameters #### Path Parameters - **id** (string) - Required - Tournament identifier ### Responses #### Success Response (200) Returns a collection of tournaments. ### Response Example (200) ```json [ { "type": 2, "id": 0, "name": "", "longName": "string", "lastEditDate": "2019-08-24T14:15:22Z", "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z", "paymentCategories": [ { "amount": 0, "currency": "string", "reason": "string" } ], "idseason": 0, "orgcommittee": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "languages": [ "string" ], "editors": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "gameJury": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "appealJury": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "trueDL": 0, "difficultyForecast": 0, "ratingSystems": [ "string" ], "maiiRating": false, "regulationsUrl": "", "rating": true, "questionQty": [ "string" ] } ] ``` -------------------------------- ### Get Team Tournaments Source: https://api.rating.chgk.info/index.yamlopenapi Retrieves a list of tournaments a team has participated in. Requires an API key for authorization. ```APIDOC ## GET /teams/{id}/tournaments ### Description Retrieves a list of tournaments a team has participated in. Requires an API key for authorization. ### Method GET ### Endpoint `https://api.rating.chgk.info/teams/{id}/tournaments` ### Parameters #### Path Parameters - **id** (string) - Required - Team identifier ### Responses #### Success Response (200) Returns the team_tournaments resource. Example Response Body: ```json { "idteam": 0, "idtournament": 0 } ``` #### Error Responses - **404** Not found ``` -------------------------------- ### Get Tournament Synch Controversial by ID Source: https://api.rating.chgk.info/index.yamlopenapi Retrieves a specific controversial tournament synch resource by its unique identifier. ```APIDOC ## GET /tournament_synch_controversials/{id} ### Description Retrieves a specific controversial tournament synch resource by its unique identifier. ### Method GET ### Endpoint /tournament_synch_controversials/{id} ### Parameters #### Path Parameters - **id** (string) - Required - TournamentSynchControversial identifier ### Responses #### Success Response (200) - **TournamentSynchControversial resource** (object) - Description of the controversial tournament synch resource #### Error Response (404) - **Not found** ### Request Example (No request body example provided) ### Response Example (200) ```json { "id": 0, "questionNumber": 0, "answer": "string", "issuedAt": "2019-08-24T14:15:22Z", "status": "string", "comment": "string", "resolvedAt": "2019-08-24T14:15:22Z", "appealJuryComment": "string" } ``` ``` -------------------------------- ### Get Venue by ID Source: https://api.rating.chgk.info/index.yamlopenapi Retrieves a specific venue resource by its unique identifier. Requires API key authorization. ```APIDOC ## GET /venues/{id} ### Description Retrieves a specific venue resource by its unique identifier. ### Method GET ### Endpoint https://api.rating.chgk.info/venues/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Venue identifier ### Responses #### Success Response (200) Venue resource #### Error Response (404) Not found ``` -------------------------------- ### Get Team Tournaments Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a list of tournaments a specific team has participated in. Requires the team ID. ```APIDOC ## Турниры, на которых играла команда Турниры, на которых играла команда ##### Authorizations: _apiKey_ ##### path Parameters idrequired| string team_tournaments identifier ---|--- ### Responses **200** team_tournaments resource **404** Not found get/teams/{id}/tournaments https://api.rating.chgk.info/teams/{id}/tournaments ``` -------------------------------- ### Get Tournament Synch Controversial by ID Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific controversial tournament synch decision by its unique identifier. ```APIDOC ## GET /tournament_synch_controversials/{id} ### Description Retrieves a specific controversial tournament synch decision by its unique identifier. ### Method GET ### Endpoint https://api.rating.chgk.info/tournament_synch_controversials/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier for the tournament synch controversial. ### Responses #### Success Response (200) - Returns the TournamentSynchControversial resource. #### Error Response (404) - Not found. ``` -------------------------------- ### Create Player Request Payload Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Sample payload for creating a new player resource. ```json { "name": "string", "alias": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "tournaments": [ "https://example.com/" ], "seasons": [ "https://example.com/" ], "dateBirth": "2019-08-24T14:15:22Z", "dateDied": "2019-08-24T14:15:22Z", "townManual": "https://example.com/", "createdBy": "https://example.com/", "comment": "string", "adminComment": "string", "user": "https://example.com/", "schoolGrade": 0, "tournamentCountTotal": 0, "toBeChecked": true, "wasRepresentative": false, "wasNarrator": false, "isDisqualified": false } ``` -------------------------------- ### Create Season Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Sample JSON response after successfully creating a season. Includes the new season's ID, dateStart, and dateEnd. ```json { "id": 0, "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z" } ``` -------------------------------- ### Get Region by ID Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific region by its unique identifier. ```APIDOC ## Get Region by ID ### Description Retrieves a specific region by its unique identifier. ### Method GET ### Endpoint /regions/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Region identifier ### Responses #### Success Response (200) - **Region resource** #### Error Response (404) - **Not found** ### Response Example (200) ```json { "id": 0, "name": "string", "country": { "id": 0, "name": "string" } } ``` ``` -------------------------------- ### Release Collection Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Sample JSON array representing a collection of releases. Each release includes an ID, date, realDate, and lastRunRefresh timestamp. ```json [ { "id": 0, "date": "2019-08-24T14:15:22Z", "realDate": "2019-08-24T14:15:22Z", "lastRunRefresh": "2019-08-24T14:15:22Z" } ] ``` -------------------------------- ### Create Player Source: https://api.rating.chgk.info/index.html?ui=re_doc Creates a new player resource. Requires an API key for authorization. ```APIDOC ## Создание игрока ### Description Creates a new player resource. ### Method POST ### Endpoint `post/players` ### Parameters #### Request Body - **name** (string) - Required - **alias** (string or null) - Optional - **patronymic** (string or null) - Optional - **surname** (string) - Required - **gotQuestionsTag** (integer or null) - Optional - **tournaments** (Array of strings) - Optional - IRI-reference - **seasons** (Array of strings) - Optional - IRI-reference - **dateBirth** (string or null) - Optional - date-time - **dateDied** (string or null) - Optional - date-time - **townManual** (string or null) - Optional - IRI-reference - **createdBy** (string or null) - Optional - IRI-reference - **comment** (string or null) - Optional - **adminComment** (string or null) - Optional - **user** (string or null) - Optional - IRI-reference - **schoolGrade** (integer or null) - Optional - **tournamentCountTotal** (integer) - Optional - Default: 0 - **toBeChecked** (boolean) - Optional - Default: true - **wasRepresentative** (boolean) - Optional - Default: false - **wasNarrator** (boolean) - Optional - Default: false - **isDisqualified** (boolean) - Optional - Default: false ### Request Example ```json { "name": "string", "alias": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "tournaments": [ "https://example.com/" ], "seasons": [ "https://example.com/" ], "dateBirth": "2019-08-24T14:15:22Z", "dateDied": "2019-08-24T14:15:22Z", "townManual": "https://example.com/", "createdBy": "https://example.com/", "comment": "string", "adminComment": "string", "user": "https://example.com/", "schoolGrade": 0, "tournamentCountTotal": 0, "toBeChecked": true, "wasRepresentative": false, "wasNarrator": false, "isDisqualified": false } ``` ### Responses - **201** - Player resource created - **400** - Invalid input - **403** - Forbidden - **422** - An error occurred ``` -------------------------------- ### Create Venue Source: https://api.rating.chgk.info/index.html?ui=re_doc Creates a new venue resource. ```APIDOC ## POST /venues ### Description Creates a new venue resource. ### Method POST ### Endpoint https://api.rating.chgk.info/venues ### Parameters #### Request Body schema: - **name** (string) - Required - **town** (Town-write object or null) - Required - **type** (VenueType-write object) - Required - Venue types. - **address** (string) - Optional - Actual address. - **urls** (Array of strings or null) - Optional - Links to the venue pages. ### Responses #### Success Response (201) - Returns the created Venue resource. #### Error Response (400) - Invalid input. #### Error Response (403) - Forbidden. #### Error Response (422) - An error occurred. ``` -------------------------------- ### Create Team Source: https://api.rating.chgk.info/index.html?ui=re_doc Creates a new team resource. Requires an API key for authorization. ```APIDOC ## Создание команды ##### Authorizations: _apiKey_ ##### Request Body schema: application/jsonapplication/merge-patch+jsonapplication/ld+jsontext/htmlapplication/json required The new Team resource namerequired| string ---|--- townrequired| object (Town-write) ### Responses **201** Team resource created **400** Invalid input **403** Forbidden **422** An error occurred post/teams https://api.rating.chgk.info/teams ``` -------------------------------- ### Region Resource Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Sample JSON structure for a region resource. Includes ID, name, and country details. ```json [ { "id": 0, "name": "string", "country": { "id": 0, "name": "string" } } ] ``` -------------------------------- ### Release Resource Details Source: https://api.rating.chgk.info/index.html?ui=re_doc JSON structure for a specific release resource, detailing its ID, date, realDate, and lastRunRefresh. ```json { "id": 0, "date": "2019-08-24T14:15:22Z", "realDate": "2019-08-24T14:15:22Z", "lastRunRefresh": "2019-08-24T14:15:22Z" } ``` -------------------------------- ### Season Collection Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Sample JSON array representing a collection of seasons. Each season includes an ID and start/end dates. ```json [ { "id": 0, "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z" } ] ``` -------------------------------- ### Player Patch Request Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Sample JSON payload for updating a player resource using the merge-patch+json content type. ```json { "name": "string", "alias": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "tournaments": [ "https://example.com/" ], "seasons": [ "https://example.com/" ], "dateBirth": "2019-08-24T14:15:22Z", "dateDied": "2019-08-24T14:15:22Z", "townManual": "https://example.com/", "createdBy": "https://example.com/", "comment": "string", "adminComment": "string", "user": "https://example.com/", "schoolGrade": 0, "tournamentCountTotal": 0, "toBeChecked": true, "wasRepresentative": false, "wasNarrator": false, "isDisqualified": false } ``` -------------------------------- ### List Releases Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a collection of releases with optional pagination. ```APIDOC ## List Releases ### Description Retrieves a collection of releases. Supports pagination. ### Method GET ### Endpoint /releases ### Parameters #### Query Parameters - **page** (integer) - Optional - The collection page number. Default: 1 - **itemsPerPage** (integer) - Optional - The number of items per page. [0 .. 30]. Default: 30 - **pagination** (boolean) - Optional - Enable or disable pagination. ### Responses #### Success Response (200) - **Release collection** ### Response Example (200) ```json [ { "id": 0, "date": "2019-08-24T14:15:22Z", "realDate": "2019-08-24T14:15:22Z", "lastRunRefresh": "2019-08-24T14:15:22Z" } ] ``` ``` -------------------------------- ### Create Venue Request Body Source: https://api.rating.chgk.info/index.html?ui=re_doc Schema for creating a new venue. Requires name, town, and type. Address and URLs are optional. ```json { "name": "string", "town": {}, "type": {}, "address": "string", "urls": [ "string" ] } ``` -------------------------------- ### Updated Team Resource Response Source: https://api.rating.chgk.info/index.yamlopenapi This is a sample response for a successful team update (200 OK). It includes the team's ID, name, and detailed town information. ```json { "id": 0, "name": "Команда Губанова", "town": { "id": 0, "name": "string", "region": { "id": 0, "name": "string", "country": { "id": 0, "name": "string" } }, "country": { "id": 0, "name": "string" } } } ``` -------------------------------- ### Team Tournaments Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc Sample JSON response for a team's tournament participation. Includes team and tournament identifiers. ```json { "idteam": 0, "idtournament": 0 } ``` -------------------------------- ### Tournament Details Response Sample Source: https://api.rating.chgk.info/index.html?ui=re_doc This JSON structure represents a successful response for tournament details. It includes various fields related to the tournament's type, dates, organizers, and rating systems. ```json { "type": 2, "id": 0, "name": "", "longName": "string", "lastEditDate": "2019-08-24T14:15:22Z", "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z", "paymentCategories": [ { "amount": 0, "currency": "string", "reason": "string" } ], "idseason": 0, "orgcommittee": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "languages": [ "string" ], "editors": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "gameJury": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "appealJury": [ { "id": 0, "name": "string", "patronymic": "string", "surname": "string", "gotQuestionsTag": 0, "dateDied": "2019-08-24T14:15:22Z", "comment": "string" } ], "trueDL": 0, "difficultyForecast": 0, "ratingSystems": [ "string" ], "maiiRating": false, "regulationsUrl": "", "rating": true, "questionQty": [ "string" ] } ``` -------------------------------- ### Get Team Seasons Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a collection of seasons a team has participated in, with options for pagination and filtering by season, player, or team. ```APIDOC ## Базовые составы команды Базовые составы команды ##### Authorizations: _apiKey_ ##### path Parameters idrequired| string Team identifier ---|--- ##### query Parameters page| integer Default: 1 The collection page number ---|--- itemsPerPage| integer [ 0 .. 30 ] Default: 30 The number of items per page pagination| boolean Enable or disable pagination idseason| integer idseason[]| Array of integers idplayer| integer idplayer[]| Array of integers idteam| integer idteam[]| Array of integers ### Responses **200** team_seasons collection get/teams/{id}/seasons https://api.rating.chgk.info/teams/{id}/seasons ``` -------------------------------- ### Get Season by ID Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a specific season by its unique identifier. A season is defined as the period from the beginning of September to the end of August of the following year. ```APIDOC ## Get Season by ID ### Description Retrieves a specific season by its unique identifier. A season is defined as the period from the beginning of September to the end of August of the following year. ### Method GET ### Endpoint /seasons/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Season identifier ### Responses #### Success Response (200) - **Season resource** #### Error Response (404) - **Not found** ### Response Example (200) ```json { "id": 0, "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z" } ``` ``` -------------------------------- ### List Venues Source: https://api.rating.chgk.info/index.html?ui=re_doc Retrieves a collection of venues with optional pagination and filtering. ```APIDOC ## GET /venues ### Description Retrieves a collection of venues with optional pagination and filtering. ### Method GET ### Endpoint https://api.rating.chgk.info/venues ### Parameters #### Query Parameters - **page** (integer) - Optional - The collection page number. Default: 1. - **itemsPerPage** (integer) - Optional - The number of items per page. Default: 30. Range: 0 to 30. - **pagination** (boolean) - Optional - Enable or disable pagination. - **name** (string) - Optional - Filter venues by name. ### Responses #### Success Response (200) - Returns a Venue collection. ``` -------------------------------- ### Create Season Request Payload Source: https://api.rating.chgk.info/index.html?ui=re_doc JSON payload for creating a new season. Requires 'dateStart' and 'dateEnd' in ISO 8601 format. ```json { "dateStart": "2019-08-24T14:15:22Z", "dateEnd": "2019-08-24T14:15:22Z" } ``` -------------------------------- ### List Venue Requests Source: https://api.rating.chgk.info/index.yamlopenapi Retrieves a list of requests associated with a specific venue, with options for pagination and filtering by date. Requires API key authorization. ```APIDOC ## GET /venues/{id}/requests ### Description Retrieves a list of requests associated with a specific venue, with options for pagination and filtering by date. ### Method GET ### Endpoint https://api.rating.chgk.info/venues/{id}/requests ### Parameters #### Path Parameters - **id** (string) - Required - Venue identifier #### Query Parameters - **page** (integer) - Optional - The collection page number. Default: 1 - **itemsPerPage** (integer) - Optional - The number of items per page. Range: [0 .. 30]. Default: 30 - **pagination** (boolean) - Optional - Enable or disable pagination - **issuedAt[before]** (string) - Optional - **issuedAt[strictly_before]** (string) - Optional - **issuedAt[after]** (string) - Optional - **issuedAt[strictly_after]** (string) - Optional - **dateStart[before]** (string) - Optional - **dateStart[strictly_before]** (string) - Optional - **dateStart[after]** (string) - Optional - **dateStart[strictly_after]** (string) - Optional ### Responses #### Success Response (200) venue_requests collection ```