HorseSearchResult
Response and request schema
Schema
object
Thin horse disambiguation result. The Hippomundo id is the
authoritative identifier and the only one returned. The other fields
exist to tell similarly named horses apart, not to carry full record
data.
| Field | Type | Description |
|---|---|---|
birth_country_iso_code | string or null · required | Birth country, ISO 3166-1 alpha-2. |
birth_year | integer or null · required | Four-digit birth year derived from the source birth date; the exact date is not exposed. |
dam_name | string or null · required | Recorded name of the horse's dam, or null when none is recorded. It is a name only, without a horse ID. Minimum length: |
id | integer (int64) · required | Public Hippomundo horse ID (authoritative, canonical). |
name | string · required | |
sex | string or null · required | Open set; clients must tolerate unknown values. |
sire_name | string or null · required | Recorded name of the horse's sire, or null when none is recorded. It is a name only, without a horse ID. Minimum length: |
studbook | StudbookRef or null · required | Slim studbook reference on a horse; null when the horse has no recorded studbook. |
Related schemas: StudbookRef
Complete OpenAPI definition
{
"description": "Thin horse disambiguation result. The Hippomundo `id` is the\nauthoritative identifier and the only one returned. The other fields\nexist to tell similarly named horses apart, not to carry full record\ndata.\n",
"properties": {
"birth_country_iso_code": {
"description": "Birth country, ISO 3166-1 alpha-2.",
"nullable": true,
"type": "string"
},
"birth_year": {
"description": "Four-digit birth year derived from the source birth date; the exact date is not exposed.",
"nullable": true,
"type": "integer"
},
"dam_name": {
"description": "Recorded name of the horse's dam, or null when none is recorded. It is a name only, without a horse ID.",
"minLength": 1,
"nullable": true,
"type": "string"
},
"id": {
"description": "Public Hippomundo horse ID (authoritative, canonical).",
"format": "int64",
"type": "integer"
},
"name": {
"type": "string"
},
"sex": {
"description": "Open set; clients must tolerate unknown values.",
"nullable": true,
"type": "string"
},
"sire_name": {
"description": "Recorded name of the horse's sire, or null when none is recorded. It is a name only, without a horse ID.",
"minLength": 1,
"nullable": true,
"type": "string"
},
"studbook": {
"$ref": "#/components/schemas/StudbookRef"
}
},
"required": [
"id",
"name",
"birth_year",
"sex",
"birth_country_iso_code",
"studbook",
"sire_name",
"dam_name"
],
"type": "object"
}