Toggle menu

FindPoints

Request Parameters

FindPoints Request Schema
 

Example Request:

{
    "query": {
        "pointType": "PointAddress",
        "postcode": "PL67TL"
    }
}

Response Parameters

FindPoints Response Schema
 

Example Response (modified with fake data):

{
    "jsonrpc": "2.0",
    "id": 12,
    "result": {
        "response": [{
            "guid": "REDACTED"
            "id": 6280609,
            "description": "TOWER 47M FROM 123 FAKE STREET 22M FROM GREEN VERGES, FAKE FOOTPATH 123, PLACE, AA1 1AA",
            "pointType": "PointAddress",
            "sharedRef": {
                "key": "Uprn",
                "type": "PointAddress",
                "value": ["1*********1"]
            }
        }, {
            "guid": "REDACTED",
            "id": 6326629,
            "description": "TOWER 19M FROM A FOOTBALL CLUB, 6M FROM UNNAMED RO, AN AVENUE, PLACE, BB2 2BB",
            "pointType": "PointAddress",
            "sharedRef": {
                "key": "Uprn",
                "type": "PointAddress",
                "value": ["1*********4"]
        }],
        "errors": [],
        "success": true
    }
}

Last modified on February 05, 2021

Share this page

Facebook icon Twitter icon email icon

Print

print icon