back

Search Records By Coordinates

Scope: geocode_search_records
App Type: All
Authorization Type: No authorization required
Url: v3/search/records/coordinates?lang={lang}&offset={offset}&limit={limit}
HTTP Method: POST

Request Information

Parameters

application/json

{
    "filter": {
        "civicId": "b050a3a6-b2d4-43f1-beaa-6cc4c5277aaf",
        "bBox": {
            "xMax": "sample string 1",
            "xMin": "sample string 2",
            "yMax": "sample string 3",
            "yMin": "sample string 4"
        },
        "geoCircle": {
            "centerX": "sample string 1",
            "centerY": "sample string 2",
            "radius": "sample string 3"
        }
    }
}

Response Information

application/json

{
    "records": [
        {
            "id": "sample string 1",
            "description": "sample string 2",
            "user": {
                "firstName": "sample string 1",
                "lastName": "sample string 2",
                "civicId": "e3d8394b-132b-48b0-9dbc-569de1762cd6",
                "email": "sample string 4"
            },
            "status": {
                "id": "sample string 1",
                "display": "sample string 2"
            },
            "type": "sample string 3",
            "coordinateX": "sample string 4",
            "coordinateY": "sample string 5",
            "addresses": [
                {
                    "id": "sample string 1",
                    "display": "sample string 2",
                    "addressFormat": "sample string 3",
                    "houseNumber": "sample string 4",
                    "houseNumberFraction": "sample string 5",
                    "streetDirection": "sample string 6",
                    "streetName": "sample string 7",
                    "streetSuffix": "sample string 8",
                    "streetSuffixDirection": "sample string 9",
                    "unit": "sample string 10",
                    "unitEnd": "sample string 11",
                    "unitType": "sample string 12",
                    "state": "sample string 13",
                    "postalCode": "sample string 14",
                    "city": "sample string 15",
                    "county": "sample string 16",
                    "country": "sample string 17",
                    "isPrimary": "sample string 18",
                    "xCoordinate": "sample string 19",
                    "yCoordinate": "sample string 20",
                    "enabled": true,
                    "entityState": "sample string 22"
                }
            ],
            "commentsCount": 6,
            "voteCount": 7,
            "downCount": 8,
            "createdDate": "sample string 9",
            "createdBy": "sample string 10"
        }
    ],
    "page": {
        "totalRows": 1,
        "hasMore": true
    }
}