YM REST Services

<back to all web services

EventAttendeeTypes

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventId}/AttendeeTypesReturn a list of attendee types for a given event.
POST/Ams/{ClientID}/Event/{EventId}/AttendeeTypesCreate new attendee types for a given event.
PUT/Ams/{ClientID}/Event/{EventId}/AttendeeTypesUpdate existing attendee types for a given event.
GET/Ams/{ClientID}/Event/{EventId}/AttendeeTypes/{Id}Return a list of selections for an attendee type of a given event.
DELETE/Ams/{ClientID}/Event/{EventId}/AttendeeTypes/{Id}Delete an existing attendee type for a given event.
EventAttendeeTypes Parameters:
NameParameterData TypeRequiredDescription
EventIdpathintNo
IdpathintNo
NamebodystringNo
DescriptionbodystringNo
ActivebodyboolNo
EventRestrictedToSignedInMembersbodyboolNo
RestrictedToSignedInMembersbodyboolNo
RestrictedToNonMembersbodyboolNo
RestrictedMemberTypesbodyList<MemberTypeInfo>No
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MemberTypeInfo Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
IsSelectedformboolNo
EventAttendeeTypesResponse Parameters:
NameParameterData TypeRequiredDescription
RowsDeletedformintNo
EventAttendeeTypeListformList<EventAttendeeType>No
EventAttendeeType Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ActiveformboolNo
RestrictedToSignedInMembersformboolNo
RestrictedToNonMembersformboolNo
RestrictedMemberTypesformList<MemberTypeInfo>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}/AttendeeTypes HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	EventId: 0,
	Id: 0,
	Name: String,
	Description: String,
	Active: False,
	EventRestrictedToSignedInMembers: False,
	RestrictedToSignedInMembers: False,
	RestrictedToNonMembers: False,
	RestrictedMemberTypes: 
	[
		{
			Id: 0,
			Name: String,
			IsSelected: False
		}
	],
	UsingRedis: True,
	AppInitTime: 2024-05-03T07:20:07.3002820-04:00,
	ServerID: WS-5-155-994,
	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-03T07:55:51.4664318-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	RowsDeleted: 0,
	EventAttendeeTypeList: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			Active: False,
			RestrictedToSignedInMembers: False,
			RestrictedToNonMembers: False,
			RestrictedMemberTypes: 
			[
				{
					Id: 0,
					Name: String,
					IsSelected: False
				}
			]
		}
	],
	EventId: 0,
	Id: 0,
	Name: String,
	Description: String,
	Active: False,
	EventRestrictedToSignedInMembers: False,
	RestrictedToSignedInMembers: False,
	RestrictedToNonMembers: False,
	RestrictedMemberTypes: 
	[
		{
			Id: 0,
			Name: String,
			IsSelected: False
		}
	],
	UsingRedis: True,
	AppInitTime: 2024-05-03T07:20:07.3002820-04:00,
	ServerID: WS-5-155-994,
	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-03T07:55:51.4664318-04:00,
	Device: Desktop
}