Ndr interface Dependency Agreement

9.Reference Documents

Ref	Name Version Date	Version	Date	Link
1	Business Requirements Document	0.1	April 2011	http://grvwiki.onconfluence.com/download/attachments/2032710/GA+Business+Requirements+Document.docx
2	Functional Solution Document	0.6	June 2011	http://grvwiki.onconfluence.com/download/attachments/2032714/GA+-+Functional+Solution+Document+v0.5.docx
3	Architecture Design	1.0	May 2011	http://grvwiki.onconfluence.com/download/attachments/2032712/GA+Portal+and+NDR+Architecture+Design+v1.0.docx
4	Minutes of User Group Workshop, 20 July 2011		July 2011

10.Appendix: Use of ETags

The following tables provide further detail of the use of ETags, as introduced in Section 5.4.

Method	Condition	Result	Request		Response
			Header	Body	Status Code	Header	Body
GET	If ETag included in request AND ETag is up-to-date.	No Entity is returned, as client is already up-to-date.	Includes a line of the form: “If-None-Matches: ” where is up-to-date.	Empty	304 Not Modified	(Does not include ETag)	Empty
GET	ETag not included in request	Latest Entity is returned.	(Does not include ETag)	Empty	200 OK	Includes the ETag, in a line of the form: “ETag: ”	The requested Entity
GET	ETag is included in request, but is not up-to-date	Latest Entity is returned.	Includes a line of the form: “If-None-Matches: ” where is NOT up-to-date.	Empty	200 OK	Includes the ETag, in a line of the form: “ETag: ”	The requested Entity

Method	Condition	Result	Request		Response
			Header	Body	Status Code	Header	Body
POST	If ETag included in request AND ETag is up-to-date.	NDR accepts updated Entity.	Includes a line of the form: “If-Match: ” where is up-to-date.	An Entity	201 Created	Includes a new ETag, corresponding to the updated Entity, in a line of the form: “ETag: ”	Empty
POST	ETag not included in request	NDR rejects updated Entity, as the client did not specify the latest ETag.	(Does not include ETag)	An Entity	412 Precondition Failed	(Does not include ETag)	Empty
POST	ETag is included in request, but is not up-to-date	NDR rejects updated Entity, as the client was not up-to-date.	Includes a line of the form: “If-Match: ” where is NOT up-to-date.	An Entity	412 Precondition Failed	(Does not include ETag)	Empty

11.

12.Appendix: Description of Attributes

The following tables provide a general description of the attributes of the Entities described in Section 4.1.

Note that the precise definition of each attribute, including the full list of permissible values, is provided in the relevant schema (included in Section 5.5).

12.1.Attributes of Dogs

Entity
Dog
Attribute	Sub Attribute	Description
Authority		The Owning Authority of the dog.
Earbrand		The earbrand of the dog.
Name		The current name of the dog.
Late name		The previous name of the dog (set when the dog is renamed).
Name reused from		This date is set if another dog has been assigned the dog’s name. This can occur once the dog is e.g. more than 15 years old. In some State Body Systems, the dog’s name may be displayed with the suffix “(OLD)” to reflect the fact that the name has been re-used.
Color		The markings of the dog.
Sex		The sex of the dog.
Microchip 1		The primary microchip of the dog.
Microchip 2		The secondary microchip of the dog.
Whelped date		The date when the dog was whelped.
Certificate no		The certificate number of the dog.
Cleared to race date		The date the dog was first cleared to race.
Registration date		The date the dog was first registered.
Dna no		The DNA signature of the dog.
Lifestate		Indicates whether the dog is active, racing, retired or deceased.
Stud Sire Flag		Indicates whether the dog is a stud sire.
Owner
	Name	The name of the owner of the dog OR “UNKNOWNINTERNATIONALPERSON” if the flag UnknownInternationalParty is set to true
	Unknown InternationalParty	May be set to true. A null value implies false.
	From date	The date that the owner commenced owning the dog.
Trainer
	Name	The name of the trainer of the dog.
	From date	The date that the trainer commenced training the dog.
Previous Owner
	Name	The name of the owner of the dog.
	From date	The date that the owner commenced owning the dog.
	To date	The date that the owner ceased owning the dog.
Previous Trainer
	Name	The name of the trainer of the dog.
	From date	The date that the trainer commenced training the dog.
	To date	The date that the owner ceased training the dog.
Authority to Breed
	Name	The name of the individual who has been given authority to breed the dog.
	From date	The date that the authority to breed was granted.
Penalty		A dog may or may not have a Dog Penalty. A Dog Penalty may or may not have one or more Penalty Clearances. A Dog Penalty may require a trial to be completed,
	Authority	The authority which applied the penalty.
	Dog Penalty Code	The code that specifies the penalty.
	Commencement date	The date the penalty commences.
	Expiration date	Optional. The date the penalty expires. This will be populated if the penalty is a fixed number of days, commencing at the commencement date and expiring at the expiration date.
	Trial required (Type)	Optional. Indicates whether a trial is required to clear the penalty, and specifies which track the trial must be performed it.
	Penalty Clearance (Type)	Optional. Provides details relating to the clearance of the penalty, including the authority which cleared the penalty, the date, and the result of satisfactory trial (if a satisfactory trial was required).
Race
	Race no	The race number.
	Race title	The race title.
	Track	The track where the race was held.
	Date	The date of the race.
	Distance	The distance of the race.
Trial	Dog Trial (Type)	Trials may or may not be associated with Dog Penalties There may be one or more Dog Trial for a single Dog Penalty. A Dog Penalty may require a trial to be completed, Dog trials are recorded against the dog, not the Penalty.
Dam Registration	state	State in which the registration is made
	registrationDate	Date when the registration is made
	Exemptions	There may be one or more exemptions
Vaccinations	state
	date
	Vaccination Type