RLBA Logbook – API
The following details provides a brief description on how to use the logbook API
implementation in RLBA.
1. GET – Search by Address
Example Request:
GET [Link]
Request Body:
{
"searchoption”: "address",
"housenumber": "19",
"postcode”: "W12 9TF"
}
Example Response:
If the record exists:
{
"address": "Emlyn Road",
"addressline2": null,
"town": "London",
"county": "Chiswick",
"housenumber": "19",
"postcode": "W12 9TF",
"UPRN": null,
"logbook_provider": "CHIMNI",
"logbook_provider_details": {
"provider_name": "Chimni Ltd.",
"provider_logo": "[Link]
40c1-99e7-0ddc6988b731_logo_header.svg",
"provider_contactinfo": "admin@[Link]",
"provider_website": "[Link]
},
"sales_information_pack": "Yes",
"lettings_information_pack": null,
"retrofit_plan": null,
"first_homes": "Yes",
"created_date": "2017-01-22T[Link].972Z",
"found": true,
"provider_name": null,
"provider_logo": null,
"provider_contactinfo": null,
"provider_website": null,
"searchoption": null,
"suggestions": null
}
If the record does not exist:
{
"address": null,
"addressline2": null,
"town": null,
"county": null,
"housenumber": null,
"postcode": null,
"UPRN": null,
"logbook_provider": null,
"logbook_provider_details": null,
"sales_information_pack": null,
"lettings_information_pack": null,
"retrofit_plan": null,
"first_homes": null,
"created_date": null,
"found": false,
"provider_name": null,
"provider_logo": null,
"provider_contactinfo": null,
"provider_website": null,
"searchoption": null,
"suggestions": null
}
2. GET – Search by UPRN
Example Request:
GET [Link]
Request Body:
{
"searchoption”: "uprn",
"UPRN": "100040745019"
}
Example Response:
If the record exists:
{
"address": "70 Kimberley Road",
"addressline2": null,
"town": "Bournemouth",
"county": "Dorset",
"housenumber": "70",
"postcode": "BH6 5BY",
"UPRN": "100040745019",
"logbook_provider": null,
"logbook_provider_details": null,
"sales_information_pack": "Yes",
"lettings_information_pack": "",
"retrofit_plan": "Yes",
"first_homes": "",
"created_date": "2021-12-02T[Link].293",
"found": true,
"provider_name": "NDD",
"provider_logo": "content/Images/[Link]",
"provider_contactinfo": "[Link]@[Link]",
"provider_website": "",
"searchoption": "uprn",
"suggestions": null
}
If the record does not exist:
{
"address": null,
"addressline2": null,
"town": null,
"county": null,
"housenumber": null,
"postcode": null,
"UPRN": null,
"logbook_provider": null,
"logbook_provider_details": null,
"sales_information_pack": null,
"lettings_information_pack": null,
"retrofit_plan": null,
"first_homes": null,
"created_date": null,
"found": false,
"provider_name": null,
"provider_logo": null,
"provider_contactinfo": null,
"provider_website": null,
"searchoption": null,
"suggestions": null
}
