diff --git a/content/v2.md b/content/v2.md index ad88f50..1865cc8 100644 --- a/content/v2.md +++ b/content/v2.md @@ -7,12 +7,12 @@ title: SeeClickFix API v2 Overview Use of the API documented here is subject to the terms of our Data License below. This describes the resources that make up the official SeeClickFix API v2. If -you have any problems or requests please contact +you have any problems or requests, please contact [Developer Support](mailto:developer-support@seeclickfix.com). -SeeClickFix provides an open311 compatible API at [http://seeclickfix.com/open311](http://seeclickfix.com/open311). +SeeClickFix provides an open311-compatible API at [http://seeclickfix.com/open311](http://seeclickfix.com/open311). -SeeClickFix also provides an organizational API based on the public API described here for its partners. +SeeClickFix also provides an organizational API, based on the public API described here, for its partners. For recommendations on which API to use, please see [this page](/v2/recommendations/). @@ -44,10 +44,10 @@ All data is sent and received as JSON. Responses follow one of two patterns: `singular` and `collection`. -`singular` responses return a single items, such as a user ID #145. +`singular` responses return single items, such as a user ID (e.g., #145). -`collection` responses return a collection of items. Collection -responses have two guaranteed attributes `metadata` and `result`. +`collection` responses return collections of items. Collection +responses have two guaranteed attributes, `metadata` and `result`. The `metadata` attribute can contain metadata for the consumer about the result, for example pagination information, api limits, or query information. Metadata can be null. The `result` attribute contains @@ -59,16 +59,16 @@ Many API methods take optional parameters. Optional parameters will be identifie For POST requests, parameters not included in the URL should be encoded in the body with a Content-Type of 'application/x-www-form-urlencoded'. -Optionally we accept JSON in the body with a Content-Type of 'application/json': +Optionally, we accept JSON in the body with a Content-Type of 'application/json': ## Pagination Requests that return multiple items will be paginated to 20 items by -default unless otherwise noted. You can specify further pages using the +default, unless otherwise noted. You can specify further pages using the `?page` parameter. You can also set a custom page size up to 100 with -the `?per_page` parameter. If you'd like to read more than 100 items -you'll need to construct and query the pages programatically. +the `?per_page` parameter. If you'd like to read more than 100 items, +you'll need to construct and query the pages programmatically.
$ curl https://seeclickfix.com/api/v2/issues?page=2&per_page=10 @@ -129,7 +129,7 @@ The URI you used to make the request has been superseded by the one specified in <%= headers 302 %> -The request should be repeated verbatim to the URI specified in the `Location` header field but clients should continue to use the original URI for future requests. +The request should be repeated verbatim to the URI specified in the `Location` header field, but clients should continue to use the original URI for future requests. Other redirection status codes may be used in accordance with the HTTP 1.1 spec. @@ -170,7 +170,7 @@ has not changed, the server will return a `304 Not Modified`. ## Geography -At various endpoints SeeClickFix recognizes geography either by a `point` +At various endpoints, SeeClickFix recognizes geography either by a `point` or `area` attribute. If multiple points are specified, they will be evaulated in the listed order of precedence. @@ -203,7 +203,7 @@ email to the creator will be delivered with Spanish translations. SeeClickFix data sources, including XML, RSS, KML and JSON, are licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 United States License. Attribution should be to seeclickfix.com. -Persons or organizations wishing to reuse large portions (ie., more than occasional queries ) of data are required to contact us first at. We are very interested in working with researchers and/or agencies to ensure that this data is put to good use! +Persons or organizations wishing to reuse large portions (ie., more than occasional queries) of data are required to contact us first at . We are very interested in working with researchers and/or agencies to ensure that this data is put to good use! ### API Rate Limits @@ -257,5 +257,5 @@ If an application abuses the rate limits, we will return a HTTP 403 Forbidden er } -If you or your application has been blacklisted and you think there has been a mistake, please contact us at +If you or your application has been blacklisted and you think there has been a mistake, please contact us at .