Home

OS Places user guide and technical specification

1. query query ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON SO16 OAS offset 0 totalresults 15 format JSON dataset DPA Lp e EN ENS maxresults 100 matchprecision 1 epoch 29 results DPA UPRN 200010019924 ADDRESS ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON SO16 OAS ORGANISATION NAME ORDNANCE SURVEY BUILDING NUMBER AM THOROUGHFARE NAME ADANAC DRIVE DEPENDENT LOCALITY NURSLING POST TOWN SOUTHAMPTON POSTCODE SO16 OAS RPE 2 X COORDINATE 437318 0 Y COORDINATE 115539 0 STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE COO1GV CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 MATCH 1 0 MATCH DESCRIPTION EXACT d DPA UPRN 200000699027 ADDRESS 4 LUKIN DRIVE NURSLING SOUTHAMPTON S016 OTN BUILDING NUMBER DAT THOROUGHFARE NAME LUKIN DRIVE DEPENDENT LOCALITY
2. Jg na lt LPI LOGICAL STATUS COD ED ESCRIPTION gt APPROVE D lt LPI_ LOGICAL STATUS COD CRIPTION gt lt MATCH gt 1 0 lt MATCH gt lt MATCH DESC RI PTION gt EXACT lt MATCH DESCRI PTION gt lt LPI gt lt results gt lt AddressAPI gt OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 34 of 61 Chapter 4 GeoSearch resources Nearest resource The nearest resource returns the closest address to a given point The coordinates for the point have to be in British National Grid BNG and to two decimal places or less A property will only be considered to be included by the search if the Address Seed is in range of the search regardless of the property s physical boundaries This resource is unavailable for addresses within Northern Ireland Parameters point Mandatory char One comma separated coordinate set in BNG that specifies the coordinate to find the nearest record to in a straight line The maximum distance that the search will try is 1 000 metres The precision of the coordinates is to two decimal places that is 1 cm accuracy Default value is 100 metres radius optional float The radius in metres to search within Maximum is 1 000 metres If above then an error message will be returned see below The precision of the distance is to two decimal places that is 1 cm accu
3. lt LPI LOGICAL STATUS CODE DESCRIPTION gt PROVISIONAL lt LPI LOGICAL STATUS COD DESCRIPTION Gl lt MATCH gt 1 0 lt MATCH gt MATCH DESCRIPTION gt EXACT lt MATCH DESCRI PTION gt lt LPI gt lt results gt lt AddressAPI gt Postcode resource The postcode resource returns addresses based on a postcode The queried postcode can be a partial postcode consisting of just the area and district or the area district and sector or a full postcode consisting of the area district sector and unit Please see below for an explanation of the properties of a postcode gem Sector SO 16 OU AS District Unit Parameters postcode Mandatory integer Integer search parameter format optional char The format the response will be returned in Default value is JSON Valid values xml json maxresults optional integer The maximum number of results to return Default is 100 Valid values 1 100 offset optional integer Offset the list of returned by this amount dataset optional char The dataset to return DPA and or LPI Multiple values can be sent separated by a comma Default is DPA Valid values DPA LPI lr optional char Which language of addresses to return Valid languages are English and Welsh Filter only applicable to DPA dataset Default value is both languages GI Valid
4. CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 MATCH 1 0 MATCH DESCRIPTION EXACT OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 32 of 61 Postcode XML LPI request https api ordnancesurvey co uk places v1 addresses postcode postcode SO1696200AS amp format xml amp dataset L Pl amp key INSERT USER API KEY HERE API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL postcode Resource being requested postcode Postcode being queried amp format Format being requested xm1 amp dataset Dataset being requested LPT amp key User API authentication key Output lt AddressAPI gt lt header gt lt uri gt https api ordnancesurvey co uk places vl addresses postcode postcode 8016 200AS amp format xml amp dataset LPI uri query postcode SO160AS query lt offset gt 0 lt offset gt lt totalresults gt 2 lt totalresults gt lt format gt xml lt format gt lt dataset gt LPI lt dat
5. ADDRESS char Char containing the concatenated address Size 142 Multiplicity 1 USRN integer Foreign key linking the Street record to the LPI record Size 8 Multiplicity 1 LPI KEY char Unique key for the LPI Size 14 Multiplicity 1 LEVEL char Memorandum of the vertical position of the address Size 30 Multiplicity 0 1 ORGANISATION char Name of current occupier on the fascia of the BLPU Size 100 Multiplicity 1 SAO START NUMBER integer The number ofthe secondary addressable object SAO or the start of the number range Size 4 Multiplicity 0 1 SAO START SUFFIX integer The suffix to the sao start number Size 2 Multiplicity 0 1 SAO END NUMBER integer The end of the number range for the SAO Size 4 Multiplicity 0 1 SAO END SUFFIX char The suffix to the sao_end_number OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 51 of 61 Size 2 Multiplicity 0 1 SAO_ TEXT char Contains the building name or description for the SAO Size 90 Multiplicity 0 1 PAO START NUMBER integer The number ofthe primary addressable object PAO or the start of the number range Size 4 Multiplicity 0 1 PAO START SUPE IX char The suffix to the pao_start_number Size 4 PAO END NUMB
6. E NTRY DAT 10 BLPU ET STAT E STATE E CODE DATE h E DAT OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 45 of 61 lt STREET STATE CODE DESCRIPTION gt Under construction lt STREET STATE CODE DESCRIPTION gt STREET CLASSIFICATION CODE gt 8 lt STREET CLASSIFICATION CODE STREET CLASSIFICATION CODE DESCRIPTION gt A11 vehicles STREET CLASSIFICATION CODE DESCRIPTION LPI LOGICAL STATUS CODE 1 LPI LOGICAL STATUS CODE I Jg Re DESCRIPTION gt APPROVED lt LPI_ LOGICAL STATUS CODE I lt LPI LOGICAL STATUS COD CRIPTION gt lt MATCH gt 1 0 lt MATCH gt lt MATCH_DESCRIPTION gt EXACT lt MATCH DESCRIPTION gt lt LPI gt lt results gt lt AddressAPI gt OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 46 of 61 Chapter 5 Output For the resources listed if the query returns results the output will vary depending on the dataset chosen The datasets share common keys and also have unique keys specific to that dataset DPA keys UPRN optional integer The Unique Property Reference Number For addresses in Northern Ireland an empty string is returned ADD
7. E CODE DESCR LPI LOGICAL STATUS CODE CRIPTION gt lt MATCH gt 0 6 lt MATCH gt MATCH D LPI results lt AddressAPI gt UPRN resource SIFICATION CO SIFICATION CO CION CODE DESC L STATUS COD DESCRIPTION gt APPROV E 16 06 2011 1 9 2010 ENT DATE gt 16 06 2 ESS_CODE gt single B LAST UPDATE DATE STATE DATE E CODE E DESCRIPTION TION Under I ET CLASSIFICATION CODI PTION gt ALL OGICAL STATUS CODE I D lt L RIPTION gt NO MATCH MATCH DESCRIPTION PI LOGICAL STATUS CODE The UPRN resource is a service that returns address details based on the Unique Property Reference Number UPRN a 12 digit unique number for every building and plot of land excluding addresses in Northern Ireland The UPRN resource is not available for addresses in Northern Ireland OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 27 of 61 Parameters uprn Mandatory char Integer search parameter format optional char The format the response will be returned in Default value is JSON Valid values xml json dataset optional char The dataset to return DPA and or LPI Multiple valu
8. LASSIFICATION CODE Service lt CLASSIFICATION CO OCA RATIVE AR I RPC PPROVED STAT 437343 63833 L 4 PAO START NUMBER PTION gt ADANAC ING TOWN NAME _AREA gt HAMPS _LOCATOR gt SO16 OAS POSTCODE E gt 437318 0 lt X_COO E 115539 0 Y COO US 115643 query RN gt 200010019924 lt UPRN gt DANAC DRIVE NURSLING HAMPSHIRE S016 PI Kl EY DRIVE STREET D ESCRIPTION V HIRE lt ADMINISTRATIVE OCATOR gt AR EA R R DINAT DINAT gt gt Si Je D PTION gt COD DE DESCRI DIAN lt OCA me C DIAN CODE D U U VALLEY lt LOCAL CUSTODIAN CODE POSTAL A POSTAL ESS CO lt lt lt B lt B IE Aur ESCRIPTION gt RESS COD RESS CODE D DESCRIPTION U STATE CODE gt 2 lt BL U STATE CODE DESC LI D D use lt BLPU STATE CODE DESCRIPTION gt lt TOPOGRA construction lt STR PHY LAY LAST UPDATE lt ENT lt BLE ST ST I p P RE R TOI DAT RY DATE gt 01 0 U_STATE DATE gt 01 09 2 ET STATE CODE gt 1 lt ST D I RE ET STATE DE DESCR S CODE 1 LOGICA LASSIFICATI
9. Y COORDINATI STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE COO1GV CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 DE Dr 437318 0 D zs 115539 0 m h D m h D LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 MATCH 1 0 MATCH DESCRIPTION EXACT Lr UPRN XML LPI request OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 29 of 61 https api ordnancesurvey co uk places v1 addresses uprn uprn 200010019920 amp format xml amp dataset LPl amp key INSERT_USER_API_KEY_HERE API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL uprn Resource being requested uprn UPRN being queried amp format Format being requested xm1 amp dataset Dataset being requested LPI amp key User API authentication key Output lt AddressAPI gt lt header gt lt uri gt https
10. amp key User API authentication key OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 25 of 61 Output lt AddressAPI gt lt header gt lt uri gt https api ordnancesurvey co uk places vl addresses find query ORDNANCE 2 OSURVEY 3204 S320ADANAC S20DRIV E amp format xml dataset LPI lt uri gt lt query gt query ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON SO16 OAS lt query gt lt offset gt 0 lt offset gt lt totalresults gt 3001914 lt totalresults gt lt format gt xml lt format gt lt dataset gt LPI lt dataset gt lt maxresults gt 100 lt maxresults gt lt matchprecision gt 1 lt matchprecision gt lt epoch gt 29 lt epoch gt lt header gt lt results gt lt LPI gt lt UPRN gt 200010019924 lt UPRN gt lt ADDRESS gt 4 ADANAC DRIVE NURSLING HAMPSHIRE SO16 OAS lt ADDRESS gt lt USRN gt 40020087 lt USRN gt Service lt CLASSIFICATION CODE DESCRI VALLEY LOCA lt LPI KEY gt 1760L000063833 lt L START NUMBER gt 4 lt PAO START NUMBER gt PT ION gt ADANAC ING TOWN NAME _AREA gt HAMPS LOCATOR gt SO16 OAS lt POSTCODE lt PAO_ STREET DESCRI TOWN NAME gt NURS lt ADMINISTRATIVE POSTCODE lt RPC gt 2 lt RPC gt PI DR HIR lt X_COORDINATE gt 437318 0 lt X_COO Y COORDINATE 115539 0 Y COO lt STATUS gt APPRO
11. lt uri gt https api ordnancesurvey co uk places vl addresses radius point 437307 620115579 53 amp RADIUS 100 amp format XML dataset LPI lt uri gt lt query gt point 437307 lt offset gt 0 lt offset gt totalresults 1 totalresults lt format gt xml lt format gt lt dataset gt LPI lt dataset gt lt maxresults gt 100 lt maxresults gt lt epoch gt 29 lt epoch gt lt header gt lt results gt lt LPI gt OAS ADDRESS UP lt ADDRESS lt US lt LPI PAO K STA 24 RT N STREET DESC TOWN lt ADMINIS lt POSTCOD lt RPC gt 2 lt lt X_COORD Y COORD lt STATUS gt A LOGICAL STATU lt C C LASSIF LASSIF Service lt CLASSIFICATION CO lt lt OCA OCA me E VALLEY lt LOCAL CUSTODIAN CO address lt POSTA lt POSTA NAM h EN A RN gt 40020087 lt US EY gt 1760L00 UMBE RI URS T e RAT RPC gt INAT INAT ICATION CODI ICATION CODE PPROV RN 00 R IV D AR D DE D D ESCR USTO USTO DIAN DIAN DE D ESC lt POSTA A A ESS ESS ADDRI ESS CO LP D B B L U STAT PU STAT R R D DE ESCR E COD D RI RN gt 200010019924 lt UPRN gt DANAC DRIVE 63833 lt L 4 lt PAO_START_NUMBER gt PT ION gt AD
12. 437318 0 Y COORDINATE 115539 0 STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE COO1GV CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 MATCH 1 0 MATCH DESCRIPTION EXACT OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 43 of 61 Radius XML LPI request https api ordnancesurvey co uk places v1 addresses radius point 437307 9620115579 53 amp RADIUS 100 amp format XML amp dataset LPI amp key INSERT USER API KEY HERE OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 44 of 61 API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL radius Resource being requested point Bounding box coordinates to be analysed amp radius Radius around the point to be used as the centre amp format Format being requested xm1 amp dataset Dataset being requested LPT amp key User API authentication key Output lt AddressAPI gt lt header gt
13. NURSLING POST TOWN SOUTHAMPTON POSTCODE SO16 OTN RPC 2 X COORDINATE 437505 0 OS Places technical specification chapter 2 v1 5 03 2015 Crown copyright Page 19 of 61 y COORDINATE 116503 0 STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODI RD CLASSIFICATION CODE DESCRIPTION Dwelling LOCAL CUSTODIAN CO 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address IE D Gil CJ LH UC U LH EI R R BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000016343656 LAST UPDATE DATE 07 05 2010 ENTRY DATE 08 10 2001 BLPU STATE DATE 19 02 2009 MATCH 0 9 MATCH DESCRIPTION GOOD Lr I XML LPI match request https api ordnancesurvey co uk places v1 addresses match query ORDNANCE 20SURVEY 204 20ADANAC 20DRIVE 20NURSLING 20SOUTHAMPTON 20S016 200AS amp format xml amp dataset LPI amp key INSERT_USER_API _KEY_HERE OS Places technical specification chapter 2 v1 5 03 2015 Crown copyright Page 20 of 61 The Unique Property Reference Number The Unique Property Reference Number https api ordna
14. STREET CLASSIFICATION CODE WA STREET CLASSIFICATION CODE DESCRIPTION All vehicles LPI LOGICAL STATUS CODE s Ir LPI LOGICAL STATUS CODE DESCRIPTION APPROVED MATCH 1 0 MATCH DESCRIPTION EXACT Lr OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 56 of 61 Annexe A OS Places usage Stress testing The user is not allowed to stress test the service at any time If the user requires to stress test OS Places then please contact Ordnance Survey at least two weeks in advance who will discuss your requirements API key security The security and usage of the API key is the responsibility of the developer If the API key is visible to the end user then adequate procedures should be undertaken to ensure that the key is not used by unintended parties OS Places technical specification annexe A v1 5 03 2015 Crown copyright Page 57 of 61 Annexe B Glossary The purpose of this chapter is to provide a glossary of terms used in the definition of products services licensing and other terms and conditions for AddressBase and OS Places Address products Where terms refer to other terms within the glossary they are connected by means of hyperlinks to the relevant entries AddressBase A range of
15. Ordnance Survey does not accept any liability whether for breach of contract negligence or otherwise for any loss or liability you or any third party may suffer in relying on this guide and any guidance suggestion advice or explanation provided in it Any liability that Ordnance Survey has to you in relation to the product its supply use accuracy data supplied functionality or any other liability arising out of or in connection with the product is limited as set out in your customer contract We may change the information in this guide at any time without notice We do not accept responsibility for the content of any third party websites referenced or accessed in or through this guide any contractual documentation and or the Ordnance Survey website OS Places user guide preface v1 5 03 2015 Crown copyright Page 3 of 61 Copyright in this guide This guide including for the avoidance of doubt any mapping images reproduced herein is Crown copyright 2014 All rights reserved Any part of this guide may be copied for use internally in your organisation or business so that you can use the product for the purpose for which it is licensed to your organisation or business but not otherwise No part of this guide may be reproduced or transmitted in any form or by any means including electronically for commercial exploitation without the prior written consent of Ordnance Survey No part of this guide may be copied or incor
16. lt CLASSIFICA T Cr che lt CLASSIFICATION CODE LOCAL C LOCAL C VALLEY LOCAL CUSTODIAN CO POSTAL E gt NURS 87 lt USRN gt PPROV TION COD ION CODE RIPTION gt DIAN CODE 1760 1 ESC RATIVE AREA gt HAMPSHI LOCATOR gt SO16 OAS lt E 437367 0 X COO E 115432 0 Y COO ED lt STAT UPRN gt GI ESCRIPTION gt NO MATCH lt MATCH DESCRIPTION gt NURSLING HAMPSHIRE SO16 OAS ERY lt ORGANISATION gt ER gt UFFIX gt PTION gt ADANAC D E lt STREET DESCRIPTION gt ING TOWN NAM E lt ADMINISTRATIVE AREA POSTCODE LOCATOR V RDINAT RDINAT EC DIAN CODE PTION gt TEST lt POSTA A ESCRIPTION gt ESS CODE gt S lt POSTA gt gt EJ Ia E gt 1 lt LOGICAL STATUS CODE ASSIFICATION CODE ESCRIPTION Children s Nursery USTODIAN CODE ESS CODE address POSTAL ADDRESS CO BLPU STAT lt BLPU_ STATE D R R D E COD ESCRIPTION gt E 2 BL CODE DESCRIPTION gt In use BLPU STATE CODE DESCRI LAST UPDAT ENTRY DAT BLPU STATE STREET ST STREET PTION gt E DAT E gt 01 0 DE CODE gt 1 lt ST
17. Availability and service parameters Service levels OS Places Service availability 99 9 Planned maintenance 8 00 am 12 00 pm Sundays and 11 00 pm 3 00 am business days Four days notice is provided for planned maintenance Access to help Ordnance Survey provides telephone support for queries on service availability subscription and technical information about the service itself from 8 30 am to 5 30 pm Monday to Friday through the Customer Service Centre Contact details can be found in the preface to this guide For assistance on setting up and using a client to access the service customers are urged to contact their system supplier and their IT security manager The IT security manager is likely to be responsible for and understand firewall and IT security protocols so is likely to able to offer advice on an optimal solution for accessing and onward managing of the OS Places service OS Places user guide chapter3 v1 5 03 2015 Crown copyright Page 10 of 61 Annexe A Product and service performance report form Ordnance Survey welcomes feedback from its customers about OS Places If you would like to share your thoughts with us please print a copy of this form and when completed post or fax it to the address below biu M Organisaatio EE EE EE EE EE EE ee dg ae PRONE So P EE RE Emaili
18. Which language of addresses to return Valid languages are English and Welsh Filter only applicable to DPA dataset Default value is both languages Valid values EN CY matchprecision optional integer The decimal point position at which the match score value is to be truncated Valid values 1 2 3 4 5 6 7 8 9 10 Example requests Due to the purposely fuzzy nature of the Find resource the response outputs have been trimmed The total results found by the search can be noted in the header metadata of the response under the key of totalresults with the returned results under the key maxresults Basic Find query request https api ordnancesurvey co uk places v1 addresses find query ORDNANCE 20SURVEY 204 20ADANAC 20 DRIVE amp key INSERT_USER_API_KEY_HERE OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 23 of 61 API components https api ordnancesurvey co uk places v1 addresses Description OS Places URL find Resource being requested query Free text search parameter amp key User API authentication key Output header uri https api ordnanc
19. and Property Gazetteer LLPG Custodian responsible for the maintenance of this record Valid values See codes list Size as per code definition document Multiplicity 1 CLASSIFICATION CODE optional char A code that describes the classification of the record for example CEO1HE is a higher education establishment Valid values See codes list Size 1 2 4 6 Multiplicity 1 CLASSIFICATION CODE DESCRIPTION optional char A description that describes the classification of the record for example CEO1HE is a higher education establishment Valid values See codes list Size as per code definition document Multiplicity 1 POSTAL ADDRESS CODE optional char A code that describes the type of postal delivery that the object is subjectto Valid values S N C M Size 1 Multiplicity 1 POSTAL ADDRESS CODE DESCRIPTION optional char A description that describes the type of postal delivery that the object is subject to Valid values A single address Not a postal address This is a multiple occupancy or child address This is a parent address with at least one child or associated address that may receive post Size 100 Multiplicity 1 LOGICAL STATUS CODE optional integer Acode for the logical status of the BLPU Valid values 1 3 6 8 Size 1 Multiplicity 1 BLPU STATE CODE optional integ
20. api ordnancesurvey co uk places vl addresses uprn uprn 20001001992 O amp format xml amp dataset LPI uri query uprn 200010019920 query lt offset gt 0 lt offset gt totalresults 1 totalresults format xml format lt dataset gt LPI lt dataset gt lt maxresults gt 100 lt maxresults gt lt epoch gt 29 lt epoch gt lt header gt lt results gt lt LPI gt A lt ADDRESS gt 1A ADANAC DRIV OTE ADDRESS USRN gt 40020087 lt USRN gt UPRN gt 200010019920 lt UPRN gt E NURSLING HAMPSH LPI KEY 21760L000063829 LPI KEY PAO START NUMBER gt 1 lt PAO START NUMBER E PAO START SUFFIX gt A lt PAO START SUFFIX gt lt STREET DESCRIPTION gt ADANAC DRIVE lt STREET DE TOWN NAME gt NURSLING lt TOWN NAME gt lt ADMINISTRATIVE AREA gt HAMPSHIRE lt ADMINISTRAT lt POSTCODE lt RPC gt 2 lt RPC gt GI lt X_COORDINATE gt 437186 0 lt X_COORDINAT lt Y_COORDINATE gt 116240 0 lt Y COORDINAT LOCATOR gt SO16 OT gt gt EJ Es lt STATUS gt PROVISIONAL lt STATUS gt lt LOGICAL STATUS CODE gt 6 lt LOGICAL STATUS COD CLASSIFICATION CODE COO1 CLASSIFICATION CODE CLASSIFICATION CODE DESCRIPTION Office Work Studio CLASSIFICATION CODE DESCRIPTION VALLEY LOCAL CUSTODIAN CODE DESCRIPTION POSTAL ADD P
21. bus aisle pe eee ee e Peu 9 GO OSES e m 9 Chapter 3 TT T 10 Availability and service parameterS eene ene tnen en tnntnnenne ne ennttn snnt tnse nennen enne 10 ACCOSSLO Fel n L 10 Annexe A Product and service performance report form ee ecce ee eese eee eee ee eene nennen EEN EER KEE 11 v1 5 03 2015 D05300 51 OS Places user guide contents v1 5 03 2015 Crown copyright Page 2 of 61 Preface This user documentation is designed to provide an overview of the Capture and Verification Matching and Cleansing and GeoSearch Service products giving technical specifications and guidelines on how to optimally use them It assumes a general knowledge of geographic information If you find an error or omission in this guide or otherwise wish to make a comment or suggestion as to how we can improve the guide please contact us at the address shown below under contact details or complete the product and service performance report form at annexe A and return it to us Contact details Our Customer Service Centre will be pleased to deal with your enquiries Customer Service Centre Ordnance Survey Adanac Drive SOUTHAMPTON SO16 0AS General enquiries calls charged at local rate 44 0 3456 050505 Dedicated Welsh Language HelpLine 03456 050504 Textphone deaf and hard of hearing users only please 44 0 23 8005 6146 c
22. public roads and streets in their administrative area logical status An indicator of the current status of a specified BLPU or LPI record in an LLPG LPI or Land and Property Identifier Used to describe the location of a BLPU Also see BS 7666 2 2006 page 2 section 3 5 for definition mandatory An action parameter or process that must be undertaken metadata Graphical or textual information about the content quality condition origins and characteristics of data National Grid Aunique referencing system that can be applied to all Ordnance Survey maps of Great Britain at all scales It provides an unambiguous spatial reference for any place or entity in Great Britain northing A value on the Y axis of the National Grid of Great Britain object A real world entity associated with land and property optional An action parameter or process that may be undertaken organisation name The name on the fascia of a building OS Places technical specification annexe B v1 5 03 2015 Crown copyright Page 59 of 61 OWPA or objects without a postal address Object such as recreation ground open space public convenience church or car park that does not receive mail PAO or Primary Addressable Object The Primary Addressable Object Name PAON is the designated premise number and or the premise name where neither of these exist then the PAON is the name of the organisation in occupation or a description of the addressable ob
23. values EN CY OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 31 of 61 Example requests Basic postcode request https api ordnancesurvey co uk places v1 addresses postcode postcode SO1696200AS amp key INSERT USER API K EY HERE API Components Description https api ordnancesurvey co uk places v1 addresses OS Places URL postcode Resource being requested postcode Postcode being queried amp key User API authentication key Output header uri https api ordnancesurvey co uk places vl addresses postcode postcode 8016 200AS Offset 0 totalresults 1 format JSON dataset DPA lr EN CY maxresults 100 epoch 29 D I results DPA a f UPRN 200010019924 ADDRESS ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON S016 OAS ORGANISATION NAME ORDNANCE SURVEY BUILDING NUMBER 4 THOROUGHFARE NAME ADANAC DRIVE DEPENDENT LOCALITY NURSLING POST TOWN SOUTHAMPTON POSTCODE SO16 OAS RPC 2 X COORDINATE 437318 0 Y COORDINATE 115539 0 STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE COO1GV D
24. 016 OAS COMPASS HOUSE S016 4BY ORDNANCE SURVEY 20 CANON STREET TAUNTON TA1 1SW ORDNANCE SURVEY UNIT 9 ECKLAND DESBOROUGH ROAD MARKET HARBOROUGH LE16 8HB ORDNANCE SURVEY TECHNOLOGY CENTRE JAMES WATT AVENUE EAST KILBRIDE GLASGOW G75 OQD one s T Street Organisation Town City Area Postcode PO Box Status Dataset Submit The postcode resource is intended to be a quick lookup for addresses within a postcode area with either a full or partial postcode as the query UPRN is a specific search based on the UPRN of a property and therefore will only return one result for each dataset that contains a match due to the nature of a UPRN GeoSearch GeoSearch provides three resources that allow queries to be made using geographic information such as points and bounding boxes The nearest resource returns the address closest to a set of British National Grid BNG coordinates The bounding box resource returns all the addresses within a bounding box and the radius search returns all the addresses within a radius of a given point Due to Northern Ireland addresses being outside of BNG GeoSearch is not available for addresses in Northern Ireland OS Places user guide chapter 2 v1 5 03 2015 Crown copyright Page 9 of 61 Chapter 3 Support The OS Places service is available 24 7 with telephone support from 8 30 am to 5 30 pm Monday to Friday direct to the Ordnance Survey Customer Service Centre
25. 400 message Requested bbox must be less than lkm2 Requested BBox was 400000 100000 500000 600000 Radius request is above the maximum radius of 1 km error statuscode 400 message Radius must be less than or equal to 1km Requested Radius was radius OS Places technical specification chapter 1 v1 5 03 2015 Crown copyright Page 17 of 61 Chapter 2 Matching and Cleansing resource Match resource The match resource is more accurate than the find resource but is stricter on which addresses are matched Like the find resource it uses a free text search based on the query parameter Both the DPA and LPI datasets can be searched To effectively use the match resource a relatively complete address is required searching for only the first line of an address will not be adequate to get results from the service and the search query is too ambiguous Such searches are better suited for the find resource Parameters query Mandatory char The free text search parameter format optional char The format the response will be returned in Default value is JSON Valid values xml json maxresults optional integer The maximum number of results to return Default is 100 Valid values 1 100 offset optional integer Offset the list of returned by this amount dataset optional char The dataset to return DPA and or LPI Multiple v
26. AMPTON SO16 OAS ORGANISATION NAME ORDNANCE SURVEY BUILDING NUMBER 4 THOROUGHFARE NAME ADANAC DRIVE DEPENDENT LOCALITY NURSLING POST TOWN SOUTHAMPTON POSTCODE SO16 OAS RROTA WM X COORDINATI Y COORDINATI STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE CO0O1GV CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 DE I 2 437318 0 of 115539 0 F P F P LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 MATCH 1 0 MATCH DESCRIPTION EXACT Lr Nearest XML LPI request https api ordnancesurvey co uk places v1 addresses nearest point 437307 9620115579 53 amp format XML amp dataset LPl amp key INSERT USER API KEY HERE OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 36 of 61 API components Descrip
27. ANAC ING TOWN NAME EA gt HAMPS E gt 437318 0 lt X_COO E 115539 0 Y COO ED lt STAT CODE gt 1 lt LOGICA US gt 115579 53 radius 100 lt query gt NURSLING HAMPSHIR PI KEY PET DRIVE STREET D V R R DINAT DINAT gt gt EE Je STATUS CODE h D LPL CO Z gt gt 176 CO DES OO ET COD V gt N S P LE Ed Fd e H COD LI ESC I gt 2 lt B PTION gt PU D h CODE DESC h use BLPU STATE CODE DESCR lt TOPOGRA PHY LAYE lt lt ENT D BLE STR R TO F LAST UPDAT RY DAT U STATE IET STAT LPL I ON gt h E gt DAT 01 0 D DAT h 9 201 2501 0 E CO DE gt 1 lt RIPT D gt osgb1000002682081995 lt TOPOG E gt 01 09 2010 lt LAST UPDAT T 0 9 2 ST Dok 0 lt LOCAL C CRIPTION gt TEST OSTAL ADD RIPTION gt A RESS CODE single STATE CODE ION gt In RAPHY Gl ESC HIRE lt ADMINISTRATIVE _LOCATOR gt SO16 OAS POSTCODE RI SO16 PTION gt h AR EA j OCATOR AY E gt CO01GV lt CLASSIFICATION CODE ESCRIPTION gt Central Government USTODIAN CODE ER TOID
28. E 2116503 0 Y COORDINAT lt STATUS gt APPROVED lt STATUS gt lt LOGICAL STATUS CODE gt 1 lt LOGICAL STATUS CODE CLASSIFICATION CODE gt RD lt CLASSIFICATION COD gt gt Gl GI IS gt CLASSIFICATION CODE DESCRIPTION gt Dwelling lt CLASSIFICATION CODE oc ESCRIPTION LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE LOCAL CUSTODIAN CODE DESCRIPTION gt TEST VALLEY LOCAL CUSTODIAN CODE DESCRIPTION POSTAL ADDRESS CODE gt S lt POSTAL ADDRESS CODE POSTAL ADDRESS CODE DESCRIPTION gt A single address POSTAL ADDRESS CODE DESCRIPTION lt BLPU STATE CODE 2 BLPU STATE CODE BLPU STATE CODE DESCRIPTION gt In use BLPU STATE CODE DESCRIPTION TOPOGRAPHY LAYER TOID 0sgb1000016343656 TOPOGRAPHY LAYER TOID LAST UPDATE DATE 207 05 2010 LAST UPDATE DATE ENTRY DATE 208 10 2001 ENTRY DATE BLPU STATE DATE 19 02 2009 BLPU STATE DATE STREET STATE CODE gt 2 lt STREET STATE CODE STREET STATE CODE DESCRIPTION gt Open lt STREET STATE CODE DESCRIPTION STREET CLASSIFICATION CODE gt 8 lt STREET CLASSIFICATION CODE STREET CLASSIFICATION CODE DESCRIPTION gt A11 vehicles l
29. ER integer Multiplicity 0 1 The end of the number range for the PAO Size 4 Multiplicity 0 1 PAO END SUFFIX char The suffix to the pao_end_number Size 2 Multiplicity 0 1 PAO TEXT char Contains the building name or description for the PAO Size 90 STREET DESCRIPTION char Multiplicity 0 1 Name description or street number Size 100 Multiplicity 1 LOCALITY NAME char An area or geographical identifier within a town village or hamlet Size 35 Multiplicity 0 1 TOWN NAME char Town name Size 30 Multiplicity 0 1 ADMINISTRATIVE AREA char Local Highway Authority name Size 30 Multiplicity 0 1 AREA NAME char Size 35 Third level of geographic area name for example to record island names or property groups such as crofts Multiplicity 0 1 POSTCODE LOCATOR char Postcode of the coordinate for the BLPU based purely on a spatial match against Code Point with polygons This field must be used in conjunction with the RPC field to determine the accuracy of its position OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 52 of 61 Size 8 Multiplicity 1 RPC integer The Representative Point Code Used to describe the nature of the coordinated allocated to the address Size 1 Mul
30. Grid spatial reference system For addresses in Northern Ireland the coordinate 0 0 is returned Size 7 2 Multiplicity 1 STATUS optional char A textual representation of the logical status code Valid values are APPROVED ALTERNATIVE PROVISONAL For addresses in Northern Ireland an empty string is returned Size 11 Multiplicity 1 MATCH optional float A score ranging from 0 0 1 0 given to the result representing how well it matches the query An exact match 1 0 Good match 0 8 0 9 Partial match 0 7 Please be aware that for the postcode resource the returned value will always be 0 0 Conditional only returned for find and match resources Size 1 1 Multiplicity 0 1 MATCH DESCRIPTION optional char A textual representation of the match score Valid values are EXACT GOOD PARTIAL Please be aware that for the postcode resource the returned string will always be NO MATCH Conditional only returned for find and match resources Size 7 Multiplicity 0 1 OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 48 of 61 LOCAL CUSTODIAN CODE optional integer Unique identifier of the Local Land and Property Gazetteer LLPG Custodian responsible for the maintenance of this record Valid values See codes list Size 4 Multiplicity 1 LOCAL CUSTODIAN CODE DESCRIPTION optional char Description of the Local Land
31. ION optional char Description of the Local Land and Property Gazetteer LLPG Custodian responsible for the maintenance of this record Valid values See codes list Size as per code definition document Multiplicity 1 CLASSIFICATION CODE optional char A code that describes the classification of the record for example CEO1HE is a higher education establishment Valid values See codes list Size 1 2 4 6 Multiplicity 1 OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 53 of 61 CLASSIFICATION CODE DESCRIPTION optional char A description that describes the classification of the record for example CEO1HE is a higher education establishment Valid values See codes list Size as per code definition document Multiplicity 1 POSTAL ADDRESS CODE optional char A code that describes the type of postal delivery that the object is subject to Valid values S N C M Size 1 Multiplicity 1 POSTAL ADDRESS CODE DESCRIPTION optional char A description that describes the type of postal delivery that the object is subject to Valid values A single address Not a postal address This is a multiple occupancy or child address This is a parent address with at least one child or associated address that may receive post Size 100 Multiplicity 1 STREET STATE CODE
32. IONS requests while also allowing caching via the HTTP ETag and Last Modified date headers AddressBase Premium AddressBase Premium is an Ordnance Survey addressing product that contains information relating to an address or property from creation to retirement It contains local authority Ordnance Survey and Royal Mail addresses structured in a relational database model Each address is assigned a Unique Property Reference Number UPRN DPA and LPI It is possible to search the Delivery Point Address DPA and or Local Property Identifier LPI databases for records of the queried address OS Places technical specification chapter 1 v1 5 03 2015 Crown copyright Page 14 of 61 DPA A Delivery Point address is defined as a property that receives deliveries from Royal Mail including addresses within Northern Ireland LPI A Local Property Identifier is a structured text entry that identifies a Basic Land and Property Unit BLPU A BLPU is defined as a real world object that is an area of land property or structure of fixed location having uniform occupation ownership or function and does not need to receive deliveries from Royal Mail to exist Depending on the dataset chosen the output will vary API resources and parameters The address matching parameters are the inputs possible for the product comprising of mandatory and optional inputs over four resources Resources are the function by which the inputs will be ran ag
33. LASSIFICATION CODE ESCRIPTION Central Government RIPT CO E gt P ON 1760 LOCAL CUSTODIAN CODE DESCRIPTION gt TEST RIPT I D eor I _CODE ON gt gt S lt POSTA ADDRESS CODE COD I D ESCRIPTION gt A single RI E COD E 2 BL E CODE D ESCR use BLPU STATE CODE D ESCRI lt TOPOGRA PHY LAYER TOI LAST UPDATE PTION gt D gt osgb1000002682081995 lt TOPOGRA DAT E gt 01 0 PTION gt PU STATE COD IPTION gt In B PHY LAY DATE ER TOID 9 2010 LAST UPDAT I OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 33 of 61 lt ENTRY_DATE gt 01 09 2010 lt ENTRY_DATE gt BLPU STATE DATE 01 09 2010 BLPU STATE DATE STREET STATE CODE gt 1 lt STREET STATE CODE STREET STATE CODE DESCRIPTION Under construction lt STREET STATE CODE DESCRIPTION STREET CLASSIFICATION CODE 8 STREET CLASSIFICATION CODE STREET CLASSIFICATION CODE DESCRIPTION Al1 vehicles STREET CLASSIFICATION CODE DESCRIPTION lt LPI_ LOGICAL STATUS CODE 1 LPI LOGICAL STATUS CODE I Q al
34. LPU_STATE DATE STREET STATE CODE gt 1 lt STREET STATE CODE STREET STATE CODE DESCRIPTION Under construction STREET STATE CODE DESCRIPTION STREET CLASSIFICATION CODE gt 8 lt STREET CLASSIFICATION CODE STREET CLASSIFICATION CODE DESCRIPTION gt A11 vehicles STREET CLASSIFICATION CODE DESCRIPTION I I lt LPI_LOGICAL STATUS CODE 1 LPI LOGICAL STATUS CODE LPI LOGICAL STATUS CODE DESCRIPTION gt APPROVED lt LPI LOGICAL STATUS CODE CRIPTION Jg Re lt MATCH gt 1 0 lt MATCH gt MATCH DESCRIPTION gt EXACT lt MATCH DESCRIPTION LPI lt LPI gt UPRN gt 200000699027 lt UPRN gt lt ADDRESS gt 4 LUKIN DRIVE NURSLING HAMPSHIRE SO16 OTN lt ADDRESS gt lt USRN gt 40015511 lt USRN gt lt LPI_KEY gt 1760L000030266 lt LPI KEY lt PAO START NUMBER gt 4 lt PAO START NUMBER STREET DESCRIPTION gt LUKIN DRIVE lt STREET DESCRIPTION TOWN NAME gt NURSLING lt TOWN NAME gt lt ADMINISTRATIVE AREA gt HAMPSHIRE lt ADMINISTRATIVE AREA gt POSTCODE LOCATOR gt SO16 OTN POSTCODE LOCATOR lt RPC gt 2 lt RPC gt lt X_COORDINATE gt 437505 0 lt X_COORDINAT Y COORDINAT
35. N CODE gt CO01GV lt CLASSIFICATION CODE CLASSIFICATION CODE DESCRIPTION gt Central Government Service CLASSIFICATION CODE DESCRIPTION V I 2 2 Si Je LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY LOCAL CUSTODIAN CODE DESCRIPTION POSTAL ADDRESS CODE gt S lt POSTAL ADDRESS CODE DDRI POSTAL ADDRESS CODE DESCRIPTION gt A single address POSTAL ADDRESS CODE DESCRIPTION BLPU STATE CODE 22 BLPU STATE CODE lt BLPU STATE CODE DESCRIPTION In use BLPU STATE CODE DESCRIPTION TOPOGRAPHY LAYER TOID 0sgb1000002682081995 TOPOGRAPHY LAYER TOID LAST UPDATE DATE gt 01 09 2010 lt LAST UPDATE DATE ENTRY DATE 201 09 2010 ENTRY DATE lt BLPU STATE DATE 201 09 2010 BLPU STATE DATE STREET STATE CODE gt 1 lt STREET STATE CODE STREET STATE CODE DESCRIPTION Under construction STREET STATE CODE DESCRIPTION Gl I uo I OS Places technical specification chapter 4 v1 5 03 2015 Cro
36. ON CODE gt CO01GV lt CLASSIFICATION CODE ESCRIPTION gt Central Government E 1760 LOCAL C ESCRIPTION gt TEST E gt S lt POSTA ESCRIPTION gt A PU_STAT RIPTION gt In D gt osgb1000002682081995 lt TOPOG E 01 09 2010 LAST UPDATE 9 2010 Gl uo STATUS CODE USTODIAN CODE ADDRESS CODE single B E COD RAPHY LAY DATE ER TOID NTRY DAT 10 BLPU STATE EET STATE CODE PTION gt Under E gt DATE ET STAT E CODE C CO _D ESCRI PTION gt OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 41 of 61 T STREET CLASSIFICATION CODE gt 8 lt STREET CLASSIFICATION CODE STREET CLASSIFICATION CODE DESCRIPTION All ET CLASSIFICATION CODE DESCRIPTION LPI LOGICAL STATUS CODE 1 LPI LOGICAL STATUS CODE vehicles STR I I lt LPI LOGICAL STATUS CODE DESCRIPTION gt APPROVED lt LPI LOGICAL STATUS CODE CRIPTION gt Jg Re lt MATCH gt 1 0 lt MATCH gt MATCH DESCRI PTION gt EXACT lt MATCH DESCRI PTION gt lt LPI gt lt results gt lt AddressAPI gt Radius resource The radius resource takes a pair of coordinates as the centre for a circle and returns all address attributes t
37. OSTAL address POSTAL ADDRESS CODE ESCRIPTION RESS CODE gt S lt POSTAL ADDRESS CODI ADDRESS CODE DESCRIPTION gt A single D LOCAL CUSTODIAN CODE gt 1760 lt LOCAL CUSTODIAN CODE LOCAL CUSTODIAN CODE DESCRIPTION gt TEST ES lt BLPU STATE CODE 1 BLPU STATE CODE lt BLPU STATE CODE DESCRIPTION gt Under construction lt BLPU STATE CODE DESCRIPTION ENTRY DATE 01 09 2010 STREET STATE CODE gt 1 lt ST BLPU STATE DATE 01 09 2010 BLPU STATE DAT R IR GI SO16 SCRIPTION gt IVE AREA gt E POSTCODE LOCATOR E NTRY DATE LAST UPDATE DATE gt 01 09 2010 lt LAST UPDATE DATE B EET STATE CODE OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 30 of 61 I STREET STATE CODE DESCRIPTION gt Under construction lt STREET STATE CODE DESCRIPTION STREET CLASSIFICATION CODE gt 8 lt STREET CLASSIFICATION CODE STREET CLASSIFICATION CODE DESCRIPTION gt A11 vehicles lt STREET CLASSIFICATION CODE DESCRIPTION I LPI LOGICAL STATUS CODE 6 LPI LOGICAL STATUS CODE
38. Output header uri https api ordnancesurvey co uk places vl addresses bbox bbox 437179 20115401 20437343 2 20115643 query bbox 437179 115401 437343 115643 offset Oly totalresults 1 format JSON dataset DPA lr EN CY maxresults 100 epoch 29 D I results DPA UPRN 200010019924 ADDRESS ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON S016 OAS ORGANISATION NAME ORDNANCE SURVEY BUILDING NUMBER 4 THOROUGHFARE NAME ADANAC DRIVE DEPENDENT LOCALITY NURSLING POST TOWN SOUTHAMPTON POSTCODE SO16 OAS RPC 2 X COORDINATE 437318 0 Y COORDINATE 115539 0 STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE COO1GV CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 MATCH 1 0 MATCH DESCRIPTION EXACT OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 39 of 61 BBOX XML LPI request https api ordnancesurvey co uk pla
39. PA UPRN 200010019924 ADDRESS ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON SO16 OAS T ORGANISATION NAME ORDNANCE SURVEY BUILDING NUMBER 4 THOROUGHFARE NAME ADANAC DRIVE DEPENDENT LOCALITY NURSLING POST TOWN SOUTHAMPTON POSTCODE SO16 OAS URBGQM ue 2m3 X COORDINATE 437318 0 Y COORDINATE 115539 0 STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE COO1GV CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE TOU y POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use T E n P G P OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 50 of 61 TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 MATCH 1 0 MATCH DESCRIPTION EXACT LPI keys UPRN integer The Unique Property Reference Number For addresses in Northern Ireland an empty string is returned Size 12 Multiplicity 1
40. RATIVE AREA gt HAMPSHIRE lt ADMINISTRATIVE AREA gt POSTCODE LOCATOR gt SO16 OAS lt POSTCODE lt RPC gt 2 lt RPC gt X COORDINATE 437318 0 X COORDINAT Y COORDINATE 115539 0 Y COORDINAT lt STATUS gt APPROVED lt STATUS gt lt LOGICAL STATUS CODE gt 1 lt LOGICAL STATUS CODE j OCATOR 2 2 Gl DI CLASSIFICATION CODE gt CO01GV lt CLASSIFICATION CODE CLASSIFICATION CODE DESCRIPTION gt Central Government N S POSTAL ADDRESS CODI DESCRIPTION gt A single 21760 LOCAL CUSTODIAN CODE DESCRIPTION gt TEST bi V STATE CODE Service CLASSIFICATION CODE DESCRIPTION LOCAL CUSTODIAN CODE LOCAL CUSTODIAN CODE VALLEY LOCAL CUSTODIAN CODE DESCRIPTION POSTAL ADDRESS CODE POSTAL ADDRESS CODE DESCRIPTION BLPU STATE CODE gt 2 lt BLPU_ lt BLPU STATE CODE DESCRIPTION gt In use lt BLPU STATE CODE DESCRIPTION TOPOGRAPHY LAYER TOID 0sgb1000002682081995 TOPOGRAPHY LAYER TOID LAST UPDATE DATE gt 01 09 2010 lt LAST UPDATE DATE ENTRY DATE ENTRY DATE 201 09 2010 OS Places technical specification chapter 2 v1 5 03 2015 Crown copyright Page 21 of 61 BLPU STATE DATE gt 01 09 2010 lt B
41. RESS optional char Size 12 Multiplicity 1 String containing the concatenated address Size 142 Multiplicity 1 PO BOX NUMBER optional char Post Office Box PO Box number Size 6 Multiplicity 0 1 ORGANISATION NAME optional char The organisation name is the business name given to a delivery point within a building or small group of buildings This field could also include entries for churches public houses and libraries Size 60 Multiplicity 0 1 DEPARTMENT NAME optional char organisation at distinct delivery points In a few organisations department name is indicated because mail is received by subdivisions of the main Size 60 Multiplicity 0 1 SUB BUILDING NAME optional char The sub building name and or number are identifiers for subdivision of properties Size 30 Multiplicity 0 1 BUILDING NAME optional char Size 50 A description applied to a single building or a small group of buildings Multiplicity 0 1 BUILDING NUMBER optional integer The building number or postal number is a number given to a single building or a small group of buildings Size 4 Multiplicity 0 1 DEPENDENT THOROUGHFARE NAME optional char In certain places such as town centres there are named thoroughfares within other named thoroughfares Size 80 Multiplicity 0 1 THOROUGHFARE NAME opt
42. Search trial Service plan name 1 000 transactions Max number of transactions 1 000 To obtain the necessary API key the user creates an App within the Developer Portal At the end of the calendar month in which the user has purchased their plan the user will receive an invoice for the service Plans automatically renew after 12 months or when the limit is consumed through the Developer Portal the user is able to view their usage statistics for the service OS Places user guide chapter 1 v1 5 03 2015 Crown copyright Page 7 of 61 Chapter 2 OS Places service products OS Places has three service products available which are collections of different resources e Matching and Cleansing e Match resource e Capture and Verification e Find resource e Postcode resource e UPRN resource e GeoSearch o Nearest resource o Bounding Box resource o Radius resource Important depending on how the GET requests from the client application are handled or how auto complete libraries are configured this can result in frequent transactions to the service If intended frequent calls can be made which could aid the user experience but please be aware that ultimately it is the developer who is in control of the frequency to which the service is accessed and each query to the service will be billed as a standard transaction Matching and Cleansing Matching and Cleansing provides the match resource This resource is intended to be a more accura
43. UPRN LPI KEY LOGICAL STATUS SAO TEXT PAO TEXT OFFICIAL FLAG 1000778256312 90511000049106 1 Approved Flat 7 Hall Court Y OS Places User guide Contents Section Page no Preface NN EE 3 Contact details erinnere t Hr E He ERE REHEH HUN EEHEG besteed ebessen 3 Use Of relies 3 Purpose and disclaimer iie dieere ide ette tends eene kranini eiieeii RE re eb ak e ode o ERE ER dra ec E 3 Copyright BRE e 4 Data copyright and other intellectual property rights 4 Trademark osrin re nte eme ee nem er am ao RR nta demie 4 Enee TA ATT A 4 Chapter 1 OS Places introduction se c ccsveiiecidesicecsisestetesssececvass Eo S eae a Eege TESE EENS 5 Address Base PrE UN EE 5 lite due Ee 5 Explanation of AddressBase Premium 6 Unique Property Reference Number UPRN essere enne enne nett tnnt enters teens nnn 6 APL access and requirements ongiaren eL e te HERE EHE EE ERE E RE RI dE ene ERES TEREE 6 Northern Ireland Adresses csssssssscssessssessessescscescccasacsceassacscesssacscescsacscssceasscssceaseeesceaseessseaseeeaeeas 6 Developer Portal E 7 Chapter 2 OS Places service prodUCtS enee Ee 8 Matching and Cleansing ic reper rf eer re Fe EFI VE E UXOR NE ERES SURE ERE XE RENE eee Eo reed ER enun 8 Captutreand Verification cid iieri bereit geo i aisha erri Ee eve eei
44. VED lt STATUS gt lt LOGICAL_STATUS_CODE gt 1 lt LOGICA KEY gt IVE lt STREET DESCRIPTION gt V C LASSIFICATION CODE COO1GV Cl C LASSIFICATION CODE LOCAL CUSTODIAN LOCAL CUSTODIAN address lt POSTA use lt BLPU STATE U U 1 CUSTODIAN CODE DESCRI lt POSTAL A ESS E DESCRI D o o B POSTAL ADDRESS ADDRESS CODE DESCRI CODE PTI N gt lt BLPU STATE CODE DESCRI PTION gt TOPOGRAPHY LAYER TOI construction lt STRE vehicles lt STREET C lt LPI_ CRIPTION gt LAST UPDATE _ ENTRY DATE gt 01 0 lt BLPU_STATE DAT lt STREET I STATE lt BLPU STATE CODE gt 2 lt BL PU_STAT CODE DESCRIPTION gt I STREET STATE ESCR ET STATE STREET C STREET C CODE DESCRI PTION gt E lt ADMINISTRATIVE RDINAT RDINAT LASSIFICATION CODE _DESCRIPTION gt Central Government PTION gt COD COD PTION gt _CODE gt S lt POSTAL ADDRESS COD AREA OCATOR gt gt gt pH STATUS CODE E 1760 LOCAL CUSTODIAN CODE PTION gt TEST zal V DESCRIPTION gt A sin
45. aces technical specification chapter 4 v1 5 03 2015 Crown copyright Page 42 of 61 Example requests Basic radius request https api ordnancesurvey co uk places v1 addresses radius point 437307 115579 53 amp radius 100 amp key INSERT USER API KEY HERE API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL radius Resource being requested point Bounding box coordinates to be analysed amp radius Radius around the point to be used as the centre amp key User API authentication key Output header T uri T A T https api ordnancesurvey co uk places v1l addresses radius point 437307 115579 53 amp RADIUS 100 query point 437307 115579 53 radius 100 offset 0 totalresults 1 format JSON dataset DPA Tipe ER CY maxresults 100 epoch 29 results DPA UPRN 200010019924 ADDRESS ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON SO16 OAS ORGANISATION NAME ORDNANCE SURVEY BUILDING NUMBER Wat THOROUGHFARE NAME ADANAC DRIVE DEPENDENT LOCALITY NURSLING POST TOWN SOUTHAMPTON POSTCODE SO16 OAS RPC 2 X COORDINATE
46. address Valid values Approved Alternative Provisional Historical Size as per code definition document Multiplicity 0 1 Example LPI output LPI OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 55 of 61 UPRN 200010019924 ADDRESS 4 ADANAC DRIVE NURSLING HAMPSHIRE S016 OAS USRN 40020087 LPI KEY 1760L000063833 PAO START NUMBER 4 STREET DESCRIPTION ADANAC DRIVE TOWN NAME NURSLING ADMINISTRATIVE AREA HAMPSHIRE POSTCODE LOCATOR SO16 OAS RPC 2 X COORDINATE 437318 0 Y COORDINATE 115539 0 STATUS APPROVED E F P F P LOGICAL STATUS CODE 1 CLASSIFICATION CODE COO01GV CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE eom BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 STREET STATE CODE 1 STREET STATE CODE DESCRIPTION Under construction
47. address based products produced by GeoPlace and supplied exclusively by Ordnance Survey addressable object Anumber and or name as approved by the contributing authority for the LPI associated with the BLPU Address Seed The recorded centre point of an object as defined by an X and Y coordinate in British National Grid format AO N or addressable object name Generic term used to describe either the Primary or Secondary Addressable Object feature API Application programming interface attribute Any item of information packaged in an AddressBase feature The UPRN TOID and the geometry of the feature are both attributes of the feature BLPU or Basic Land and Property Unit A real world object recorded within a gazetteer child A child BLPU is represented by an LPI that contains an entry in both the SAO and PAO classification A description ofthe use of a real world object to be found at a BLPU conditional Dependent upon the type of the field being mandatory or optional for the data to be entered contributing authority A local authority responsible for creating and maintaining an LLPG data source The source of the application cross reference An external dataset that is linked to or provides a source of ACI database A system intended to organise store and retrieve large amounts of data easily Digital databases are managed using database management systems which store database contents allowing data creation and maint
48. ainst The seven resources are e Find matches a full or partial address text string e Match matches a full or partial address text string with more precision than the find resource e UPRN returns address attributes based on a UPRN e Postcode returns address attributes based on a postcode e Nearest returns the nearest address to a set of BNG coordinates e Bounding Box returns all the addresses within a bounding box e Radius returns all the addresses within the radius of a given point The parameters and values required for the service are not case sensitive URI encoding Please be aware that when sending a query to the service if the query contains reserved special characters please encode the query according to standard percent encoding procedures for a URI The list of reserved characters can be located here http tools ietf org html rfc3986 section 2 2 Examples of URI encoding can be found below Javascript URI Encoding var query ordnance survey 4 Adanac drive nursling Southampton var encodeUri encodeURI query PHP URI Encoding Squery ordnance survey 4 Adanac drive nursling Southampton SencodeUri rawurlencode query Service metadata Each request made contains metadata about the request in the header of the response This information includes the URI the string that was queried the format requested and other information uri char The unique resource ide
49. alues can be sent separated by a comma Default is DPA Valid values DPA LPI lr optional char Which language of addresses to return Valid languages are English and Welsh Filter only applicable to DPA dataset Default value is both languages Valid values EN CY matchprecision optional integer The decimal point position at which the match score value is to be truncated Valid values 1 2 3 4 5 6 7 8 9 10 Example requests Basic Match query request https api ordnancesurvey co uk places v1 addresses match query ORDNANCE 20SURVEY 204 20ADANAC 20DRIVE 20NURSLING 20SOUTHAMPTON 20S016 200AS amp key I NSERT_USER_API_KEY_HERE API Components Description https api ordnancesurvey co uk places v1 addresses OS Places URL match Resource being requested OS Places technical specification chapter 2 v1 5 03 2015 Crown copyright Page 18 of 61 query Free text search parameter amp key User API authentication key Output header uri https api ordnancesurvey co uk places vl addresses match query ORDNANCE 20SUR VEY 2C 204 2C 20ADANAC 20DRIVES2C 20NURSLING 2C 20SOUTHAMPTONS2C 20SO16 200AS
50. aset gt lt maxresults gt 100 lt maxresults gt lt epoch gt 29 lt epoch gt lt header gt lt results gt lt LPI gt OAS ADDRESS Service lt CLASSIFICATION CODE address POSTA UP ADD US LPI PAO K RN gt 200010 RESS gt 4 RN gt 400200 EY gt 176 START_N lt ST REET DE lt TOWN NAME gt NURS A RN gt 6383 lt ADMINIST lt POSTCODE lt RPC gt 2 lt I lt STATUS gt A C C LASSIFICA LASSIFICA RATIVE ION CODI TION CODE D D ESC lt lt OCA OCA me xs DIAN DIAN X ESC U U VALLEY lt LOCAL CUSTODIAN CODE A lt POSTA ESS lt POSTA D o ESS R DRI D ESC ADDRESS CODE U STAT U STAT BLP BLP E 437318 0 X COO E 115539 0 Y COO PPROVED STAT lt LOGICAL STATUS CODE gt 1 lt LOGICA 019924 lt UPRN gt DANAC DRIVE NURSLING HAMPSHIR Gl SO16 3 lt LPI_KEY gt ER gt 4 lt PAO_START_NUMBER gt IPTION gt ADANAC ING TOWN NAME AREA DAMES _LOCATOR gt SO16 OAS lt POSTCODE RPC gt lt X_COORDINAT Y COORDINAT DRIVE STREET D ESCRIPTION V HIRE lt ADMINISTRATIVE j OCATOR AR EA R R DINAT DINAT gt gt EI el US gt STATUS CODE E COO01GV C
51. at optional char The format the response will be returned in Default value is JSON Valid values xml json maxresults optional integer The maximum number of results to return Default is 100 Valid values 1 100 offset optional integer The format the response will be returned in Default value is JSON dataset optional char The dataset to return DPA and or LPI Multiple values can be sent separated by a comma Default is DPA Valid values DPA LPI lr optional char Which language of addresses to return Valid languages are English and Welsh Filter only applicable to DPA dataset Default value is both languages Valid values EN CY Example requests Basic BBOX request https api ordnancesurvey co uk places v1 addresses bbox bbox 437179 9620115401 9620437343 9020115643 amp key INSERT USER AP KEY HERE OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 38 of 61 API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL bbox Resource being requested bbox Bounding box coordinates to be analysed amp key User API authentication key
52. ces v1 addresses bbox bbox 437179 9620115401 9620437343 9020115643 amp format XML amp dataset LPI amp key INSERT USER API KEY HERE OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 40 of 61 API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL bbox Resource being requested bbox Bounding box coordinates to be analysed amp format Format being requested xm1 amp dataset Dataset being requested LPI amp key User API authentication key Output lt AddressAPI gt lt header gt lt uri gt https api ordnancesurvey co uk places vl addresses bbox bbox 437179 201 15401 620437343 20115643 amp format XML dataset LPI lt uri gt lt query gt bbox 437179 115401 lt offset gt 0 lt offset gt totalresults 1 totalresults format xml format lt dataset gt LPI lt dataset gt lt maxresults gt 100 lt maxresults gt lt epoch gt 29 lt epoch gt lt header gt lt results gt lt LPI gt OAS lt ADDRESS gt address lt POSTA ADDRI UP AD US LP ST TOWN lt ADMINIST lt POSTCODE lt RPC gt 2 lt lt X_COORDINAT lt Y_COORDINAT lt STATUS gt A LOGICAL STATU lt C C lt I lt PAO DRI ESS 4 A RN gt 40020087 lt USRN gt KEY gt 1760L0000 START NUMBER REET DESCRI NAME gt NURS
53. ch and zoom facilities and allows you to navigate within Hyperlinks are used to navigate between associated parts of the guide and to relevant Internet resources by clicking on the blue hyperlinks and the table of contents If you are unfamiliar with any words or terms used and require clarification please refer to the glossary at the end of the document OS Places user guide preface v1 5 03 2015 Crown copyright Page 4 of 61 Chapter 1 OS Places introduction OS Places is the brand for a range of data querying service products and developer tools that will enable customers to accomplish business tasks They are 1 Capture and Verification a service product that is intended for client side events and activities for example address form filling 2 Matching and Cleansing a service product that is intended for server side activities for example cleansing addresses in databases 3 GeoSearch a service product that is intended to enable address queries based on geographical information for example return the addresses in a bounding box They are intended to make queries to the database faster and simpler while retaining all the data found within the AddressBase Premium dataset The service is based on a RESTful API service with API key authentication allowing the API to be called with the correct URL structure a query and an API key AddressBase Premium AddressBase Premium provides the most detailed view of an address a
54. d Since headers A Conditional GET request will return a 304 status to indicate that no changes have been made to the underlying data and previously cached results are still valid If the search index has been updated then a 200 response will be served along with the requested results Conditional GET requests are faster to serve than the alternative which involves re running the search on the server and then re processing the full results on the client Clients are therefore encouraged to make use of this facility to improve overall performance from the product The service has the functionality to be able to check the DPA Royal Mail information and or the LPI local authority information dataset Northern Ireland addresses are within the DPA dataset and contain an empty string for the UPRN and status fields and the X Y coordinates are 0 0 due to being outside ofthe British National Grid GeoSearch is unavailable for Northern Ireland addresses as well as the UPRN resource within Capture and Verification Where applicable queries to the service can be made in English Welsh or Gaelic The service will respond in either XML or JSON format with JSON being the default format RESTful API A RESTful API is a service with which users can make different requests can be made to a server and the resources it hosts extracting relevant results when applicable The call is done via a https request The product supports GET requests as well as OPT
55. enance and search and other access The result of every query is presented as a relation dataset An identifiable set of data that share common characteristics and that are managed as a subset of the data within a database Delivery Point Address A Delivery Point Address is defined as a property that receives deliveries from Royal Mail OS Places technical specification annexe B v1 5 03 2015 Crown copyright Page 58 of 61 easting A value on the X axis of the National Grid of Great Britain field A defined area in a database record into which an item of data or value is entered header Supplemental data at the beginning of a file identifier An identifier that is primarily intended to provide unique and unambiguous feature identification for the purposes of exchanging feature based information between computer systems or associating data within a computer system JavaScript A programming language for web browsers used primarily for front end interaction JSON JSON JavaScript Object Notation is a lightweight data interchange format returning data in the javascript object format life cycle The series of events that occur in the life of a real world object or the address s that represents it This will always include those events that result in creation and deletion and may also include events that result in amendments or change Local Highway Authority A local authority with the responsibility for maintaining
56. enges M QUOTATION or orderref rence nun ORI RECHNEN N NC en Please record your comments or feedback in the space below We will acknowledge receipt of your form within three 3 working days and provide you with a full reply or a status report within 21 working days If you are posting this form please send it to OS Places Product Manager Ordnance Survey Adanac Drive SOUTHAMPTON SO16 OAS If you wish to return it by fax please dial 023 8005 6159 Any personal information that you supply with this report form will be used by Ordnance Survey only in the improvement of its products and services It will not be made available to third parties OS Places user guide annexe A v1 5 03 2015 Crown copyright Page 11 of 61 OS Places Technical specification Contents Section Introduction Chapter 1 Chapter 2 Chapter 3 Chapter 4 Chapter 5 Annexe A Annexe B Page no TII IL 13 Purpose of this specification and disclaimer 13 Copyright in this specification eese eene enne ener enne nete teeth tenent entere en nennen nnn 13 Dll me 14 BESTIOLARL get 14 AddressBase Premillm3 etie e eer e ev eee sn PER NV FE rte er eere Nese Pede deal EE NSSE rides 14 DPAcANG LPL E 14 API resources and param
57. er A code for the physical nature of the property or land object These are used to represent the physical state of the feature Valid values 1 2 3 4 6 null Size 1 Multiplicity 1 BLPU STATE CODE DESCRIPTION optional char A description for the physical nature of the property or land object There are used to represent the physical state OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 49 of 61 of the feature Valid values Under construction In use Unoccupied No longer existing Planning permission granted Unknown Not applicable Size As per code definition document Multiplicity 0 1 TOPOGRAPHY LAYER TOID optional char Unique key for the application cross reference record Size 14 Multiplicity 1 PARENT UREN optional integer UPRN of the parent record Size 12 Multiplicity 0 1 LAST UPDATE DATE optional date Date this record was last updated Size Date Multiplicity 1 ENTRY DATE optional date Date of the data entry Size Date Multiplicity 1 LEGAL NAME optional char Registered legal name of organisation Size 60 Multiplicity 0 1 BLPU STATE DATE optional date Date at which the BLPU achieved its current state in the real world Size Date Multiplicity 0 1 Example DPA output D
58. es can be sent separated by a comma Default is DPA Valid values DPA LPI lr optional char Which language of addresses to return Valid languages are English and Welsh Filter only applicable to DPA dataset Default value is both languages Valid values EN CY Example requests Basic UPRN request https api ordnancesurvey co uk places v1 addresses uprn uprn 200010019924 amp key INSERT USER API KEY HERE API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL uprn Resource being requested uprn UPRN being queried amp key User API authentication key Output header uri https api ordnancesurvey co uk places vl addresses uprn uprn 200010019924 query uprn 200010019924 ottset zc totalresults 1 format JSON dataset DPA Lp RN ECH maxresults 100 epoch 29 D I results DPA UPRN 200010019924 ADDRESS ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON SO16 OAS ORGANISATION NAME ORDNANCE SURVEY BUILDING NUMBER 4 THOROUGHFARE NAME ADANAC DRIVE DEPENDENT LOCALITY NURSLING POST TOWN SOUTHAMPTON POSTCODE SO16 OAS OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 28 of 61 RPO i ZU X COORDINAT
59. esurvey co uk places vl addresses find query ORDNANCES20SURVEY 6204 s20ADANAC S20DRIVE query query ORDNANCE SURVEY 4 ADANAC DRIVE offset 0 totalresults 2678569 format JSON dataset DPA lr EN CY maxresults 100 matchprecision Ly epoch 29 D I results WDPAM 2 UPRN 200010019924 ADDRESS ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON SO16 OAS ORGANISATION NAME ORDNANCE SURVEY BUILDING NUMBER As THOROUGHFARE NAME ADANAC DRIVE DEPENDENT LOCALITY NURSLING POST TOWN SOUTHAMPTON POSTCODE S016 OAS RPC 2 X COORDINATE 437318 0 Y COORDINATE 115539 0 STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE COO1GV CLASSIFICATION CODE DESCRIPTION Central Government Service LOCAL CUSTODIAN CODE 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS CODE S POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000002682081995 LAST UPDATE DATE 01 09 2010 ENTRY DATE 01 09 2010 BLPU STATE DATE 01 09 2010 MATCH 1 0 MATCH DESCRIPTION EXACT DPA UPRN 100062508062 ADDRESS UNIT 4 FRANCONIA DRIVE NURSLING SOUTHAMPTON SO16 OYW BUILDING NAME UNIT 4 THOROUGHFARE NAME FRANCONIA DRIVE DEPENDENT LOCALITY NURSLING OS Places
60. eters ecccceseeccesecseeseceeeeceaeescesecseesecseeeecaeeseesecseesecaecsecaaeeeceaecaeesesseeeeseaees 15 WRU CNCOGING E SetVice te E E Service HTTP codes Matching and Cleansing resource ccisiissccccssisescccsssccseccnvecccccesesistebessccsseeuetaccenseccevsseeoeaceusess 18 EU SieeI MM 18 Parameters ie iier o PELEAS EMERGERE UAR RUIN A IER UR ION 18 Elle EN D 18 Capture and Verification resources ecce eee e eee e eee e eene tena seats esses see so sess sess sess sess sessio 23 UA HES OUNCE cass fase ces E 23 Parameters E 23 elle ER UPRN FES OUNCE ss cssscs assess 27 Ia IIae n 28 Example tequests e e een reete ee E SEE XE E Ue Eeer Ee 28 POStCOD EH CSOUNCE C 31 INTE 31 elle 32 GEOSEANCH FESOUNCES siioni snaa aa deed davaes a a a 35 NEEE oe A E E E A E 35 LEETE EEEE E E E 35 elei ET 35 BBOX cre M 38 Parameters vec e EE Ea 38 Example Fedlests iis seen or retra reser et pe esee deae eet eden uve pe Reset educ eee PN PNE Ere 38 Radius TOSOUICE ee 42 Pala Ober fee 42 elle ET 43 ijt nl scscusssscsscsastsesiesteecessesasesasseraoensesusecases Eege 47 DPA KOS MC M 47 E
61. ference Number A Unique Street Reference Number is assigned to each street VOA or Valuation Office Agency Organisation responsible for the compilation of national registers of rateable property OS Places technical specification annexe B v1 5 03 2015 Crown copyright Page 60 of 61 XML Extensible Markup Language A flexible way to create common information formats and share both the format and the data on the Internet Intranets and elsewhere XML is extensible because unlike HTML the markup tags are unlimited and self defining XML is a simpler and easier to use subset of the Standard Generalised Markup Language SGML the standard for how to create a document structure OS Places technical specification annexe B v1 5 03 2015 Crown copyright Page 61 of 61
62. gle In D gt osgb1000002682081995 lt TOPOGRAPHY DATE 01 09 2010 1 9 2010 E 501 09 20 CODE gt 1 lt STR CODE D I AASSIFICATION CODE gt 8 lt STR AASSIFICATION CODE D ASSIFICATION CODE DESCRI MATCH 0 6 MATCH LPI LOGICAL STATUS CODE gt 1 lt L PI LAST UPDATE DATE NTRY DATE 10 BLPU ET STATE CODE PTION gt Under _DESCRI PTION E CODE AYER TOID gt STATE DATE gt I ET CLASSIFICATION CODE PTION gt A1LL GICAL STATUS CODE LOGICAL STATUS CODE DESCRIPTION gt APPROVE D LPI LOGICAL STATUS COD I OS Places technical specification chapter 3 v1 5 03 2015 Crown copyright Page 26 of 61 lt LPI gt lt LPI gt A A EXPLORERS DAY NURS GI construction lt STREET STATE STREET C STREET C vehicles STREET CLASSIFICAJ LPI LOGICA AA A AA A A lt PAO STA MATCH Dl UPRN gt 200010019925 lt ADDRESS gt RY 4A ADANAC DRIVE ADDRESS gt USRN gt 400200 PI KEY 17601000063834 LPI K ORGANISATION gt EXPLORERS DAY ER 4 PAO ST RT SUFFIX gt A lt PAO_ ST PAO START NUMB STREET ESCRI TOWN NAM lt ADMINIST lt POSTCOD lt RPC gt 2 lt lt X_COORDINAT Y COORDINAT lt STATUS gt A lt LOGICAL STATUS COD lt CLASSIFICA
63. hat are intersected by the resulting circle A property will only be considered to be included by the search if the Address Seed is in range of the search regardless of the property s physical boundaries This resource is unavailable for addresses within Northern Ireland Parameters point Mandatory char One comma separated coordinate set in BNG that specifies the coordinate at the centre of the search circle The precision of the coordinates is two decimal places that is 1 cm accuracy radius optional float The radius to search within in metres The maximum radius is 1 000 metres If above then an error message is returned The precision of the distance is to two decimal places that is 1 cm accuracy format optional char The format the response will be returned in Default value is JSON Valid values xml json maxresults optional integer The maximum number of results to return Default is 100 Valid values 1 100 offset optional integer The offset the list of returned by this amount dataset optional char The dataset to return DPA and or LPI Multiple values can be sent separated by a comma Default is DPA Valid values xml json lr optional char Which language of addresses to return Valid languages are English and Welsh Filter only applicable to DPA dataset Default value is both languages GI Valid values EN CY OS Pl
64. ied or incorporated in products services or publications that you generate for onward sale or as free promotional or support materials without the prior written consent of Ordnance Survey OS Places technical specification introduction v1 5 03 2015 Crown copyright Page 13 of 61 Chapter 1 Overview This section describes how to access the service products best practices for using it and expected behaviour of the service The service products described in this documentation are RESTful API services that enables users to perform Internet based search queries against services that use the AddressBase Premium dataset receiving back relevant address information for both internal and external applications The product is intended to provide a flexible and uncomplicated method with which to accomplish specific tasks The service is intended to be a quick and efficient way to access the information held within the AddressBase Premium product via an https GET request When a sufficient request is made to the service either a JSON or XML reply will be returned containing the results of the request Service responses are fully cacheable with caching supported via the HTTP ETag and Last Modified date headers When updates are made to the underlying datasets the values of these headers are automatically updated meaning that clients can easily revalidate locally cached results using Conditional GET requests via the If None Match and or If Modifie
65. ional char Size 80 A thoroughfare in AddressBase Premium is fundamentally a road track or named access route on which there are Royal Mail delivery points Multiplicity 0 1 OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 47 of 61 DOUBLE DEPENDENT LOCALITY optional char Used to distinguish between similar or same thoroughfares within a dependent locality Size 35 Multiplicity 0 1 DEPENDENT LOCALITY optional char Dependent locality areas may define an area within a post town Size 35 Multiplicity 0 1 POST TOWN optional char The town or city in which the Royal Mail sorting office is located Size 30 Multiplicity 1 POSTCODE optional char A postcode is an abbreviated form of address made up of combinations of between five and seven alphanumeric characters Size 8 Multiplicity 1 RPC optional integer The Representative Point Code Used to describe the nature of the coordinated allocated to the address Size 1 Multiplicity 1 X COORDINATE optional float Easting coordinates in metres defining the location in the British National Grid spatial reference system For addresses in Northern Ireland the coordinate 0 0 is returned Size 6 2 Multiplicity 1 Y COORDINATE optional float Northing coordinates in metres defining the location in the British National
66. ject parent In a parent child relationship a parent BLPU is represented by an LPI that contains an entry in the PAO but no entry in the SAO point A pair of coordinates REST Representational state transfer an architectural style used by the world wide web RESTful API An API that follows the RESTful architectural style RPC or Representative Point Code Quality statement with regard to the grid coordinate assigned to a BLPU SAO or Secondary Addressable Object The Secondary Addressable Object Name SAON is the number name or description used to identify the secondary addressable object within or related to a primary addressable object SNN or street naming and numbering Function performed by a contributing authority under the statutory legislation responsible for the approval of all street names and property numbering schemes within that administrative area street A way or thoroughfare providing a right of passage on foot by cycle or by motor vehicle or access to more than one property street name Official text approved by the contributing authority used to describe a type 1 street TOID An identifier that uniquely identifies addressable features associated within OS MasterMap Topography and OS MasterMap ITN products UDPRN A Unique Delivery Point Reference Number assigned by Royal Mail UPRN or Unique Property Reference Number A Unique Property Reference Number assigned to each BLPU USRN or Unique Street Re
67. nce Survey s surveyors Royal Mail Royal Mail provides the Postcode Address File PAF which provides the UDPRN and the delivery point address record Valuation Office Agency VOA VOA provides cross references to council tax CT and non domestic rates NDR records OS Places user guide chapter 1 v1 5 03 2015 Crown copyright Page 5 of 61 Explanation of AddressBase Premium Product name AddressBase Premium Features e UPRN e Royal Mail Postcode Address File e National Grid coordinates e References to OS MasterMap address TOID e Four levels of classification e Feature life cycle dates e Local authority addresses e OWPA e Multiple occupancy addresses e Local authority streets e USRN e Street start and end coordinates e References to all OS MasterMap TOIDs e Parent child relationships e Alternative addresses e Provisional addresses e Historical addresses Unique Property Reference Number UPRN The UPRN is the persistent key identifier providing consistency across the AddressBase products range Excluding addresses in Northern Ireland each address record has a UPRN which provides a reference key to join related address records across different datasets Throughout its life cycle information on the address of a property can change This may be due to a change of name change of use such as from single occupancy to multiple occupancies or the eventual demolition of the property All of
68. ncesurvey co uk places v1 addresses OS Places URL match Resource being requested query Free text search parameter amp format Format being requested xm1 amp dataset Dataset being requested LPT amp key User API authentication key Output lt AddressAPI gt lt header gt https api ordnancesurvey co uk places vl addresses match query ORDNANCE 20SURVEY 2C 204 2C 20ADANAC S20DRIVE 2C 20NURSLINGS2C 20SOUTHAMPTON 2C 20S016 200 lt uri gt AS amp format XML dataset LPI query ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING lt uri gt lt query gt lt query gt lt offset gt 0 lt offset gt lt totalresults gt 4 lt totalresults gt lt format gt xml lt format gt lt dataset gt LPI lt dataset gt lt maxresults gt 100 lt maxresults gt SOUTHAMPTON S016 OAS lt matchprecision gt 1 lt matchprecision gt lt epoch gt 29 lt epoch gt NURSLING HAMPSHIR IE SO16 lt header gt lt results gt lt LPI gt lt UPRN gt 200010019924 lt UPRN gt lt ADDRESS gt 4 ADANAC DRIVE OAS lt ADDRESS gt address lt POSTAL ADDRESS CODE lt USRN gt 40020087 lt USRN gt lt LPI_ KEY21760L000063833 LPI KEY lt PAO START NUMBER gt 4 lt PAO START NUMBER STREET DESCRIPTION gt ADANAC DRIVE lt STREET DESCRIPTION TOWN NAME gt NURSLING lt TOWN NAME V lt ADMINIST
69. nd its life cycle It has more records than other AddressBase products as it provides all the information relating to an address or property from creation to retirement It contains local authority Ordnance Survey and Royal Mail addresses current approved addresses and alternatives for current addresses reflecting differences in versions of addresses in current use provisional addresses proposed planning developments and historic information for each address where available plus OWPAs and cross references to the OS MasterMap TOIDs Information source Local Land and Property Gazetteer AddressBase Premium contains data provided by the creating authorities local custodian including information captured under statutory obligation through the SNN process This provides address data early in the property life cycle and is underpinned by the UPRN One Scotland Gazetteer AddressBase Premium contains data provided by the creating authorities local custodian including information captured under statutory obligation through the SNN process This provides address data early in the property life cycle and is underpinned by the UPRN Ordnance Survey Ordnance Survey brings together cross references to large scale data such as OS MasterMap Topography Layer and Integrated Transport Network Layer via the TOID Ordnance Survey provides additional objects without postal addresses as well as verifying each address coordinate position via Ordna
70. ntifier Multiplicity 1 query char Decoded query string OS Places technical specification chapter 1 v1 5 03 2015 Crown copyright Page 15 of 61 Multiplicity 1 offset integer The offset requested Multiplicity 0 1 totalresults integer Total number of results found Multiplicity 1 format char Requested format Multiplicity 1 dataset char Datasets requested Multiplicity 1 lr char The language requested Multiplicity 0 1 maxresults integer Maximum number of results requested Multiplicity 0 1 epoch char Aversion reference for the Data product Multiplicity 1 Below is an example of the metadata from a find resource request returned in JSON format header uri https api ordnancesurvey co uk places vl addresses find query ordnance 20survey amp key INSERT USER API KEY HERE query query ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON SO16 OAS offset 0 totalresults 2678569 format JSON dataset DPA lr EN CY maxresults 100 matchprecision 1 epoch 29 OS Places technical specification chapter 1 v1 5 03 2015 Crown copyright Page 16 of 61 Service HTTP codes Depending on the query made to the service different response codes will be sen
71. optional integer A code identifying the current state of the street Valid values 1 2 4 Size 1 Multiplicity 0 1 STREET STATE CODE DESCRIPTION optional char A description identifying the current state of the street Valid values Under construction Open Permanently closed y Size 100 Multiplicity 0 1 STREET CLASSIFICATION CODE optional integer A code for the primary street classification Valid values 4 6 8 9 10 Size 2 Multiplicity 0 1 STREET CLASSIFICATION CODE DESCRIPTION optional char A description for the primary street classification Valid values Pedestrian way or footpath Cycle track of cycleway All vehicles Restricted byway Bridleway Size as per code definition document Multiplicity 1 LOGICAL STATUS CODE optional integer A code for the logical status of the BLPU Valid values 1 3 6 8 Size 1 Multiplicity 1 BLPU_STATE CODE optional integer A code for the physical nature of the property or land object These are used to represent the physical state of the feature OS Places technical specification chapter 5 v1 5 03 2015 Crown copyright Page 54 of 61 Valid values 1 2 3 4 6 null Size 1 Multiplicity 1 BLPU STATE CODE DESCRIPTION optional char A description for the physical nature of the property
72. or land object There are used to represent the physical state of the feature amp Valid values Under construction In use Unoccupied No longer existing Planning permission granted Unknown Not applicable Size As per code definition document Multiplicity 0 1 TOPOGRAPHY LAYER TOLID optional char Unique key for the application cross reference record Size 14 Multiplicity 1 PARENT UREN optional integer UPRN of the parent record Size 12 Multiplicity 0 1 LAST UPDATE DATE optional date Date this record was last updated Size Date Multiplicity 1 ENTRY DATE optional date Date of the data entry Size Date Multiplicity 1 LEGAL NAME optional char Registered legal name of organisation Size 60 Multiplicity 0 1 BLPU STATE DATE optional date Date at which the BLPU achieved its current state in the real world Size Date Multiplicity 0 1 LPI LOGICAL STATUS CODE optional integer A code for the logical status of this record Valid values 1 3 6 8 Size 1 Multiplicity 1 LPI LOGICAL STATUS CODE DESCRIPTION optional char A description for the logical status reflects where the LPI has reached in its life cycle Logical status is important in identification of the addresses requirements for example whether it is an alternative address or an historic
73. porated in products services or publications that you generate for onward sale or as free promotional or support materials without the prior written consent of Ordnance Survey Data copyright and other intellectual property rights The Crown or where applicable Ordnance Survey s suppliers owns the intellectual property rights in Ordnance Survey digital map data Full details of the terms and conditions under which Ordnance Survey digital map data may be processed and or manipulated or copied by a customer whether or not for use on PCs or workstations or for making hard copies are available from the Customer Service Centre please see contact details You should check the terms and conditions with us before using the data It is also the responsibility of the holder of the digital map data to ensure that any plotted or printed output contains the required copyright and database acknowledgements in a conspicuous position Trademarks Ordnance Survey the OS Symbol AddressBase OS MasterMap and TOID are registered trademarks and Integrated Transport Network is a trademark of Ordnance Survey the national mapping authority of Great Britain Royal Mail PAF and PO Box are registered trademarks of Royal Mail Group Limited Ordnance Survey acknowledges all other trademarks Using this guide The documentation is supplied in portable document format PDF only Free Adobe Reader software which displays the guide incorporates sear
74. racy Default value is 100 metres format optional char The format the response will be returned in Default value is JSON Valid values xml json dataset optional char The dataset to return DPA and or LPI Multiple values can be sent separated by a comma Default is DPA Valid values DPA LPI lr optional char Which language of addresses to return Valid languages are English and Welsh Filter only applicable to DPA dataset Default value is both languages Valid values EN CY Example requests Basic nearest request https api ordnancesurvey co uk places v1 addresses nearest point 437307 9020115579 53 amp key INSERT USER API KEY HERE API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL nearest Resource being requested point Point being queried amp key User API authentication key Output header OS Places technical specification chapter 4 v1 5 03 2015 Crown copyright Page 35 of 61 Mae e D https api ordnancesurvey co uk places vl addresses nearest POINT 437307 320115 579 53 query point 437307 115579 53 offset r 0 totalresults 1 format JSON dataset DPA lr EN CY maxresults 1 epoch 29 hy results DPA UPRN 200010019924 ADDRESS ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTH
75. t A successful request will result in a code of 200 being returned whereas a request with incorrect syntax will respond with a code of 400 Below is a table comprising of the different HTTP response codes Code Description 200 Request has been successful 304 Not Modified In response to a conditional GET request this response indicates that the underlying data has not changed since the previous request and cached results may be re used 400 Bad request for example missing query parameter malformed syntax 401 Unauthorized the client has not provided authentication or incorrect authentication 404 The server has not found anything matching the Request URI 405 Method not allowed Request used an unsupported HTTP method for example DELETE or PUT 500 Generic internal server error Below are examples of returned error codes Incorrect resource error s 3 statuscode 404 message Resource maatch does not exist Valid resources are match find uprn postcode No query parameter set error statuscode 400 message No query parameter provided Non existent parameter given error i d statuscode 400 message Parameter daataset is not a valid parameter for resource find Valid parameters for requested resource are query format dataset maxresults offset Bounding box exceeds lkm error Y statuscode
76. t STREET CLASSIFICATION CODE DESCRIPTION lt LPI LOGICAL STATUS CODE gt 1 lt LPI LOGICAL STATUS CODE I Ee I LPI LOGICAL STATUS CODE DESCRIPTION APPROVED LPI LOGICAL STATUS CODE DES CRIPTION gt lt MATCH gt 0 9 lt MATCH gt MATCH DESCRIPTION GOOD MATCH DESCRIPTION LPI results lt AddressAPI gt OS Places technical specification chapter 2 v1 5 03 2015 Crown copyright Page 22 of 61 Chapter 3 Capture and Verification resources Find resource The find resource is a service request based on either a full or partial address intended to be a more ambiguous search function than the match resource query Mandatory char Parameters query Mandatory char The free text search parameter format optional char The format the response will be returned in Default value is JSON Valid values xml json maxresults optional integer The maximum number of results to return Default is 100 Valid values 1 100 offset optional integer Offset the list of returned by this amount dataset optional char The dataset to return DPA and or LPI Multiple values can be sent separated by a comma Default is DPA Valid values DPA LPI lr optional char
77. te and intensive search than the find query and therefore requires a more accurate query to return a result as well as taking more time to retrieve a result from the service than the find resource found in Capture and Verification The intention of the match resource is for it to be used on back end functions of address databases such as cleansing an already populated database providing uniformity to the database entries BUILDING_NUMBER COMPANY_NAME STREET_NAME AREA POST TOWN POSTCODE ADANAC DRIVE SOUTHAMPTON SO160AS ORDNANCE SURVEY NURSLING SOUTHAMPTON SO160AS ORDNANCE SURVEY ADANAC DRIVE NURSLING The above table demonstrates partial entries into a database When the existing addresses in the database are passed through as the query for the match resource the correct full address is returned BUILDING NUMBER COMPANY NAME STREET NAME AREA POST TOWN POSTCODE ORDNANCE SURVEY ADANAC DRIVE NURSLING SOUTHAMPTON SO160AS OS Places user guide chapter2 v1 5 03 2015 Crown copyright Page8 of 61 Capture and Verification Capture and Verification provides three resources The find resource is intended to be a fast address lookup service for front end functions such as populating address forms in a consistent manner Examples of such uses would be autocomplete address forms Enter Address ordnance survey 4 adanac drive southampton ORDNANCE SURVEY 4 ADANAC DRIVE NURSLING SOUTHAMPTON
78. technical specification chapter 3 v1 5 03 2015 Crown copyright Page 24 of 61 POST TOWN SOUTHAMPTON POSTCODE 5016 OYW RPC 1 X COORDINAT Y COORDINAT STATUS APPROVED LOGICAL STATUS CODE 1 CLASSIFICATION CODE CI03 CLASSIFICATION CODE DESCRIPTION Workshop Light Industrial LOCAL CUSTODIAN CO 1760 LOCAL CUSTODIAN CODE DESCRIPTION TEST VALLEY POSTAL ADDRESS COD e POSTAL ADDRESS CODE DESCRIPTION A single address BLPU STATE CODE 2 BLPU STATE CODE DESCRIPTION In use TOPOGRAPHY LAYER TOID osgb1000016320371 LAST UPDATE DATE 12 04 2012 ENTRY DATE 05 05 2001 BLPU STATE DATE 19 02 2009 MATCH 0 6 MATCH DESCRIPTION NO MATCH 436902 0 toe ITO2V6 0 F P F P E D E Du oO oO Du pu Lr XML LPI find request https api ordnancesurvey co uk places v1 addresses find query ORDNANCE9620SURVEY 96204 9620ADANAC9620 DRIVE amp format xml amp dataset LPI amp key INSERT USER API KEY HERE API components Description https api ordnancesurvey co uk places v1 addresses OS Places URL find Resource being requested query Free text search parameter amp format Format being requested xm1 amp dataset Dataset being requested LPT
79. these historic alternative and provisional addresses are recorded against the same UPRN API access and requirements The Matching and Cleansing and Capture and Verification service products use the same URL To access the API the URL required is https api ordnancesurvey co uk places v1 addresses After the URL above has been entered follow the URL with the resource you intend to use for example find Using the API key consists of amending the parameter key followed by your API key to the query over a HTTPS connection Northern Ireland Addresses OS Places contains addresses located within Northern Ireland however they have a few unique characteristics due to not being derived from Address Base Premium Addresses within Northern Ireland will not have a UPRN or status and coordinates will be 0 0 due to falling outside of the British National Grid OS Places user guide chapter 1 v1 5 03 2015 Crown copyright Page 6 of 61 Developer Portal In order to use the service the user has to register an account in the Developer Portal Once this has been done the user must accept the terms and conditions of the service which will then present the user one of three trial packages Matching and Cleansing Capture and Verification and GeoSearch details of which can be seen below praa Jemen CS Resources ra oeswei OOOO Max number of transactions 10 000 GeoSearch Resources Nearest BBOX and Radius Package name Geo
80. tion https api ordnancesurvey co uk places v1 addresses OS Places URL nearest Resource being requested point Point being queried amp format Format being requested xm1 amp dataset Dataset being requested LPI amp key User API authentication key Output lt AddressAPI gt lt header gt lt uri gt https api ordnancesurvey co uk places vl addresses nearest POINT 437307 20115579 53 amp format XML dataset LPI lt uri gt lt query gt point 437307 115579 53 radius 100 lt query gt lt offset gt 0 lt offset gt lt totalresults gt 1 lt totalresults gt lt format gt xml lt format gt lt dataset gt LPI lt dataset gt lt maxresults gt 1 lt maxresults gt lt epoch gt 29 lt epoch gt lt header gt lt results gt lt LPI gt lt UPRN gt 200010019924 lt UPRN gt lt ADDRESS gt 4 ADANAC DRIVE NURSLING HAMPSHIRE S016 OAS lt ADDRESS gt lt USRN gt 40020087 lt USRN gt lt LPI_KEY gt 1760L000063833 lt LPI_KEY gt lt PAO START NUMBER gt 4 lt PAO START NUMBER STREET DESCRIPTION gt ADANAC DRIVE STREET DESCRIPTION TOWN NAME gt NURSLING lt TOWN_ NAME lt ADMINISTRATIVE AREA gt HAMPSHIRE lt ADMINISTRATIVE AREA POSTCODE LOCATOR SO16 OAS POSTCODE LOCATOR lt RPC gt 2 lt RPC gt lt X_COORDINATE gt 437318 0 lt X COORDINAT Y COORDINATE 2115539 0 Y COORDINAT lt STATUS gt APPROVED lt STATUS gt lt LOGICAL STATUS CODE gt 1 lt LOGICAL STATUS CODE CLASSIFICATIO
81. tiplicity 1 X COORDINATE float Easting coordinates in metres defining the location in the British National Grid spatial reference system Size 6 2 Multiplicity 1 Y COORDINATE float Northing coordinates in metres defining the location in the British National Grid spatial reference system Size 7 2 Multiplicity 1 STATUS char A textual representation of the logical status code Valid values are APPROVED ALTERNATIVE PROVISONAL Size 11 Multiplicity 1 MATCH float A score ranging from 0 0 1 0 given to the result representing how well it matches the query An exact match 1 0 Good match 0 8 0 9 Partial match 0 7 Please be aware that for the postcode resource the returned value will always be 0 0 Conditional only returned for find and match resources Size 1 1 Multiplicity 0 1 MATCH DESCRIPTION char A textual representation of the match score Valid values are EXACT GOOD PARTIAL Please be aware that for the postcode resource the returned string will always be NO MATCH Conditional only returned for find and match resources Size 7 Multiplicity 0 1 LOCAL CUSTODIAN CODE optional integer Unique identifier of the Local Land and Property Gazetteer LLPG Custodian responsible for the maintenance of this record Valid values See codes list Size 4 Multiplicity 1 LOCAL CUSTODIAN CODE DESCRIPT
82. ustomerservices os uk or visit the Ordnance Survey website at www os uk This document has been screened in accordance with the requirements set out in Ordnance Survey s Equality scheme If you have difficulty reading this information in its current format and would like to find out how to access it in a different format Braille large print computer disk or in another language please contact us on 44 0 3456 050505 Use of the product The terms and conditions upon which the product including this guide is made available to you and your organisation are contained in the customer contract made between you and Ordnance Survey If there is an inconsistency between the terms of your customer contract and this guide then the terms of your customer contract prevail If you or your organisation has not signed a valid current customer contract then you are not entitled to use the product Purpose and disclaimer This guide is provided for guidance only and does not constitute any warranty representation undertaking commitment or obligation express or implied about the product or its suitability for any particular or intended purpose Any warranties representations undertakings commitments and obligations given by Ordnance Survey about the product and or its suitability for any particular or intended purpose are set out in your customer contract It is your responsibility to ensure that this product is suitable for your intended purpose
83. wn copyright Page 37 of 61 lt STREET CLASSIFICATION CODE gt 8 lt STREET CLASSIFICATION CODE gt STREET CLASSIFICATION CODE DESCRIPTION gt A11 vehicles lt STREET CLASSIFICATION CODE DESCRIPTION LPI LOGICAL STATUS CODE 1 LPI LOGICAL STATUS CODE lt LPI LOGICAL STATUS CODE DESCRIPTION gt APPROVE D LPI LOGICAL STATUS CODE DES CRIPTION gt lt MATCH gt 1 0 lt MATCH gt MATCH DESCRI PTION gt EXACT lt MATCH DESCRI PTION gt lt LPI gt lt results gt lt AddressAPI gt BBOX resource The BBOX bounding box resource takes two points and creates a bounding box around the points All addresses in this bounding box are then returned The maximum size of the bounding box is 1 km A property will only be considered to be included by the search if the Address Seed is in range of the search regardless of the property s physical boundaries This resource is unavailable for addresses within Northern Ireland Parameters bbox Mandatory char A pair of comma separated coordinates in BNG projection with an accuracy of two decimal places or less that specify the lower left and upper right coordinates of the bounding box The maximum size of the bounding box is 1km If the bounding box exceeds this an error message is returned The precision of the coordinates is to an accuracy of 8 metres form
84. xample DPA OUTPUT no oft erento dert heroe E Ee ee e suse ele vv Revmi ev eve cedere lo eh en 50 MIRARI COMME EE 51 Exam ple LPI OUt DURE PES 55 OS PlaCes Usage sisicosctcicies T 57 KE UE 57 APIIKGY SCGUIEY M 57 GLOSS ANY dee 58 v1 5 03 2015 OS Places technical specification contents v1 5 03 2015 Crown copyright Page 12 of 61 Introduction Purpose of this specification and disclaimer This is the technical specification hereafter referred to as the specification applicable to the Capture and Verification and Matching and Cleansing Service products hereafter referred to as the product which is referred to in the Framework Direct Licence Specific Use Framework Partner Licence or your other customer contract for the product Copyright in this specification This specification including for the avoidance of doubt any mapping images reproduced herein is Crown copyright 2014 All rights reserved Any part of this specification may be copied for use internally in your organisation or business so that you can use OS Places for the purpose for which it is licensed to your organisation or business but not otherwise No part of this specification may be reproduced or transmitted in any form or by any means including electronically for commercial exploitation without the prior written consent of Ordnance Survey No part of this specification may be cop

OS Places user guide and technical specification

Contents

Download Pdf Manuals

Related Search

Related Contents