Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 6 Next »

This set of resources is used to expose the animal breeds.
 

Data guidance
 

In some cases animals have multiple breeds associated to them. A common known occurrence of this is when a dog breed, such as Poodle, is crossed with another breed, such as Cavalier King Charles Spaniel, ending in the cross breed known as Cavoodle. Because when the animal has multiple breeds there is usual a favouritism of one breed over the other, there is a a special return type for the GET /api/animalBreeds?/animalId={id} resource that allows for such a favouritism to be distinguished. Please refer to Figure 10.
 

Table 9. Animal breed resources

URI Description

Method

Relative URI

Get by ID.

GET

/api/v{version}/animalBreeds/{id}

Get by animal type

GET

/api/v{version}/animalBreeds/?animalTypeId={id}

Get by animal ID

GET

/api/v{version}/animalBreeds/?animalId={id}

 


 

A sample JSON return of an animal breed
{
    "Id": 1,
    "Descriptor": "Budgie"
} 
A sample JSON return of a distinguishing animal breed
 {
    "IsPrimary": true,
    {
        "Id": 1,
        "Descriptor": "Budgie"
    }
}
  • No labels