Austin 3-1-1

Austin 3-1-1

Get Service Requests

Query the current status of multiple requests.

Response Information

Method NameService Requests
Requires API Key?No
Response FormatsJSON, XML
HTTP MethodsGET

Arguments

jurisdiction_id

optionalbutton
This is optional on Austin's Open311 endpoint.

service_request_id or token

optionalbutton
nonstandardbutton-2.jpg
The service_request_id or token you wish to query.

service_code

optionalbutton
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

optionalbutton
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, e.g. 2010-01-01T00:00:00Z.

end_date

optionalbutton
Latest datetime to include in search. When provided with start_date, allows one to search for requests which have a requested_datetime that matches a given range. Must use w3 format, e.g. 2010-01-01T00:00:00Z.

status

optionalbutton
Allows for search of requests which have a specific status. This defaults to all statuses; can be declared multiple times, comma delimited (no spaces); Options: open, closed.

extensions

optionalbutton

non-standard

The Austin Open311 endpoint provides supplemental details about service requests that are in addition to the ones described in the standard specification. This data are nested in the ‘attributes’, 'extended_attributes', and ‘notes’ field in the service request response. In order to retrieve the new supplemental details, add the query parameter “extensions=true” to this Open 311 API request.

page_size

optionalbutton
nonstandardbutton-2.jpg
Controls the maximum amount of results a single call will return. The default value is 50. The maximum value is 500.

page

optionalbutton
nonstandardbutton-2.jpg
For calls that logically include more records than the page size, the page parameter can be use to page through the results. Use in combination with page_size and with multiple calls to download all data in a logical set of records

 

Response Parameters

service_request_idThe unique ID of the service request created.
service_codeReturns the service_code associated with the definition, the same one submitted for this call.
statusThe current status of the service request.
service_nameThe human readable name of the service request type.
service_codeThe unique identifier for the service request type.
descriptionA full description of the request or report submitted.
agency_responsibleThe agency responsible for fulfilling or otherwise addressing the service request.
requested_datetimeThe date and time when the service request was made.
updated_datetimeThe date and time when the service request was last modified. For requests with status=closed, this will be the date the request was closed.
addressHuman readable address or description of location.
zipcodeThe postal code for the location of the service request.
latLatitude using the (WGS84) projection.
longLongitude using the (WGS84) projection.
media_urlA URL to media associated with the request, e.g. an image.

attributes

nonstandardbutton-2.jpg
This field displays the specific service request’s attribute codes and values answered by the end user.

channel

nonstandardbutton-2.jpg
Nested in extended_attributes field (extended_attributes.channel). Describes the method that the service request was input into the 311 system (i.e. phone, web, Open311).

duplicate

nonstandardbutton-2.jpg
Nested in extended_attributes field (extended_attributes.duplicate). Indicates that this service request is a duplicate of a service request that is already in the system. This can happen when, for example, the same pothole is reported multiple times. Use in conjunction with extended_attributes.parent_service_request_id to identify duplicates and their associated 'master' (aka parent) service request records.

parent_service_request_id

nonstandardbutton-2.jpg
Nested in extended_attributes field (extended_attributes.parent_service_request_id). When a service request is a duplicate, this value shows which service request (the parent) it is a duplicate of. Use in conjunction with extended_attributes.duplicate to identify duplicates and their associated 'master' (aka parent) service request records.

notes

nonstandardbutton-2.jpg
This field holds nested and related status details, activities, follow-on case details, for the Service Request. Will generally have a Request Opened activity and a Request closed activity when the request is closed. May also hold other activity types (i.e. Dispatch Work Crew) and notes about Follow-on Service Requests (usually transfer of Service Request ownership from one department to another). Each activity in the array of 1 or more activities can have additional properties that are described below.

notes.summary

nonstandardbutton-2.jpg
Short description of the activity / action described by the note.

notes.datetime

nonstandardbutton-2.jpg
The date and time of the activity / action described by the note.

notes.type

nonstandardbutton-2.jpg
Category of the activity / action described by the note (i.e activity / opened / closed).

Have more questions? Email us at Open311developers@austintexas.gov