Versions Compared

Key

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

Parameters are being used but filtering does not seem to be working

...

The parameter might be expecting an array instead of a single integer, try converting the integer to an array.

UpdatedSinceUtc must be in the Utc format.

Check out our dates page on how to format dates.

If allowed this update could potentially overwrite newer information

This can happen when the LastUpdatedDate for an entity is not set. This is to ensure you are retrieving the latest details of an entity so that change are not overwritten by another api call or user.

Is there an API that gives us the local time we are connecting to?

This is available in our location endpoint:

...

This has the locations of each shelter, and then a UtcOffset property you can use to find the UTC Time zone.

Why do I receive a credentials don't match a valid user when authenticating?

This can sometimes happen when the username and password is not URL encoded.

...

How do I get a list of adopted animals?

To get a list of adopted animals you can use StatusHistoryV2 with the property DateRange for the dates you want new adoptions for.  You would then populate the Status property with an array of adopted statuses.  To get adopted status you use the StatusV2 endpoint and post with the IsAdoption property.

How do I get a list of in care animals?

...

This can be achieved by using the end point:
MedicalHistoryV2
api/v2/animal/medicalhistory/{animalId}

How do I set the address type when processing a license?

To set the location address radio box on the license details screen you can use the AddressDetail property of the license model and set it to “residential” and this will flag the location address as “Owner’s Residential”. If nothing is set for this property then it will default to “other”.

How can we access these icon values from the API

This is a Icon property in the animal entity, its an array of the icons the animal has ticked.

How do I adopt an animal?

Use the following endpoint to adopt an animal:

AdoptionProcessV2 (/api/v2/animal/process/adoption)

See our Resources page for examples of the adoption insert model.

PersonId is the id of the person who is adopting the animal (i.e. the new owner).

StatusId is the id of an adoption status to create in the status history. StatusDateTimeUtc is the value used for the status date.

The Receipt model (for a new receipt) or a ReceiptId (for an existing receipt) is required. Any payments and allocations made for the adoption should be included in the Receipt model or added using the receipt endpoint (ReceiptV2 /api/v2/receipt).

AdoptionCounselorId is the id of a user who is listed as an adoption counselor.

AdoptionFeeId is required if the animal doesn't already have an adoption amount or adoption fee set.

SelectedOptInChoiceIds is an array of ids for each of the choices the person wants to be opted in to. If null then the person will not be opted in to any choice. You can get a list of available opt in choices from LookupListItemV2 /api/v2/person/optinchoice.

How do i select only people that have opted in to a service as part of an adoption?

...