Getting Started: Consumers
We’re glad you’re interested in writing software that uses Open511 data! Here are a few suggestions that we hope will help you out.
An Open511 event resource can be provided either via a dynamic API, or as a non-interactive XML file. We mostly assume you have access to an API. If you don’t, and you'd like some of the features — JSON, filtering, archiving ’ than an API gives you, we have open-source software that can serve an API based on an XML feed.
Specify a version
You probably don't want your software to break when the data publisher moves to a newer version of Open511. So, on every API request you make, you should be sure to specify the version you're building against, via an
Open511-Version: v1 header or
?version=v1 as a query-string parameter.
Get in touch
This is a new and changing format, and there are likely to still be points of confusion when implementing it. We'd like to help. The easiest way to make sure you're not missing anything is to email us at firstname.lastname@example.org and tell us what you're building; we can offer specific advice, and tell you about anything we're aware of that may impact your work.