Open311

Wiki

Collaboration for an Open311 Standard
Personal tools

Difference between revisions of "GeoReport v2"

Collaboration for an Open311 Standard

Jump to: navigation, search
(→‎Servers (can receive reports))
m (removing extra whitespace)
Line 50: Line 50:
 
|-
 
|-
 
|}
 
|}
−
 
−
 
−
 
−
 
 
</onlyinclude>
 
</onlyinclude>
  

Revision as of 16:14, 5 April 2011

This spec has been frozen and finalized, but the documentation will continue to be updated for clarity. Join the Mailing List for updates.

The GeoReport API allows developers to build applications to report non-emergency issues such as graffiti, potholes, and street cleaning directly to government organizations like cities.

Status

Specification

Stable: The GeoReport v2 Spec has been finalized, but we are still updating documentation for clarity and verifying compliance of implementations

Servers (can receive reports)

Servers receive and manage reports on behalf of a jurisdiction. A more comprehensive list is being maintained on the GeoReport v2 Servers page

Note that the URLs require a method and jurisdiction_id at the end, the root URL is not intended to be accessed directly.

Name Status API Key Service Discovery URL Dev API Production API
San Francisco Development Ready Request Key - Dev URL Production URL
Washington D.C. Development Ready Request Key - Beta URL -
Boston Development Ready Request Key - Beta URL -
SeeClickFix (Also supports 20+ jurisdiction endpoints, see full server list) Development Ready Request Key or use guid cookie HTML / XML / JSON Dev URL Production URL


Developer Resources

Please contribute to the full resources page.

Open source developer resources for the GeoReport v2 specification.

Server Software

Server applications provide an API endpoint and can receive and manage reports.

Client Applications

Software that interacts with an Open311 server by connecting to an API.

Dashboards & Data Viz

See also open source libraries for Visualizations

Client Libraries (API Wrappers)

Client libraries make it easier to build client applications that work with the spec.

  • PHP by Ronaldo Barbachano at Code for America
  • Python by Zach Williams at Code for America
  • Ruby Gem by Code for America labs et al (see it on GitHub)
  • Node.js by Mark Headd and Ben Sheldon
  • C# by Mark Headd
  • Clojure by Ryan Briones
  • Java by Santiago Munín at Code for America

Test Suites

Test suites are used to verify that a server is compliant with the specification.

Products & Services

See also GeoReport v2 Support for products and services.

Internationalization and Encoding

Date/time format

All date/time fields must be formatted in a common subset of ISO 8601 as per the w3 note. Timezone information (either Z meaning UTC, or an HH:MM offset from UTC) must be included.

Examples:

  • 1994-11-05T08:15:30-05:00 corresponds to November 5, 1994, 8:15:30 am, US Eastern Standard Time.
  • 1994-11-05T13:15:30Z corresponds to the same instant.

Encoding

UTF-8 is required everywhere.

All text returned by the service, whether in XML, JSON, or any other text-based content-type, MUST be encoded as UTF-8. Appropriate HTTP headers must be set, and the root element must be preceded with the XML declaration including the encoding="UTF-8" attribute. All text received by the service from the client will be assumed to be UTF-8 and must be decoded accordingly. Examples of the HTTP content-type headers for each format are shown below under Format Support.

Format Support

XML is a required format, but JSON can be provided at the discretion of the API provider. The output formats supported by the provider are indicated through the Service Discovery formats field for the API endpoint being used. The client can specify the desired format by appending the format name to the resource. For example a GET request to /services.xml for text/xml output from the services resource and /services/01.json for application/json (RFC 4627) output for a specific service definition.

The HTTP content-type headers should look like this for each format:

POST Service Request: Content-Type: application/x-www-form-urlencoded; charset=utf-8

XML: Content-Type: text/xml; charset=utf-8

JSON: Content-Type: application/json; charset=utf-8

XML Support

XML for the API should be Content-Type: text/xml. The XML output currently defined is schemaless and without a namespace declaration. For now, extending the output with additional namespaces should be done at your own risk. To guarantee that all clients can support the XML output, it is recommended that you adhere to the specification strictly and do not include foreign tags or namespaces. It is also assumed that the default namespace is not specified, but if it must be specified, the XMLNS URI is the URL of the specification: http://wiki.open311.org/GeoReport_v2

JSON Support

JSON for the API should be Content-Type: application/json. JSON support is based on a programmatic mapping of the XML format using the Spark Convention. This means that if you have an XML file, you can easily generate the JSON version with XSL. This can be done using a server side XSLT (php example).

Definitions

jurisdiction_id

As a means to allow this API to distinguish multiple jurisdictions we've included a "jurisdiction_id" which will be the unique identifier for cities. It has been suggested that we use the jurisdiction's main website root url (without the www) as the "jurisdiction_id". For San Francisco, the jurisdiction_id is sfgov.org. Implementations can ignore this parameter and treat it as an "Optional Argument" if the implementation only serves one jurisdiction.

Optional Arguments

"Optional" means that the response should be the same whether a parameter is passed and is empty or is not passed at all. A null parameter should be treated as equivalent to a non-declared parameter in processing the request.

API methods

GET Service List

Required Arguments

  • jurisdiction_id

Response

  • services
    • Explanation: root element
  • service
    • Parent: services
    • Explanation: container for service_code, service_name, description, metadata, type, keywords, group
  • service_code
    • Parent: service
    • Explanation: The unique identifier for the service request type
  • service_name
    • Parent: service
    • Explanation: The human readable name of the service request type
  • description
    • Parent: service
    • Explanation: A brief description of the service request type.
  • metadata
    • Parent: service
    • Explanation: Possible values: true, false
      • true: This service request type requires additional metadata so the client will need to make a call to the Service Definition method
      • false: No additional information is required and a call to the Service Definition method is not needed.
  • type
    • Parent: service
    • Explanation: Possible values: realtime, batch, blackbox
      • realtime: The service request ID will be returned immediately after the service request is submitted
      • batch: A token will be returned immediately after the service request is submitted. This token can then be later used to return the service request ID.
      • blackbox: No service request ID will be returned after the service request is submitted
    • Explanation:
  • keywords
    • Parent: service
    • Explanation: A comma separated list of tags or keywords to help users identify the request type. This can provide synonyms of the service_name and group.
  • group
    • Parent: service
    • Explanation: A category to group this service type within. This provides a way to group several service request types under one category such as "sanitation"

Possible Errors

The numbers represent the HTTP status code returned for each error type:

  • 404 - jurisdiction_id provided was not found (specify in error response)
  • 400 - jurisdiction_id was not provided (specify in error response)
  • 400 - General service error (Anything that fails during service list processing. The client will need to notify us)

Example response


GET Service Definition

  • Conditional: Yes - This call is only necessary if the Service selected has metadata set as true from the GET Services response
  • Purpose: define attributes associated with a service code. These attributes can be unique to the city/jurisdiction.
  • URL: https://[API endpoint]/services/[service_code].[format]
  • Sample URL: https://open311.sfgov.org/dev/v2/services/033.xml?jurisdiction_id=sfgov.org
  • Formats: XML (JSON available if denoted by Service Discovery)
  • HTTP Method: GET
  • Requires API Key: No

Required Arguments

  • service_code
  • jurisdiction_id

Response

  • service_definition
    • Explanation: root element
  • service_code
    • Parent: service_definition
    • Explanation: Returns the service_code associated with the definition, the same one submitted for this call.
  • attributes
    • Parent: service_definition
    • Explanation: container for attribute
  • attribute
    • Parent: attributes
    • Explanation: container for the following elements:
  • variable
    • Parent: attribute
    • Options: true, false
    • Explanation: Setting 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
    • Parent: attribute
    • Explanation: A unique identifier for the attribute
  • datatype
    • Parent: attribute
    • Options: string, number, datetime, text, singlevaluelist, multivaluelist
      • string: A string of characters without line breaks. Represented in an HTML from using an <input> tag
      • number: A numeric value. Represented in an HTML from using an <input> tag
      • datetime: The input generated must be able to transform into a valid ISO 8601 date. Represented in an HTML from using <input> tags
      • text: A string of characters that may contain line breaks. Represented in an HTML from using an <textarea> tag
      • singlevaluelist: A set of predefined values (specified in this response) where only one value may be selected. Represented in an HTML from using the <select> and <option> tags
      • multivaluelist: A set of predefined values (specified in this response) where several values may be selected. Represented in an HTML from using the <select multiple="multiple"> and <option> tags
    • Explanation: Denotes the type of field used for user input.
  • required
    • Parent: attribute
    • Options: true, false
    • Explanation: Setting true means that the value is required to submit service request
  • datatype_description
    • Parent: attribute
    • Explanation: A description of the datatype which helps the user provide their input
  • order
    • Parent: attribute
    • Options: Any positive integer not used for other attributes in the same service_code
    • Explanation: The sort order that the attributes will be presented to the user. 1 is shown first
  • description
    • Parent: attribute
    • Explanation: An description of the attribute field with instructions for the user to find and identify the requested information
  • values
    • Parent: attribute
    • Explanation: A container for a list of predefined options for singlevaluelist or multivaluelist. Required if datatype is set to singlevaluelist or multivaluelist.
  • value
    • Parent: values
    • Explanation: A container for a predefined option (key and name) for singlevaluelist or multivaluelist
  • key
    • Parent: value
    • Explanation: The unique identifier associated with an option for singlevaluelist or multivaluelist. This is analogous to the value attribute in an html option tag.
  • name
    • Parent: value
    • Explanation: The human readable title of an option for singlevaluelist or multivaluelist. This is analogous to the innerhtml text node of an html option tag.


Possible Errors

The numbers represent the HTTP status code returned for each error type:

  • 404 - service_code or jurisdiction_id provided were not found (specify in error response)
  • 400 - service_code or jurisdiction_id was not provided (specify in error response)
  • 400 - General service error (Anything that fails during service list processing. The client will need to notify us)

Example response


POST Service Request

  • Purpose: Create service requests
  • URL: https://[API endpoint]/requests.[format]
  • Sample URL: https://open311.sfgov.org/dev/v2/requests.xml
  • Format sent: Content-Type: application/x-www-form-urlencoded
  • Formats returned: XML (JSON available if denoted by Service Discovery)
  • HTTP Method: POST
  • Requires API Key: Yes

Required Arguments

  • jurisdiction_id
  • service_code (obtained from GET Service List method)
  • location: either lat & long or address_string or address_id must be submitted

Optional Arguments

  • lat
    • Explanation: latitude using the (WGS84) projection.
  • long
    • Explanation: longitude using the (WGS84) projection.
  • address_string
    • Explanation: Human entered address or description of location. 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. This is required if no lat/lon is provided.
  • address_id
    • Explanation: The internal address ID used by a jurisdictions master address repository or other addressing system.
  • email
    • Explanation: The email address of the person submitting the request
  • device_id
    • Explanation: The unique device ID of the device submitting the request. This is usually only used for mobile devices. For example, Android devices use TelephonyManager.getDeviceId() and iPhone's use [UIDevice currentDevice].uniqueIdentifier
  • account_id
    • Explanation: The unique ID for the user account of the person submitting the request
  • first_name
    • Explanation: The given name of the person submitting the request
  • last_name
    • Explanation: The family name of the person submitting the request
  • phone
    • Explanation: The phone number of the person submitting the request
  • description
    • Explanation: A full description of the request or report being submitted. This may contain line breaks, but not html or code. Otherwise, this is free form text limited to 4,000 characters.
  • media_url
    • Explanation: A URL to media associated with the request, eg an image. A convention for parsing media from this URL has yet to be established, so currently it will be done on a case by case basis. For example, if a jurisdiction accepts photos submitted via Twitpic.com, then clients can parse the page at the Twitpic URL for the image given the conventions of Twitpic.com. This could also be a URL to a media RSS feed where the clients can parse for media in a more structured way.
  • attribute
    • Explanation: An array of key/value responses based on Service Definitions. 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

Response

  • service_requests
    • Explanation: root element
  • request
    • Parent: service_requests
    • Explanation: container for service_request_id, token, service_notice, account_id
  • service_request_id
    • Parent: request
    • Explanation: The unique ID of the service request created. This will not be returned if token is returned
  • token
    • Parent: request
    • Explanation: If returned, use this to call GET request_id from a token This will not be returned if service_request_id is returned
  • service_notice
    • Parent: request
    • Explanation: Information about the action expected to fulfill the request or otherwise address the information reported. (may not be returned)
  • account_id
    • Parent: request
    • Explanation: The unique ID for the user account of the person submitting the request. (may not be returned)

Possible Errors

The numbers represent the HTTP status code returned for each error type:

  • 404 - service_code or jurisdiction_id was not found (specified in error response)
  • 400 - service_code or jurisdiction_id was not provided (specified in error response)
  • 400 - General Service Error (Any failure during create request processing, eg CRM is down. Client will need to notify us)

Example Request

POST /dev/v2/requests.xml
Host: open311.sfgov.org
Content-Type: application/x-www-form-urlencoded; charset=utf-8

api_key=xyz&jurisdiction_id=sfgov.org&service_code=001&lat=37.76524078&long=-122.4212043&address_string=1234+5th+street&email=smit333%40sfgov.edu&device_id=tt222111&account_id=123456&first_name=john&last_name=smith&phone=111111111&description=A+large+sinkhole+is+destroying+the+street&media_url=http%3A%2F%2Ffarm3.static.flickr.com%2F2002%2F2212426634_5ed477a060.jpg&attribute[WHISPAWN]=123456&attribute[WHISDORN]=COISL001

Example response:


GET request_id from a token

  • Conditional: Yes - This call is only necessary if the response from POST Service Request contains a token
  • Purpose: get the request_id from a temporary token. This is unnecessary if the response from creating a service request does not contain a token.
  • URL: https://[API endpoint]/tokens/[token id].[format]
  • Sample URL: https://open311.sfgov.org/dev/v2/tokens/123456.xml?jurisdiction_id=sfgov.org
  • Formats: XML (JSON available if denoted by Service Discovery)
  • HTTP Method: GET
  • Requires API Key: No

Required Arguments

  • jurisdiction_id
  • token

Response

  • service_requests
    • Explanation: root element
  • request
    • Parent: service_requests
    • Explanation: container for service_request_id, token
  • service_request_id
    • Parent: request
    • Explanation: The unique ID for the service request created. This can be used to call the GET Service Request method.
  • token
    • Parent: request
    • Explanation: The token ID used to make this call.

Possible Errors

The numbers represent the HTTP status code returned for each error type:

  • 404 - jurisdiction_id or token not found (specified in error response)
  • 400 - jurisdiction_id or token was not provided (specified in error response)
  • 400 - General Service error (Any failure during service query processing. Client will have to notify us)

Example response


GET Service Requests

Required Arguments

  • jurisdiction_id

Optional Arguments

  • service_request_id
    • Explanation: To call multiple Service Requests at once, multiple service_request_id can be declared; comma delimited. This overrides all other arguments.
  • service_code
    • Explanation: 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
    • Explanation: 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
    • Explanation: 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
    • Options: open, closed
    • Explanation: Allows one to search for requests which have a specific status. This defaults to all statuses; can be declared multiple times, comma delimited;

Response

  • service_requests
    • Explanation: root element
  • request
    • Parent: service_requests
    • Explanation: container for variable, code, datatype, required, datatype_description, order, description, values
  • service_request_id
    • Parent: request
    • Explanation: The unique ID for the service request returned
  • status
    • Parent: request
    • Options: open, closed
    • Explanation: The current status of the service request. Open means that it has been reported. Closed means that it has been resolved.
  • status_notes
    • Parent: request
    • Explanation: Explanation of why status was changed to current state or more details on current status than conveyed with status alone. (May not be returned)
  • service_name
    • Parent: request
    • Explanation: The human readable name of the service request type
  • service_code
    • Parent: request
    • Explanation: The unique identifier for the service request type
  • description
    • Parent: request
    • Explanation: A full description of the request or report submitted. This may contain line breaks, but not html or code. Otherwise, this is free form text limited to 4,000 characters.
  • agency_responsible
    • Parent: request
    • Explanation: The agency responsible for fulfilling or otherwise addressing the service request. (May not be returned)
  • service_notice
    • Parent: request
    • Explanation: Information about the action expected to fulfill the request or otherwise address the information reported. (May not be returned)
  • requested_datetime
    • Parent: request
    • Explanation: The date and time when the service request was made. Returned in w3 format, eg 2010-01-01T00:00:00Z
  • updated_datetime
    • Parent: request
    • Explanation: The date and time when the service request was last modified. For requests with status=closed, this will be the date the request was closed. Returned in w3 format, eg 2010-01-01T00:00:00Z
  • expected_datetime
    • Parent: request
    • Explanation: The date and time when the service request can be expected to be fulfilled. This may be based on a service-specific service level agreement. (May not be returned)
  • address
    • Parent: request
    • Explanation: Human readable address or description of location. This should be provided 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
    • Parent: request
    • Explanation: The internal address ID used by a jurisdictions master address repository or other addressing system.
  • zipcode
    • Parent: request
    • Explanation: The postal code for the location of the service request.
  • lat
    • Parent: request
    • Explanation: latitude using the (WGS84) projection.
  • long
    • Parent: request
    • Explanation: longitude using the (WGS84) projection.
  • media_url
    • Parent: request
    • Explanation: A URL to media associated with the request, eg an image. A convention for parsing media from this URL has yet to be established, so currently it will be done on a case by case basis. For example, if a jurisdiction accepts photos submitted via Twitpic.com, then clients can parse the page at the Twitpic URL for the image given the conventions of Twitpic.com. This could also be a URL to a media RSS feed where the clients can parse for media in a more structured way.

Response Volume

  • Default query limit is a span of 90 days or first 1000 requests returned, whichever is smallest.

Possible Errors

The numbers represent the HTTP status code returned for each error type:

  • 404 - jurisdiction_id not found (specified in error response)
  • 400 - jurisdiction_id was not provided (specified in error response)
  • 400 - General Service error (Any failure during service query processing. Client will have to notify us)


Example response


GET Service Request

Required Arguments

  • service_request_id
  • jurisdiction_id

Optional Arguments

  • none

Response

  • service_requests
    • Explanation: root element
  • request
    • Parent: service_requests
    • Explanation: container for variable, code, datatype, required, datatype_description, order, description, values
  • service_request_id
    • Parent: request
    • Explanation: The unique ID for the service request returned
  • status
    • Parent: request
    • Options: open, closed
    • Explanation: The current status of the service request. Open means that it has been reported. Closed means that it has been resolved.
  • status_notes
    • Parent: request
    • Explanation: Explanation of why status was changed to current state or more details on current status than conveyed with status alone. (May not be returned)
  • service_name
    • Parent: request
    • Explanation: The human readable name of the service request type
  • service_code
    • Parent: request
    • Explanation: The unique identifier for the service request type
  • description
    • Parent: request
    • Explanation: A full description of the request or report submitted. This may contain line breaks, but not html or code. Otherwise, this is free form text limited to 4,000 characters.
  • agency_responsible
    • Parent: request
    • Explanation: The agency responsible for fulfilling or otherwise addressing the service request. (May not be returned)
  • service_notice
    • Parent: request
    • Explanation: Information about the action expected to fulfill the request or otherwise address the information reported. (May not be returned)
  • requested_datetime
    • Parent: request
    • Explanation: The date and time when the service request was made. Returned in w3 format, eg 2010-01-01T00:00:00Z
  • updated_datetime
    • Parent: request
    • Explanation: The date and time when the service request was last modified. For requests with status=closed, this will be the date the request was closed. Returned in w3 format, eg 2010-01-01T00:00:00Z
  • expected_datetime
    • Parent: request
    • Explanation: The date and time when the service request can be expected to be fulfilled. This may be based on a service-specific service level agreement. (May not be returned)
  • address
    • Parent: request
    • Explanation: Human readable address or description of location. This should be provided 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
    • Parent: request
    • Explanation: The internal address ID used by a jurisdictions master address repository or other addressing system.
  • zipcode
    • Parent: request
    • Explanation: The postal code for the location of the service request.
  • lat
    • Parent: request
    • Explanation: latitude using the (WGS84) projection.
  • long
    • Parent: request
    • Explanation: longitude using the (WGS84) projection.
  • media_url
    • Parent: request
    • Explanation: A URL to media associated with the request, eg an image. A convention for parsing media from this URL has yet to be established, so currently it will be done on a case by case basis. For example, if a jurisdiction accepts photos submitted via Twitpic.com, then clients can parse the page at the Twitpic URL for the image given the conventions of Twitpic.com. This could also be a URL to a media RSS feed where the clients can parse for media in a more structured way.

Possible Errors

The numbers represent the HTTP status code returned for each error type:

  • 404 - jurisdiction_id not found (specified in error response)
  • 400 - jurisdiction_id was not provided (specified in error response)
  • 400 - General Service error (Any failure during service query processing. Client will have to notify us)


Example response


Errors

Response

  • errors
    • Explanation: root element
  • error
    • Parent: errors
    • Explanation: container for code, description
  • code
    • Parent: error
    • Explanation: The error code representing the type of error. In most cases, this should match the HTTP status code returned in the HTTP header.
  • description
    • Parent: error
    • Explanation: A human readable description of the error that occurred. This is meant to be seen by the user.


  • General Errors
    • 403 - Missing or Invalid API Key (specify in error message)
    • 400 - The URL request is invalid or open311 service is not running or reachable. Client should notify us after checking URL


HTTP error codes are required, but the code in the response body shouldn't necessarily match the HTTP error code, so that more specific and unique error code identifiers can be used. The HTTP error codes should always be 404 for resources that don't exist, 403 for errors because of wrong or missing api_key and basically 400 for any other error where the request can not be fulfilled as expected. Multiple errors codes and descriptions can be returned in the body (the response is an array).

Example:

Retrieved from "https://wiki-archive.open311.org/index.php?title=GeoReport_v2&oldid=1097"