Short-term lets: data collection specification
Data collection specification and example XML schema for the collection of licencing data for short-term lets.
Property details
This section gives the details for the fields related to the property details and describes each of the variables to be exported, their names, the acceptable responses, the values to be returned for those responses, and the automatic validation checks which will be performed by the ProcXed system when they are uploaded.
Unique Property Reference Number
XML Tag:
UniquePropertyReferenceNumber
Description:
The Unique Property Reference Number of the address of the Short Term Let property.
Format
Numeric
Validation
Mandatory (Optional if property does not have a UPRN or if application is invalid)
Responses
A valid UPRN which matches the address given
Address Line 1
XML TAG:
AddressLine1
Description:
The first line of the address of the Short Term Let property. Usually this will be a house name or number, or a flat number or designation.
Format
String (text)
Validation
Mandatory (Optional if application is invalid)
Address Line 2
XML TAG:
AddressLine2
Description:
The second line of the address of the Short Term Let property. Usually this will be a street name or road. Sometimes this is not required if the first line provides this information.
Format
String (text)
Validation
Mandatory – unless provided in first line of address or if application is invalid
Address Line 3
XML TAG:
AddressLine3
Description:
The third line of the address of the Short Term Let property. This is usually only required for very long addresses with multiple components.
Format
String (text)
Validation
Optional
Address Town
XML TAG:
AddressTown
Description:
The town component of the address of the Short Term Let property. Usually this will be the town but sometimes a local region is given.
Format
String (text)
Validation
Mandatory for towns – Optional otherwise or if application is invalid
Postal town
XML TAG:
PostalTown
Description:
If a postal town is required for providing an address, enter it in this field. Usually this will be the town but sometimes a local region is given.
Format
String (text)
Validation
Optional
Council Ward
XML TAG:
Ward
Description:
This data field relates to the Electoral Ward of the address of the Short Term Let property.
A full list of current Electoral Ward codes in the format of the Government Statistical Service 9 character code beginning with S13 can be found in the ‘Scotland Register of GSS Codes’ document available on the small area statistics reference page Small area statistics: reference materials - gov.scot (www.gov.scot) (refer only to “Live” Wards and not those archived). In addition, the Electoral Ward for each postcode can be found in the National Records of Scotland (NRS) postcode index csv files available at Scottish Postcode Directory (SPD) | National Records of Scotland (nrscotland.gov.uk).
We are aware from the provision of the first quarter of data that local authorities are currently recording the data behind this field in different ways, and that any change to the required format of Ward codes for this specification may cause some further work for authorities to implement. We therefore propose to explore this further through circulating a paper setting out further details of the current position and the available GSS Ward codes, and to consider how this may help to standardise the approach whilst also assessing any implications on authorities.
Format
String (text)
Validation
Mandatory (Optional if application is invalid)
Address County
XML TAG:
AddressCounty
Description:
The county of the address of the Short Term Let property. Generally corresponds to the local authority. This data field is optional.
Format
String (text)
Validation
Optional
Postcode
XML Tag:
Postcode
Description:
The postcode of the address of the Short Term Let property.
Format
Alphanumeric, seven characters maximum that match post code regular expression
Validation
Mandatory (Optional when a property does not have a postcode or if application is invalid)
Responses
A valid postcode matching the following regular expression.
(GIR 0AA)|((([A-Z][0-9][0-9]?)|(([A-Z][A-HJ-Y][0-9][0-9]?)|(([A-Z][0-9][A-Z])|([A-Z][A-HJ-Y][0-9]?[A-Z]))))[0-9][A-Z]{2})
National Park
XML Tag:
NationalPark
Description:
Which national park, if any, the Short Term Let property is within.
Format
List (two digits codes with leading zeros)
Validation
Mandatory (Optional if application is invalid)
Responses
|
Valid Responses |
Code |
Description |
|
Not in a National Park |
01 |
Property is not within a National Park |
|
Loch Lomond and Trossachs National Park |
02 |
Property is within Loch Lomond and Trossachs National Park |
|
Cairngorms National Park |
03 |
Property is within Cairngorms National Park |
Contact
Email: housingstatistics@gov.scot
There is a problem
Thanks for your feedback