YM REST Services

<back to all web services

EventTickets

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/Event/{EventId}/TicketsReturn a list of tickets linked to an event.
PUT/Ams/{ClientID}/Event/{EventId}/TicketsUpdate a given event ticket.
POST/Ams/{ClientID}/Event/{EventId}/TicketsCreate a new event ticket.
GET/Ams/{ClientID}/Event/{EventId}/Tickets/{TicketId}Return the details for a given event ticket.
DELETE/Ams/{ClientID}/Event/{EventId}/Tickets/{TicketId}Delete a given event ticket.
EventTickets Parameters:
NameParameterData TypeRequiredDescription
TicketIdpathint?No
EventIdpathintNo
DateCreatedbodyDateTimeNo
NamebodystringNo
Quantitybodyint?No
ChargeForEventbodyboolNo
Activebodybool?No
Requiredbodybool?No
TypebodyTicketTypeNo
DescriptionbodystringNo
Categorybodyint?No
UseInventorybodyboolNo
AvailablebodyAvailableType?No
SKUbodystringNo
GLCodebodystringNo
QBClassbodystringNo
UnitPricebodydouble?No
PricesbodyProductPrice[]No
ExcludeFromEventbodyboolNo
PromoCodeIdsbodyList<int>No
IsForCopybodyboolNo
IsForReusebodyboolNo
IsLinkedbodyboolNo
EventTicketLinkIdbodyintNo
TaxLocationIDbodyint?No
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
ProductPrice Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
Priceformdouble?No
EventTicketsResponse Parameters:
NameParameterData TypeRequiredDescription
TicketsformList<EventTickets>No
RestrictAvailableTypesformboolNo

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

{
	TicketId: 0,
	EventId: 0,
	DateCreated: 0001-01-01,
	Name: String,
	Quantity: 0,
	ChargeForEvent: False,
	Active: False,
	Required: False,
	Type: Product,
	Description: String,
	Category: 0,
	UseInventory: False,
	Available: Both,
	SKU: String,
	GLCode: String,
	QBClass: String,
	UnitPrice: 0,
	Prices: 
	[
		{
			Id: 0,
			Name: String,
			Price: 0
		}
	],
	ExcludeFromEvent: False,
	PromoCodeIds: 
	[
		0
	],
	IsForCopy: False,
	IsForReuse: False,
	IsLinked: False,
	EventTicketLinkId: 0,
	TaxLocationID: 0,
	UsingRedis: True,
	AppInitTime: 2024-05-03T07:46:06.7713048-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-03T10:31:42.6217126-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Tickets: 
	[
		{
			TicketId: 0,
			EventId: 0,
			DateCreated: 0001-01-01,
			Name: String,
			Quantity: 0,
			ChargeForEvent: False,
			Active: False,
			Required: False,
			Type: Product,
			Description: String,
			Category: 0,
			UseInventory: False,
			Available: Both,
			SKU: String,
			GLCode: String,
			QBClass: String,
			UnitPrice: 0,
			Prices: 
			[
				{
					Id: 0,
					Name: String,
					Price: 0
				}
			],
			ExcludeFromEvent: False,
			PromoCodeIds: 
			[
				0
			],
			IsForCopy: False,
			IsForReuse: False,
			IsLinked: False,
			EventTicketLinkId: 0,
			TaxLocationID: 0,
			UsingRedis: True,
			AppInitTime: 2024-05-03T07:46:06.7713048-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-03T10:31:42.6217126-04:00,
			Device: Desktop
		}
	],
	RestrictAvailableTypes: False,
	TicketId: 0,
	EventId: 0,
	DateCreated: 0001-01-01,
	Name: String,
	Quantity: 0,
	ChargeForEvent: False,
	Active: False,
	Required: False,
	Type: Product,
	Description: String,
	Category: 0,
	UseInventory: False,
	Available: Both,
	SKU: String,
	GLCode: String,
	QBClass: String,
	UnitPrice: 0,
	Prices: 
	[
		{
			Id: 0,
			Name: String,
			Price: 0
		}
	],
	ExcludeFromEvent: False,
	PromoCodeIds: 
	[
		0
	],
	IsForCopy: False,
	IsForReuse: False,
	IsLinked: False,
	EventTicketLinkId: 0,
	TaxLocationID: 0,
	UsingRedis: True,
	AppInitTime: 2024-05-03T07:46:06.7713048-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-03T10:31:42.6373327-04:00,
	Device: Desktop
}