Schemas
SportPedigree
Response and request schema
Schema
object
Genealogy to great-grandparents and up to four dam families, each three offspring generations deep. The cap counts at most 500 full dam-line horse occurrences, including the dams. Tree nodes, sire offspring and compact sister references are outside the cap. Trimming removes deepest generations first, starting with the fourth dam family. The truncation flag reports omitted horses.
Additional properties: false.
| Field | Type | Description |
|---|---|---|
dam_line | array of SportDamLineEntry · required | Maximum items: |
dam_line_truncated | boolean · required | |
sire_best_offspring | array of SportSireOffspring · required | Maximum items: |
subject | object · required | Additional properties: |
tree | SportTree · required | Additional properties: |
Related schemas: SportDamLineEntry, SportSireOffspring, PedigreeStudbookRef, BirthYear, PedigreeSport, NullablePedigreeStudbookRef, SportTree
Complete OpenAPI definition
{
"additionalProperties": false,
"description": "Genealogy to great-grandparents and up to four dam families, each three offspring generations deep. The cap counts at most 500 full dam-line horse occurrences, including the dams. Tree nodes, sire offspring and compact sister references are outside the cap. Trimming removes deepest generations first, starting with the fourth dam family. The truncation flag reports omitted horses.",
"properties": {
"dam_line": {
"items": {
"$ref": "#/components/schemas/SportDamLineEntry"
},
"maxItems": 4,
"type": "array"
},
"dam_line_truncated": {
"type": "boolean"
},
"sire_best_offspring": {
"items": {
"$ref": "#/components/schemas/SportSireOffspring"
},
"maxItems": 3,
"type": "array"
},
"subject": {
"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"
},
"sex": {
"nullable": true,
"type": "string"
},
"sport": {
"$ref": "#/components/schemas/PedigreeSport"
},
"studbook": {
"$ref": "#/components/schemas/NullablePedigreeStudbookRef"
}
},
"required": [
"id",
"name",
"birth_year",
"sex",
"colour",
"studbook",
"approved_for",
"sport"
],
"type": "object"
},
"tree": {
"$ref": "#/components/schemas/SportTree"
}
},
"required": [
"subject",
"tree",
"dam_line",
"dam_line_truncated",
"sire_best_offspring"
],
"type": "object"
}