1. Home
  2. /
  3. Resource Types
  4. /
  5. Livestock
  6. /
  7. Livestock Movements
  8. /
  9. birth-registrations

—

title: Birth Registration
menu_order: 1
post_status: publish
post_excerpt: Animal – Birth Registration
taxonomy:
category:

  • api
  • data
    post_tag:
  • api

Resource Type: Livestock – Movements – Animal Birth Registration

URLs

Get all animal birth registrations that you have access to.

GET /data/livestock/movement/animal-birth-registrations

Get an individual animal birth registration for a given AnimalBirthRegId, the Id of the animal birth registration is required.

GET /data/livestock/movement/animal-birth-registrations/{AnimalBirthRegId}

Get all animal birth registrations for a given holding, the HoldingId is required.

GET /data/holdings/{HoldingId}/livestock/movement/animal-birth-registrations

Get an individual animal birth registration with a given HoldingId and AnimalBirthRegId, both Ids are required.

GET /data/holdings/{HoldingId}/livestock/movement/animal-birth-registrations/{AnimalBirthRegId}

Response Structure

A call to the Livestock Animal Birth Registration endpoint returns the following fields:

{
    "self": "string",
    "id": "string",
    "meta": { ... },
    "resourceType": "/livestock/movement/animal-birth-registration",
    "eventDateTime": "string",
    "traitLabel": { ... },
    "responsible": "string",
    "remark": "string",
    "contemporaryGroup": "string",
    "registrationReason": "string",
    "location": { ... },
    "animal": { ... },
    "animalDetail": { ... }
}
Response Item Description Data Type
Self A link to the specific Animal Birth Registration. URL
Id The Pure Farming Id of this Animal Birth Registration. UUID
Meta Meta data for the resource. Metadata
Resource Type The fixed discriminator for the Animal Birth Registration resource type.
Value: /livestock/movement/animal-birth-registration		 String
Event DateTime The datetime when the event happened. Shall be UTC format with Z, specified in RFC3339. Date/Time
Trait Label If the event represents a formal trait, this identifies the recording system and trait. Identifier
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
Remark A comment or remark field for additional user-specified information about the event. String
Contemporary Group For manually recorded events, record any contemporary group code that would affect statistical analysis. String
Registration Reason Enumeration for registration reason: Born, or Registered (induct existing animal). Enumeration
Location An identifier for the location of the Animal Birth Registration. Identifier
Remark A comment or remark field for additional user-specified information about the event. String
Animal Unique animal scheme and identifier combination. Identifier
Animal Detail Core schema for representing animal. See the Animal definition. AnimalDetail