GET api/Agencies/FindAgenciesByName/{name}/{lang}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| name | string |
Required |
|
| lang | string |
Default value is en |
Body Parameters
None.
Response Information
Resource Description
Collection of ApiProfileViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AgencyId | integer |
None. |
|
| AgencyName | string |
None. |
|
| FriendlyName | string |
None. |
|
| AgencyType | string |
None. |
|
| ServiceCategory | string |
None. |
|
| Description | string |
None. |
|
| Acronym | string |
None. |
|
| LogoUrl | string |
None. |
|
| WebsiteURL | string |
None. |
|
| ContactPhone | string |
None. |
|
| ContactPhoneDisplay | string |
None. |
|
| ContactPhoneDigits | string |
None. |
|
| HearingImpairedPhone | string |
None. |
|
| FaxNumber | string |
None. |
|
| PhoneHours | string |
None. |
|
| ContactURL | string |
None. |
|
| ContactEmail | string |
None. |
|
| LivechatLink | string |
None. |
|
| TwitterAccount | string |
None. |
|
| string |
None. |
||
| MobileApps | string |
None. |
|
| YouTube | string |
None. |
|
| NewsFeed | string |
None. |
|
| Updated | date |
None. |
|
| GssSearchEngineID | string |
None. |
|
| GaUA_ID | string |
None. |
|
| ServiceNameTag | string |
None. |
|
| AgencyTags | string |
None. |
|
| Keywords | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"AgencyId": 1,
"AgencyName": "sample string 2",
"FriendlyName": "sample string 3",
"AgencyType": "sample string 4",
"ServiceCategory": "sample string 5",
"Description": "sample string 6",
"Acronym": "sample string 7",
"LogoUrl": "sample string 8",
"WebsiteURL": "sample string 9",
"ContactPhone": "sample string 10",
"ContactPhoneDisplay": "sample string 11",
"ContactPhoneDigits": "sample string 12",
"HearingImpairedPhone": "sample string 13",
"FaxNumber": "sample string 14",
"PhoneHours": "sample string 15",
"ContactURL": "sample string 16",
"ContactEmail": "sample string 17",
"LivechatLink": "sample string 18",
"TwitterAccount": "sample string 19",
"Facebook": "sample string 20",
"MobileApps": "sample string 21",
"YouTube": "sample string 22",
"NewsFeed": "sample string 23",
"Updated": "2025-12-20T12:18:07.0422982+00:00",
"GssSearchEngineID": "sample string 24",
"GaUA_ID": "sample string 25",
"ServiceNameTag": "sample string 26",
"AgencyTags": "sample string 27",
"Keywords": "sample string 28"
},
{
"AgencyId": 1,
"AgencyName": "sample string 2",
"FriendlyName": "sample string 3",
"AgencyType": "sample string 4",
"ServiceCategory": "sample string 5",
"Description": "sample string 6",
"Acronym": "sample string 7",
"LogoUrl": "sample string 8",
"WebsiteURL": "sample string 9",
"ContactPhone": "sample string 10",
"ContactPhoneDisplay": "sample string 11",
"ContactPhoneDigits": "sample string 12",
"HearingImpairedPhone": "sample string 13",
"FaxNumber": "sample string 14",
"PhoneHours": "sample string 15",
"ContactURL": "sample string 16",
"ContactEmail": "sample string 17",
"LivechatLink": "sample string 18",
"TwitterAccount": "sample string 19",
"Facebook": "sample string 20",
"MobileApps": "sample string 21",
"YouTube": "sample string 22",
"NewsFeed": "sample string 23",
"Updated": "2025-12-20T12:18:07.0422982+00:00",
"GssSearchEngineID": "sample string 24",
"GaUA_ID": "sample string 25",
"ServiceNameTag": "sample string 26",
"AgencyTags": "sample string 27",
"Keywords": "sample string 28"
}
]
application/xml, text/xml
Sample:
<ArrayOfApiProfileViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models">
<ApiProfileViewModel>
<Acronym>sample string 7</Acronym>
<AgencyId>1</AgencyId>
<AgencyName>sample string 2</AgencyName>
<AgencyTags>sample string 27</AgencyTags>
<AgencyType>sample string 4</AgencyType>
<ContactEmail>sample string 17</ContactEmail>
<ContactPhone>sample string 10</ContactPhone>
<ContactPhoneDigits>sample string 12</ContactPhoneDigits>
<ContactPhoneDisplay>sample string 11</ContactPhoneDisplay>
<ContactURL>sample string 16</ContactURL>
<Description>sample string 6</Description>
<Facebook>sample string 20</Facebook>
<FaxNumber>sample string 14</FaxNumber>
<FriendlyName>sample string 3</FriendlyName>
<GaUA_ID>sample string 25</GaUA_ID>
<GssSearchEngineID>sample string 24</GssSearchEngineID>
<HearingImpairedPhone>sample string 13</HearingImpairedPhone>
<Keywords>sample string 28</Keywords>
<LivechatLink>sample string 18</LivechatLink>
<LogoUrl>sample string 8</LogoUrl>
<MobileApps>sample string 21</MobileApps>
<NewsFeed>sample string 23</NewsFeed>
<PhoneHours>sample string 15</PhoneHours>
<ServiceCategory>sample string 5</ServiceCategory>
<ServiceNameTag>sample string 26</ServiceNameTag>
<TwitterAccount>sample string 19</TwitterAccount>
<Updated>2025-12-20T12:18:07.0422982+00:00</Updated>
<WebsiteURL>sample string 9</WebsiteURL>
<YouTube>sample string 22</YouTube>
</ApiProfileViewModel>
<ApiProfileViewModel>
<Acronym>sample string 7</Acronym>
<AgencyId>1</AgencyId>
<AgencyName>sample string 2</AgencyName>
<AgencyTags>sample string 27</AgencyTags>
<AgencyType>sample string 4</AgencyType>
<ContactEmail>sample string 17</ContactEmail>
<ContactPhone>sample string 10</ContactPhone>
<ContactPhoneDigits>sample string 12</ContactPhoneDigits>
<ContactPhoneDisplay>sample string 11</ContactPhoneDisplay>
<ContactURL>sample string 16</ContactURL>
<Description>sample string 6</Description>
<Facebook>sample string 20</Facebook>
<FaxNumber>sample string 14</FaxNumber>
<FriendlyName>sample string 3</FriendlyName>
<GaUA_ID>sample string 25</GaUA_ID>
<GssSearchEngineID>sample string 24</GssSearchEngineID>
<HearingImpairedPhone>sample string 13</HearingImpairedPhone>
<Keywords>sample string 28</Keywords>
<LivechatLink>sample string 18</LivechatLink>
<LogoUrl>sample string 8</LogoUrl>
<MobileApps>sample string 21</MobileApps>
<NewsFeed>sample string 23</NewsFeed>
<PhoneHours>sample string 15</PhoneHours>
<ServiceCategory>sample string 5</ServiceCategory>
<ServiceNameTag>sample string 26</ServiceNameTag>
<TwitterAccount>sample string 19</TwitterAccount>
<Updated>2025-12-20T12:18:07.0422982+00:00</Updated>
<WebsiteURL>sample string 9</WebsiteURL>
<YouTube>sample string 22</YouTube>
</ApiProfileViewModel>
</ArrayOfApiProfileViewModel>