API Method - Event Get – Agile Ticketing Solutions

This method will get an event based on the event ID.

Parameters

appKey

string

A key identifying the application making the call

userKey

string

A key identifying the user making the call

corpOrgID

int

The corp organization ID

eventID

long

The event ID

buyerTypeID

int

optional

The buyer type ID used to help evaluate SalesState

Return Values

An event data structure with the following fields

EventID

long

The event ID

ExternalEventID

string

The external event ID

OrgID

int

The event level organization ID

Name

string

The name of the event

VenueID

int

The venue ID

VenueName

string

The name of the venue

StartDate

datetime

The start date/time of the event

EndDate

datetime

The end date/time of the event

DateTBD

bool

The date/time of the event is still to be determined

ShowEndDate

bool

The end date should be shown when displaying the event

ShowTime

bool

The time should be shown when displaying the event

ShortDescription

string

The short description for the event

ShortDescriptive1

string

The supporting text for an event name

ShortDescriptive2

string

The supporting text for an event date/time

ExtraHTML

string

The extra HTML/Text for the event

DisplayColor

int

The display color for the event

EventImage

string

The image name

EventThumbImage

string

The thumbnail image name

ConfigImage

string

The venue config image name

ConfigThumbImage

string

The venue config thumbnail image name

SalesMessage

string

The current sales message to display

SalesState

int

The current sales status (1 – Before sales, 2 – Available for sales, 3 – After sales but before the event, 4 – After event, 5 – Display custom message)

StreamingType

string

The type of video streaming source. (Vimeo, VimeoLive, VimeoShowcase, CineSend, CineSendVoucher, ExternalURL, EmbedURL, PurchaseURL, ZoomMeeting, Brightcove, AgileLINK, AgileLINKVoucher)

StreamingWindowType

string

The type of availability for streaming. (FirstWatch, PurchaseDate, StartDate, EndDate, OpenToMembers, OpenToAll)

StreamingID

string

The streaming asset ID or URL for integration

StreamingHours

int

The number of hours streaming is available after the customer purchases

StreamingWatchURLOverride

string

The URL for overriding where to send the customer for viewing the streaming title

StreamingPrompt

string

The “Watch Now” prompt to show the customer to start the stream

PurchasePrompt

string

The “Buy Tickets” prompt that should be shown to customers to start purchase

MoreInfoPrompt

string

The “More Info” prompt that should be shown to customers to see more details about the event/title

CustomProperties

list

A list of custom property data structures with the following fields

int

The custom property ID

Group

string

The grouping value for the custom property

Name

string

The custom property name

Value

string

The custom value for this show

Hidden

bool

Indicates whether this custom property should be visible to the end customer or just internal

Sequence

int

The sequence order for sorting

AdditionalMedia

list

A list of additional images, html, or trailers for the show

Caption

string

The caption to show with the media or image

MainDuplicate

bool

Indicates this is the same as the main image

Sequence

int

The sequence order for sorting

Type

string

The type of media (Image, HTML, YouTube, Vimeo)

Value

string

The raw URL or html value

MediaEmbed

string

The formatted html for embed

RelatedEvents

list

A list of related events or shorts

long

The related event ID

OrgID

int

The event level organization ID

Name

string

The name of the event

UntilDate

datetime

The date of the related event

Duration

int

The duration of the event in minutes

ShortDescriptive

string

The supporting text for the event name

Description

string

The description of the event

ImageURL

string

The image URL

ThumbnailURL

string

The thumbnail image URL

Errors

ApplicationKeyMissing

1000

Required parameter appkey is missing or invalid

UserCredentialsMissing

1001

Required user credentials are missing or invalid

SecurityInsufficient

1002

User security does not permit access to the requested function

RequiredParameter

1028

Required parameter is missing

RequestedEventNotFound

1007

Requested event not found

Example Request

https://prod1.agileticketing.net/api/sales.svc/xml/EventGet?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&eventid={EVENTID}

Example JSON Response

{
	"EventID":9223372036854775807,
	"ExternalEventID":"String content",
	"OrgID":2147483647,
	"Name":"String content",
	"VenueID":2147483647,
	"VenueName":"String content",
	"StartDate":"\/Date(928167600000-0500)\/",
	"EndDate":"\/Date(928167600000-0500)\/",
	"DateTBD":true,
	"ShowEndDate":true,
	"ShowTime":true,
	"ShortDescription":"String content",
	"ShortDescriptive1":"String content",
	"ShortDescriptive2":"String content",
	"ExtraHTML":"String content",
	"DisplayColor":2147483647,
	"EventImage":"String content",
	"EventThumbImage":"String content",
	"ConfigImage":"String content",
	"ConfigThumbImage":"String content",
	"SalesMessage":"String content",
	"SalesState":2147483647,
        "StreamingType":"String content",
	"StreamingWindowType":"String content",
	"StreamingID":"String content",
	"StreamingHours":2147483647,
	"StreamWatchURLOverride":"String content",
	"StreamPrompt":"String content",
	"PurchasePrompt":"String content",
	"MoreInfoPrompt":"String content",
	"CustomProperties":[{
		"ID":2147483647,
		"Group":"String content",
		"Name":"String content",
		"Value":"String content",
		"Hidden":true,
		"Sequence":2147483647
	}],
	"AdditionalMedia":[{
		"Caption":"String content",
		"MainDuplicate":true,
		"Sequence":2147483647,
		"Type":"String content",
		"Value":"String content",
		"MediaEmbed":"String content"
	}],
	"RelatedEvents":[{
		"ID":9223372036854775807,
		"OrgID":2147483647,
		"Name":"String content",
		"UntilDate":"\/Date(928167600000-0500)\/",
		"Duration":2147483647,
		"ShortDescriptive":"String content",
		"Description":"String content",
		"ImageURL":"String content",
		"ThumbnailURL":"String content"
	}]
}

Example XML Response

<Event xmlns="http://www.agiletix.com/api">
  <EventID>9223372036854775807</EventID>
  <ExternalEventID>String content</ExternalEventID>
  <OrgID>2147483647</OrgID>
  <Name>String content</Name>
  <VenueID>2147483647</VenueID>
  <VenueName>String content</VenueName>
  <StartDate>1999-05-31T11:20:00</StartDate>
  <EndDate>1999-05-31T11:20:00</EndDate>
  <DateTBD>true</DateTBD>
  <ShowEndDate>true</ShowEndDate>
  <ShowTime>true</ShowTime>
  <ShortDescription>String content</ShortDescription>
  <ShortDescriptive1>String content</ShortDescriptive1>
  <ShortDescriptive2>String content</ShortDescriptive2>
  <ExtraHTML>String content</ExtraHTML>
  <DisplayColor>2147483647</DisplayColor>
  <EventImage>String content</EventImage>
  <EventThumbImage>String content</EventThumbImage>
  <ConfigImage>String content</ConfigImage>
  <ConfigThumbImage>String content</ConfigThumbImage>
  <SalesMessage>String content</SalesMessage>
  <SalesState>2147483647</SalesState>
  <StreamingType>String content</StreamingType>
  <StreamingWindowType>String content</StreamingWindowType>
  <StreamingID>String content</StreamingID>
  <StreamingHours>2147483647</StreamingHours>
  <StreamWatchURLOverride>String content</StreamWatchURLOverride>
  <StreamPrompt>String content</StreamPrompt>
  <PurchasePrompt>String content</PurchasePrompt>
  <MoreInfoPrompt>String content</MoreInfoPrompt>
  <CustomProperties>
    <CustomItemProperty>
      <ID>2147483647</ID>
      <Group>String content</Group>
      <Name>String content</Name>
      <Value>String content</Value>
      <Hidden>true</Hidden>
      <Sequence>2147483647</Sequence>
    </CustomItemProperty>
    <CustomItemProperty>
      <ID>2147483647</ID>
      <Group>String content</Group>
      <Name>String content</Name>
      <Value>String content</Value>
      <Hidden>true</Hidden>
      <Sequence>2147483647</Sequence>
    </CustomItemProperty>
  </CustomProperties>
  <AdditionalMedia>
    <AdditionalMediaItem>
      <Caption>String content</Caption>
      <MainDuplicate>true</MainDuplicate>
      <Sequence>2147483647</Sequence>
      <Type>String content</Type>
      <Value>String content</Value>
      <MediaEmbed>String content</MediaEmbed>
    </AdditionalMediaItem>
    <AdditionalMediaItem>
      <Caption>String content</Caption>
      <MainDuplicate>true</MainDuplicate>
      <Sequence>2147483647</Sequence>
      <Type>String content</Type>
      <Value>String content</Value>
      <MediaEmbed>String content</MediaEmbed>
    </AdditionalMediaItem>
  </AdditionalMedia>
  <RelatedEvents>
    <RelatedEvent>
      <ID>9223372036854775807</ID>
      <OrgID>2147483647</OrgID>
      <Name>String content</Name>
      <UntilDate>1999-05-31T11:20:00</UntilDate>
      <Duration>2147483647</Duration>
      <ShortDescriptive>String content</ShortDescriptive>
      <Description>String content</Description>
      <ImageURL>String content</ImageURL>
      <ThumbnailURL>String content</ThumbnailURL>
    </RelatedEvent>
    <RelatedEvent>
      <ID>9223372036854775807</ID>
      <OrgID>2147483647</OrgID>
      <Name>String content</Name>
      <UntilDate>1999-05-31T11:20:00</UntilDate>
      <Duration>2147483647</Duration>
      <ShortDescriptive>String content</ShortDescriptive>
      <Description>String content</Description>
      <ImageURL>String content</ImageURL>
      <ThumbnailURL>String content</ThumbnailURL>
    </RelatedEvent>
  </RelatedEvents>
</Event>

Comments