GET GetLocationsByAgencyId?agencyId={agencyId}&lang={lang}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
agencyId | integer |
Required |
|
lang | string |
Default value is en |
Body Parameters
None.
Response Information
Resource Description
Collection of ServiceLocationViewModelName | Description | Type | Additional information |
---|---|---|---|
Id | integer |
None. |
|
AgencyProfileId | integer |
None. |
|
PointLocation | DbGeography |
None. |
|
LocationName | string |
None. |
|
Description | string |
None. |
|
StreetAddress | string |
None. |
|
City | string |
None. |
|
State | string |
None. |
|
ZipCode | string |
None. |
|
OpenSunday | boolean |
None. |
|
OpenMonday | boolean |
None. |
|
OpenTuesday | boolean |
None. |
|
OpenWednesday | boolean |
None. |
|
OpenThursday | boolean |
None. |
|
OpenFriday | boolean |
None. |
|
OpenSaturday | boolean |
None. |
|
HoursSunday | string |
None. |
|
HoursMonday | string |
None. |
|
HoursTuesday | string |
None. |
|
HoursWednesday | string |
None. |
|
HoursThursday | string |
None. |
|
HoursFriday | string |
None. |
|
HoursSaturday | string |
None. |
|
BingGeocodingResult | string |
None. |
|
DateTimeStamp | date |
None. |
|
AgencyServiceIds | Collection of integer |
None. |
Response Formats
application/json, text/json
Sample:
[ { "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", "BingGeocodingResult": "sample string 23", "DateTimeStamp": "2025-05-22T10:27:57.006867+00:00", "AgencyServiceIds": [ 1, 2 ] }, { "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", "BingGeocodingResult": "sample string 23", "DateTimeStamp": "2025-05-22T10:27:57.006867+00:00", "AgencyServiceIds": [ 1, 2 ] } ]
application/xml, text/xml
Sample:
<ArrayOfServiceLocationViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models"> <ServiceLocationViewModel> <AgencyProfileId>2</AgencyProfileId> <AgencyServiceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </AgencyServiceIds> <BingGeocodingResult>sample string 23</BingGeocodingResult> <City>sample string 6</City> <DateTimeStamp>2025-05-22T10:27:57.006867+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> <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:d3p1="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> </ServiceLocationViewModel> <ServiceLocationViewModel> <AgencyProfileId>2</AgencyProfileId> <AgencyServiceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </AgencyServiceIds> <BingGeocodingResult>sample string 23</BingGeocodingResult> <City>sample string 6</City> <DateTimeStamp>2025-05-22T10:27:57.006867+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> <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:d3p1="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> </ServiceLocationViewModel> </ArrayOfServiceLocationViewModel>