baarkerlounger
/
submit-social-housing-lettings-and-sales-data
mirror of https://github.com/communitiesuk/submit-social-housing-lettings-and-sales-data.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Submit social housing lettings and sales data (CORE)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1985 Commits
218 Branches
260 Tags
83 MiB
 
 
 
 
Tree: 7598f46cb5
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '7598f46cb5'
${ noResults }
submit-social-housing-letti.../UPRN.md

1.6 KiB
Raw Blame History

Question: Which OS product can we use to do our address to UPRN lookup?

  • #UPRN: to check if provided UPRN exists

API DOCS: https://osdatahub.os.uk/docs/places/technicalSpecification

Question: Can we do API lookups? Are there any limitations on the product (API requests etc.)

  • Can't see any sort of limitation for our account: "As a member of the PSGA you are entitled to free Public Sector data transactions" https://osdatahub.os.uk/dashboard

The API can return 429 but cannot find more details about it:

429 Too many requests Exceeded the number of requests per minute (rate-limit).

Additional QQ and notes:

  • when searching UPRN from address there are usually multiple results and match accuracy isn't provided. Do we want users to pick the matching address or should we just pick the first match?
  • could not find a free OS ruby client for the API that I would recommend using. Best option is this but seems to be relying on a private repository https://github.com/DEFRA/defra-ruby-address/
  • Auth strategy, there's 3 of them HTTP Header / Query String / OAuth2.

Flows that need to be handled:

  • UPRN check:
    • API is down / not responding
    • UPRN is invalid
    • UPRN is valid
  • UPRN retrieval via address:
    • API is down / not responding
    • Address is valid but no UPRN found
    • Address is valid and UPRN found
    • Address is valid but multiple UPRNs found
    • Address is not found and multiple UPRNs found