API Update March 3, 2013

Written March 3, 2013 by
Categories: API, Developers
2 comments

We've made a few changes and updates to our APIs over the past week or two.

REST API

Limit for the updatedAfter timestamp

Rest API will now only return results from the past 10 days when you use the updatedAfter timestamp. Because of the volume of updates, after 10 days it makes more sense to just do a full download instead of using the updatedAfter timestamp.

Please note that the REST API will not return any results if your timestamp is more than 10 days in the past.

XML data download

We are working out the kinks in our new XML data download. The data currently is only available every few days, but we are hoping to get the export running every day and complete by 6 AM.

If you haven’t signed up for this new feature, please do so. Downloading a zipped XML file is a lot more efficient than processing pages of data… and you can have a full download every day (once it’s working on schedule).  You can enable this option by using the link in your API Key Verification email.

HTTP/json API

We’ve been steady improving and growing the HTTP/json API.

foundRows on public queries

Public animal queries will now return the foundRows value only if you specifically send calcFoundRows = “Yes” in your search properties. This change will reduce queries times significantly if you aren’t asking for the total matching row count.

Documentation

Documentation of the HTTP/json API can be found here:

http://support.rescuegroups.org:8091/x/FYA7

We’ve added additional documentation to the User Guide for the HTTP/json API. Specifically, a large page on the objects and available actions:

http://support.rescuegroups.org:8091/x/ewFa

SOAP API

Please note that we are in the process of retiring the SOAP API in favor of the HTTP/json API.  If you are developing or have already developed on the SOAP API please consider migrating to the HTTP/json API.  We do not currently have an end-of-life date for the SOAP API.

Posted in API, Developers

2 Responses to "API Update March 3, 2013"

  • By Jason Davis March 3, 2013 - 6:33 PM

    I recently was hired to do PHP project for a client that uses your REST API…unfortunately, when there is 0 results, it does not return a proper empty XML header…pleeeeeeease add this feature. Because of this issue I have to make my code do more work that shouldn’t have to be done.

    If there are 0 results it should still return an empty XML document

    • By Richard Saffell March 3, 2013 - 6:41 PM

      Jason, we absolutely will resolve this issue. Does this happen when you provide invalid search criteria, like an invalid updatedAfter time stamp (more than 10 days)? Feel free to open a support ticket also. Thank you.