Skip to content

Commit

Permalink
Clarified jurisdiction_id requirements
Browse files Browse the repository at this point in the history
The language was not exactly correct and disagreed with information
listed on the [API
endpoint](http:https://test311api.cityofchicago.org/open311/v2/).
  • Loading branch information
Tom Schenk Jr committed Apr 10, 2018
1 parent 0448112 commit 707480d
Show file tree
Hide file tree
Showing 5 changed files with 35 additions and 35 deletions.
32 changes: 16 additions & 16 deletions docs/post_service_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,26 @@ Create a service request in the City's database. Once a service request has been

## Arguments

| Argument | Required | Description |
|--------------------|----------|-----------------------------------------------------------|
| `jurisdiction_id` | optional | This is currently optional on Chicago's Open311 endpoint. |
| `service_code` | required | This is obtained from GET Service List method. |
| Argument | Required | Description |
|--------------------|----------|------------------------------------------------------------------------------------------------------------------------|
| `jurisdiction_id` | optional | Optional, but if it is included, it must be set to `cityofchicago.org` |
| `service_code` | required | This is obtained from GET Service List method. |
| `attribute` | required | This takes the form of attribute[code]=value where multiple code/value pairs can be specified as well as multiple values for the same code in the case of a multivaluelist datatype (attribute[code1][]=value1&attribute[code1][]=value2&attribute[code1][]=value3) - see example. - This is only required if the service_code requires a service definition with required fields. |
| `lat` | required | lat & long both need to be sent even though they are sent as two separate parameters. lat & long are required. |
| `long` | required | lat & long both need to be sent even though they are sent as two separate parameters. lat & long are required. |
| `address_string` | required | This should be written from most specific to most general geographic unit, eg address number or cross streets, street name, neighborhood/district, city/town/village, county, postal code. |
| `address_id` | optional | The internal address ID used by a jurisdiction's master address repository or other addressing system. |
| `email` | optional | The email address of the person submitting the request. |
| `device_id` | optional | The unique device ID of the device submitting the request. This is usually only used for mobile devices. |
| `account_id` | optional | The unique ID for the user account of the person submitting the request. |
| `first_name` | optional | The given name of the person submitting the request. |
| `last_name` | optional | The family name of the person submitting the request. |
| `phone` | optional | The phone number of the person submitting the request. |
| `description` | optional | A full description of the request or report being submitted. |
| `media_url` | optional | A URL to media associated with the request, eg an image. |
| `address_string` | required | This should be written from most specific to most general geographic unit, eg address number or cross streets, street name, neighborhood/district, city/town/village, county, postal code. |
| `address_id` | optional | The internal address ID used by a jurisdiction's master address repository or other addressing system. |
| `email` | optional | The email address of the person submitting the request. |
| `device_id` | optional | The unique device ID of the device submitting the request. This is usually only used for mobile devices. |
| `account_id` | optional | The unique ID for the user account of the person submitting the request. |
| `first_name` | optional | The given name of the person submitting the request. |
| `last_name` | optional | The family name of the person submitting the request. |
| `phone` | optional | The phone number of the person submitting the request. |
| `description` | optional | A full description of the request or report being submitted. |
| `media_url` | optional | A URL to media associated with the request, eg an image. |

## Response Parameters

| Argument | Description |
|----------|------------------------------------------------------------------------|
| Argument | Description |
|----------|------------------------------------------------------------------------------------------------------------------------------------------------------|
| `token` | If returned, use this to call GET service_request_id from a token to discover what the service_request_id is after it is created by the City system. |
24 changes: 12 additions & 12 deletions docs/service_definition.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,22 +12,22 @@ Define attributes associated with a service code.

## Arguments

| Argument | Required | Description |
|-------------------|----------|-----------------------------------------------------------|
| `jurisdiction_id` | optional | This is currently optional on Chicago's Open311 endpoint. |
| Argument | Required | Description |
|-------------------|----------|-------------------------------------------------------------------------------------------------|
| `jurisdiction_id` | optional | Optional, but if it is included, it must be set to `cityofchicago.org` |
| `service_code` | required | The service_code is specified in the main URL path rather than an added query string parameter. |

## Response Parameters

| Argument | Description |
|----------------|------------------------------------------------------------------------|
| `service_code` | Returns the service_code associated with the definition, the same one submitted for this call. |
| `variable` | 'true' denotes that user input is needed. 'false' means the attribute is only used to present information to the user within the description field. |
| `code` | A unique identifier for the attribute. |
| `datatype` | Denotes the type of field used for user input. |
| `required` | 'true' means that the value is required to submit service request. 'false' means that the value not required. |
| `service_code` | Returns the service_code associated with the definition, the same one submitted for this call. |
| `variable` | 'true' denotes that user input is needed. 'false' means the attribute is only used to present information to the user within the description field. |
| `code` | A unique identifier for the attribute. |
| `datatype` | Denotes the type of field used for user input. |
| `required` | 'true' means that the value is required to submit service request. 'false' means that the value not required. |
| `datatype_description` | A description of the datatype which helps the user provide their input. |
| `order` | The sort order that the attributes will be presented to the user. 1 is shown first in the list. |
| `description` | A description of the attribute field with instructions for the user to find and identify the requested information. |
| `key` | The unique identifier associated with an option for singlevaluelist or multivaluelist. This is analogous to the value attribute in an html option tag. |
| `name` | The human readable title of an option for singlevaluelist or multivaluelist. This is analogous to the innerhtml text node of an html option tag. |
| `order` | The sort order that the attributes will be presented to the user. 1 is shown first in the list. |
| `description` | A description of the attribute field with instructions for the user to find and identify the requested information. |
| `key` | The unique identifier associated with an option for singlevaluelist or multivaluelist. This is analogous to the value attribute in an html option tag.|
| `name` | The human readable title of an option for singlevaluelist or multivaluelist. This is analogous to the innerhtml text node of an html option tag. |
6 changes: 3 additions & 3 deletions docs/service_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Provide a list of acceptable 311 service request types and their associated serv

## Arguments

| Argument | Required | Description |
|-------------------|----------|-----------------------------------------------------------|
| `jurisdiction_id` | optional | This is currently optional on Chicago's Open311 endpoint. |
| Argument | Required | Description |
|-------------------|----------|------------------------------------------------------------------------|
| `jurisdiction_id` | optional | Optional, but if it is included, it must be set to `cityofchicago.org` |

## Response Parameters

Expand Down
6 changes: 3 additions & 3 deletions docs/service_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Define attributes associated with a service code.

## Arguments

| Argument | Required | Description |
|-------------------|----------|-----------------------------------------------------------|
| `jurisdiction_id` | optional | This is currently optional on Chicago's Open311 endpoint. |
| Argument | Required | Description |
|-------------------|----------|-------------------------------------------------------------------------------------------------|
| `jurisdiction_id` | optional | Optional, but if it is included, it must be set to `cityofchicago.org` |
| `service_code` | required | The service_code is specified in the main URL path rather than an added query string parameter. |
| `extensions` | optional | The Chicago Open311 endpoint provides supplemental details about Service Requests that are in addition to the ones described in the standard specification. These data are nested in the 'extended_attributes' field in the Service Request response. In order to retrieve the new supplemental details, add the query parameter “extensions=true” to any Open 311 api request. |

Expand Down
2 changes: 1 addition & 1 deletion docs/service_requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Query the current status of multiple requests. Because the Chicago endpoint may

| Argument | Required | | Description |
|----------------------|----------|--------------|----------------------------------------------------------|
| `jurisdiction_id` | optional | | This is currently optional on Chicago's Open311 endpoint. |
| `jurisdiction_id` | optional | | Optional, but if it is included, it must be set to `cityofchicago.org` |
| `service_request_id` | optional | | To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited. |
| `service_code` | optional | | Specify the service type by calling the unique ID(s) of the service_codes you wish to query. This defaults to all service codes when not declared; can be declared multiple times, comma delimited (no spaces). |
| `start_date` | optional | | Earliest datetime to include in search. When provided with end_date, allows one to search for requests which have a requested_datetime that matches a given range. Must use w3 format, eg 2010-01-01T00:00:00Z. |
Expand Down

0 comments on commit 707480d

Please sign in to comment.