This set of resources is used to expose the animals.
Data guidance
- Sex is "null" when it's unknown. Desexed is "null" when it's unknown. An animal by have a single Breeds when IsCrossBreed is "true".
- IsVaccinated is "null" when it is unknown
- HadHealthChecked is "null" when it is unknown
- IsWormed is "null" when it is unknown
- HadBehaviourEvaluated is "null" when it is unknown
- DOB will have a date of 1/1/1900 if the DOB is unknown (this is the database default date)
- AdoptionSummary.Generic is a custom value which can be set per public site.
- An example generic description:
Introducing {name}! {NominativeSex} is a {colour} {breed} {animalType} located at our RSPCA {location}. {Name} is very happy to meet you and have you watching over {posessiveSex} this festive season. <a href="{viewPublicSiteUrl}">Please click here</a> to view {name}’s adoptapet profile. (RSPCA Reference Number: AID {shelterbuddyId})
The following fields are able to be used in a generic adoption summary.
Field Example {Name} / {name} Max / max {NominativeSex} / {nominativeSex} She, He, It / she, he, it {PosessiveSex} / {posessiveSex} Her, Him, It / her, him, it {Color} / {Colour} / {Color} / {colour} Blue / blue {Breed} / {breed} Poodle / poodle {AnimalType} / {animalType} Dog / dog {Location} / {location} Noosa / noosa {shelterBuddyId} 999999 {viewPublicSiteUrl} http://adoptapet.com.au/animal/animalDetails.asp?statusId=3animalid=159432
- An example generic description:
Table 5. Animal resources
URI Description | Method | Relative URI |
Get by ID | GET | /api/v{version}/animals/{id} |
Get by Animal Status | GET | /api/v{version}/animals?animalStatusId={id} |
| Get by Animal Status and Shelter | GET | /api/v{version}/animals?animalStatusId={id}&shelterId={id} |
| Get by Animal Status and State ID | GET | /api/v{version}/animals?animalStatusId={id}&stateId={id} |
| Get by Animal Type and State ID | GET | /api/v{version}/animals?animalTypeId={id}&stateId={id} |
| Get by Animal Search Type | GET | /api/v{version}/animals?animalSearchTypeId={id} |
| Get by Animal Search Type and State ID | GET | /api/v{version}/animals?animalSearchTypeId={id}&stateId={id} |
...