Resource Type: Animal

  • [URLs]()
  • [Response Structure]()

URLs

Get all Animals that you have access to

GET /data/livestock/animals

Get the Animal for the specified id

GET /data/livestock/animals/{id}

Get all Animals that are linked to the provided holding id

GET /data/holdings/{holdingId}/livestock/animals

Get the Animal for the specified id that is linked to the provided holding id

GET /data/holdings/{holdingId}/livestock/animals/{id}

Response Structure

A call to the Animals endpoints returns the following fields.

{
  "self": "string",
  "location": {...},
  "meta": {...},
  "resourceType": "/livestock/animal",
  "alternativeIdentifiers": [{...}],
  "birthDate": "string",
  "breedFractions": {...},
  "coatColor": "string",
  "coatColorIdentifier": {...},
  "gender": "string",
  "healthStatus": "string",
  "identifier": {...},
  "lactationStatus": "string",
  "managementTag": "string",
  "name": "string",
  "officialName": "string",
  "parentage": [{...}],
  "primaryBreed": {...},
  "productionPurpose": "string",
  "reproductionStatus": "string",
  "specie": "string",
  "status": "string",
  "id": "string"
}
Response Item Description Data Type
Self A link to this specific Animal URI
Location An identifier for the location of the Animal Identifier
Meta Meta data for the resource Metadata
Resource Type The fixed discriminator for the animal resource type.
Value: /livestock/animal
String
Alternative Identifiers Any identifier of this Animal Array of Identifiers
Birth Date The date of birth of this Animal Date/Time
Breed Fractions The breed fractions for this Animal Breed Fractions
Coat Color The color of this Animal’s coat String
Coat Color Identifier The color of this Animal’s coat using a national or breed-defined scheme and identifier Identifier
Gender The gender of this Animal. (Valid values: Female, FemaleNeuter, Male, MaleCryptorchid, MaleNeuter, Unknown) Enumeration
Health Status The health status of this Animal. (Valid values: Healthy, Suspicious, Ill, InTreatment, ToBeCulled) Enumeration
Identifier The identifier of this Animal Identifier
Lactation Status The lactation status of this Animal. (Valid values: Dry, Lead, Fresh, Early, Lactating) Enumeration
Management Tag The identifier used by the farmer in day-to-day management of this Animal. String
Name Name for given by the farmer for this Animal String
Official Name Official herdbook name for this Animal String
Parentage The parents, grandparents, ancestors of this Animal Array Parentage
Primary Breed ICAR breed code for this Animal. For example:
{ "scheme": "ICAR2", "id": "AN" }
For more details, see also Reference Data Breeds – PureFarming DevHub
Identifier
Production Purpose Primary production purpose for which this Animal was bred. (Valid values: Meat, Milk, Wool) Enumeration
Reproduction Status The reproduction status of this Animal. (Valid values: Open, Inseminated, Pregnant, NotPregnant, Birthed, DoNotBreed, PregnantMultipleFoetus) Enumeration
Specie The species of this Animal. (Valid values: Buffalo, Cattle, Deer, Elk, Goat, Horse, Pig, Sheep) Enumeration
Status On-farm status of this Animal (Valid values: Alive, Dead, OffFarm, Unknown) Enumeration
Id The Pure Farming Id of this Animal UUID

Breed Fractions

Breed Fractions are …

{
  "denominator": 0,
  "fractions": [{...}]
}
Response Item Description Data Type
Denominator The denominator of breed fractions for this Animal. This specifies the number of fractions there are. Number
Fractions The several fractions’ details of the breed for this Animal Fraction

Fraction

A Fraction is …

{
  "breed": {...},
  "fractionFraction": 0
}
Response Item Description Data Type
Breed Identifies a breed using scheme and id Identifier
Fraction Fraction The proportion of the denominator that this breed comprises. This could be for example 5. That would mean, by a given denominator of 16 that this animal is a blend of breeds and consists to 5 parts (of 16) of the specified breed. Number

Parentage

A description of the parents of this Animal

{
  "gender": "string",
  "identifier": {...},
  "officialName": "string",
  "parentOf": {...},
  "relation": "string"
}
Response Item Description Data Type
Gender The gender of this Animal. (Valid values: Female, FemaleNeuter, Male, MaleCryptorchid, MaleNeuter, Unknown) Enumeration
Identifier The identifier of this Animal Identifier
Official Name Official herd-book name for this Animal String
Parent Of The identifier for the child of the Animal Identifier
Relation Identifies the type of parent. (Valid values: Genetic, Recipient, Adoptive) Enumeration