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 .csv suffix or ?format=csv

HTTP + CSV

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/csv
Content-Type: text/csv
Content-Length: length

{"TicketId":0,"EventId":0,"DateCreated":"0001-01-01T00:00:00.0000000","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:23:49.7169919-04:00","ServerID":"WS-6-134-823","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:05:56.7900156-04:00","Device":"Desktop"}

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

{"Tickets":[{"TicketId":0,"EventId":0,"DateCreated":"0001-01-01T00:00:00.0000000","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:23:49.7169919-04:00","ServerID":"WS-6-134-823","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:05:56.7910146-04:00","Device":"Desktop"}],"RestrictAvailableTypes":false,"TicketId":0,"EventId":0,"DateCreated":"0001-01-01T00:00:00.0000000","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:23:49.7169919-04:00","ServerID":"WS-6-134-823","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:05:56.7910146-04:00","Device":"Desktop"}