This system built to be able to integrate with other systems that conform to international standards of data - excchange.
Services
| Purpose | Provide a list of acceptable service request types and their associated service codes. These request types can be unique to the city/jurisdiction. |
|---|---|
| URL | http://localhost/adoan/georeport/v2/services.[format] |
| Sample URL | http://localhost/adoan/georeport/v2/services.xml |
| Formats | XML / JSON |
| HTTP Method | GET |
| Requires API Key | No |
Requests
| Purpose | Query the current status of multiple requests |
|---|---|
| URL | http://localhost/adoan/georeport/v2/requests.[format] |
| Sample URL | http://localhost/adoan/georeport/v2/requests.json?start_date=2015-4-6... |
| Formats | XML, JSON |
| HTTP Method | GET |
| Requires API Key | No |
Optionale Parameter
| Field Name | Description | Notes & Requirements |
|---|---|---|
|
service_code |
Specify the service type by calling the unique ID of the service_code. | This defaults to all service codes when not declared; can be declared multiple times, comma delimited |
|
start_date |
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. | When not specified, the range defaults to most recent 90 days. Must use w3 format, eg 2010-01-01T00:00:00Z. |
|
end_date |
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. | When not specified, the range defaults to most recent 90 days. Must use w3 format, eg 2010-01-01T00:00:00Z. |
|
status |
Allows one to search for requests which have a specific status. This defaults to all statuses; can be declared multiple times, comma delimited; | Options: open , closed |
Single Request
| Purpose | Query the current status of an individual request |
|---|---|
| URL | http://localhost/adoan/georeport/v2/request/#ID.[format] |
| Sample URL | http://localhost/adoan/georeport/v2/requests/R-1.json |
| Formats | XML, JSON |
| HTTP Method | GET |
| Requires API Key | No |