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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<EventTickets xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Active>false</Active>
  <Available>Both</Available>
  <Category>0</Category>
  <ChargeForEvent>false</ChargeForEvent>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <Description>String</Description>
  <EventId>0</EventId>
  <EventTicketLinkId>0</EventTicketLinkId>
  <ExcludeFromEvent>false</ExcludeFromEvent>
  <GLCode>String</GLCode>
  <IsForCopy>false</IsForCopy>
  <IsForReuse>false</IsForReuse>
  <IsLinked>false</IsLinked>
  <Name>String</Name>
  <Prices>
    <ProductPrice>
      <Id>0</Id>
      <Name>String</Name>
      <Price>0</Price>
    </ProductPrice>
  </Prices>
  <PromoCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PromoCodeIds>
  <QBClass>String</QBClass>
  <Quantity>0</Quantity>
  <Required>false</Required>
  <SKU>String</SKU>
  <TaxLocationID>0</TaxLocationID>
  <TicketId>0</TicketId>
  <Type>Product</Type>
  <UnitPrice>0</UnitPrice>
  <UseInventory>false</UseInventory>
</EventTickets>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EventTicketsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Active>false</Active>
  <Available>Both</Available>
  <Category>0</Category>
  <ChargeForEvent>false</ChargeForEvent>
  <DateCreated>0001-01-01T00:00:00</DateCreated>
  <Description>String</Description>
  <EventId>0</EventId>
  <EventTicketLinkId>0</EventTicketLinkId>
  <ExcludeFromEvent>false</ExcludeFromEvent>
  <GLCode>String</GLCode>
  <IsForCopy>false</IsForCopy>
  <IsForReuse>false</IsForReuse>
  <IsLinked>false</IsLinked>
  <Name>String</Name>
  <Prices>
    <ProductPrice>
      <Id>0</Id>
      <Name>String</Name>
      <Price>0</Price>
    </ProductPrice>
  </Prices>
  <PromoCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </PromoCodeIds>
  <QBClass>String</QBClass>
  <Quantity>0</Quantity>
  <Required>false</Required>
  <SKU>String</SKU>
  <TaxLocationID>0</TaxLocationID>
  <TicketId>0</TicketId>
  <Type>Product</Type>
  <UnitPrice>0</UnitPrice>
  <UseInventory>false</UseInventory>
  <RestrictAvailableTypes>false</RestrictAvailableTypes>
  <Tickets>
    <EventTickets>
      <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
      <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
      <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <Active>false</Active>
      <Available>Both</Available>
      <Category>0</Category>
      <ChargeForEvent>false</ChargeForEvent>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <Description>String</Description>
      <EventId>0</EventId>
      <EventTicketLinkId>0</EventTicketLinkId>
      <ExcludeFromEvent>false</ExcludeFromEvent>
      <GLCode>String</GLCode>
      <IsForCopy>false</IsForCopy>
      <IsForReuse>false</IsForReuse>
      <IsLinked>false</IsLinked>
      <Name>String</Name>
      <Prices>
        <ProductPrice>
          <Id>0</Id>
          <Name>String</Name>
          <Price>0</Price>
        </ProductPrice>
      </Prices>
      <PromoCodeIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1:int>
      </PromoCodeIds>
      <QBClass>String</QBClass>
      <Quantity>0</Quantity>
      <Required>false</Required>
      <SKU>String</SKU>
      <TaxLocationID>0</TaxLocationID>
      <TicketId>0</TicketId>
      <Type>Product</Type>
      <UnitPrice>0</UnitPrice>
      <UseInventory>false</UseInventory>
    </EventTickets>
  </Tickets>
</EventTicketsResponse>