HSDA Postal Code Search Parameters

[kinlane]

Adding postal code search for HSDA, allowing searching using proximity across all core resources.

• Issue: https://github.com/openreferral/api-specification/issues/46#issuecomment-427619061
• OpenAPI: https://gist.github.com/kinlane/d29bcb807f9a4cf8c66487430845b754

[NeilMcKLogic]

Just want to point out for this to work properly, the entity hosting the data needs a reliable lat/long approximation for each postal code to get reasonably accurate results. Unfortunately, postal codes can be geographically quite large (see rural Canada for example, hundreds of square kilometers each). It's better than nothing, but far from perfect. Caveat emptor.

[kinlane]

OpenReferral can only speak to the schema, and access via the API to the schema. I would say that quality / scope of functionality behind interface is out of scope of this work.

[MikeThacker1]

In the UK we have asked implementation to support a syntax like this /services?postcode=BS3%204AQ&proximity=5000 with proximity in metres.

[kinlane]

I am proposing we adopt an approach similar to GitHubs:

• Github
• Working thoughts