Animals /api/animals

This set of resources is used to expose the animals.

Data Guidance

PhysicalLocation is null when the pet is not in the shelter (ie. not in care).
SecondarySpecies is null when either the pet is a purebred, or the secondary breed is unknown.

Resources

URI Description

Method

Relative URI

Return Type

Get by ID.

Get

/api/v{version}/animals/{id}

Single: Animal

Search

all parameters listed are optional)
- ExcludedSearchGroupID and SearchGroupId can be set multiple timesth

Get

/api/v{version}/animals?RegionId={id}&BreedId={id}&ClassId={id}&ExcludedSearchGroupID={id}&SearchGroupId={id}&TypeId={id}&UpdatedSince={dateTime}&

Multiple animals with pagination

Get by person ID

Get

/api/v{version}/animals?personId={id}

Multiple animals with pagination

Sample Json

{  
   "Age":{  
      "IsApproximate":false,
      "Months":8,
      "Weeks":2,
      "Years":3
   },
   "Behaviour":{  
      "IsGoodWithCats":false,
      "IsGoodWithDogs":false,
      "IsGoodWithKids":true,
      "IsHouseTrained":false
   },
   "Breed":{  
      "Primary":{  
         "Name":"Dachshund",
         "Uri":"/api/v1/animalbreeds/103",
         "Id":103
      },
      "Secondary":null,
      "PrimarySpecies":{  
         "Uri":"/api/v1/animalspecies/88",
         "Id":88
      },
      "SecondarySpecies":null
   },
   "Features":{  
      "CoatLength":null,
      "PrimaryColour":"Black",
      "SecondaryColour":"Tan"
   },
   "Identification":{  
      "HasMicrochip":true,
      "PrimaryMicrochipNumber":"90001200015648",
      "SecondaryMicrochipNumber":null
   },
   "Medical":{  
      "HasSpecialNeeds":false,
      "IsDeclawed":false,
      "IsVaccinated":true,
      "SpayedNeutered":"Yes"
   },
   "Found":{  
      "Date":"2009-11-03T14:00:00Z",
      "Location":"Wishart, QLD, 4122, Australia"
   },
   "Intake":{  
      "Date":"2009-11-03T23:13:00Z",
      "Source":{  
         "Description":"Cruelty Case Offspring",
         "Uri":"/api/v1/animalsources/10",
         "Id":10
      },
      "Region":{  
         "Name":"Fairfield",
         "Uri":"/api/v1/regions/4",
         "Id":4
      }
   },
   "Media":{  
      "DefaultPhoto":null,
      "PhotoThumbnailFormat":null,
      "Photos":"/api/v1/animalPhotos?animalId=463388",
      "DefaultVideo":null
   },
   "Id":463388,
   "Name":"Pickles",
   "Type":{  
      "Name":"Dog",
      "Uri":"/api/v1/animaltypes/3",
      "Id":3
   },
   "DateOfBirth":"2009-11-13T14:00:00Z",
   "LastUpdated":"2014-03-06T11:20:03.783Z",
   "Owner":{  
      "Email":"test@test.com",
      "FirstName":"Cameron",
      "LastName":"Priem",
      "Name":"Cameron Priem",
      "Uri":"/api/v1/persons/3789",
      "Id":3789
   },
   "Sex":{  
      "Description":"Male",
      "Id":1
   },
   "PhysicalLocation":null,
   "Size":"Small",
   "Status":{  
      "Description":"Information",
      "Uri":"/api/v1/animalstatuses/45",
      "Id":45
   },
   "Weight":"6.4 ",
   "ContactLocation":{  
      "Name":"Fairfield",
      "Uri":"/api/v1/regions/4",
      "Id":4
   }
}