Data Types

JSON

type description
AgeGroup
Altersklasse Alterklassen used to determine the Altersklassenfaktor §3, Anhang A.3
CalculationType
ChessResult Possible results of a DWZMatch or a DWZRestpartie. This result contains the points for player white and player black, the string representation of the result and the data base value for persistence.
ClubState
CountryAndClubState
DSBClubDTO Data transfer object representing a chess club in the DSB Wertungsportal.

Fields

  • clubVkz – Club number (VKZ / Vereinskennziffer), uniquely identifying the club within the DSB.
  • clubName – Name of the club.
  • federation – VKZ of the federation (Verband) the club belongs to.
  • parentFederation – VKZ of the parent federation (übergeordneter Verband).
  • state – State of the club (DELETE_STATE_FALSE or DELETE_STATE_TRUE). Only serialized in the JSON response, never written to the CSV export.
DSBFederationDTO Data transfer object representing a federation in the DSB Wertungsportal.

Fields

  • federationNumber – VKZ (Verbandskennziffer) of this federation.
  • federation – Top-level federation identifier.
  • parentFederation – VKZ of the immediate parent federation. null if no parent exists.
  • federationName – Name of the federation.
DSBMatchDTO Represents a single chess game within a DWZ tournament.

Fields

  • tournamentUuid – UUID of the tournament this game belongs to.
  • round – Round number within the tournament.
  • result – Game result from white's perspective (e.g. WHITE_WINS, REMIS, BLACK_WINS).
  • expected – Expected score from white's perspective based on rating difference.
  • restpartie – true if this is an adjourned game carried over from a previous tournament, false for a regular game.
  • whitePlayer – The player with the white pieces including DWZ evaluation data. null if no player is assigned.
  • blackPlayer – The player with the black pieces including DWZ evaluation data. null if no player is assigned.
DSBMembershipDTO View model of a single current club membership of a person (a membership without an until date).
  • vkz – VKZ (Vereinskennzeichen) of the club.
  • memberNo – DSB member number (licence number) within the club.
  • clubName – Name of the club.
  • licenceState – Licence state of the membership. Possible values: ACTIVE, PASSIVE. May be null.
  • regionName – Name of the region the club belongs to.
  • federationName – Name of the federation the club belongs to.
DSBPersonDTO View model of a person with their latest known DWZ rating and index and all current club memberships.

Identity fields

  • uuid – UUID identifying this person.
  • nuLigaPersonId – nuLiga person ID.
  • firstname / lastname – Full name of the person.
  • birthyear – Year of birth.
  • gender – Gender of the person. See PersonalGender.
  • fideId – FIDE ID. May be null.

Membership fields

  • memberships – All current club memberships of the person. Each entry carries the club-specific data (VKZ, member number, club name, licence state, region and federation). See DSBMembershipDTO.

Evaluation fields

  • weekOfLastTournamentEvaluation – Year and ISO week number of the last rated tournament the person participated in, formatted as YYYYWW (e.g. 202503 for week 3 of 2025). May be null if no rated tournament exists.

DWZ fields

  • rating – Latest known DWZ rating.
  • index – Latest known DWZ coefficient index.
DSBPlayerDTO View model of a player and their DWZ evaluation result within a tournament.

Identity fields

  • playerUuid – UUID identifying this player's participation in the tournament. Can be used to retrieve the player's scoresheet.
  • nuLigaPersonId – nuLiga person ID. Can be used to retrieve the player's full tournament history.
  • firstname / lastname – Full name of the player.
  • birthyear – Year of birth.
  • vkz – VKZ (Vereinskennzeichen) of the player's club.
  • memberNo – DSB member number.
  • clubName – Name of the player's club.
  • fideId – FIDE ID. May be null.
  • playerNo – Player's starting number within the tournament.
  • eloPlayer – Whether the player was an Elo player when entering the tournament.

DWZ evaluation fields

  • ratingOld – DWZ rating before the tournament.
  • indexOld – DWZ coefficient index before the tournament.
  • ratingNew – DWZ rating after the tournament evaluation.
  • indexNew – DWZ coefficient index after the tournament evaluation.
  • factorK – DWZ K-factor: determines the weight of rating changes per game.
  • averageRatingCompetitors – Average DWZ rating of all opponents faced.
  • wins – Actual score achieved (1 = win, 0.5 = draw, 0 = loss).
  • numberOfGames – Number of rated games played.
  • winsExpected – Expected score based on rating differences against all opponents.
  • tournamentPerformance – DWZ performance rating for this tournament.
DSBScoresheetDTO Scoresheet for a single player in a tournament.

Fields

  • matches – All games of this player in the current tournament, ordered by round.
  • restpartienAlt – Adjourned games from previous tournaments for the same person, ordered by tournament end date and round. Only populated for players receiving their first DWZ rating.
DSBTournamentDTO View model of a DSB tournament.

Fields

  • uuid – Unique identifier of the tournament.
  • label – Display name of the tournament.
  • vkz – VKZ (Vereinskennzeichen) of the organizing club.
  • startdate – Start date of the tournament (ISO-8601).
  • enddate – End date of the tournament (ISO-8601).
  • processingState – Current processing state. See ProcessingState.
  • ratingState – Current rating state. See RatingState.
  • referentFirstname / referentLastname – Full name of the primary referent.
  • referentEmail – E-mail address of the primary referent. Allows participants to contact the referent directly.
  • additionalReferentFirstname / additionalReferentLastname – Full name of the secondary referent. May be null.
  • additionalReferentEmail – E-mail address of the secondary referent. May be null.
  • location – Venue where the tournament takes place.
  • url – URL to the tournament's web page. May be null.
  • lastCalculated – Timestamp of the most recent DWZ calculation run. May be null if never calculated.
  • rounds – Number of rounds of the tournament. May be null.
DSBTournamentDetailDTO Extended view model of a single DSB tournament, returned only by the tournament detail endpoint (GET /dwz/tournaments/{uuid}).

In addition to all fields of DSBTournamentDTO it carries aggregate counts that require dedicated database queries and are therefore not provided for the (potentially large) tournament list responses.

Additional fields

  • playerCount – Number of players participating in the tournament.
  • matchCount – Number of games (Partien) played in the tournament.
DSBTournamentEvaluationDTO View model of a rated DSB tournament including the DWZ evaluation results for all its players.

Only available for tournaments with rating state RATED.

Fields

  • tournament – The tournament metadata including aggregate counts. See DSBTournamentDetailDTO.
  • players – List of players with their individual DWZ evaluation results. See DSBPlayerDTO.
DSBTournamentHistoryDTO View model of a player's complete DWZ tournament history.

Contains all tournament entries in which the player participated, ordered by tournament end date descending (most recent first).

Fields

  • person – Person for which the history was retrieved. See DSBPersonDTO.
  • entries – List of history entries, each pairing a tournament with the player's evaluation data. See DSBTournamentHistoryEntryDTO.
  • upgrades – List of DWZ upgrades (DWZ-Umstufungen) of the person, ordered by reference date descending (most recent first). See DSBUpgradeDTO.
DSBTournamentHistoryEntryDTO A single entry in a player's tournament history, combining the tournament metadata with the player's DWZ evaluation result within that tournament.

Fields

  • tournament – Metadata of the tournament. See DSBTournamentDTO.
  • player – The player's evaluation data within this tournament. See DSBPlayerDTO.
DSBUpgradeDTO View model of a DWZ upgrade (DWZ-Umstufung) of a person.

An upgrade is an externally imported re-grading that becomes the binding DWZ baseline from its reference date on. In contrast to a tournament entry it carries no game-level evaluation data (number of games, K-factor, performance, …) – only the rating and index before and after the upgrade.

Fields

  • referenceDate – Reference date (Stichtag) from which the upgrade is the binding baseline.
  • name – Label of the upgrade checkpoint.
  • ratingOld – DWZ rating before the upgrade.
  • indexOld – DWZ coefficient index before the upgrade.
  • ratingNew – DWZ rating after the upgrade.
  • indexNew – DWZ coefficient index after the upgrade.
DTBRankinglistDTO
DTBRankinglistEntryDTO
DTBRankinglistResultDTO
LKAltersklasse
LKBonus Bonus for special events according to §9 "Bonus für besondere Wettbewerbe"
LKCountingType
LKGradingType The possible types of a GradingStep as defined in § 10 "Durchführungsbestimmungen zur Leistungsklassenordnung (LKO)"
LKMatchType
LKNoShow Possible "no show" states
LKRetired Aufgabe eines Spielers, z.B. aufgrund einer Verletzung
LKSportType
LKWinner Outcome of a single or double match.
LicenceStateSchachDE
MBPAnnualLKDTO collection entry of the lk history of an player
MBPCalculationDTO A result of the "LK Rechner". Given the LK of two players A and B and the Altersklasse, MBPCalculation gives the two possible outcomes for player A or B.
MBPCustomNoShowDTO A match or Motivationsaufschlag during the week. Instances of WeekItemDTO may contribute to the lkDelta property of a week.
MBPDoubleDTO A double match as exposed by the REST API of the DTB LK 2.0 service. Matches (there are two types: single and double) are always contained in WeekDTO instances (property items).
MBPGradingStepDTO A grading step in the LK 2.0 protocol like "Ersteinstufung", "Umstufung", ... (see attribute gradingType)
MBPHiddenNoShowDTO A match or Motivationsaufschlag during the week. Instances of WeekItemDTO may contribute to the lkDelta property of a week.
MBPMatch
MBPMotivationItemDTO Each month, the amount of 0.1 will be added to a players LK. This amount will be split into one or more MotivationItemDTOs.
MBPNoShowInfoDTO detail content of a no show entry
MBPPersonBase Base class for DTOs with personal context.
MBPProtocolDTO View model of a players DTB-LK-2.0 protocol.
MBPProtocolStepDTO A step in the LK 2.0 protocol. LK values of a player may change only from step to step. For example, a step of the subclass WeekStepDTO contains all the matches, that contribute to the lk-change of that week.
MBPRaceClubDTO A clubs position on one of the different rankings of the mybigpoint races.

Both club race results are carried at once: the classic best-5 sum (v1, top5Sum) and the ranglistenbereinigte average per listed member (v2, averagePerMember = totalPoints / memberCount). The ?v2 flag only decides which of the two drives rank and points.
MBPRacePlayerDTO A players position on one of the different rankings of the mybigpoint races.
MBPSingleDTO A single match as exposed by the REST API of the DTB LK 2.0 service. Matches (there are two types: single and double) are always contained in WeekDTO instances (property items).

Determine match source

meeting
the attributes uuid and meetingId are set
tournament
the attributes uuid and competitionId are set
MBPStatisticsDTO Simple statistics (won:lost for single and double matches) for a given period.
MBPWeekDTO A week step in the LK 2.0 protocol. It spans from the day stored in attribute "date" (typically a Monday) to endOfWeek (typically a Sunday). Contains all the matches, that are chronologically assigned to that week (either scheduled or entered). If the week contains the last day of a month, it might contain a MotivationItemDTO as well.
MBPWeekItemDTO A match or Motivationsaufschlag during the week. Instances of WeekItemDTO may contribute to the lkDelta property of a week.
NTDBSourceType
NUCompetitionDTO Competition (Konkurrenz) of a tournament, or some other set of related matches (sharing altersklasse and bonus type).
NUEventDTO Superclass of NUMeetingDTO and NUCompetitionDTO, representing an event with a set of matches sharing the same alterklasse and bonus type.
NUGradingDTO Ein- und Umstufungen laut §10. Semantics: the referenceDate is usually a Monday and the gradedLK shall be valid for the that week. The Ersteinstufung on 01.10.2020 according to LK-classic 2020 will not be handled as a grading.
NUHiddenNoShowDTO If a player doesn't show up at a tournament, he might be replaced by some other player. So there won't be a noShow-typed match in the list of matches. In this case, and only in this case, a NUHiddenNoShowDTO needs to be added to hiddenNoShows in NUCompetitionDTO.
NUMatchDTO A single or double match. "Normal match": LKWinner.WINNER_IS_A or LKWinner.WINNER_IS_B LKNoShow.NO_NO_SHOW LKRetired.NO_RETIRED 0:1 (Player is injured in the match): LKWinner.WINNER_IS_A or LKWinner.WINNER_IS_B LKNoShow.NO_NO_SHOW LKRetired.RETIRED_A (if LKWinner.WINNER_IS_B) or LKRetired.RETIRED_B (if LKWinner.WINNER_IS_A) 0:0 (Player is injured before the match (warming up)): LKWinner.NO_WINNER LKNoShow.NO_NO_SHOW LKRetired.RETIRED_A or LKRetired.RETIRED_B One player does not show up to the match: LKWinner.NO_WINNER LKNoShow.NO_SHOW_A or LKNoShow.NO_SHOW_B LKRetired.NO_RETIRED One player does not have to play, since he has no opponent (player UUID is null) in a meeting match: LKWinner.NO_WINNER LKNoShow.NO_NO_SHOW LKRetired.NO_RETIRED Both meeting and competition matches can be configured to be LKNoShow.NO_SHOW_A or LKNoShow.NO_SHOW_B. The LK service decides whether the no show will be punished or not. At the moment meeting match no shows are not punished!
NUMeetingDTO Superclass of NUMeetingDTO and NUCompetitionDTO, representing an event with a set of matches sharing the same alterklasse and bonus type.
NUPlayerBaseDTO
NUPlayerDTO NUPlayerDTO represents a person, that plays matches in LK relevant events and who is covered by the LK-system.

This DTO is used in requests pushed by nuSport, as well as responses of the lk2020 service. When used in requests, the DTO carries the properties as they are present in the NTDB. If lk is present in a request body, then this should be the initial LK of that person (Ersteinstufung). The property dtbRank shall only be used, when pushing new ranking lists to the lk2020 service.

In responses of the lk2020 service, the properties personUUID and lk will be used only.

NUPlayerMergeDTO NUPlayerMergeDTO holds all the information about the merger of different player instances, who represent the same (natural) player.
NUPlayerPatchDTO NUPlayerPatchDTO is used to update (patch) a player. This class may hold several different DTOs for different (to be executed) operations.
NURankingDTO
NURankingListDTO
PageNavigationLinks Navigation links for paginated REST responses.

Each field contains an absolute URL pointing to the respective page. Fields are null when the corresponding page does not exist (e.g. next on the last page, previous on the first page).

  • self – URL of the current page.
  • first – URL of the first page.
  • last – URL of the last page.
  • next – URL of the next page. null if this is already the last page.
  • previous – URL of the previous page. null if this is already the first page.
PagedResponseMetadata Metadata of a PagedResponse.
  • limit – Maximum number of items per page as requested by the client. null indicates that no limit was applied and all matching items are returned.
  • offset – Zero-based starting position of this page within the total result set.
  • totalCount – Total number of items matching the applied filters, regardless of pagination.
PagedResponseOfDSBClubDTO Generic REST response wrapper for endpoints that support pagination.

Contains the requested page of results alongside pagination metadata and navigation links that allow clients to move through the full result set.
PagedResponseOfDSBFederationDTO Generic REST response wrapper for endpoints that support pagination.

Contains the requested page of results alongside pagination metadata and navigation links that allow clients to move through the full result set.
PagedResponseOfDSBMatchDTO Generic REST response wrapper for endpoints that support pagination.

Contains the requested page of results alongside pagination metadata and navigation links that allow clients to move through the full result set.
PagedResponseOfDSBPersonDTO Generic REST response wrapper for endpoints that support pagination.

Contains the requested page of results alongside pagination metadata and navigation links that allow clients to move through the full result set.
PagedResponseOfDSBTournamentDTO Generic REST response wrapper for endpoints that support pagination.

Contains the requested page of results alongside pagination metadata and navigation links that allow clients to move through the full result set.
PersonalGender Gender of a player: female or male.
ProcessingState Processing state of a DSB tournament, describing its current position in the workflow.
RankingListState
RankinglistEntryResponse
RankinglistResponse
RatingState Rating state of a DSB tournament, indicating whether the DWZ calculation has been performed.