Market Interface Specification - ARAMS

voraciousdrabΛογισμικό & κατασκευή λογ/κού

14 Δεκ 2013 (πριν από 3 χρόνια και 8 μήνες)

61 εμφανίσεις



Client Confidential

Commercial in Confidence













SouthWestern

Interface

Specification

For

Market

Movement

Web Services








Project Title:





Market

Movement

Webservices







Version:






0
.
4

Addendum Created
?:




Effective Date:




01
/
10
/201
3



AMT
-
SYBEX Author


Name:

John Wharry

Position:

Technical Consultant

Date:




AMT
-
SYBEX Reviewer


Name:

Sharon French

Position:

Application

Consultant

Date:


Authorised:

< physical signature only >





SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
2

of
18

Created from template v3.3


CONTENTS:


0.

DOCUMENT CONTROL

................................
................................
................................
...

3

1.

Confidentiality

................................
................................
................................
...............................

3

2.

Change Control

................................
................................
................................
.............................

3

3.

Historical Reference

................................
................................
................................
......................

3

4.

Cross Reference

................................
................................
................................
...........................

3

5.

Distribution

................................
................................
................................
................................
....

3

1.

INTERFACE SPECIFICATION DETAIL

................................
................................
...........

4

1.

Introduction

................................
................................
................................
................................
...

4

2.

Scope

................................
................................
................................
................................
...........

4

3.

Web services

................................
................................
................................
................................

4

1.1.1

MarketMovement Web service

................................
................................
................................
...............

6

4.

Appendix 1

................................
................................
................................
................................
..

16








SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
3

of
18

Created from template v3.3


0.

DOCUMENT CONTROL

1.

Confidentiality

This document must be treated as confidential. This
document can only be used and copied within the
client company for use in relation to the intended activity. However, no copies can be forwarded to
any person who is not an employee or agent of the client without the prior written approval of AMT
-
SYBEX and

after having received a signed non
-
disclosure agreement from any such person or agent.
The methodology or format used to derive this document is owned by AMT
-
SYBEX.

2.

Change Control

This document is the responsibility of the Project Leader. It is subject
to formal change control after
the initial approved release (i.e. issue no. 1.0). Requests for change
must

be communicated to the
Project Leader in writing. Agreed changes are recorded in the Historical Reference Section of the
document.

3.

Historical Refe
rence


Issue
No.

Date


Author

Status

Issue:

0.1


2
4
S
e
p
13

J Wharry

1
st

Draft

Changes:

N/A

Issue:

0.2

25Sep13

J Wharry

2
nd

Draft

Changes:

Changes made after internal review

Issue:

0.3 01Oct13 J Wharry 3
rd

Draft

Changes:

Changes based on SouthWestern review. Additional values added to Enums

Issue:

0.4 17Oct13 J Wharry 4
th

Draft

Changes:

Changes to the Message response and subsequent WSDL definition

4.

Cross Reference

Abbreviations

Used/Terms of Reference

I
S:

Interface

Specification.

AMLS: Animal Movement Licensing System

DEFRA: Department for Environment, Food and Rural Affairs

5.

Distribution

Controlled copies of this FS will be distributed to each of the people specified below. Thes
e copies will
be reissued whenever changes are made to the master document.

Title

Person

Copy#

Technical Project
manager

Stephen Wilson

1

Application Consultant

Sharon French

1

Project Manager

Colm Lehane

1

Principal Solutions
Architect

Caitriona Barry

1








SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
4

of
18

Created from template v3.3


1.

INTERFACE

SPECIFICATION DETAIL

1.

Introduction


This document describes and specifies
the

Web Service interface
s

to
APHIS ENGLAND

application
. The interface
s

are designed for
Market

software providers to

enable their software to

submit

movement data

and retrieve movement information.
The interface
s

will
allow the client
to do
the following:





Verify that a movement for Sheep, Goats and Deer is valid



Submit completed movements for Sheep, Goats and Deer



Update previously completed movement for Sheep,
Goats and Deer




Cancel previously completed movement for Sheep, Goats and Deer



2.

Scope


The overall purpose of the document is to specify the interface
s

and

their

expected behaviour

and

list

the
error or warning conditions that may occur.


The document is

a
developer’s

guide to the service

and its functions
. It does not
provide

details on
how to
implement

this within

a client application
.

3.

Web

service
s


The
Market

Clients will be provided with
a Web Service




Market
Movements



When calling
th
is

Web service
, security information must be provided in the SOAP Header of the
request
.

T
hese credentials will be provided to a client when they sign up to use the service.

The Username and Password will be used to validate and identify the specific
Market
on the APHIS

England application.

The soap header should look

as follows:

<soapenv:Header>



<wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="
http://docs.oasis
-
o
pen.org/wss/2004/01/oasis
-
200401
-
wss
-
wssecurity
-
secext
-
1.0.xsd
">



<wsse:UsernameToken wsu:Id="UsernameToken
-
15426812" xmlns:wsu="
http://docs.oasis
-
op
en.org/wss/2004/01/oasis
-
200401
-
wss
-
wssecurity
-
utility
-
1.0.xsd
">



<wsse:Username>
MarketUserName
t</wsse:Username>



<wsse:Password Type="
http://docs.oasis
-
open.org/wss/2004/01/oasis
-
200401
-
wss
-
username
-
token
-
profile
-
1.0#PasswordText
">
MarketPassword
</wsse:Password>






</wsse:UsernameToken>



</wsse:Security>



</soapenv:Header>



The provided credentials
should be

used within the Security element of the SOAP Header.





SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
5

of
18

Created from template v3.3


The secure HTTPS transport protocol is used to invoke the Web Service. Neither the request

header nor the body are encrypted.

If a service request message cannot be processed (e.g. invalid message format, internal system
error), then a technical fault will be returned within a SOAP fault response.


When processing fails and the Response messa
ge cannot be populated, a SOAP Fault message
is returned. The format of the SOAP Fault is as follows:

<?xml version="1.0" encoding="UTF
-
8"?>


<
soap:Envelope

xmlns:soap
="
http://www.w3.org/2003/05/soap
-
envelope
"

xmlns:xsi
="
http://www.w3.org/2001/XMLSchema
-
instance
"

xsi:schemaLocation
="
http://www.w3.org/2003/05/soap
-
envelope soap
-
envelope.xsd
">


<
soap:Body
>



<
soap:Fault
>




<
soap:Code
>





<
soap:Value
>
soap:Sender
</
soap:Value
>





<
soap:Subcode
>






<
soap:Value
>
error code
</
s
oap:Value
>





</
soap:Subcode
>




</
soap:Code
>




<
soap:Reason
>





<
soap:Text

xml:lang
="
en
">
error text
</
soap:Text
>




</
soap:Reason
>




<
soap:Detail
>





<any...>




</
soap:Detail
>



</
soap:Fault
>


</
soap:Body
>

</
soap:Envelope
>










SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
6

of
18

Created from template v3.3



1.1.1

Market
Movement

Web

service



The
web service provided to carry out these tasks which will function in
four

Action Types
: New,
Amend, Cancel

and

Verify

.




The
Action Type

“New” will be used to upload
new

on or off
movements to APHIS England.



The
Action Type

“Amend” will
allow movements, previously uploaded by the market, to be
amended. Moves uploaded in the previous X days (where X is a parameter set by the bureau
under instruction from DEFRA) can be amended.



The
Action Type

“Cancel” will allow movements, previously uplo
aded in the previous X days by
the market to be cancelled.



“Verify” will allow markets to validate a movement before it is uploaded. It is recommended that
the web service is called in “Verify” mode to validate the movement detail so when the actual
mov
ements are uploaded,
the corrected data will pass validation
. Therefore making use of the
Verify facility will allow the opportunity for any issues to be resolved earlier in the process.


This web service will be available throughout the day and evening

to allow the Market to submit the
movements. We would recommend using the Verify Action Type first to ensure the movements are
correct or to allow time to rectify any errors or warnings returned. We would also recommend
sending the movements throughout th
e day e.g the On to the Market could be created shortly after
the animals arrive at the Market.



The following sections define the structures of the all the Web service requests and responses.


Note: All Enum definitions are
described
in full in
Appendix 1




SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
7

of
18

Created from template v3.3


1.1.1.1

Market
Request Definition


Field

Mandatory

Type

Description

Market
Movements Level 1 ( Mandatory 1
-
1)

SoftwareSupplierID

Y

VarChar(35)

This is the
Software

Supplier Id

ActionType

Y

Enum:

New,

Amend, Cancel, Verify

The Action type to carry out

DateTimeStamp

Y

DateTime

The date time the webservice is called

Species

Y

Enum: Sheep, Goat, Deer

The Species of the move

MarketActivity

Y

Enum: Red, Green

The Markets activity for this move.

Red for Slaughter Market

Green for
Store Market

Movements Level 2 Mandatory 1

OnMovementDetail Level 3 Mandatory 1
-

many

OperatorName

N

VarChar(35)

Back Office Operator Identifier

SupplierMovementId

Y

Number

The
Markets
Suppliers unique id for the
On
move
. Please
note: it is presumed that this id
is unique for the On move
and the Off move

APHISEnglandMovementId

N

Number

The Aphis England Unique Id for the move. Not required for
New or Verify Action type Moves. Mandatory for Amend and
Cancel

KeeperDetail Level 4 Mandatory 1
-
1

CPH

Y

VarChar(35)

The CPH of the Departure Keeper bring
ing

the Animals to the
Market

Title

N

VarChar(35)

Departure keepers Title

Initials

N

VarChar(35)

Departure keepers Initials

FirstName

Y

VarChar(35)

Departure keepers First Name

Surname

Y

VarChar(35)

Departure
keepers Surname

Address1

Y

VarChar(200)

Departure keepers Address 1

Address2

N

VarChar(200)

Departure keepers Address 2

Address3

N

VarChar(200)

Departure keepers Address 3

TelNo

N

VarChar(35)

Departure keepers Tel No





SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
8

of
18

Created from template v3.3


PostCode

Y

VarChar(10)

Departure keepers PostCode

MovementDetail Level 4 Mandatory 1
-
1

TotalNoAnimals

Y

Number

The Total Number of animals moved to the Market on this
move

OnExemptionCode

N

Enum: 199, 210 etc

The On
Exemption

Code
The codes are explained in

Appendix
1

OffExemptionCode

N

Enum: 199, 210 etc

The Off
Exemption

Code

The codes are explained in

Appendix 1

DepartureDate

Y

Date

The Departure date of the Animals from the Departure
Keepers premise

LoadingDate

N

Date

The Loading Date of the Animals from the Departure Keepers
premise

TimeFirstLoaded

N

Time

The time the first
animal was loaded from the Departure
Keepers premise

DepartureTime

N

Time

The Departure time of the Animals from the Departure
Keepers premise

ExpectedJourneyDuration

N

VarChar(10)

The
Expected Journey Duration

from the Departure Keepers
premise

UsingCPRC

Y

Enum: Y, N

Y if Keeper has requested the Market to act a s a CPRC
otherwise N

Arrival
Detail

Level 4

Mandatory 1
-
1

ArrivalDate

Y

Date

The arrival date of the Animals at the Market

UnloadingDate

N

Date

The unloading date of the Animals at
the Market

TimeLastAnimalUnloaded

N

Time

The time the last animal was unloaded at the Market

NumberAnimalsReceived

N

Number

The number of Animals received at the Market

BatchMovementDetail Level 4 Optional 0
-
Many

FlockMark

N

VarChar(20)

The Flock mark
of the batch of animals

Description

N

VarChar(20)

A description of the Batch of animals


deer only

NoAnimalsInBatch

Y

Number

Number of Animals in the Batch

IndividualMovements Level 4 Optional 0
-
Many

TagNumber

N

VarChar(25)

The unique tag identifier
of the animal moved

FCIInfo Level 4 Optional 0
-
1

FCISatisfied

N

Enum Y or N

Y if the FCI Satisfied check box is ticked on the AML form. N
if the Not FCI Satisfied check box is ticked





SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
9

of
18

Created from template v3.3


DiseaseOrDiagnosis

N

VarChar(1000)

Details from the AML form

WithdrawalPeriods

N

VarChar(1000)

Details from the AML form

HoldingRestrictionsInfo

N

VarChar(1000)

Details from the AML form

AnimalTags Level 5 Optional 0
-
Many

TagNumber

N

VarChar(25)

Each Individual Tag identified on the FCI section of the AML
form

HaulierInfo Level 4 Optional 0
-
1

WhoTransportedAnimals

Y

Enum: DK, RK, H

Who transported the Animals to the destination. DK for the
Departure Keeper, RK for the Receiving Keeper or H for
Haulier

VehicleReg

N

VarChar(10)

The Vehicles Registration as
detailed on the AML form

DateVehicleLastCleansed

N

Date

Date the vehicle was last cleansed as detailed on the AML
form

PlaceVehicleCleansed

N

VarChar(100)

Place the vehicle was last cleansed as detailed on the AML
form

HaulageCompany

N

VarChar(200)

Name of the haulage company as detailed on the AML form

TransporterAuthNo

N

VarChar(300)

Transporter Authorisation Number as detailed on the AML
form

TransporterPermitNo

N

VarChar(300)

Transporter Permit number as detailed on the AML form

AssuredSchemeNo

N

VarChar(300)

The Assured Scheme Number as detailed on the AML form

HauliersName

N

VarChar(30)

The hauliers name as detailed on the AML form

HauliersPhoneNo

N

VarChar(35)

The hauliers phone number as detailed on the AML form

OffMovementDetail Level 3 Mandatory 1
-

many

OperatorName

N

VarChar(35)

Back Office Operator Identifier

SupplierMovementId

Y

Number

The Suppliers unique id for the
OFF
move
. Please note: it is
presumed that this id is unique for the On move and the Off
move.

APHISEnglandMovementId

N

Number

The Aphis England Unique Id for the move. Not required for
New or Verify Action types Moves. Mandatory for Amend and
Cancel

KeeperDetail
Level
4
Mandatory
1
-
1

CPH

Y

VarChar(35)

The CPH of the
Destination

Keeper the Animals
are moving
to.

Title

N

VarChar(35)

Destination

keepers Title





SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
10

of
18

Created from template v3.3


Initials

N

VarChar(35)

Destination

keepers Initials

FirstName

Y

VarChar(35)

Destination

keepers First Name

Surname

Y

VarChar(35)

Destination

keepers Surname

Address1

Y

VarChar(200)

Destination

keepers Address 1

Address2

N

VarChar(200)

Destination

keepers Address 2

Address3

N

VarChar(200)

Destination

keepers Address 3

TelNo

N

VarChar(35)

Destination

keepers Tel No

PostCode

Y

VarChar(10)

Destination

keepers PostCode

MovementDetail

Level
4 Mandatory 1
-
1

TotalNoAnimals

Y

Number

The Total Number of animals moved
from

the Market on this
move

OnExemptionCode

N

Enum: 199, 210 etc

T
he On
Exemption

Code (The codes are explained in
appendix )

OffExemptionCode

N

Enum: 199, 210 etc

The Off
Exemption

Code (The codes are explained in
appendix )

DepartureDate

Y

Date

The Departure date of the Animals from the
Market

LoadingDate

N

Date

The Loading Date of the Animals from the
Market

TimeFirstLoaded

N

Time

The time the first animal was loaded from the
Market

DepartureTime

N

Time

The Departure time of the Animals from the
Market

ExpectedJourneyDuration

N

VarChar(10)

The
Expected Journey

Duration

from the
Market

UsingCPRC

Y

Enum: Y, N

Y if Keeper has requested the Market to act a s a CPRC
otherwise N

BatchMovementDetail Level 4 Optional 0
-
Many

FlockMark

N

VarChar(20)

The Flock mark of the batch of animals

Description

N

VarChar(20)

A
description of the Batch of animals


deer only

NoAnimalsInBatch

Y

Number

Number of Animals in the Batch

IndividualMovements Level 4 Optional 0
-
Many

TagNumber

N

VarChar(25)

The unique tag identifier of the animal moved

FCIInfo Level 4 Optional 0
-
1

FCISatisfied

N


Y if the FCI Satisfied check box is ticked on the AML form. N
if the Not FCI Satisfied check box is ticked

DiseaseOrDiagnosis

N

VarChar(1000)

Details from the AML form

WithdrawalPeriods

N

VarChar(1000)

Details from the AML form

HoldingRestrictionsInfo

N

VarChar(1000)

Details from the AML form





SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
11

of
18

Created from template v3.3


AnimalTags Level 5 Optional 0
-
Many

TagNumber

N

VarChar(25)

Each Individual Tag identified on the FCI section of the AML
form

HaulierInfo Level 4 Optional 0
-
1

WhoTransportedAnimals

Y

Enum: DK, RK, H

Who transported the Animals to the receiving keeper/abattoir.
DK for the Departure Keeper, RK for the Receiving Keeper or
H for Haulier

VehicleReg

N

VarChar(10)

The Vehicles Registration as detailed on the AML form

DateVehicleLastCleansed

N

Date

Date the vehicle was last cleansed as detailed on the AML
form

PlaceVehicleCleansed

N

VarChar(100)

Place the vehicle was last cleansed as detailed on the AML
form

HaulageCompany

N

VarChar(200)

Name of the haulage company as detailed on the AML form

TransporterAuthNo

N

VarChar(300)

Transporter Authorisation Number as detailed on the AML
form

TransporterPermitNo

N

VarChar(300)

Transporter Permit number as detailed on the AML form

AssuredSchemeNo

N

VarChar(300)

The Assured Scheme Number as detailed on the AML form

HauliersName

N

VarChar(30)

The hauliers name as detailed on the AML form

HauliersPhoneNo

N

VarChar(35)

The hauliers phone number as detailed on the AML form








SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
12

of
18

Created from template v3.3




1.1.1.2

Market
Movement Response
Definition



This section describes
the
Response

returned
.

If a request call has been successfully received and processed, but the content of the message has violated some validation r
ules a successful SOAP
response will be returned

with warnings and errors within the following structure


Field

Mandatory

Type

Description

MarketMovementsResults

Level 1 ( Mandatory 1
-
1
)

RequestId

Y

Number

This is a unique id to identify the Request/Response. This should be used
when raising any
support calls with 1st line support

Success

Y

Enum (0
-
1)

This field will identify if the
full
request has been successful. 1 = Success and
0 = Failure. If a failure the error details will be provided
below

ErrorCode

N

Number

The Error code to identify the error

ErrorDescription

N

VarChar(255)

The full error description

MarketMovementsResult

Level
2

(
Optional

1
-
Many
)

SupplierMovementId

N

Number

This is the
Supplier Movement ID supplied in the Request to identify the
movement on the back office system

APHISEnglandMovementId

N

Number

This is the unique Movement Id assigned to the movement within the APHIS
England application not populated when called with an ActionType of Verify

Success

Y

Enum (0
-
1)

This field will identify if the
specific movement

has been successful. 1 =
Success and 0 = Failure. If a failure the error details will be provided in the
Error section

Errors

Level
3

(
Optional

0
-
Many
)

ErrorCode

Y

Number

The Error code to identify the
specific movement
error see section

ErrorDescription

Y

VarChar(255)

The full error description

AnimalTags

Level
4

(
Optional

0
-
Many
)

TagNumber

N

VarChar(25)

This will contain any Tag numbers related to the error





SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
13

of
18

Created from template v3.3


Warnings

Level
3

(
Optional

0
-
Many
)

WarningCode

Y

Number

The code to identify the warning see section
1.1.1.4


WarningDescription

Y

VarChar(255)

The full warning description

AnimalTags

Level
4

(
Optional

0
-
Many
)

TagNumber

N

VarChar(25)

This will contain any Tag numbers related to the Warning




1.1.1.3

WSDL

This section presents the Web Services Definition Language interface for th
e

service




1.1.1.4

Error/Warnings


The Web services will carry out validation on the inbound request before any further processing takes place. All Validation
rules will
be carried out before any further process
ing

occurs.
Once the validation rules have completed i
f
there are any

e
rror
s

no further
process
ing will occur and
all errors and warnings will be returned in the response message.

The Markets will be expe
cted to rectify any
errors and submit the movement using the New Action Type to ensure the movement is stored on the APHIS England system.

If no
errors have occurred
,

the
data from the request will be store
d

in

the APHIS England database and
any
warnings

found
will be returned
in the response.
It will be expected that the Markets should rectify any warnings returned by calling the Amend Action Type for this
movement


Error/
Warning

Error/

Warning Code

Error/Warning Message

Additional information

E

2001

Departure and Destination CPH cannot be the same


E

2002

TagNumber does not exist on ETAS or is not a valid EU tag

All individually identified tags will be validated to




SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
14

of
18

Created from template v3.3


format

ensure they are valid

E

2003

T
o
o many transaction
s

in request

The application
will only allow a total of x
OnMovementDetails and OffMovementDetails in any
one request

E

2005

Cannot cancel movement after this length of time

The System will only allow the Abattoir to Cancel a
move within x days. This will be defined by
AHVLA
.

E

2006

Aphis England Movement Id is unknown.

This will occur if the movement id is not recognised
when using any of the following ActionTypes



Amend



Cancel



Confirm

E

3000

System access has been revoked

An administrator has revoked access to the
database acr
oss the system

E

3001

Username and/or password is invalid

Username is unknown, or password is invalid

E

3002

User does not have access

User’s access has been revoked by an administrator;
they have entered an incorrect password 3 times in
succession or
they are trying to log
-
in outside of the
“StartDate” and “EndDate” set up by an administrator
for that user code.

W

2501

CPH field is not a recognised Sheep, Goats or Deer Premise


W

2502

Departure
CPH does not match the following format
NN/NNN/NNN


W

2503

Departure Date is greater than Arrival Date


W

2504

Arrival date is in the future


W

2505

Difference between the Arrival date and departure date is to
o

far
apart


This is currently defined as 1 day

W

2507

Destination CPH does not match the following format
NN/NNN/NNN


W

2508

TotalNoAnimals must be greater than zero


W

2509

TotalNoAnimals is too large

This is currently defined as a max of
99,999

W

2510

TotalNoAnimals
does not
matches the no. of
animals/batches in
the movement


W

2511

Loading
date
after before departure date


W

2512

Unloading date before arrival

date






SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
15

of
18

Created from template v3.3


W

2513

NumberAnimalsReceived (if populated) <> TotalNoAnimals


W

2514

AnimalsTags in FCI Info must be in AnimalTags in
IndividualMovements


W

2515

DateVehicleLastCleansed in the future


W

2516

Arrival date is not reasonable

Arrival date must not be more than
233 Days in the
Past









SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
16

of
18

Created from template v3.3


4.

Appendix 1


E
num Definitions


Enum

Values

Description

Species

Sheep



Goats



Deer





OffExemptionCode

0

No On Exemption Declare for movement


101

Foster Lambs

on Movement or Foster Kids on Movement


102

Animals moving from tack


154

Moving from sheep dog trials back to premises of origin


168

Moving to show and no animals have moved onto the holding
since the animals last visited a show


169

Moving to show and no animals have moved onto the holding since the animals
last visited a show


173

Returning to their correct home after being
inadvertently rounded
up from common land


185

Moving to a slaughter market/collecting centre, from where, the
only move is to slaughter


187

Animals moved for performance/exhibition purposes and a permit has been
issued for the move.


195

Declaration
for sheep/goats returning home from an AI centre received and
they have been placed in Defra Approved Isolation


197

Movement of Breeding Rams or Bulls, move takes place between August 1st
and November 30th they are isolated upon arrival and a breeding de
claration
has been received from the recipient


198

Rams or bulls intended for breeding moving to market between Aug 1 and Nov
30, animals isolated and a declaration received from the sender


199

Rams or bulls intended for Breeding returning from a
market. Move takes
place between August 1st and November 30th , animals are isolated upon their
return


200

Movement of breeding goats, isolated prior to their departure and a breeding
declaration has been received from the recipient,




On
Exemption
Code

0

No On Exemption Declare for movement


101

Foster Lambs

on Movement or Foster Kids on Movement


102

Animals moving from tack


169

Moving to show and no animals have moved onto the holding since the animals
last visited a show


173

Returning to
their correct home after being inadvertently rounded
up from common land


187

Animals moved for performance/exhibition purposes and a permit has been
issued for the move.


195

Declaration for sheep/goats returning home from an AI centre received and
they

have been placed in Defra Approved Isolation


197

Movement of Breeding Rams or Bulls, move takes place between August 1st
and November 30th they are isolated upon arrival and a breeding declaration
has been received from the recipient


198

Rams or bulls

intended for breeding moving to market between Aug 1 and Nov
30, animals isolated and a declaration received from the sender


199

Rams or bulls intended for Breeding returning from a market. Move takes




SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
17

of
18

Created from template v3.3


place between August 1st and November 30th , animal
s are isolated upon their
return


200

Movement of breeding goats, isolated prior to their departure and a breeding
declaration has been received from the recipient,




UsingCPRC

Y

Use if CPRC has been requested


N

Use if CPRC has not been requested




WhoTransportedAnimals

DK

Use if the Departure Keeper transported the Animals


RK

Use if the Receiving Keeper transported the Animals


H

Use if a Haulier transported the Animals




ActionType

New

Use if submitting a new movement to APHIS England


Amend

Use if Amending a previously created move on APHIS England


Cancel

Use if Cancelling a previously Created move on APHIS England


Verify

Use to Verify if a Movement will pass the APHIS England
validation




MarketActivity

Red

Use this to indicate
the market is working as a Slaughter Market


Green

Use this to indicate the market is working as a Store Market




FCISatisfied

Y

Use if the question on AML1 form “
All the animals in the
consignment satisfy the FCI requirements
” is ticked


N

Use if

the question on AML1 form “The FCI statements are not
satisfied for all the animals in the consignment and additional
information is provided on the reverse of the pick copy or on an
attached document” is ticked









Electronic Tag Identification Va
lidation


The following checks
will be

applied

by the APHIS England application

on individual animal tag
identification reported with the movement details:




Must not be blank



Number of individual tags recorded must match the total number of animals
recorded.



Tag IDs can be of the following format

UK 0 244200 00100

Where 244200 is the 6 digit flock mark (flock number)

00100 is the five digit animal number.

UK is an animal that has a UK issued tag (may have been born outside the state but has been
reta
gged with a UK tag.)



Animals from EU member states may retain the tag of their original destination, unless the tags are
lost in which case they will be reissued with a new UK allocated replacement tag.



Check if tag exists in ETAS extract





SouthWestern


IS for

Market Movement submission



Client Confidential

C:
\
PROGRAM FILES
\
NEEVIA.COM
\
DOCCONVERTERPRO
\
TEMP
\
NVDC
\
C18F489C
-
2839
-
49A8
-
9402
-
17EB20B51FBF
\
VORACIOUSDRAB_45DEF
712
-
F0ED
-
4261
-
8ED9
-
E914548C1A12.DOCX

© Copyright AMT
-
SYBEX 2011
-

All rights reserved.

Commercial in Confidence

Page
18

of
18

Created from template v3.3




If tag does not
exist in ETAS, check that first two or three characters match the two
-
letter country
code or three
-
digit country code listed below to indicate animal originated in an EU member state



Tags from outside the EU should be tagged with a UK tag on import


Count
ry

Two
-
letter
Country Code

Three
-
digit

country code

Austria

AT

040

Belgium

BE

056

Denmark

DK

208

Finland

FI

246

France

FR

250

Germany

DE

276

Greece

EL

300

Ireland

IE

372

Italy

IT

380

Luxembourg

LU

442

Netherlands

NL

528

Portugal

PT

620

Spain

ES

724

Sweden

SE

752

United
Kingdom

UK

826