Skip to main content

A Python API wrapper for the Open311 API v2.

Project description

A Python API wrapper for the Open311 API v2.

Usage

The Python wrapper follows closely with the structure of the [Ruby Open311 API wrapper](https://github.com/codeforamerica/open311).

>>> from open311 import Open311
>>> o = Open311()
>>> # If you forgot to configure your instance.
... o.configure(endpoint='http://open311.endpoint.com',
...             api_key='my_api_key', jurisdiction='endpoint.com')
>>> # You can also reset your instance to its original state.
... o.reset()
>>> # Receive a list of services available -- in dictionary form.
... o.service_list()
>>> # Specific service definition.
... o.service_definition('033')
>>> # Service requests.
... o.service_requests()
>>> # Get a specific service request.
... o.get_service_request('638344')
>>> # Post a service request.
... o.post_service_request(
...     service_code='001', address_string='123 Any Street',
...     first_name='John', last_name='Smith',
...     phone='111-111-1111', email='me@email.com',
...     description='A large sinkhole is destroying the street',
...     media_url='http://imgur.com/123_street_sinkhole.png')
>>> # Get a request id from a token.
... o.request_id_from_token('123456')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for open311, version 1.1
Filename, size File type Python version Upload date Hashes
Filename, size open311-1.1.tar.gz (6.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page