GET api/events?start={start}&end={end}

Returns the current list of events for an optional date range. If start is not specified, it will use today.

Request Information

URI Parameters

Name	Description	Type	Additional information
start		date	None.
end		date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of Event

Name	Description	Type	Additional information
EventId	Event's internal identifier	integer	None.
EventGuid	Event's external identifier	globally unique identifier	None.
EventName	Event's name	string	None.
EventDate	Event's start date. Format: m/d/yyyy.	string	None.
EventTime	Event's start time. Format: h:mm AM/PM.	string	None.
TimeZone	Event's time zone.	string	None.
EventState	Possible vales: Planning, Active, Cancelled, Complete	EventStates	None.
Synopsis	Description of the event.	string	None.
Is3dInd	Indicates if the event is a 3D event.	boolean	None.
LengthInMinutes	The length of the event in minutes.	integer	None.
EventGroupName	The event group name the event is a part of.	string	None.
EventGroupGuid	The event group identifier	globally unique identifier	None.
EventCategory	The category for the event: Arts And Entertainment, Anime, Broadcast, Classics, Comedy, Inspirational, Metopera, Music, Original Programming, Premieres, Red Carpet, Sports, B2B, Transport, Private, Childrens	string	None.
SuggestedTicketPrice	This is the General suggested ticket price	decimal number	None.
SuggestedTicketPriceAdult	This is the Adult suggested ticket price	decimal number	None.
SuggestedTicketPriceChild	This is the Child suggested ticket price	decimal number	None.
SuggestedTicketPriceSenior	This is the Senior suggested ticket price	decimal number	None.
SuggestedTicketPriceStudent	This is the Student suggested ticket price	decimal number	None.
EventVariation	This is what type of variation this event is	string	None.
PublicOnSaleDate		string	None.
PrivateOnSaleDate		string	None.
WebPageActiveDate		string	None.
EventRating		string	None.
AdditionalComments		string	None.
Bookings		Collection of Booking	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "EventId": 1,
    "EventGuid": "c0075765-8634-4835-ad57-3107fecbe3d9",
    "EventName": "sample string 3",
    "EventDate": "sample string 4",
    "EventTime": "sample string 5",
    "TimeZone": "sample string 6",
    "EventState": 0,
    "Synopsis": "sample string 7",
    "Is3dInd": true,
    "LengthInMinutes": 1,
    "EventGroupName": "sample string 8",
    "EventGroupGuid": "d6c9d4d6-909d-48c3-a063-c2885c6faac6",
    "EventCategory": "sample string 9",
    "SuggestedTicketPrice": 1.0,
    "SuggestedTicketPriceAdult": 1.0,
    "SuggestedTicketPriceChild": 1.0,
    "SuggestedTicketPriceSenior": 1.0,
    "SuggestedTicketPriceStudent": 1.0,
    "EventVariation": "sample string 10",
    "PublicOnSaleDate": "sample string 11",
    "PrivateOnSaleDate": "sample string 12",
    "WebPageActiveDate": "sample string 13",
    "EventRating": "sample string 14",
    "AdditionalComments": "sample string 15",
    "Bookings": [
      {
        "BookingGuid": "5177dabf-56b7-45f7-b312-e0eecf3d052b",
        "TheaterGuid": "8bd91901-249b-4175-9c17-78f402dba429",
        "EventGuid": "056e7063-f5e5-4e13-aed7-afcd8b80d49f",
        "Auditoriums": [
          {
            "Auditiorium": 1,
            "SeatCount": 2,
            "AuditoriumState": 0
          },
          {
            "Auditiorium": 1,
            "SeatCount": 2,
            "AuditoriumState": 0
          }
        ],
        "LocalStartDate": "sample string 2",
        "LocalStartTime": "sample string 3",
        "BookingState": 0,
        "TicketTestState": 0,
        "ListingUrl": "sample string 4",
        "PurchaseUrl": "sample string 5"
      },
      {
        "BookingGuid": "5177dabf-56b7-45f7-b312-e0eecf3d052b",
        "TheaterGuid": "8bd91901-249b-4175-9c17-78f402dba429",
        "EventGuid": "056e7063-f5e5-4e13-aed7-afcd8b80d49f",
        "Auditoriums": [
          {
            "Auditiorium": 1,
            "SeatCount": 2,
            "AuditoriumState": 0
          },
          {
            "Auditiorium": 1,
            "SeatCount": 2,
            "AuditoriumState": 0
          }
        ],
        "LocalStartDate": "sample string 2",
        "LocalStartTime": "sample string 3",
        "BookingState": 0,
        "TicketTestState": 0,
        "ListingUrl": "sample string 4",
        "PurchaseUrl": "sample string 5"
      }
    ]
  },
  {
    "EventId": 1,
    "EventGuid": "c0075765-8634-4835-ad57-3107fecbe3d9",
    "EventName": "sample string 3",
    "EventDate": "sample string 4",
    "EventTime": "sample string 5",
    "TimeZone": "sample string 6",
    "EventState": 0,
    "Synopsis": "sample string 7",
    "Is3dInd": true,
    "LengthInMinutes": 1,
    "EventGroupName": "sample string 8",
    "EventGroupGuid": "d6c9d4d6-909d-48c3-a063-c2885c6faac6",
    "EventCategory": "sample string 9",
    "SuggestedTicketPrice": 1.0,
    "SuggestedTicketPriceAdult": 1.0,
    "SuggestedTicketPriceChild": 1.0,
    "SuggestedTicketPriceSenior": 1.0,
    "SuggestedTicketPriceStudent": 1.0,
    "EventVariation": "sample string 10",
    "PublicOnSaleDate": "sample string 11",
    "PrivateOnSaleDate": "sample string 12",
    "WebPageActiveDate": "sample string 13",
    "EventRating": "sample string 14",
    "AdditionalComments": "sample string 15",
    "Bookings": [
      {
        "BookingGuid": "5177dabf-56b7-45f7-b312-e0eecf3d052b",
        "TheaterGuid": "8bd91901-249b-4175-9c17-78f402dba429",
        "EventGuid": "056e7063-f5e5-4e13-aed7-afcd8b80d49f",
        "Auditoriums": [
          {
            "Auditiorium": 1,
            "SeatCount": 2,
            "AuditoriumState": 0
          },
          {
            "Auditiorium": 1,
            "SeatCount": 2,
            "AuditoriumState": 0
          }
        ],
        "LocalStartDate": "sample string 2",
        "LocalStartTime": "sample string 3",
        "BookingState": 0,
        "TicketTestState": 0,
        "ListingUrl": "sample string 4",
        "PurchaseUrl": "sample string 5"
      },
      {
        "BookingGuid": "5177dabf-56b7-45f7-b312-e0eecf3d052b",
        "TheaterGuid": "8bd91901-249b-4175-9c17-78f402dba429",
        "EventGuid": "056e7063-f5e5-4e13-aed7-afcd8b80d49f",
        "Auditoriums": [
          {
            "Auditiorium": 1,
            "SeatCount": 2,
            "AuditoriumState": 0
          },
          {
            "Auditiorium": 1,
            "SeatCount": 2,
            "AuditoriumState": 0
          }
        ],
        "LocalStartDate": "sample string 2",
        "LocalStartTime": "sample string 3",
        "BookingState": 0,
        "TicketTestState": 0,
        "ListingUrl": "sample string 4",
        "PurchaseUrl": "sample string 5"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfEvent xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dcip.Cloud.Booking.Services.Models">
  <Event>
    <AdditionalComments>sample string 15</AdditionalComments>
    <Bookings>
      <Booking>
        <Auditoriums>
          <BookingAuditorium>
            <Auditiorium>1</Auditiorium>
            <AuditoriumState>Unknown</AuditoriumState>
            <SeatCount>2</SeatCount>
          </BookingAuditorium>
          <BookingAuditorium>
            <Auditiorium>1</Auditiorium>
            <AuditoriumState>Unknown</AuditoriumState>
            <SeatCount>2</SeatCount>
          </BookingAuditorium>
        </Auditoriums>
        <BookingGuid>5177dabf-56b7-45f7-b312-e0eecf3d052b</BookingGuid>
        <BookingState>Unknown</BookingState>
        <EventGuid>056e7063-f5e5-4e13-aed7-afcd8b80d49f</EventGuid>
        <ListingUrl>sample string 4</ListingUrl>
        <LocalStartDate>sample string 2</LocalStartDate>
        <LocalStartTime>sample string 3</LocalStartTime>
        <PurchaseUrl>sample string 5</PurchaseUrl>
        <TheaterGuid>8bd91901-249b-4175-9c17-78f402dba429</TheaterGuid>
        <TicketTestState>NotTested</TicketTestState>
      </Booking>
      <Booking>
        <Auditoriums>
          <BookingAuditorium>
            <Auditiorium>1</Auditiorium>
            <AuditoriumState>Unknown</AuditoriumState>
            <SeatCount>2</SeatCount>
          </BookingAuditorium>
          <BookingAuditorium>
            <Auditiorium>1</Auditiorium>
            <AuditoriumState>Unknown</AuditoriumState>
            <SeatCount>2</SeatCount>
          </BookingAuditorium>
        </Auditoriums>
        <BookingGuid>5177dabf-56b7-45f7-b312-e0eecf3d052b</BookingGuid>
        <BookingState>Unknown</BookingState>
        <EventGuid>056e7063-f5e5-4e13-aed7-afcd8b80d49f</EventGuid>
        <ListingUrl>sample string 4</ListingUrl>
        <LocalStartDate>sample string 2</LocalStartDate>
        <LocalStartTime>sample string 3</LocalStartTime>
        <PurchaseUrl>sample string 5</PurchaseUrl>
        <TheaterGuid>8bd91901-249b-4175-9c17-78f402dba429</TheaterGuid>
        <TicketTestState>NotTested</TicketTestState>
      </Booking>
    </Bookings>
    <EventCategory>sample string 9</EventCategory>
    <EventDate>sample string 4</EventDate>
    <EventGroupGuid>d6c9d4d6-909d-48c3-a063-c2885c6faac6</EventGroupGuid>
    <EventGroupName>sample string 8</EventGroupName>
    <EventGuid>c0075765-8634-4835-ad57-3107fecbe3d9</EventGuid>
    <EventId>1</EventId>
    <EventName>sample string 3</EventName>
    <EventRating>sample string 14</EventRating>
    <EventState>Unknown</EventState>
    <EventTime>sample string 5</EventTime>
    <EventVariation>sample string 10</EventVariation>
    <Is3dInd>true</Is3dInd>
    <LengthInMinutes>1</LengthInMinutes>
    <PrivateOnSaleDate>sample string 12</PrivateOnSaleDate>
    <PublicOnSaleDate>sample string 11</PublicOnSaleDate>
    <SuggestedTicketPrice>1</SuggestedTicketPrice>
    <SuggestedTicketPriceAdult>1</SuggestedTicketPriceAdult>
    <SuggestedTicketPriceChild>1</SuggestedTicketPriceChild>
    <SuggestedTicketPriceSenior>1</SuggestedTicketPriceSenior>
    <SuggestedTicketPriceStudent>1</SuggestedTicketPriceStudent>
    <Synopsis>sample string 7</Synopsis>
    <TimeZone>sample string 6</TimeZone>
    <WebPageActiveDate>sample string 13</WebPageActiveDate>
  </Event>
  <Event>
    <AdditionalComments>sample string 15</AdditionalComments>
    <Bookings>
      <Booking>
        <Auditoriums>
          <BookingAuditorium>
            <Auditiorium>1</Auditiorium>
            <AuditoriumState>Unknown</AuditoriumState>
            <SeatCount>2</SeatCount>
          </BookingAuditorium>
          <BookingAuditorium>
            <Auditiorium>1</Auditiorium>
            <AuditoriumState>Unknown</AuditoriumState>
            <SeatCount>2</SeatCount>
          </BookingAuditorium>
        </Auditoriums>
        <BookingGuid>5177dabf-56b7-45f7-b312-e0eecf3d052b</BookingGuid>
        <BookingState>Unknown</BookingState>
        <EventGuid>056e7063-f5e5-4e13-aed7-afcd8b80d49f</EventGuid>
        <ListingUrl>sample string 4</ListingUrl>
        <LocalStartDate>sample string 2</LocalStartDate>
        <LocalStartTime>sample string 3</LocalStartTime>
        <PurchaseUrl>sample string 5</PurchaseUrl>
        <TheaterGuid>8bd91901-249b-4175-9c17-78f402dba429</TheaterGuid>
        <TicketTestState>NotTested</TicketTestState>
      </Booking>
      <Booking>
        <Auditoriums>
          <BookingAuditorium>
            <Auditiorium>1</Auditiorium>
            <AuditoriumState>Unknown</AuditoriumState>
            <SeatCount>2</SeatCount>
          </BookingAuditorium>
          <BookingAuditorium>
            <Auditiorium>1</Auditiorium>
            <AuditoriumState>Unknown</AuditoriumState>
            <SeatCount>2</SeatCount>
          </BookingAuditorium>
        </Auditoriums>
        <BookingGuid>5177dabf-56b7-45f7-b312-e0eecf3d052b</BookingGuid>
        <BookingState>Unknown</BookingState>
        <EventGuid>056e7063-f5e5-4e13-aed7-afcd8b80d49f</EventGuid>
        <ListingUrl>sample string 4</ListingUrl>
        <LocalStartDate>sample string 2</LocalStartDate>
        <LocalStartTime>sample string 3</LocalStartTime>
        <PurchaseUrl>sample string 5</PurchaseUrl>
        <TheaterGuid>8bd91901-249b-4175-9c17-78f402dba429</TheaterGuid>
        <TicketTestState>NotTested</TicketTestState>
      </Booking>
    </Bookings>
    <EventCategory>sample string 9</EventCategory>
    <EventDate>sample string 4</EventDate>
    <EventGroupGuid>d6c9d4d6-909d-48c3-a063-c2885c6faac6</EventGroupGuid>
    <EventGroupName>sample string 8</EventGroupName>
    <EventGuid>c0075765-8634-4835-ad57-3107fecbe3d9</EventGuid>
    <EventId>1</EventId>
    <EventName>sample string 3</EventName>
    <EventRating>sample string 14</EventRating>
    <EventState>Unknown</EventState>
    <EventTime>sample string 5</EventTime>
    <EventVariation>sample string 10</EventVariation>
    <Is3dInd>true</Is3dInd>
    <LengthInMinutes>1</LengthInMinutes>
    <PrivateOnSaleDate>sample string 12</PrivateOnSaleDate>
    <PublicOnSaleDate>sample string 11</PublicOnSaleDate>
    <SuggestedTicketPrice>1</SuggestedTicketPrice>
    <SuggestedTicketPriceAdult>1</SuggestedTicketPriceAdult>
    <SuggestedTicketPriceChild>1</SuggestedTicketPriceChild>
    <SuggestedTicketPriceSenior>1</SuggestedTicketPriceSenior>
    <SuggestedTicketPriceStudent>1</SuggestedTicketPriceStudent>
    <Synopsis>sample string 7</Synopsis>
    <TimeZone>sample string 6</TimeZone>
    <WebPageActiveDate>sample string 13</WebPageActiveDate>
  </Event>
</ArrayOfEvent>