- Home
- /
- Resource Types
- /
- Livestock
- /
- Livestock Movements
- /
- Group Death
Resource Type: Group-Death
- [URLs]()
- [Response Structure]()
URLs
Get all group death events that you have access to.
GET /data/livestock/movement/group-death
Get an individual group death event for the specified GroupDeathId, the Id is required.
GET /data/livestock/movement/group-death/{GroupDeathId}
Get all group death events that are linked to the provided HoldingId, holding Id is required.
GET /data/holdings/{HoldingId}/livestock/movement/group-death
Get an individual group death event with a given HoldingID and GroupDeathId, both Ids are required
GET /data/holdings/{HoldingId}/livestock/movement/group-death/{GroupDeathId}
Response Structure
A call to the animal death event endpoints returns the following fields.
{
"id": "string",
"resourceType": "/livestock/movement/group-death",
"groupMethod": "string",
"traitLabel" : {...},
"consignment": {...},
"contemporaryGroup": "string",
"countObserved": "number",
"deathMethod" : "string",
"deathReason" : "string",
"disposalMethod" : "string",
"disposalOperator" : "string",
"disposalReference" : "string",
"eventDateTime": "DateTimeOffset",
"explanation" : "string",
"embeddedAnimalSet": {...},
"inventoryClassification": {...},
"location": {...},
"remark" : "string",
"responsible" : "string",
"meta": {...},
"animalSetReference": {...},
"self": "string"
}
Response Item | Description | Data Type |
---|---|---|
Id | The Pure Farming Id of this death event. | UUID |
Resource Type | The fixed discriminator for the animal death resource type. Value: /livestock/movement/animal-death |
String |
Group Method | Indicates whether the event references an existing animal set, has an embedded animal set, or an inventory classification. (Valid values: ExistingAnimalSet, EmbeddedAnimalSet, InventoryClassification, EmbeddedAnimalSetAndInventoryClassification) | Enumeration |
Trait Label | If the event represents a formal trait, this identifies the recording system and trait. | Identifier |
Consignment | Consignment information for a movement (arrival, departure). See the Consignment definition | Consignment |
ContemporaryGroup | For manually recorded events, record any contemporary group code that would affect statistical analysis. | String |
Count Observed | Summarises the number of animals observed in the event. Generally the number of animals in the group, but sometimes a sample. | Number |
Death Method | How the animal was killed (Valid values: Accident, Culled, Lost, Other, Perished, Slaughter, Theft). | Enumeration |
Death Reason | The reason for the death (Valid values: Missing, Parturition, Disease, Accident, Consumption, Culled, Other, Unknown, Age, Mastitis, Production, LegOrClaw, MilkingAbility, Nutrition, Fertility). | Enumeration |
Disposal Method | How the animal was disposed of (Valid values: ApprovedService, Consumption, OnPremise, Other). | Enumeration |
Disposal Operator | Disposal operator official name (should really be schema.org/organization). | String |
Disposal Reference | Reference (receipt, docket, or ID) for disposal. | String |
Event Date Time | The Time that this event occurred. | DateTimeOffset |
Explanation | Free text explanation of the reason for death. | String |
Embeded Animal Set | Specifies the set of animals as a list of member animal identifiers. | Embedded Animal Set |
Inventory Classification | Describe the group of animals by their characteristics rather than animal identifiers. | Inventory Classification |
Location | An identifier for the location of the Animal Death. | Identifier |
Remark | A comment or remark field for additional user-specified information about the event. | String |
Responsible | Use if an observation is manually recorded, or an event is carried out or authorised by a person. SHOULD be a person object. | String |
Meta | Meta data for the resource. | Metadata |
Animal Set Reference | Reference an existing animal set by ID and optionally URI. | ResourceReference |
Self | A link to this specific Animal Death. | URI |