Resource Type: Animal-Departure

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

URLs

Get all animal departure events that you have access to.

GET /data/livestock/movement/animal-departures

Get an individual animal departure event for the specified DepartureId, the Id is required.

GET /data/livestock/movement/animal-departures/{DepartureId}

Get all animal departure events that are linked to the provided HoldingId, the holding Id is required.

GET /data/holdings/{HoldingId}/livestock/movement/animal-departures

Get an individual animal departure event with a given HoldingId and DepartureId, both Ids are required.

GET /data/holdings/{HoldingId}/livestock/movement/animal-departures/{DepartureId}

Response Structure

A call to the animal departure endpoints returns the following fields.

{
  "self": "string",
  "location": {...},
  "animalDetailMeta": {...},
  "resourceType": "/livestock/movement/animal-departure",
  "consignment": {...},
  "responsable": "string",
  "contemporaryGroup": "string",
  "remark": "string",
  "traitLabel" : {...},
  "animal" : {...},
  "departureKind" : "string",
  "departureReason": "string",
  "eventDateTime" : "DateTimeOffset",
  "id": "string"
}
Response Item Description Data Type
Self A link to this specific Animal Departure URI
Location An identifier for the location of the Animal Departure Identifier
Animal Detail Meta Meta data for the resource Metadata
Resource Type The fixed discriminator for the animal departure resource type.
Value: /livestock/movement/animal-departure
String
Consignment Consignment information for a movement (arrival, departure). See the Consignment definition Consignment
Responsable Use if an observation is manually recorded, or an event is carried out or authorised by a person. SHOULD be a person object. String
ContemporaryGroup For manually recorded events, record any contemporary group code that would affect statistical analysis. String
Remark A comment or remark field for additional user-specified information about the event. String
Trait Label If the event represents a formal trait, this identifies the recording system and trait. Identifier
Animal Unique animal scheme and identifier combination. Identifier
Departure Kind The kind of departure event (Valid values: Agistment, AgistmentReturn, Export, InternalTransfer, Newborn, Other, Sale, SaleReturn, Show, ShowReturn, Slaughter, StudService, StudServiceReturn) Enumeration
Departure Reason The Reason for the departure (Valid values: Age, BadType, Behaviour, Fertility, Health, LegOrClaw, Mastitis, MilkingAbility, Newborn, Nutrition, Other, Parturition,
Production, Sale, Slaughter, Superfluous, Unknown) Enumeration
Event Date Time The Time that this event occured DateTimeOffset
Id The Pure Farming Id of this Animal Departure UUID