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

Request Information

URI Parameters

Name	Type	Additional 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

Name	Description	Type	Additional information
QueryGeography		DbGeography	None.
QueryResults		Collection of SerivceLocationProximityQueryResult	None.

Response Formats

application/json, text/json

Sample:

{
  "QueryGeography": null,
  "QueryResults": [
    {
      "LinearDistance": 1.1,
      "Id": 1,
      "AgencyProfileId": 2,
      "PointLocation": null,
      "LocationName": "sample string 3",
      "Description": "sample string 4",
      "StreetAddress": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "ZipCode": "sample string 8",
      "OpenSunday": true,
      "OpenMonday": true,
      "OpenTuesday": true,
      "OpenWednesday": true,
      "OpenThursday": true,
      "OpenFriday": true,
      "OpenSaturday": true,
      "HoursSunday": "sample string 16",
      "HoursMonday": "sample string 17",
      "HoursTuesday": "sample string 18",
      "HoursWednesday": "sample string 19",
      "HoursThursday": "sample string 20",
      "HoursFriday": "sample string 21",
      "HoursSaturday": "sample string 22",
      "DateTimeStamp": "2025-05-22T10:06:51.9096067+00:00",
      "AgencyServiceIds": [
        1,
        2
      ]
    },
    {
      "LinearDistance": 1.1,
      "Id": 1,
      "AgencyProfileId": 2,
      "PointLocation": null,
      "LocationName": "sample string 3",
      "Description": "sample string 4",
      "StreetAddress": "sample string 5",
      "City": "sample string 6",
      "State": "sample string 7",
      "ZipCode": "sample string 8",
      "OpenSunday": true,
      "OpenMonday": true,
      "OpenTuesday": true,
      "OpenWednesday": true,
      "OpenThursday": true,
      "OpenFriday": true,
      "OpenSaturday": true,
      "HoursSunday": "sample string 16",
      "HoursMonday": "sample string 17",
      "HoursTuesday": "sample string 18",
      "HoursWednesday": "sample string 19",
      "HoursThursday": "sample string 20",
      "HoursFriday": "sample string 21",
      "HoursSaturday": "sample string 22",
      "DateTimeStamp": "2025-05-22T10:06:51.9096067+00:00",
      "AgencyServiceIds": [
        1,
        2
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<SerivceLocationProximityQueryResultsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models">
  <QueryGeography xmlns:d2p1="http://schemas.datacontract.org/2004/07/System.Data.Entity.Spatial" i:nil="true" />
  <QueryResults>
    <SerivceLocationProximityQueryResult>
      <AgencyProfileId>2</AgencyProfileId>
      <AgencyServiceIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </AgencyServiceIds>
      <City>sample string 6</City>
      <DateTimeStamp>2025-05-22T10:06:51.9096067+00:00</DateTimeStamp>
      <Description>sample string 4</Description>
      <HoursFriday>sample string 21</HoursFriday>
      <HoursMonday>sample string 17</HoursMonday>
      <HoursSaturday>sample string 22</HoursSaturday>
      <HoursSunday>sample string 16</HoursSunday>
      <HoursThursday>sample string 20</HoursThursday>
      <HoursTuesday>sample string 18</HoursTuesday>
      <HoursWednesday>sample string 19</HoursWednesday>
      <Id>1</Id>
      <LinearDistance>1.1</LinearDistance>
      <LocationName>sample string 3</LocationName>
      <OpenFriday>true</OpenFriday>
      <OpenMonday>true</OpenMonday>
      <OpenSaturday>true</OpenSaturday>
      <OpenSunday>true</OpenSunday>
      <OpenThursday>true</OpenThursday>
      <OpenTuesday>true</OpenTuesday>
      <OpenWednesday>true</OpenWednesday>
      <PointLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Data.Entity.Spatial" i:nil="true" />
      <State>sample string 7</State>
      <StreetAddress>sample string 5</StreetAddress>
      <ZipCode>sample string 8</ZipCode>
    </SerivceLocationProximityQueryResult>
    <SerivceLocationProximityQueryResult>
      <AgencyProfileId>2</AgencyProfileId>
      <AgencyServiceIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </AgencyServiceIds>
      <City>sample string 6</City>
      <DateTimeStamp>2025-05-22T10:06:51.9096067+00:00</DateTimeStamp>
      <Description>sample string 4</Description>
      <HoursFriday>sample string 21</HoursFriday>
      <HoursMonday>sample string 17</HoursMonday>
      <HoursSaturday>sample string 22</HoursSaturday>
      <HoursSunday>sample string 16</HoursSunday>
      <HoursThursday>sample string 20</HoursThursday>
      <HoursTuesday>sample string 18</HoursTuesday>
      <HoursWednesday>sample string 19</HoursWednesday>
      <Id>1</Id>
      <LinearDistance>1.1</LinearDistance>
      <LocationName>sample string 3</LocationName>
      <OpenFriday>true</OpenFriday>
      <OpenMonday>true</OpenMonday>
      <OpenSaturday>true</OpenSaturday>
      <OpenSunday>true</OpenSunday>
      <OpenThursday>true</OpenThursday>
      <OpenTuesday>true</OpenTuesday>
      <OpenWednesday>true</OpenWednesday>
      <PointLocation xmlns:d4p1="http://schemas.datacontract.org/2004/07/System.Data.Entity.Spatial" i:nil="true" />
      <State>sample string 7</State>
      <StreetAddress>sample string 5</StreetAddress>
      <ZipCode>sample string 8</ZipCode>
    </SerivceLocationProximityQueryResult>
  </QueryResults>
</SerivceLocationProximityQueryResultsModel>