Skip to content

Commit

Permalink
Minor formatting tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
tomschenkjr committed Aug 12, 2017
1 parent f34446e commit 1c73f02
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 6 deletions.
6 changes: 6 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ Visit the above URL to request an API key from the test Open311 system. Your req
### Production
[Request production API key](http:https://311api.cityofchicago.org/open311/v2/apps/new) may be requested after successfully using a test API key.

!!! tip
All requests for API keys must first be tested in the development environment.
Use the same application name as used with the test key to ensure quick turn-around
for your request. When testing, ensure that your application can successfully write
and retrieve service requests.

Production API keys may only be requested after successfully testing with a test API key. The API Key application you submit will need to be reviewed and approved by City of Chicago Staff to ensure compliance with the [Terms of Service](tos/).

## Service Request Meta Data
Expand Down
12 changes: 6 additions & 6 deletions docs/service_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Provide a list of acceptable 311 service request types and their associated serv
## Response Parameters

| Argument | Description |
|----------------|------------------------------------------------------------------------|
|:---------------|:-----------------------------------------------------------------------|
| `service_code` | The unique identifier for the service request type. |
| `service_name` | The human readable name of the service request type. |
| `description` | A brief description of the service request type. |
| `metadata` | Determines whether there are additional form fields for this service type. |
| `type` | Explains how this deals with the Open311 service request ID dance. |
| `keywords` | A comma separated list of tags or keywords to help users identify the request type. This can provide synonyms of the service_name and group. |
| `group` | A category to group this service type within. This provides a way to group several service request types under one category such as 'sanitation'. |
| `description` | A brief description of the service request type. |
| `metadata` | Determines whether there are additional form fields for this service type. |
| `type` | Explains how this deals with the Open311 service request ID dance. |
| `keywords` | A comma separated list of tags or keywords to help users identify the request type. This can provide synonyms of the service_name and group. |
| `group` | A category to group this service type within. This provides a way to group several service request types under one category such as 'sanitation'. |

0 comments on commit 1c73f02

Please sign in to comment.