Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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).
  • Contact location is the last location the animal was linked to, so for outgoing animals such as adopted animals this would be the shelter they were last in.
  • Intake region is the location the pet was most recently brought into (if an animal came into the shelter multiple times).
  • SecondarySpecies is null when either the pet is a purebred, or the secondary breed is unknown.
  • If a date is 1/1/1900 it means no date has been entered (this is the database default).
  • Spay / Neuter is not a boolean because it can be either Yes, No, or Unknown.

 

Resources

...

  • .

...

Search

  • All parameters listed are optional
  • ExcludedSearchGroupId and SearchGroupId can be set multiple times
  • Date/Time is in ISO format

...

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

...

...

 

...