YM REST Services

<back to all web services

SavedSearches

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/SavedSearchReturn the list of saved searches.
SavedSearches Parameters:
NameParameterData TypeRequiredDescription
SearchTypequerystringNo
strSearchNamequerystringNo
strSearchTextquerystringNo
strSearchTermsHumanquerystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
SavedSearchResponse Parameters:
NameParameterData TypeRequiredDescription
SavedSearchListformList<ListData>No
ListData Parameters:
NameParameterData TypeRequiredDescription
SavedSearchIdformintNo
SearchNameformstringNo
SearchTextformstringNo
SearchTextPrintSetformstringNo
SharedformboolNo
SearchTypeformstringNo
VersionformstringNo
NameformstringNo
FilePathformstringNo
CurrentVersionformstringNo
AdminUserIdformintNo
ErrorCountformintNo
FullNameformstringNo
SearchTermsHumanformstringNo
SearchCategoryIdformstringNo
SearchNameFilterformstringNo
SearchStatusProductformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/SavedSearch HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"SavedSearchList":[{"SavedSearchId":0,"SearchName":"String","SearchText":"String","SearchTextPrintSet":"String","Shared":false,"SearchType":"String","Version":"String","Name":"String","FilePath":"String","CurrentVersion":"String","AdminUserId":0,"ErrorCount":0,"FullName":"String","SearchTermsHuman":"String","SearchCategoryId":"String","SearchNameFilter":"String","SearchStatusProduct":"String"}],"SearchType":"String","strSearchName":"String","strSearchText":"String","strSearchTermsHuman":"String","UsingRedis":true,"AppInitTime":"2024-05-03T02:25:06.8728823-04:00","ServerID":"WS-6-183-431","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T04:04:58.7628139-04:00","Device":"Desktop"}