Versions Compared

Key

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

This documentation is obsolete. Please see updated documentation at http://docs.singleplatform.com/spv2/rest-api/

REST API

General API Information

...

  • q: The query string. A free-form query, it searches in the following ways (NOTE: blank queries return nothing):
    • by phone number in one of these forms: 10 sequential digits; with dash or period separators (ex: XXX-XXX-XXXX)
    • by zip code in one of these forms: 5 digit zip, 9 digit zip with dash (ex. 10001-4356)
    • by name of location
  • page: The page number. A zero-based value. The default value is 0 for the first page.
  • count: The number of results per page. The default value is 20, and the maximum value is 1000.
  • updatedSince: Filter the results to list only those locations updated since the specified date and time.
    • Format (date only): YYYY-MM-DD
    • Example:
      • ?updatedSince=2013-01-05
    • Format (date & time): YYYY-MM-DDTHH%3AMM%3ASS
    • Example:
      • ?updatedsinceupdatedSince=2013-01-05T09%3A10%3A00

URI Examples:

...

In the URI, LOCATION should be replaced by the ID of the location. For example, the ID for Haru might be haru-7 and the URI would be /locations/haru-7/

GET

Request

Headers:

  • Accept: takes one of: application/json

...