This action may lead to changes in the database
Do you want to continue?
Data Explorer
Web API Query String
Request Information
Return a list of Saved Searches for a single client.
Parameters:
- ClientId
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId |
Client Id |
integer |
Required |
Response
×
The request was made Successfully! Check the result!.
×
Error Something happen, the Api doesn't have a response.
{
"Time": "sample string 1",
"Error": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
},
"ErrorMessage": "sample string 2",
"Status": "sample string 3",
"Server": "sample string 4",
"Count": 1,
"FavoriteCounts": {
"CommCount": 1,
"PlanCount": 2,
"SpecCount": 3
},
"FavoriteFacets": {
"Cities": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"PostalCodes": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
],
"Markets": [
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
},
{
"MarketId": 1,
"Count": 1,
"Distance": 1.1,
"Key": 2,
"Value": "sample string 3",
"State": "sample string 4"
}
]
},
"Result": [
{
"SearchId": 1,
"UserId": "sample string 2",
"ClientId": 1,
"SearchName": "sample string 3",
"SearchParameters": "sample string 4",
"SendEmailUpdate": true,
"IsEmailSent": true,
"DateCreated": "2025-04-19T09:13:52.1234589-05:00",
"DateLastChanged": "2025-04-19T09:13:52.1234589-05:00",
"DateLastViewed": "2025-04-19T09:13:52.1234589-05:00",
"ScheduledForAction": true,
"ShowToClient": true,
"IsActive": true
},
{
"SearchId": 1,
"UserId": "sample string 2",
"ClientId": 1,
"SearchName": "sample string 3",
"SearchParameters": "sample string 4",
"SendEmailUpdate": true,
"IsEmailSent": true,
"DateCreated": "2025-04-19T09:13:52.1234589-05:00",
"DateLastChanged": "2025-04-19T09:13:52.1234589-05:00",
"DateLastViewed": "2025-04-19T09:13:52.1234589-05:00",
"ScheduledForAction": true,
"ShowToClient": true,
"IsActive": true
}
]
}
<Root>
<Time>sample string 1</Time>
<Error>
<ClassName>System.Exception</ClassName>
<Message />
<Data />
<InnerException />
<HelpURL>sample string 1</HelpURL>
<StackTraceString />
<RemoteStackTraceString />
<RemoteStackIndex>0</RemoteStackIndex>
<ExceptionMethod />
<HResult>3</HResult>
<Source>sample string 2</Source>
<WatsonBuckets />
</Error>
<ErrorMessage>sample string 2</ErrorMessage>
<Status>sample string 3</Status>
<Server>sample string 4</Server>
<Count>1</Count>
<FavoriteCounts>
<CommCount>1</CommCount>
<PlanCount>2</PlanCount>
<SpecCount>3</SpecCount>
</FavoriteCounts>
<FavoriteFacets>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<Cities>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Cities>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<PostalCodes>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</PostalCodes>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
<Markets>
<MarketId>1</MarketId>
<Count>1</Count>
<Distance>1.1</Distance>
<Key>2</Key>
<Value>sample string 3</Value>
<State>sample string 4</State>
</Markets>
</FavoriteFacets>
<Result>
<SearchId>1</SearchId>
<UserId>sample string 2</UserId>
<ClientId>1</ClientId>
<SearchName>sample string 3</SearchName>
<SearchParameters>sample string 4</SearchParameters>
<SendEmailUpdate>true</SendEmailUpdate>
<IsEmailSent>true</IsEmailSent>
<DateCreated>2025-04-19T09:13:52.1234589-05:00</DateCreated>
<DateLastChanged>2025-04-19T09:13:52.1234589-05:00</DateLastChanged>
<DateLastViewed>2025-04-19T09:13:52.1234589-05:00</DateLastViewed>
<ScheduledForAction>true</ScheduledForAction>
<ShowToClient>true</ShowToClient>
<IsActive>true</IsActive>
</Result>
<Result>
<SearchId>1</SearchId>
<UserId>sample string 2</UserId>
<ClientId>1</ClientId>
<SearchName>sample string 3</SearchName>
<SearchParameters>sample string 4</SearchParameters>
<SendEmailUpdate>true</SendEmailUpdate>
<IsEmailSent>true</IsEmailSent>
<DateCreated>2025-04-19T09:13:52.1234589-05:00</DateCreated>
<DateLastChanged>2025-04-19T09:13:52.1234589-05:00</DateLastChanged>
<DateLastViewed>2025-04-19T09:13:52.1234589-05:00</DateLastViewed>
<ScheduledForAction>true</ScheduledForAction>
<ShowToClient>true</ShowToClient>
<IsActive>true</IsActive>
</Result>
</Root>
Code Generator
Response Information
A list of Saved Searches
ApiResultModelOfListOfApiSavedSearch| Name | Description | Type | Additional information |
|---|---|---|---|
| Time | string |
None. |
|
| Error | Exception |
None. |
|
| ErrorMessage | string |
None. |
|
| Status | string |
None. |
|
| Server | string |
None. |
|
| Count | integer |
None. |
|
| FavoriteCounts | ApiFavoriteCounts |
None. |
|
| FavoriteFacets | ApiFavoriteFacets |
None. |
|
| Result | List of ApiSavedSearch |
None. |
|
| VerboseLogger | List of IVerboseLogger |
None. |
GET
api/v2/SavedSearches/ClientList?clientId={clientId}