Skip to content

Commit 2d4dfe2

Browse files
committed
Filled in readme
1 parent 2a27893 commit 2d4dfe2

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

readme.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Rock Ideal Postcodes Location Service
2+
3+
### Intro
4+
This is a location service for [Rock](http://rockrms.com) that verifies, standardises, and geocodes UK addresses using the [Ideal Postcodes](ideal-postcodes.co.uk) API.
5+
6+
The repository includes the Visual Studio solution for use with the [Rockit SDK](http://www.rockrms.com/Rock/Developer) and also the .dll file that will eventually be packaged as a Rock Store plugin.
7+
8+
### A Quick Explanation
9+
This location service will pass the values (if any are present) of the address line 1, address line 2, city, state, and ZIP code fields to Ideal Postcodes. It will then ask for the best match and where values are present in the response, replace the values stored in Rock with the response values.
10+
11+
<b>Note:</b> The use of the county address line was deprecated in 1996 and as a result not every request will return a matching county field. For example, 10 Downing Street does not have a county according to PAF data. As a result I've decided to pass the administrative district data from the ONS if no county data is present. I may put a toggle on this behaviour in a future release.
12+
13+
### Closing
14+
If anything looks broken, flag up an issue.
15+
16+
This project is licensed under the [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0.html).

0 commit comments

Comments
 (0)