GeoReport v2.1 Swagger Draft
This page is automatically generated from the GeoReport v2.1 Swagger File (using the Jekyll-Swagger layout)
/requests.{response_format}
GET
requests
Parameters
Name
Located in
Description
Type
String
String
service_request_id
query
To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited.This overrides all other arguments.
String
service_code
query
Specify the service type by calling the unique ID of the service_code.
String
start_date
query
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, but may not span more than 90 days.
String
end_date
query
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, but may not span more than 90 days.
String
status
query
Allows one to search for requests which have a specific status. This defaults to all statuses; can be declared multiple times, comma delimited.
String
Responses
200
List of matching requests (Default query limit is a span of 90 days or first 1000 requests returned, whichever is smallest).
Response Object
array
Model
Request
Description
Issues that have been reported as service requests. Location is submitted via lat/long or address or address_id
400
jurisdiction_id was not provided (specified in error response) or General Service error (Any failure during service query processing. Client will have to notify us)
401
jurisdiction_id not found (specified in error response)
POST
Create service request
Parameters
Name
Located in
Description
Type
String
String
service_code
query
String
lat
query
WGS-84 latitude
Number
long
query
WGS-84 longitude
Number
address_string
query
String
address_id
query
String
attribute
query
array of key/value responses based on Service Definitions.
Array
of String
Responses
200
success returns an tracking-id
Response Object
array
Model
RequestResponse
Description
Details for tracking an created service request
GET requests
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| String | |||
| String | |||
| service_request_id | query | To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited.This overrides all other arguments. | String |
| service_code | query | Specify the service type by calling the unique ID of the service_code. | String |
| start_date | query | 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, but may not span more than 90 days. | String |
| end_date | query | 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, but may not span more than 90 days. | String |
| status | query | Allows one to search for requests which have a specific status. This defaults to all statuses; can be declared multiple times, comma delimited. | String |
Responses
200 List of matching requests (Default query limit is a span of 90 days or first 1000 requests returned, whichever is smallest).
| Response Object | array |
|---|---|
| Model | Request |
| Description | Issues that have been reported as service requests. Location is submitted via lat/long or address or address_id |
400 jurisdiction_id was not provided (specified in error response) or General Service error (Any failure during service query processing. Client will have to notify us)
401 jurisdiction_id not found (specified in error response)
POST Create service request
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| String | |||
| String | |||
| service_code | query | String | |
| lat | query | WGS-84 latitude | Number |
| long | query | WGS-84 longitude | Number |
| address_string | query | String | |
| address_id | query | String | |
| attribute | query | array of key/value responses based on Service Definitions. | Array of String |
Responses
200 success returns an tracking-id
| Response Object | array |
|---|---|
| Model | RequestResponse |
| Description | Details for tracking an created service request |
/request/{service_request_id}.{response_format}
GET
current status
Parameters
Name
Located in
Description
Type
String
String
service_request_id
path
Is specified in the main URL path rather than an added query string parameter.
String
Responses
200
success returns request details
Response Object
GET current status
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| String | |||
| String | |||
| service_request_id | path | Is specified in the main URL path rather than an added query string parameter. | String |
Responses
200 success returns request details
| Response Object |
|---|
/services.{response_format}
GET
service types
Parameters
Name
Located in
Description
Type
String
String
Responses
200
ok
Response Object
array
Model
Service
Description
A single service (type) offered via Open311
400
The URL request is invalid or service is not running or reachable. Client should notify us after checking URL
404
jurisdiction_id provided was not found (specify in error response).
GET service types
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| String | |||
| String |
Responses
200 ok
| Response Object | array |
|---|---|
| Model | Service |
| Description | A single service (type) offered via Open311 |
400 The URL request is invalid or service is not running or reachable. Client should notify us after checking URL
404 jurisdiction_id provided was not found (specify in error response).
/services/{service_code}.{response_format}
GET
(extended) definition of a service type
Parameters
Name
Located in
Description
Type
String
String
service_code
path
String
Responses
200
returns ServiceDefinition for the Service
Response Object
400
service_code or jurisdiction_id provided were not found (specify in erraddor response)
404
service_code or jurisdiction_id provided were not found (specify in error response)
GET (extended) definition of a service type
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| String | |||
| String | |||
| service_code | path | String |
Responses
200 returns ServiceDefinition for the Service
| Response Object |
|---|
400 service_code or jurisdiction_id provided were not found (specify in erraddor response)
404 service_code or jurisdiction_id provided were not found (specify in error response)
/tokens/{token_id}.{response_format}
GET
Id of service_request via token
Parameters
Name
Located in
Description
Type
String
String
token_id
path
String
Responses
200
returns tuple request ID, token
Response Object
GET Id of service_request via token
Parameters
| Name | Located in | Description | Type |
|---|---|---|---|
| String | |||
| String | |||
| token_id | path | String |
Responses
200 returns tuple request ID, token
| Response Object |
|---|