Hippomundo Enterprise API
Schemas

SportOffspring

Response and request schema

Schema

object

Foal with at most three offspring generations below its dam. Repeated dams have no nested offspring.

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.

is_subjectboolean · required
namestring · required

Minimum length: 1.

offspringarray of SportOffspring · required

Maximum items: 500.

performanceSportDetails · required

Additional properties: false.

repeated_damboolean · required
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, SportOffspring, SportDetails, PedigreeSport, NullablePedigreeStudbookRef

Complete OpenAPI definition
{
  "additionalProperties": false,
  "description": "Foal with at most three offspring generations below its dam. Repeated dams have no nested offspring.",
  "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"
    },
    "is_subject": {
      "type": "boolean"
    },
    "name": {
      "minLength": 1,
      "type": "string"
    },
    "offspring": {
      "items": {
        "$ref": "#/components/schemas/SportOffspring"
      },
      "maxItems": 500,
      "type": "array"
    },
    "performance": {
      "$ref": "#/components/schemas/SportDetails"
    },
    "repeated_dam": {
      "type": "boolean"
    },
    "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",
    "is_subject",
    "repeated_dam",
    "performance",
    "offspring"
  ],
  "type": "object"
}