YM REST Services

SavedSearches

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin

The following routes are available for this service:
GET	/Ams/{ClientID}/SavedSearch	Return the list of saved searches.

**SavedSearches** Parameters:
Name	Parameter	Data Type	Required
SearchType	query	string	No
strSearchName	query	string	No
strSearchText	query	string	No
strSearchTermsHuman	query	string	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**SavedSearchResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SavedSearchList	form	List<ListData>	No

**ListData** Parameters:
Name	Parameter	Data Type	Required
SavedSearchId	form	int	No
SearchName	form	string	No
SearchText	form	string	No
SearchTextPrintSet	form	string	No
Shared	form	bool	No
SearchType	form	string	No
Version	form	string	No
Name	form	string	No
FilePath	form	string	No
CurrentVersion	form	string	No
AdminUserId	form	int	No
ErrorCount	form	int	No
FullName	form	string	No
SearchTermsHuman	form	string	No
SearchCategoryId	form	string	No
SearchNameFilter	form	string	No
SearchStatusProduct	form	string	No

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

HTTP + JSV

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: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
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-02T23:24:29.3036719-04:00,
	ServerID: WS-4-69-031,
	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-03T00:24:51.4255585-04:00,
	Device: Desktop
}