Animals /api/animals

This set of resources is used to expose the animals.

Data guidance

Id is the public site database animal Id, to reference the ShelterBuddy animal ID use the ShelterBuddyId field.
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)
Shelter is the physical location / region that the animal is located at, while ShelterLocation is the area in the shelter that the pet is located. For example Shelter is "Beverley Hills Shelter", and ShelterLocation is "Dog Adoptions 1"
Kennel identifies the animal's current kennel number or location within a particular ShelterLocation, eg. "Dog Boarding 1, Kennel 7"
AvailableForAdoptionFrom: is the date the animal was made available for adoption. This is from the shelterbuddy field “Date Available From”.
Source > Date is the date the animal came into the shelter.
Age is the animals current age information
Breed contains the animal's breed info.
Collar represents the animal's collar details
DefaultPhoto contains a URI of the animal's default photograph
Photos contains an API reference to the AnimalPhotos controller
Desexed is a nullable boolean value, where null means the desexed status is unknown.
Features contains further details such as tail, ear and coat types, as well as eye and coat colours
Name is the animal's name
Size is an indication of the animal's size
Weight is an indication of the animal's weight
Status represents the animals current status
Type represents the type of animal
EditedOn is the date the animal was last updated.
AddedOn is the date this animal record was first entered.
LostFoundAddress contains address details of the animal's last known location
SearchTypes are the search categories the animal is associated with, eg. Available for adoption, Lost, Found
Bonds contains API references to other animals that this animal has a relationship with
Size is a categorisation of the animal's size
ShelterBuddyStatusDate is the current status date from ShelterBuddy.
YouTubeVideos is an array of YouTube video identifiers which can be appended to a url (eg. www.youtube.com/watch?v={YouTubeVideoId} OR youtu.be/{YouTubeVideoId}
AdoptionSummary.EnteredBase64 and AdoptionSummary.GenericBase64 are base64 encoded UTF8 strings, which contain control characters, such as \r, \n, and \t. These properties are recommend over their non-base64 encoded versions when their use requires formatting be kept, such as when displaying the data on webpage.

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

Table 5. Animal resources

Get resources are ordered by animal ID unless specified otherwise.

URI Description	Method	Relative URI	Notes
Get by ID	GET	/api/v{version}/animals/{id}
Get by Animal Status ID (Deprecated)	GET	/api/v{version}/animals?animalStatusId={id}	Use the resource Get by Animal Search Type
Get by Animal Status ID and Shelter ID (Deprecated)	GET	/api/v{version}/animals?animalStatusId={id}&shelterId={id}	Use the resource Get by Animal Search Type
Get by Animal Status ID and State ID (Deprecated)	GET	/api/v{version}/animals?animalStatusId={id}&stateId={id}	Use the resource Get by Animal Search Type and State ID
Get by Animal Type ID and State ID (Deprecated)	GET	/api/v{version}/animals?animalTypeId={id}&stateId={id}
Get by Animal Search Type ID	GET	/api/v{version}/animals?animalSearchTypeId={id}
Get by Animal Search Type ID and Animal Updated After	GET	/api/v{version}/animals?animalSearchTypeId={id}&animalUpdatedAfter={date-UTC}	Encode date using ISO 8601 format.
Get by Animal Search Type ID and State ID	GET	/api/v{version}/animals?animalSearchTypeId={id}&stateId={id}
Get by Animal Search Type ID, State ID, and Animal Updated After	GET	/api/v{version}/animals?animalSearchTypeId={id}&stateId={id}&animalUpdatedAfter={date-UTC}	Encode date using ISO 8601 format.
Get by Animal Search Type ID Shelter ID State ID Animal Updated After Animal Type ID Can Have No Photo (use this to only get animals that have a photo)	GET	/api/v{version}/animals?animalSearchTypeId={id}&shelterId={id}&stateId={id}&animalTypeId={id}&canHaveNoPhoto=true&animalUpdatedAfter={date-UTC}	Encode date using ISO 8601 format.
Get by ShelterBuddyId	GET	/api/v{version}/animals?shelterBuddyId={id}	Returns paged results as multiple shelter buddy sites can upload to one public site.

A sample JSON return of an animal

{
  "ShelterBuddyStatusDate": "2013-08-10T03:44:00Z",
  "AddedOn": "2007-07-06T14:05:28.217Z",
  "AdoptionCost": 99,
  "AdoptionSummary": {
    "Entered": "Hello my name is Mumbles, I'm a beautiful boy with a big and happy heart I'm looking for love and a forever home.... could you be the one for me? I will suit a happy active home and love people. I would not like to live with little kids though my babysitting days are done.I have been desexed, micro chipped and vaccinated. I have nothing to be done and I'm just a real cutie....very smart. Trust me once we meet you will want to take me home... forever! I have a beautiful medium coat and I'm shiny black. I'm the good luck cat.If you love me please come in and see my staff they will be very excited to meet you.2 black pets for 1 magic number! Adopt two pets for the one price in October.The animal care centre is open 7 days a week from 8.30-4.00 and you can call us on 5449 1371.Please call I need you! My adoption price is $99.00Love you alreadyMumbles x x",
    "EnteredBase64": "SGVsbG8gbXkgbmFtZSBpcyBNdW1ibGVzLCANCkknbSBhIGJlYXV0aWZ1bCBib3kgd2l0aCBhIGJpZyBhbmQgaGFwcHkgaGVhcnQgSSdtIGxvb2tpbmcgZm9yIGxvdmUgYW5kIGEgZm9yZXZlciBob21lLi4uLiBjb3VsZCB5b3UgYmUgdGhlIG9uZSBmb3IgbWU/IA0KSSB3aWxsIHN1aXQgYSBoYXBweSBhY3RpdmUgaG9tZSBhbmQgbG92ZSBwZW9wbGUuIEkgd291bGQgbm90IGxpa2UgdG8gbGl2ZSB3aXRoIGxpdHRsZSBraWRzIHRob3VnaCBteSBiYWJ5c2l0dGluZyBkYXlzIGFyZSBkb25lLg0KSSBoYXZlIGJlZW4gZGVzZXhlZCwgbWljcm8gY2hpcHBlZCBhbmQgdmFjY2luYXRlZC4gSSBoYXZlIG5vdGhpbmcgdG8gYmUgZG9uZSBhbmQgSSdtIGp1c3QgYSByZWFsIGN1dGllLi4uLnZlcnkgc21hcnQuIA0KVHJ1c3QgbWUgb25jZSB3ZSBtZWV0IHlvdSB3aWxsIHdhbnQgdG8gdGFrZSBtZSBob21lLi4uIGZvcmV2ZXIhIEkgaGF2ZSBhIGJlYXV0aWZ1bCBtZWRpdW0gY29hdCBhbmQgSSdtIHNoaW55IGJsYWNrLiBJJ20gdGhlIGdvb2QgbHVjayBjYXQuDQpJZiB5b3UgbG92ZSBtZSBwbGVhc2UgY29tZSBpbiBhbmQgc2VlIG15IHN0YWZmIHRoZXkgd2lsbCBiZSB2ZXJ5IGV4Y2l0ZWQgdG8gbWVldCB5b3UuMiBibGFjayBwZXRzIGZvciAxIG1hZ2ljIG51bWJlciEgQWRvcHQgdHdvIHBldHMgZm9yIHRoZSBvbmUgcHJpY2UgaW4gT2N0b2Jlci4NClRoZSBhbmltYWwgY2FyZSBjZW50cmUgaXMgb3BlbiA3IGRheXMgYSB3ZWVrIGZyb20gOC4zMC00LjAwIGFuZCB5b3UgY2FuIGNhbGwgdXMgb24gNTQ0OSAxMzcxLg0KUGxlYXNlIGNhbGwgSSBuZWVkIHlvdSEgTXkgYWRvcHRpb24gcHJpY2UgaXMgJDk5LjAwDQpMb3ZlIHlvdSBhbHJlYWR5DQpNdW1ibGVzIHggeA==",
    "Generic": "Introducing Mumbles! He is a black / white domestic medium hair cat located at our RSPCA Noosa. Mumbles is very happy to meet you and have you watching over him this festive season. <a href=\"https://public-shelterbuddy-au-dev.shelterbuddy.io/animal/animalDetails.asp?searchType=4&animalId=41639\">Please click here</a> to view Mumbles's adoptapet profile. (RSPCA Reference Number: AID 305907)",
    "GenericBase64": "SW50cm9kdWNpbmcgTXVtYmxlcyEgSGUgaXMgYSBibGFjayAvIHdoaXRlIGRvbWVzdGljIG1lZGl1bSBoYWlyIGNhdCBsb2NhdGVkIGF0IG91ciBSU1BDQSBOb29zYS4gTXVtYmxlcyBpcyB2ZXJ5IGhhcHB5IHRvIG1lZXQgeW91IGFuZCBoYXZlIHlvdSB3YXRjaGluZyBvdmVyIGhpbSB0aGlzIGZlc3RpdmUgc2Vhc29uLiA8YSBocmVmPSJodHRwczovL3B1YmxpYy1zaGVsdGVyYnVkZHktYXUtZGV2LnNoZWx0ZXJidWRkeS5pby9hbmltYWwvYW5pbWFsRGV0YWlscy5hc3A/c2VhcmNoVHlwZT00JmFuaW1hbElkPTQxNjM5Ij5QbGVhc2UgY2xpY2sgaGVyZTwvYT4gdG8gdmlldyBNdW1ibGVzJ3MgYWRvcHRhcGV0IHByb2ZpbGUuIChSU1BDQSBSZWZlcmVuY2UgTnVtYmVyOiBBSUQgMzA1OTA3KQ=="
  },
  "AvailableForAdoptionFrom": null,
  "Age": {
    "DateOfBirth": "2007-01-05T14:00:00Z",
    "IsApproximated": true,
    "Months": 1,
    "Readable": "10 years and 1 months",
    "Week": 1,
    "Years": 10
  },
  "Breed": {
    "IsCross": true,
    "Primary": {
      "Depiction": "Domestic Medium Hair",
      "Uri": "/api/v1/animalBreeds/32",
      "Id": 32
    },
    "Secondary": null
  },
  "Collar": null,
  "DefaultPhoto": null,
  "Desexed": true,
  "EditedOn": "2013-10-18T03:28:34.817Z",
  "Features": {
    "CoatType": {
      "Depiction": "Short",
      "Uri": "/api/v1/animalCoatTypes/33",
      "Id": 33
    },
    "Colours": "/api/v1/animalColours?animalId=41639",
    "EarType": {
      "Depiction": "Pricked",
      "Uri": "/api/v1/animalEarTypes/18",
      "Id": 18
    },
    "EyeColour": {
      "Depiction": "Yellow",
      "Uri": "/api/v1/animalEyeColours/7",
      "Id": 7
    },
    "TailType": {
      "Depiction": "Full",
      "Uri": "/api/v1/animalTailTypes/14",
      "Id": 14
    }
  },
  "HadBehaviourEvaluated": null,
  "HadHealthChecked": true,
  "Id": 41639,
  "IsVaccinated": true,
  "IsMicrochipped": false,
  "IsWormed": true,
  "Name": "Mumbles",
  "AcoRecord": "test123",
  "Photos": "/api/v1/animalPhotos?animalId=41639",
  "LostFoundAddress": {
    "State": {
      "Name": "QLD",
      "Uri": "/api/v1/states/1",
      "Id": 1
    },
    "Suburb": {
      "Name": "CAPALABA",
      "Id": 8921
    },
    "StreetType": null,
    "Country": {
      "Name": "Australia",
      "Uri": "/api/v1/countries/3",
      "Id": 3
    },
    "DirectionOne": null,
    "DirectionTwo": null,
    "ExtraAddressDetails": null,
    "Postcode": "4157",
    "StreetName": null,
    "StreetNumber": null,
    "UnitNumber": null,
    "AddressType": " ",
    "Id": 26631
  },
  "SearchTypes": [
    {
      "Depiction": "Adoption",
      "Uri": "/api/v1/animalSearchTypes/4",
      "Id": 4
    }
  ],
  "Bonds": null,
  "Sex": "Male",
  "Shelter": {
    "Depiction": "Noosa",
    "Uri": "/api/v1/shelters/18",
    "Id": 18
  },
  "ShelterLocation": "Adoption Cats",
  "Kennel": "",
  "ShelterBuddyId": 305907,
  "Size": {
    "Depiction": "Medium",
    "Uri": "/api/v1/animalSizes/3",
    "Id": 3
  },
  "Status": {
    "Depiction": "Adoption",
    "Uri": "/api/v1/animalStatuses/3",
    "Id": 3
  },
  "Symbols": "/api/v1/animalSymbols?animalId=41639",
  "Tags": "/api/v1/animalTags?animalId=41639",
  "Type": {
    "Depiction": "Cat",
    "Uri": "/api/v1/animalTypes/2",
    "Id": 2
  },
  "Weight": {
    "Kilograms": 5.15,
    "Pounds": 11.353793
  },
  "ViewPublicSiteUrl": "https://public-shelterbuddy-au-dev.shelterbuddy.io:443/animal/animalDetails.asp?searchType=4&animalId=41639",
  "Source": {
    "Date": "2013-08-06T00:15:00Z"
  },
  "YouTubeVideos": []
}

Public Site API

Animals /api/animals

Analytics

Related content