POST api/Agencies/Query

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
lang	string	None.
name	string	None.
agencyTypeIds	Collection of integer	None.
agencyTagIds	Collection of integer	None.
page	integer	None.
pageSize	integer	None.
sortDirection	SortDirection	None.

Request Formats

application/json, text/json

Sample:

{
  "lang": "sample string 1",
  "name": "sample string 2",
  "agencyTypeIds": [
    1,
    2
  ],
  "agencyTagIds": [
    1,
    2
  ],
  "page": 1,
  "pageSize": 1,
  "sortDirection": 0
}

application/xml, text/xml

Sample:

<QueryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models">
  <agencyTagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </agencyTagIds>
  <agencyTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </agencyTypeIds>
  <lang>sample string 1</lang>
  <name>sample string 2</name>
  <page>1</page>
  <pageSize>1</pageSize>
  <sortDirection>Ascending</sortDirection>
</QueryModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'QueryModel'.

Response Information

Resource Description

AgencyQueryResultModel

Name	Type	Additional information
Results	Collection of ApiProfileViewModel	None.
Page	integer	None.
PageSize	integer	None.
SortDirection	SortDirection	None.
TotalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Results": [
    {
      "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",
      "HearingImpairedPhone": "sample string 11",
      "FaxNumber": "sample string 12",
      "PhoneHours": "sample string 13",
      "ContactURL": "sample string 14",
      "ContactEmail": "sample string 15",
      "LivechatLink": "sample string 16",
      "TwitterAccount": "sample string 17",
      "Facebook": "sample string 18",
      "MobileApps": "sample string 19",
      "YouTube": "sample string 20",
      "NewsFeed": "sample string 21",
      "Updated": "2025-06-22T09:09:36.8492175+00:00",
      "GssSearchEngineID": "sample string 22",
      "GaUA_ID": "sample string 23",
      "ServiceNameTag": "sample string 24",
      "AgencyTags": "sample string 25",
      "Keywords": "sample string 26"
    },
    {
      "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",
      "HearingImpairedPhone": "sample string 11",
      "FaxNumber": "sample string 12",
      "PhoneHours": "sample string 13",
      "ContactURL": "sample string 14",
      "ContactEmail": "sample string 15",
      "LivechatLink": "sample string 16",
      "TwitterAccount": "sample string 17",
      "Facebook": "sample string 18",
      "MobileApps": "sample string 19",
      "YouTube": "sample string 20",
      "NewsFeed": "sample string 21",
      "Updated": "2025-06-22T09:09:36.8492175+00:00",
      "GssSearchEngineID": "sample string 22",
      "GaUA_ID": "sample string 23",
      "ServiceNameTag": "sample string 24",
      "AgencyTags": "sample string 25",
      "Keywords": "sample string 26"
    }
  ],
  "Page": 1,
  "PageSize": 1,
  "SortDirection": 0,
  "TotalCount": 1
}

application/xml, text/xml

Sample:

<AgencyQueryResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models">
  <Page>1</Page>
  <PageSize>1</PageSize>
  <Results>
    <ApiProfileViewModel>
      <Acronym>sample string 7</Acronym>
      <AgencyId>1</AgencyId>
      <AgencyName>sample string 2</AgencyName>
      <AgencyTags>sample string 25</AgencyTags>
      <AgencyType>sample string 4</AgencyType>
      <ContactEmail>sample string 15</ContactEmail>
      <ContactPhone>sample string 10</ContactPhone>
      <ContactURL>sample string 14</ContactURL>
      <Description>sample string 6</Description>
      <Facebook>sample string 18</Facebook>
      <FaxNumber>sample string 12</FaxNumber>
      <FriendlyName>sample string 3</FriendlyName>
      <GaUA_ID>sample string 23</GaUA_ID>
      <GssSearchEngineID>sample string 22</GssSearchEngineID>
      <HearingImpairedPhone>sample string 11</HearingImpairedPhone>
      <Keywords>sample string 26</Keywords>
      <LivechatLink>sample string 16</LivechatLink>
      <LogoUrl>sample string 8</LogoUrl>
      <MobileApps>sample string 19</MobileApps>
      <NewsFeed>sample string 21</NewsFeed>
      <PhoneHours>sample string 13</PhoneHours>
      <ServiceCategory>sample string 5</ServiceCategory>
      <ServiceNameTag>sample string 24</ServiceNameTag>
      <TwitterAccount>sample string 17</TwitterAccount>
      <Updated>2025-06-22T09:09:36.8492175+00:00</Updated>
      <WebsiteURL>sample string 9</WebsiteURL>
      <YouTube>sample string 20</YouTube>
    </ApiProfileViewModel>
    <ApiProfileViewModel>
      <Acronym>sample string 7</Acronym>
      <AgencyId>1</AgencyId>
      <AgencyName>sample string 2</AgencyName>
      <AgencyTags>sample string 25</AgencyTags>
      <AgencyType>sample string 4</AgencyType>
      <ContactEmail>sample string 15</ContactEmail>
      <ContactPhone>sample string 10</ContactPhone>
      <ContactURL>sample string 14</ContactURL>
      <Description>sample string 6</Description>
      <Facebook>sample string 18</Facebook>
      <FaxNumber>sample string 12</FaxNumber>
      <FriendlyName>sample string 3</FriendlyName>
      <GaUA_ID>sample string 23</GaUA_ID>
      <GssSearchEngineID>sample string 22</GssSearchEngineID>
      <HearingImpairedPhone>sample string 11</HearingImpairedPhone>
      <Keywords>sample string 26</Keywords>
      <LivechatLink>sample string 16</LivechatLink>
      <LogoUrl>sample string 8</LogoUrl>
      <MobileApps>sample string 19</MobileApps>
      <NewsFeed>sample string 21</NewsFeed>
      <PhoneHours>sample string 13</PhoneHours>
      <ServiceCategory>sample string 5</ServiceCategory>
      <ServiceNameTag>sample string 24</ServiceNameTag>
      <TwitterAccount>sample string 17</TwitterAccount>
      <Updated>2025-06-22T09:09:36.8492175+00:00</Updated>
      <WebsiteURL>sample string 9</WebsiteURL>
      <YouTube>sample string 20</YouTube>
    </ApiProfileViewModel>
  </Results>
  <SortDirection>Ascending</SortDirection>
  <TotalCount>1</TotalCount>
</AgencyQueryResultModel>