YM REST Services

<back to all web services

EventRegistrationForms

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/EventRegistrationFormsReturn a list of registration Forms.
POST/Ams/{ClientID}/EventRegistrationFormsCreate a registration form.
EventRegistrationForms Parameters:
NameParameterData TypeRequiredDescription
FormIdbodyintNo
FormNamebodystringNo
AutoApprovebodyboolNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
EventRegistrationFormsResponse Parameters:
NameParameterData TypeRequiredDescription
defaultFormIdformintNo
FormsListformList<EventRegistrationForms>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.

POST /Ams/{ClientID}/EventRegistrationForms HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	FormId: 0,
	FormName: String,
	AutoApprove: False,
	UsingRedis: True,
	AppInitTime: 2024-05-02T23:57:28.8020412-04:00,
	ServerID: WS-5-59-079,
	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-03T01:22:48.8471687-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	defaultFormId: 0,
	FormsList: 
	[
		{
			FormId: 0,
			FormName: String,
			AutoApprove: False,
			UsingRedis: True,
			AppInitTime: 2024-05-02T23:57:28.8020412-04:00,
			ServerID: WS-5-59-079,
			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-03T01:22:48.8511702-04:00,
			Device: Desktop
		}
	],
	FormId: 0,
	FormName: String,
	AutoApprove: False,
	UsingRedis: True,
	AppInitTime: 2024-05-02T23:57:28.8020412-04:00,
	ServerID: WS-5-59-079,
	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-03T01:22:48.8521709-04:00,
	Device: Desktop
}