Hippomundo Enterprise API
Schemas

SportDamHorse

Response and request schema

Schema

object

Additional properties: false.

FieldTypeDescription
approved_forarray of PedigreeStudbookRef · required
birth_yearBirthYear or null · required

Four-digit year derived from the recorded birth date. Null when no year is available; an exact month and day are never exposed.

Minimum: 1000. Maximum: 9999.

colourstring or null · required
idinteger (int64) · required

Minimum: 1.

namestring · required

Minimum length: 1.

performanceSportDamDetails · required

Additional properties: false.

sexstring or null · required
sire_namestring or null · required

Recorded name of this horse's sire, or null when none is recorded. It is a name only, without a horse ID.

Minimum length: 1.

sportPedigreeSport · required

Stored sport flags, current raw rating (null when zero or unavailable), and levels.

Additional properties: false.

studbookNullablePedigreeStudbookRef or null · required

Additional properties: false.

Related schemas: PedigreeStudbookRef, BirthYear, SportDamDetails, PedigreeSport, NullablePedigreeStudbookRef

Complete OpenAPI definition
{
  "additionalProperties": false,
  "properties": {
    "approved_for": {
      "items": {
        "$ref": "#/components/schemas/PedigreeStudbookRef"
      },
      "type": "array"
    },
    "birth_year": {
      "$ref": "#/components/schemas/BirthYear"
    },
    "colour": {
      "nullable": true,
      "type": "string"
    },
    "id": {
      "format": "int64",
      "minimum": 1,
      "type": "integer"
    },
    "name": {
      "minLength": 1,
      "type": "string"
    },
    "performance": {
      "$ref": "#/components/schemas/SportDamDetails"
    },
    "sex": {
      "nullable": true,
      "type": "string"
    },
    "sire_name": {
      "description": "Recorded name of this horse's sire, or null when none is recorded. It is a name only, without a horse ID.",
      "minLength": 1,
      "nullable": true,
      "type": "string"
    },
    "sport": {
      "$ref": "#/components/schemas/PedigreeSport"
    },
    "studbook": {
      "$ref": "#/components/schemas/NullablePedigreeStudbookRef"
    }
  },
  "required": [
    "id",
    "name",
    "birth_year",
    "sex",
    "colour",
    "studbook",
    "approved_for",
    "sire_name",
    "sport",
    "performance"
  ],
  "type": "object"
}