POST GetNearestLocations?longitude={longitude}&latitude={latitude}&agencyId={agencyId}&lang={lang}&maxReturn={maxReturn}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
longitude

decimal number

Required

latitude

decimal number

Required

agencyId

integer

None.

lang

string

Default value is en

maxReturn

integer

None.

Body Parameters

None.

Response Information

Resource Description

SerivceLocationProximityQueryResultsModel

NameDescriptionTypeAdditional information
QueryGeography

Geometry

None.

QueryResults

Collection of SerivceLocationProximityQueryResult

None.

Response Formats

application/json, text/json

Sample:
{
  "QueryGeography": {
    "Geography": {
      "CoordinateSystemId": 4326,
      "WellKnownText": "POINT (0 0)"
    }
  },
  "QueryResults": [
    {
      "LinearDistance": 1,
      "Id": 1,
      "AgencyProfileId": 1,
      "PointLocation": {
        "Geography": {
          "CoordinateSystemId": 4326,
          "WellKnownText": "POINT (0 0)"
        }
      },
      "LocationName": "sample string",
      "Description": "sample string",
      "StreetAddress": "sample string",
      "City": "sample string",
      "State": "sample string",
      "ZipCode": "sample string",
      "OpenSunday": true,
      "OpenMonday": true,
      "OpenTuesday": true,
      "OpenWednesday": true,
      "OpenThursday": true,
      "OpenFriday": true,
      "OpenSaturday": true,
      "HoursSunday": "sample string",
      "HoursMonday": "sample string",
      "HoursTuesday": "sample string",
      "HoursWednesday": "sample string",
      "HoursThursday": "sample string",
      "HoursFriday": "sample string",
      "HoursSaturday": "sample string",
      "DateTimeStamp": "2026-01-01T00:00:00Z",
      "AgencyServiceIds": [
        1,
        1
      ]
    },
    {
      "LinearDistance": 1,
      "Id": 1,
      "AgencyProfileId": 1,
      "PointLocation": {
        "Geography": {
          "CoordinateSystemId": 4326,
          "WellKnownText": "POINT (0 0)"
        }
      },
      "LocationName": "sample string",
      "Description": "sample string",
      "StreetAddress": "sample string",
      "City": "sample string",
      "State": "sample string",
      "ZipCode": "sample string",
      "OpenSunday": true,
      "OpenMonday": true,
      "OpenTuesday": true,
      "OpenWednesday": true,
      "OpenThursday": true,
      "OpenFriday": true,
      "OpenSaturday": true,
      "HoursSunday": "sample string",
      "HoursMonday": "sample string",
      "HoursTuesday": "sample string",
      "HoursWednesday": "sample string",
      "HoursThursday": "sample string",
      "HoursFriday": "sample string",
      "HoursSaturday": "sample string",
      "DateTimeStamp": "2026-01-01T00:00:00Z",
      "AgencyServiceIds": [
        1,
        1
      ]
    }
  ]
}

application/xml, text/xml

Sample:

Sample not available.