Open311 GeoReport API

Assessment

• Open License Yes

• Transferable to Other Jurisdictions Yes

  GeoReport API has been adopted in various jurisdictions across the US. The OPEN311 does not specify the codes, making it possible for the API to be applied to whatever civic services specifically offered in that city

• Stakeholder Participation Yes

  Collaboration between developers, government, and nonprofit organizations

• Consensus-Based Governance Yes

  The public can contribute to the standard's 'issue tracker' on GitHub

• Extensions Yes

  MySociety has proposed an extension to better update clients about status changes of requests to better serve citizens with platforms such as fixmystreet (in the UK). The extension allows for more communication from the government body to the client. This extension proposes the methods POST/GET Service Updates. See extension's proposal here: https://www.mysociety.org/2013/02/20/open311-extended/

• Human Readable Yes

  Open311 follows the REST schema and uses human readable identifiers to label the data

• Machine Readable Yes

  API retrieves the data in XML format and supports JSON format when indicated by the API. The content of the API manages two main resources consisting of services and service requests. Requests are handled over HTTP to retrieve data in XML format, and in JSON when denoted by service discovery. Jurisdiction_ID will be globally unique variable in order to clarify the city implementing the API (required only when entire interface serves more than one jurisdiction). The API employs 7 API methods for services and service requests. These methods include: GET service list, GET service definition, POST Service Request, GET request_id from a token, GET service request(s). The GET service method handles what services are available to the client user based on the unique service_code. The POST service request handles requests posted by the client to the government body. Open311 requires a location when requesting a service. GET service request(s) provides records of service requests based on date thresholds, service codes, service request IDs, and status

• Requires Up-To-Date / Real-Time Data Yes

  The API Gets and Posts service requests in real time

• Metadata Yes

  There is a required resource for specifying metadata. The GET service definition method of the API provide description for the service being requested by adding metadata=yes to it response