The following details are taken from the documentation available on https://spportal.mycas.org.uk
UPRN is a unique number associated with every property of Scotland. This service allows you to find the address of a property searching by postcode or UPRN
Guidance
- Either of Address or UPRN can be passed for this web service. If both are passed the UPRN takes the precedence
- UPRNType will be ignored even if the permissible values are provided and will only work for the genuine UPRN
- Multiple addresses can be returned as a part of the response and the maximum limit of the records is limited to 25 records
Request
requires a postcode and optional search addressstring or a UPRN. The addressstring can be any word from the address lines or name of town that may filter out the results coming out from Post Code Search
Examples
Using postcode and house number
{
"method":"queryUPRN",
"params":{
"callertoken":"YourCallerToken",
"postcode":"PH33 7LY",
"addressstring":"1"
},
"id":"12",
"jsonrpc": "2.0"
}
using UPRN
{
"method":"queryUPRN",
"params":{
"callertoken":"YourCallerToken",
"uprn":"135024740"
},
"id":"12",
"jsonrpc": "2.0"
}
Response
- Address (Array)
- AddressDetails
- AddressLine
- AddressLine1
- AddressLine2
- AddressLine3
- Town
- PostCode
- LACode
- AddressProvider
- AddressLine
- AddressString - Full Address String of the Address
- UPRN
- value UPRN of the Matched Address provided in Request
- UPRNType
- usrn Unique Street reference number for the matched address
- AddressDetails
Response Codes
Response Code | Result | Response Message |
---|---|---|
1029 | True | More Records are available |
1030 | True | Address match found |
0461 | False | No Address found with the given UPRN |
5016 | False | Please provide UPRNType P:Permanent |
10003 | False | A technical error has been faced. Kindly try again later. |