API Method - Show List – Agile Ticketing Solutions

This method will get a list of shows for the corp organization. If the optional show level organization ID is defined only the shows in that org will be returned. If the optional buyer type ID is defined only the events on sale for that buyer type will be returned.

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

showOrgID

int

optional

The show level organization ID

buyerTypeID

int

optional

The buyer type ID

startDate

datetime

The start date for listing events

endDate

datetime

The end date for listing events

Return Values

A list of show data structures with the following fields

long

The show ID

ExternalID

string

The external show ID

CorpOrgID

int

The corp level organization ID

CorpOrgName

string

The corp level organization name

OrgID

int

The show level organization ID

Name

string

The name of the show

Duration

int

The duration of the show in minutes

ShortDescription

string

The short description for the show

ShortDescriptive1

string

The supporting text for a show name

ShortDescriptive2

string

The supporting text for a show date/time

ExtraHTML

string

The extra HTML/Text for the show

DisplayColor

int

The display color for the show

ThumbImage

string

The thumbnail image URL

MainImage

string

The main image URL

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

StreamPrompt

string

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

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

ShowTimes

list

A list of show times

long

The show time event ID

OrgID

int

The event level organization ID

DateTBD

bool

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

StartDateTime

datetime

The start date/time of the event

EndDateTime

datetime

The end date/time of the event

Duration

int

The duration of the event in minutes

ShortDescriptive

string

The supporting text for an event date/time

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)

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

VenueID

int

The venue ID

VenueName

string

The name of the venue

ContentDelivery

string

The type of content being delivered (InPerson, Streaming)

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

Example Request

https://prod1.agileticketing.net/api/sales.svc/xml/ShowList?appkey={APPKEY}&userkey={USERKEY}&corporgid={CORPORGID}&showorgid={SHOWORGID}&buyertypeid={BUYERTYPEID}&startdate={STARTDATE}&enddate={ENDDATE}

Example JSON Response

[{
	"ID":9223372036854775807,
	"ExternalID":"String content",
	"CorpOrgID":2147483647,
	"CorpOrgName":"String content",
	"OrgID":2147483647,
	"Name":"String content",
	"Duration":2147483647,
	"ShortDescription":"String content",
	"ShortDescriptive1":"String content",
	"ShortDescriptive2":"String content",
	"ExtraHTML":"String content",
	"DisplayColor":"String content",
	"ThumbImage":"String content",
	"MainImage":"String content",
        "StreamingType":"String content",
	"StreamingWindowType":"String content",
	"StreamingID":"String content",
	"StreamingHours":2147483647,
	"StreamWatchURLOverride":"String content",
	"StreamPrompt":"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"
	}],
	"ShowTimes":[{
		"ID":9223372036854775807,
		"OrgID":2147483647,
		"DateTBD":true,
		"StartDateTime":"\/Date(928167600000-0500)\/",
		"EndDateTime":"\/Date(928167600000-0500)\/",
		"Duration":2147483647,
		"ShortDescriptive":"String content",
		"SalesMessage":"String content",
		"SalesState":"String content",
                "PurchasePrompt":"String content",
		"MoreInfoPrompt":"String content",
		"VenueID":9223372036854775807,
		"VenueName":"String content",
                "ContentDelivery":"String content"
	}]
}]

Example XML Response

<ArrayOfShow xmlns="http://www.agiletix.com/api">
  <Show>
    <ID>9223372036854775807</ID>
    <ExternalID>String content</ExternalID>
    <CorpOrgID>2147483647</CorpOrgID>
    <CorpOrgName>String content</CorpOrgName>
    <OrgID>2147483647</OrgID>
    <Name>String content</Name>
    <Duration>2147483647</Duration>
    <ShortDescription>String content</ShortDescription>
    <ShortDescriptive1>String content</ShortDescriptive1>
    <ShortDescriptive2>String content</ShortDescriptive2>
    <ExtraHTML>String content</ExtraHTML>
    <DisplayColor>String content</DisplayColor>
    <ThumbImage>String content</ThumbImage>
    <MainImage>String content</MainImage>
    <StreamingType>String content</StreamingType>
    <StreamingWindowType>String content</StreamingWindowType>
    <StreamingID>String content</StreamingID>
    <StreamingHours>2147483647</StreamingHours>
    <StreamWatchURLOverride>String content</StreamWatchURLOverride>
    <StreamPrompt>String content</StreamPrompt>
    <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>
    <ShowTimes>
      <ShowTime>
        <ID>9223372036854775807</ID>
        <OrgID>2147483647</OrgID>
        <DateTBD>true</DateTBD>
        <StartDateTime>1999-05-31T11:20:00</StartDateTime>
        <EndDateTime>1999-05-31T11:20:00</EndDateTime>
        <Duration>2147483647</Duration>
        <ShortDescriptive>String content</ShortDescriptive>
        <SalesMessage>String content</SalesMessage>
        <SalesState>String content</SalesState>
        <PurchasePrompt>String content</PurchasePrompt>
        <MoreInfoPrompt>String content</MoreInfoPrompt>
        <VenueID>9223372036854775807</VenueID>
        <VenueName>String content</VenueName>
        <ContentDelivery>String content</ContentDelivery>
      </ShowTime>
      <ShowTime>
        <ID>9223372036854775807</ID>
        <OrgID>2147483647</OrgID>
        <DateTBD>true</DateTBD>
        <StartDateTime>1999-05-31T11:20:00</StartDateTime>
        <EndDateTime>1999-05-31T11:20:00</EndDateTime>
        <Duration>2147483647</Duration>
        <ShortDescriptive>String content</ShortDescriptive>
        <SalesMessage>String content</SalesMessage>
        <SalesState>String content</SalesState>
        <PurchasePrompt>String content</PurchasePrompt>
        <MoreInfoPrompt>String content</MoreInfoPrompt>
        <VenueID>9223372036854775807</VenueID>
        <VenueName>String content</VenueName>
        <ContentDelivery>String content</ContentDelivery>
      </ShowTime>
    </ShowTimes>
  </Show>
</ArrayOfShow>

Comments