YM REST Services

EventCustomLabels

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

The following routes are available for this service:
GET	/Ams/{ClientID}/Event/{EventId}/EventCustomLabels	Return a list of available labels a client can customize for a given event.
PUT	/Ams/{ClientID}/Event/{EventId}/EventCustomLabels	Create the custom values of registration labels for a given event.
POST	/Ams/{ClientID}/Event/{EventId}/EventCustomLabels	Update the custom values of registration labels for a given event.

**EventCustomLabels** Parameters:
Name	Parameter	Data Type	Required	Description
EventId	path	int	No
Labels	body	List<EventCustomLabel>	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

**EventCustomLabel** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
MetaId	form	int	No
Name	form	string	No
Title	form	string	No
DefaultValue	form	string	No
CustomValue	form	string	No

**EventCustomLabelsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
HasCustomValues	form	bool	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}/Event/{EventId}/EventCustomLabels HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EventId: 0,
	Labels: 
	[
		{
			Id: 0,
			MetaId: 0,
			Name: String,
			Title: String,
			DefaultValue: String,
			CustomValue: String
		}
	],
	UsingRedis: True,
	AppInitTime: 2024-05-03T02:24:13.1616448-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-03T04:23:41.8231143-04:00,
	Device: Desktop
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	HasCustomValues: False,
	EventId: 0,
	Labels: 
	[
		{
			Id: 0,
			MetaId: 0,
			Name: String,
			Title: String,
			DefaultValue: String,
			CustomValue: String
		}
	],
	UsingRedis: True,
	AppInitTime: 2024-05-03T02:24:13.1616448-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-03T04:23:41.8281139-04:00,
	Device: Desktop
}