Hippomundo Enterprise

Schema

object

Class of an edition belonging to an existing competition. The class carries the class purse; a result's awarded prize is a different field. star_level is the star designation applying to the class and max_height_metres is the jumping difficulty; see each field for the per-discipline meaning.

Field	Type	Description
`date`	string (date) · required	Effective class date, falling back to the edition date. Never null on a public class.
`edition_id`	integer (int64) · required	Public ID of the parent edition.
`format`	ClassFormat · required	Normalized class format. `code` is an open set: recognized source values receive a stable code and canonical `display` label; an unmapped value returns `code: unknown` with the original safe text as `display` and never receives invented semantics.
`id`	integer (int64) · required	Public class ID.
`max_height_metres`	number or null · required	Maximum obstacle height as a decimal in metres. The difficulty indicator for jumping classes; null for other disciplines.
`name`	string · required
`prize_money_eur_cents`	integer (int64) or null · required	Advertised class purse as an integer in euro cents, converted at the exchange rate on the class date and frozen; the value is stable and never recomputed. Distinct from a result's `awarded_prize_money_eur_cents`.
`star_level`	integer or null · required	Star designation applying to this class, from one to five, using the same vocabulary as the edition's `star_level`. Eventing classes are individually starred and may differ from other classes of the same edition, so for eventing this filters by class difficulty. International dressage and jumping classes carry their event's designation, so for those disciplines it reflects the event's prestige, not the difficulty of the individual class — jumping difficulty is `max_height_metres`. Null for national dressage, youth dressage tests and when no designation is recorded. Known values (open set): `[1,2,3,4,5]`.

Related schemas: ClassFormat

Complete OpenAPI definition

{
  "description": "Class of an edition belonging to an existing competition. The class carries the class purse; a result's awarded prize is a different field. `star_level` is the star designation applying to the class and `max_height_metres` is the jumping difficulty; see each field for the per-discipline meaning.",
  "properties": {
    "date": {
      "description": "Effective class date, falling back to the edition date. Never null on a public class.",
      "format": "date",
      "type": "string"
    },
    "edition_id": {
      "description": "Public ID of the parent edition.",
      "format": "int64",
      "type": "integer"
    },
    "format": {
      "$ref": "#/components/schemas/ClassFormat"
    },
    "id": {
      "description": "Public class ID.",
      "format": "int64",
      "type": "integer"
    },
    "max_height_metres": {
      "description": "Maximum obstacle height as a decimal in metres. The difficulty indicator for jumping classes; null for other disciplines.",
      "nullable": true,
      "type": "number"
    },
    "name": {
      "type": "string"
    },
    "prize_money_eur_cents": {
      "description": "Advertised class purse as an integer in euro cents, converted at the exchange rate on the class date and frozen; the value is stable and never recomputed. Distinct from a result's `awarded_prize_money_eur_cents`.",
      "format": "int64",
      "nullable": true,
      "type": "integer"
    },
    "star_level": {
      "description": "Star designation applying to this class, from one to five, using the same vocabulary as the edition's `star_level`. Eventing classes are individually starred and may differ from other classes of the same edition, so for eventing this filters by class difficulty. International dressage and jumping classes carry their event's designation, so for those disciplines it reflects the event's prestige, not the difficulty of the individual class — jumping difficulty is `max_height_metres`. Null for national dressage, youth dressage tests and when no designation is recorded.",
      "nullable": true,
      "type": "integer",
      "x-known-values": [
        1,
        2,
        3,
        4,
        5
      ]
    }
  },
  "required": [
    "id",
    "edition_id",
    "name",
    "format",
    "date",
    "max_height_metres",
    "star_level",
    "prize_money_eur_cents"
  ],
  "type": "object"
}