View on GitHub

easitrace

« Back to Contents

Movement Services | SCOT-MOVES

SCOT-MOVES is the Movement Service for Cattle and Sheep in Scotland.

Overview

This document covers primarily the functions available through Easitrace for SCOT-MOVES.
These include, but are not limited to:

Sections

Additional Holdings Movements

Get Additional Holdings

Results for this transaction can be obrained via GET /api/properties/{id}/transactions/{transactionId}/historical API. It will return array of transactions each representing a single holding with details in a fields property. Each such transaction is linked to the original via parentTransactionId field. In order to record a get additional holdings there are no fields need to be provided.

Example Transaction:

{
  "reference": "SCOTMOVES-HOLDING",
  "transactionDate": "2019-08-13T21:30:00Z",
  "type": "GET-ADDTNL-HOLDINGS",
  "speciesCode": "C",
  "propertyIdentifier": "89/677/0009",
  "fields": {},
  "animals": [],
  "untaggedAnimals": []
}

Once transaction succeeded the results can be queried by providing transaction id to GET /api/properties/{id}/transactions/{transactionId}/historical API.

For more information about submitting Transactions see Submitting transactions.

Register animals

In order to record a animal registration the following fields are required by SCOT-MOVES:

for each animal visual, breedCode, birthDate, sexCode and field UserReference (animal alias) are required.

The following fields are optional:

Example Transaction:

{
  "reference": "SCOTMOVES-REGISTER",
  "transactionDate": "2019-08-13T21:30:00Z",
  "type": "REG",
  "serviceTag": "SCOT-MOVES",
  "speciesCode": "C",
  "propertyIdentifier": "89/677/0009",
  "fields": {
    "Register.BirthPropertyIdentifier": "89/677/0009",
    "Register.BirthPropertyPostalIdentifier": "89/677/0009"
  },
  "animals": [
    {
      "visual": "543210123458",
			"damofficialid": "543210123058",
			"sireofficialid": "543210123158",
      "breedCode": "AA",
      "birthDate": "2020-07-22T22:27:08.712Z",
      "sexCode": "M",
      "fields": {
        "UserReference": "Calf 1"
      }
    },
    {
      "visual": "543210123459",
			"damofficialid": "543210123058",
			"sireofficialid": "543210123158",
      "breedCode": "AA",
      "birthDate": "2020-07-22T22:27:08.712Z",
      "sexCode": "M",
      "fields": {
        "UserReference": "Calf 2"
      }
    }
  ],
  "untaggedAnimals": []
}

For more information about submitting Transactions see Submitting transactions.

Movements

Movements Off

In order to record a movement on the following fields are required by Scot-Moves:

The following fields are optional and allow to move from/to sub-holdings:

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:

{
	"transactionDate": "2020-08-29T22:27:08.712Z",
	"type": "MOV-OFF",
	"speciesCode": "C",
	"servicetag": "SCOT-MOVES",
	"propertyIdentifier": "89/677/0009",
	"fields": {
		"Departure.Identifier": "89/677/0009",
		"Destination.Identifier": "84/567/0037"
	},
	"animals": [
		{
			"visual": "5432101234601"
		},
		{
			"visual": "5432101234602"
		}
	],
	"untaggedAnimals": [
	]
}

For more information about submitting Transactions see Submitting transactions.

Movements On

In order to record a movement on the following fields are required by Scot-Moves:

The following fields are optional and allow to move from/to sub-holdings:

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:

{
	"transactionDate": "2020-08-29T22:27:08.712Z",
	"type": "MOV-ON",
	"speciesCode": "C",
	"servicetag": "SCOT-MOVES",
	"propertyIdentifier": "84/567/0037",
	"fields": {
		"Departure.Identifier": "89/677/0009",
		"Destination.Identifier": "84/567/0037"
	},
	"animals": [
		{
			"visual": "5432101234601"
		},
		{
			"visual": "5432101234602"
		}
	],
	"untaggedAnimals": [
	]
}

For more information about submitting Transactions see Submitting transactions.

Record animal death

In order to record an animal death the following fields are required by Scot-Moves:

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:

{
	"transactionDate": "2020-07-22T22:27:08.712Z",
	"type": "DTH",
	"speciesCode": "C",
	"servicetag": "SCOT-MOVES",
	"propertyIdentifier": "89/677/0009",
	"fields": {
		"Death.Location": "89/677/0009",
		"Death.Date": "2020-08-22"
	},
	"animals": [
		{
			"visual": "UK100015401645"
		},
		{
			"visual": "UK100015501619"
		}
	],
	"untaggedAnimals": [
	]
}

For more information about submitting Transactions see Submitting transactions.