YM REST Services

<back to all web services

FindEventRegistrationForms

Requires Authentication
Requires any of the roles:admin, oauthadminRequired permission:/admin/store/
The following routes are available for this service:
GET/Ams/{ClientID}/FindEventRegistrationFormsLook up event registration forms - with cache.Find event registration form by search key elements of a product.
FindEventRegistrationForms Parameters:
NameParameterData TypeRequiredDescription
termquerystringNo
limitqueryintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
FindEventRegistrationFormsResponse Parameters:
NameParameterData TypeRequiredDescription
itemsformList<FormFound>No
FormFound Parameters:
NameParameterData TypeRequiredDescription
idformintNo
labelformstringNo

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}/FindEventRegistrationForms HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	items: 
	[
		{
			id: 0,
			label: String
		}
	],
	term: String,
	limit: 0,
	UsingRedis: True,
	AppInitTime: 2024-05-03T01:46:05.4743219-04:00,
	ServerID: WS-4-7-585,
	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-03T03:37:01.1251152-04:00,
	Device: Desktop
}