GET api/events/{guid}
Returns information for a given event guid.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
guid |
event guid |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
EventName | 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
{ "EventId": 1, "EventGuid": "95b5268e-569f-4fba-b340-038c223cf57a", "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": "7cd9c4d8-7f40-4f8f-b130-39f0941518e7", "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": "8a7e3ff2-bffd-476f-bacf-a464eeddb7dd", "TheaterGuid": "dee5543a-9272-4a5f-bc32-256f402efbfa", "EventGuid": "a6482ad4-a479-4b5c-a5b8-94583de4da34", "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": "8a7e3ff2-bffd-476f-bacf-a464eeddb7dd", "TheaterGuid": "dee5543a-9272-4a5f-bc32-256f402efbfa", "EventGuid": "a6482ad4-a479-4b5c-a5b8-94583de4da34", "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
<Event xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Dcip.Cloud.Booking.Services.Models"> <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>8a7e3ff2-bffd-476f-bacf-a464eeddb7dd</BookingGuid> <BookingState>Unknown</BookingState> <EventGuid>a6482ad4-a479-4b5c-a5b8-94583de4da34</EventGuid> <ListingUrl>sample string 4</ListingUrl> <LocalStartDate>sample string 2</LocalStartDate> <LocalStartTime>sample string 3</LocalStartTime> <PurchaseUrl>sample string 5</PurchaseUrl> <TheaterGuid>dee5543a-9272-4a5f-bc32-256f402efbfa</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>8a7e3ff2-bffd-476f-bacf-a464eeddb7dd</BookingGuid> <BookingState>Unknown</BookingState> <EventGuid>a6482ad4-a479-4b5c-a5b8-94583de4da34</EventGuid> <ListingUrl>sample string 4</ListingUrl> <LocalStartDate>sample string 2</LocalStartDate> <LocalStartTime>sample string 3</LocalStartTime> <PurchaseUrl>sample string 5</PurchaseUrl> <TheaterGuid>dee5543a-9272-4a5f-bc32-256f402efbfa</TheaterGuid> <TicketTestState>NotTested</TicketTestState> </Booking> </Bookings> <EventCategory>sample string 9</EventCategory> <EventDate>sample string 4</EventDate> <EventGroupGuid>7cd9c4d8-7f40-4f8f-b130-39f0941518e7</EventGroupGuid> <EventGroupName>sample string 8</EventGroupName> <EventGuid>95b5268e-569f-4fba-b340-038c223cf57a</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>