Fixed significant errors; clarified docs

Many of the errors simply listed the incorrect commands for API services. I compared the instructions with open311.org to resolve the disagreements. Moreover, I changed the titles to be readable and action-focused. I moved the specific syntax to Resource Informationt able. This should improve clarity.
Chicago · Apr 10, 2018 · 0448112 · 0448112
1 parent 68782fa
commit 0448112
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 39 deletions.
diff --git a/docs/post_service_request.md b/docs/post_service_request.md
@@ -1,13 +1,13 @@
-# POST requests.:format
+# Create a New Service Request
 
 Create a service request in the City's database. Once a service request has been processed by the City (this can take an undetermined amount of time), you should be able to call the GET service_request_id method (tokens/:token_id.:format) to get back the service_request_id for a SR. Therefore, it is nesseary to poll the GET service_request_id method until an SR id is returned. Because the Chicago endpoint may return service requests with no token and no service_reqeust_id in calls to GET service_requests while recently submitted SRs are still being processed by City systems, users of the GET service_requests method should ignore any service requests returned by the API until they have a service_request_id.
 
-| Resource Information | |
-|----------------------|----------------------|
-| Method Name | Post Service Request |
-| Requires API key? | Yes |
-| Response Formats | JSON, XML |
-| HTTP Methods | POST |
+| Resource Information |  |
+|----------------------|-----------------------|
+| Method  | POST requests.:format |
+| Requires API key? | Yes  |
+| Response Formats | JSON, XML  |
+| HTTP Methods | POST  |
 
 ## Arguments
 

diff --git a/docs/service_definition.md b/docs/service_definition.md
@@ -1,14 +1,14 @@
-# GET services/:service_code.:format
+# Retrieve the Definitions for a Service Request
 
 Define attributes associated with a service code.
 
-| Resource Information | |
-|----------------------|-----|
-| Method Name | Service Definition |
-| Requires API key? | No |
-| Response Formats | JSON, XML |
-| HTTP Methods | GET |
-| JSONP | callback=? |
+| Resource Information |  |
+|----------------------|------------------------------------|
+| Method  | GET services/:service_code.:format |
+| Requires API key?  | No  |
+| Response Formats  | JSON, XML  |
+| HTTP Methods  | GET  |
+| JSONP  | callback=?  |
 
 ## Arguments
 

diff --git a/docs/service_list.md b/docs/service_list.md
@@ -1,14 +1,14 @@
-# GET services.:format
+# List Available Open311 Services
 
 Provide a list of acceptable 311 service request types and their associated service codes.
 
-| Resource Information | |
-|----------------------|-----|
-| Method Name | Service List |
-| Requires API key? | No |
-| Response Formats | JSON, XML |
-| HTTP Methods | GET |
-| JSONP | callback=? |
+| Resource Information |  |
+|----------------------|----------------------|
+| Method  | GET services.:format |
+| Requires API key?  | No  |
+| Response Formats  | JSON, XML  |
+| HTTP Methods  | GET  |
+| JSONP  | callback=?  |
 
 ## Arguments
 

diff --git a/docs/service_request.md b/docs/service_request.md
@@ -1,14 +1,14 @@
-# GET services/:service_code.:format
+# Retrieving an Individual Request
 
 Define attributes associated with a service code.
 
-| Resource Information | |
-|----------------------|-----|
-| Method Name | Service Definition |
-| Requires API key? | No |
-| Response Formats | JSON, XML |
-| HTTP Methods | GET |
-| JSONP | callback=? |
+| Resource Information |  |
+|----------------------|------------------------------------------|
+| Method  | GET requests/:service_request_id.:format |
+| Requires API key?  | No  |
+| Response Formats  | JSON, XML  |
+| HTTP Methods  | GET  |
+| JSONP  | callback=?  |
 
 ## Arguments
 

diff --git a/docs/service_requests.md b/docs/service_requests.md
@@ -1,14 +1,14 @@
-# GET requests.:format
+# Query the Current Status of Multiple Requests
 
 Query the current status of multiple requests. Because the Chicago endpoint may return service requests with no token and no service_reqeust_id in calls to GET service_requests while recently submitted SRs are still being processed by City systems, users of the GET service_requests method should ignore any service requests returned by the API until they have a service_request_id.
 
-| Resource Information | |
-|----------------------|-----|
-| Method Name | Service Definition |
-| Requires API key? | No |
-| Response Formats | JSON, XML |
-| HTTP Methods | GET |
-| JSONP | callback=? |
+| Resource Information |  |
+|----------------------|----------------------|
+| Method  | GET requests.:format |
+| Requires API key?  | No  |
+| Response Formats  | JSON, XML  |
+| HTTP Methods  | GET  |
+| JSONP  | callback=?  |
 
 ## Arguments