View on GitHub

easitrace

« Back to Contents

Movement Services | DAERA (APHIS)

DAERA is the Movement Service for Cattle in Northern Ireland.

Overview

This document covers primarily the functions available through Easitrace for DAERA (APHIS).
These include, but are not limited to:

Sections

Authentication
Movements

Authentication

Authentication for DAERA (APHIS) is handled differently to all other services with which EasiTrace communicates.
This is covered in significantly more detail here.

As of July 2020 the burden of authenticating with DAERA falls upon the caller of EasiTrace, this is due to changes in the GovGateway login system.
This means that the caller will need to provide a token in the body of each transaction submitted, as below:

{
  "reference": "<< Reference goes here >>",
  "transactionDate": "2019-01-31T22:26:47.075+00:00",
  "type": "MOV-OFF",
  "speciesCode": "C",
  "propertyIdentifier": "<< Herd Number goes here >>",
  "serviceAuthToken": "<< JWT Token goes here >>"
  "fields": {
    ...
  },
  "animals": [
    ...
  ]
}

Movements

Movements with DAERA follow a structured pattern which is similar to how movements may work for the ARAMS Sheep service.
This essentially follows the following steps:

  1. Seller Records an “Intention to Move” (MOV-INTENT)
  2. Between the Movement Date and 6 days subsequent the Seller confirms the movement (MOV-OFF)
  3. The Buyer confirms the movement (MOV-ON)

Itention to Move

Movements Off for DAERA (APHIS) represent an “Intention to Move” and not a movement itself, which is a departure from how movements are handled for the other services supported by EasiTrace.
This is due to how DAERA handles movements, insofar as that unless the seller has confirmed an “Intention to Move” then no movement has taken place.
In order to record an intention to move the following fields are required by DAERA:

For animals provided as part of a movement off, only the Visual property is required for them, although it must be in the following format:
NB: Spaces are shown by ⋅, numbers by N.

UK⋅N⋅NNNNNN⋅NNNN⋅N

Example Transaction:

{
  "reference": "0100000",
  "transactionDate": "2020-06-29",
  "type": "MOV-INTENT",
  "speciesCode": "C",
  "propertyIdentifier": "450676",
  "serviceAuthToken": "...",
  "fields": {
    "Destination.HerdNumber": "122161",
    "EmailAddress": "your.email@domain.com",
    "Destination.Type": "F"
  },
  "animals": [
    {
      "visual": "UK 9 450676 0050 1"
    }
  ]
}

For more information about submitting Transactions see Submitting transactions.

Movements Off

Movements Off for DAERA (APHIS) are able to be performed with or without previously recording a MOV-INTENT.
In this case, performing a MOV-OFF will do one of two things:

Example Transaction (with Movement.Id):

{
  "reference": "0100000",
  "transactionDate": "2020-06-29",
  "type": "MOV-OFF",
  "speciesCode": "C",
  "propertyIdentifier": "450676",
  "serviceAuthToken": "...",
  "fields": {
    "Movement.Id": "E12356",
    "EmailAddress": "sample@mail.com",
    "Destination.HerdNumber": "122161"
  }
}

Example Transaction (without Movement.Id):

{
  "reference": "0100000",
  "transactionDate": "2020-06-29",
  "type": "MOV-OFF",
  "speciesCode": "C",
  "propertyIdentifier": "450676",
  "serviceAuthToken": "...",
  "fields": {
    "Destination.HerdNumber": "122161",
    "EmailAddress": "your.email@domain.com",
    "Destination.Type": "F"
  },
  "animals": [
    {
      "visual": "UK 9 450676 0050 1"
    }
  ]
}

For animals provided as part of a movement off, only the Visual property is required for them, although it must be in the following format:
NB: Spaces are shown by ⋅, numbers by N.

UK⋅N⋅NNNNNN⋅NNNN⋅N

For more information about submitting Transactions see Submitting transactions.

Movements On

Movements On for DAERA (APHIS) represent a buyer “Confirmation of Move”. If Seller confirmed movement (UPDATEMOV-OFF) between the Movement Date and 6 days subsequent there is no need in a confirmation from buyer.

In order to record a movement on the following fields are required by DAERA:

The following fields are optional:

For animals provided as part of a movement on, only the Visual property is required for them, although it must be in the following format:
NB: Spaces are shown by ⋅, numbers by N.

UK⋅N⋅NNNNNN⋅NNNN⋅N

Example Transaction:

{
  "reference": "0100000",
  "transactionDate": "2020-06-29",
  "type": "MOV-ON",
  "speciesCode": "C",
  "propertyIdentifier": "450676",
  "serviceAuthToken": "...",
  "fields": {
    "Movement.ConfirmationNo": "...",
    "Departure.HerdNumber": "122161",
    "Movement.Id": "..."
  },
  "animals": [
    {
      "visual": "UK 9 450676 0050 1"
    }
  ]
}

Get Animal Details

In order to get animal details visual is required for each animal.

Example Transaction:

{
	"reference": "DAERA-GET-ANM",
	"transactionDate": "2019-08-13T21:30:00Z",
	"type": "ANM-DET",
	"speciesCode": "C",
	"propertyIdentifier": "122161",
	"serviceAuthToken": "<< Service token goes here >>",
	"animals": [
		{
			"visual": "UK 9 490918 2760 1"
		},
		{
			"visual": "UK 9 490918 2766 7"
		}
	]
}

For more information about submitting Transactions see Submitting transactions.