Redirecting a link to a specific sales page in the Web Services

It is straightforward to redirect a link from your main web site to a specific web page on the Theatre Manager web listeners if you construct a link using the following syntax (generally with a target="_blank")

https:// tickets. yourvenue. org [/TheatreManager/1/login[?action=0|number][&lang=XX][&tmsource=YYY]]

The meaning of the parts of the above syntax is:

  • https:// tickets. yourserver. com is the direct link to the Theatre Manager web server. It is the only part that is mandatory.
  • /TheatreManager/1/login - if supplied, is used by the apache server to direct the user to the theatre manager web listeners and begin the sales process. The '1' is replaced by your outlet number in a multi-outlet site. In most cases, it is '1' corresponding to the '1' folder within the standard 'htdocs' web page structure.
  • ?action=0|number - 'action=' is replaced by one of the specific words as shown in the sections that follow (eg action might be 'event' or 'pass' or 'donation'). If you use 0 as the parameter, the user will be able to start at the selection process for 'action'. If you use a specific number as the parameter, then the user will be placed directly at the start of the sales process for the 'action'. For ticket sales web page access, there are some other options as described below.
  • &lang=XX - if you build a multi language web site, you can direct the user to begin using a language you specify. &lang=EN is the default. There must be a WebPagesXX folder for each language you want to support
  • &tmsource=yyy - which is an additional parameter that can be used to detect the web site referrer and attach it to a shopping cart. The idea with this is that you might tie the source to an eblast, another web site, your own site, some tourism source, etc. The value 'yyy' is attached to a shopping cart and once a value is in the cart, it cannot be changed. This means that the first source (or referrer) is used. Note: the source can also be set using a cookie if you want instead of a command line argument. For additional steps on setting up source references, click here.

Note that parameters in a URL are case sensitive.

Most keyword parameters are lower case unless they refer to an actual database variable. The documentation attempts to show examples in the appropriate case.

It is possible to write an interface to extract the event information and upload it your main marketing web site. For example: you can use the extracted information to publish data from TM into a custom calendar object and create 'buy now' links using the patterns above.

You can only use 'GET' style links on web pages in normal format or behind pictures of buttons.

You cannot simulate these links with 'posts' due to PCI compliance requirements to use form-tokens in each post per OWASP requirements to prevent cross-site scripting

Standard Access to Web Sales

https://tickets.yourvenue.org/TheatreManager/1/login?event=0

 

The general starting place for all sales is usally a link like the one above which is placed on the main web site. This link directs the patron to the Event List within the online sales. It allows them to start their online shopping experience by selecting the first performance they are interested in purchasing.

Direct Link to Login

https://tickets.yourvenue.org/TheatreManager/1/login

 

Each direct link contains a reference to login. This allows the link to bypass the login window and access the desired location. When a link to only the login window is desired, leave out any additional parameters on the URL.

Direct Link to Event

https://tickets.yourvenue.org/TheatreManager/1/login?event=xx

 

To create links beside each event advertise on your web site:

Click here to purchase tickets to Event #1 - https://tickets.yourvenue.org/TheatreManager/1/login&event=51
Click here to purchase tickets to Event #2 - https://tickets.yourvenue.org/TheatreManager/1/login&event=52
Click here to purchase tickets to Event #3 - https://tickets.yourvenue.org/TheatreManager/1/login&event=58
Click here to purchase tickets to Event #4 - https://tickets.yourvenue.org/TheatreManager/1/login&event=62

In the above examples the event value is defined by Theatre Manager as the unique event number for each different event. The event number is found by:

You can add other parameters to the event list such as:

  • &year=201x (to get events for that year)
  • &month=xx (to get events for that month)
  • &genre=mm (to show only events for that genre)
  • &venue=zz (to those only events in that venue)
  • and you can use a combination of the above to limit to a specific year and month if you want, or a specific year in a venue

Note: years are in yyyy format, Months are 0 to 12, genre # is from code tables, venue # is from list of venues. eg:

https://tickets.yourvenue.org/TheatreManager/1/login&event=51&year=2016&month&9&venue=5

  • Click Setup >> Events.
  • Click the button to populate the Event List.
  • Locate the Event # column to the far left.

    This column in the Event List shows the unique sequence number for each item in the list. Use the Event # to replace the "xx" in the link above.

Direct Link to Performance

https://tickets.yourvenue.org/TheatreManager/1/login?performance=xx

 

The link above will go directly to selling a performance (bypassing the event selection). The unique performance number will replace the "xx" in the link. To find the performance number:

  • Click Setup >> Events.
  • Click the button to populate the Event List.
  • Double-click an Event to open it.
  • In the Event Setup Window, select the Performance Tab to see the list of Performances for that Event.
  • Locate the far left column, labeled Perf #

    This column displays the unique performance number for each performance of the Event. Replace the "xx" in the link above with the desired performance number to create a direct link to the performance.

Direct Link to Genre

https://tickets.yourvenue.org/TheatreManager/1/login?event=0&genre=xx

 

To create a link for genre's of events the &event=0 is required prior to the &genre=xx parameter. The genre options are the same as those defined for ticket trove and cannot be changed by the venue. The values for xx can be found in the 'event genre' code table:

  • Click Setup >> System Tables >> Code Tables.
  • Select the Event Genre option in the left column.
  • Locate the Seq # column.

    This is the unique number representing the genera. It can be used to replace the "xx" in the link above.

Direct Link to Pick-Your-Seat

https://tickets.yourvenue.org/TheatreManager/1/login?bestavail=xx&section=yy&pricecode=Z&qty=qq&separate=1&seats=123,124,125

 

The link above will go directly to the best available seats to the performance named by bestavail (bypassing the event and performance selection).

Each of the items in the link (except bestavail) are optional
They mean:
  • bestavail=xx xx=the unique performance number. This parameter is mandatory
  • section=yy causes seats to be suggested in the best available section which is set up for the pricing map used for that performance. Leave blank to search the entire venue.
  • pricecode=Z causes seats to be suggested that matches a price code enabled for the performance. If the price code is not valid or not enabled for the performance, nothing will be shown on the best seat map.
  • qty=qq causes the system to look for 'qq' seats.
    • If not specified, this will default to the suggested purchase quantity for a performance in the Web tab. This is usually it is 2 for tickets and 1 for courses.
    • If specified, it overrides the default in the suggested purchase quantity
    • Specifying qty=0 has a special meaning. It will take the patron from directly the select your seats without pre-selecting anything. This means the option is select your seat with no fallback choices for the patron
  • separate=1 allows the system to suggest seats that are separate from each other, which is useful as the performance sells out. separate=0 is the default, meaning that seats offered to the patron must be together
  • seats=123,124,125 allow you to specify which logical seats you want to select on the the 'choose your own seats' map. It is not guaranteed that the patron will get those seats, only that they will be highlighted on the map and then the patron will have to choose them and have Theatre Manager confirm that it is ok to choose them. The seat numbers are the left column in the pricing map

You can put any combination of the parameters together that you wish. if the system cannot find seats based on your combination of selections, you'll be told.

The simplest form of the url to get any seats anywhere in the venue is

An example to allow pick your own without reserving seats first

 

To find the performance number:

  • Click Setup >> Events.
  • Click the button to populate the Event List.
  • Double-click an Event to open it.
  • In the Event Setup Window, select the Performance Tab to see the list of Performances for that Event.
  • Locate the far left column, labeled Perf #

    This column displays the unique performance number for each performance of the Event. Replace the "xx" in the link above with the desired performance number to create a direct link to the performance.

Direct Link to Coupon & Pre-Access Codes

Pre-Access Codes

https://tickets.yourvenue.org/TheatreManager/1/online?presale&code=xxx

 

Coupon

https://tickets.yourvenue.org/TheatreManager/1/online?coupon&code=xxx

 

Where xxx is the CODE


The above links will auto add a pre-access or coupon code for a patron.

 

Direct Link to Courses

https://tickets.yourvenue.org/TheatreManager/1/login?event=0&search=PB_SALES_METHOD='xx'

 

This link will take the patron to a select list of Performances based on the Sales Method for the Performance. The "xx" represents the Performance Sales Method sequence value from within Theatre Manager.

Sequence #Performance Sales Method
1Reserved Performances
2Festival Seating Performances
3Inventory
6Courses

Direct Link to Print-at-Home Tickets

Printable HTML: https://tickets.yourvenue.org/TheatreManager/1/login?futureticketsprint&[ cart=xxx] | [&order=yyyy]

PDF: https://tickets.yourvenue.org/TheatreManager/1/login?futureticketspdf&[ cart=xxx] | [&order=yyyy]

Logged In Options

Theatre Manager supports print at home tickets in either bar or QR code format which means you can send URL's to the user via email to get ticket printed. Theatre Manager does the one for the cart automatically on the confirmation letter during the sales process

By adding options to the URL above, you can print tickets for

  • All future tickets - leave the URL blank
  • A specific order - add &order=xxxx to the URL
  • A specific shopping cart - add &cart=yyyy to the URL

Note: if the patron owning the tickets is:

  • currently logged in to the online sales web site, the ticket print dialog will open.
  • not logged in, then the web site will require a log in before taking the patron to the print tickets window

Testing Options

Printable HTML: https://tickets.yourvenue.org/TheatreManager/1/login?futureticketsprint&test=1

PDF content as HTML: https://tickets.yourvenue.org/TheatreManager/1/login?futureticketspdf&test=1&html=1

Direct Link to Venue

https://tickets.yourvenue.org/TheatreManager/1/login?venue=xx

 

Purchasing Tickets to a Venue

The above link can be used when a venue has different type of events and a link is required to directly sell any performance in that venue. The 'venue' value is defined by Theatre Manager as the unique venue map number. To find the venue map number:

  • Click Setup >> Venue Maps.
  • Locate the far left column is labeled Map #:

    This is the unique sequence number representing the map. It can be used to replace the "xx" in the link above.

Direct Link to event from an advertisement

https://tickets.yourvenue.org/TheatreManager/1/login?event=0

 

To create links to show only events relating to a pre advertise on your web site:

Click here to purchase tickets to Event #1 - https://tickets.yourvenue.org/TheatreManager/1/login?event=51
Click here to purchase tickets to Event #2 - https://tickets.yourvenue.org/TheatreManager/1/login?event=52
Click here to purchase tickets to Event #3 - https://tickets.yourvenue.org/TheatreManager/1/login?event=58
Click here to purchase tickets to Event #4 - https://tickets.yourvenue.org/TheatreManager/1/login?event=62

In the above examples the event value is defined by Theatre Manager as the unique event number for each different event. The event number is found by:

  • Click Setup >> Events.
  • Click the button to populate the Event List.
  • Locate the Event # column to the far left.

    This column in the Event List shows the unique sequence number for each item in the list. Use the Event # to replace the "xx" in the link above.

Direct link to Calendar

https://tickets.yourvenue.org/TheatreManager/1/calendars/upcoming_events?view=month&start=2018-06-01

 

The Calendar displays upcoming Performances and Classes available for purchase. Patrons can choose to download an existing copy of the calendar as it appears today in an ICS file format or subscribe to the calendar which will allow for automatic updates to their iCal, Outlook or Google calendar program.

 

Optional Parameters

  • view
    • view=month - show items in a monthly calendar view as per the example below - this is the default
    • view=week - show items in weekly calendar format
    • view=list - show items in a list view
  • start
    • indicate the start date for the calendar in yyyy-mm-dd format

Direct link to Manage Performances

https://tickets.yourvenue.org/TheatreManager/1/login?manageperf=xx

 

This link will take the a staff member or volunteer with permission to manage events online to the 'manage event' page in the online sales. The "xx" represents the event # from within Theatre Manager. If the event number is zero, then the employee/volunteer will see a list of all events that they can manage.

Permission to manage an event online is occurs when three things are true:

This link displays the tmEventManagement.html web page. Once the Instructor is on this page, they can:

Direct Link to Subscriptions

https://tickets.yourvenue.org/TheatreManager/1/login?subscription=xx

 

The link above will take the patron directly to a Season Subscription. The "xx" represents the unique subscription number for that subscription package value as it is defined by Theatre Manager. To find the subscription number:

  • Click Patron Sales >> Season Reservations >> Setup Season Packages.
  • Click the button to populate the list.
  • Location the subscription number for each package.

    The Subscription number is in the far left column labeled Seq #. It can be used to replace the "xx" in the link above.

Direct Link to Special List of Events

https://tickets.yourvenue.org/TheatreManager/1/login?event=0&search=XXXXXX

 

The above can be used to create a direct link to a specific list of events (or date range of events) where a customized search is required. The options below are examples of search strings that can be used to replace the "XXXXXX" in the link above. Do NOT place quotes around the entire search parameter. Example:

  • P_SEQ IN (x,y,z,...) where x, y, z are valid P_SEQ (event) numbers - find these 3 specific events
  • PB_SEQ IN (x,y,z,...) where x, y, z are valid PB_SEQ (performance) numbers - find these 3 specific performances.
  • VE_SEQ=a where a is a valid VE_SEQ (venue) number - find all performances in venue 'a'
  • VE_SEQ IN (a,b,c) where a, b and c are valid VE_SEQ (venue) numbers - find all performances in venues 'a', 'b', and 'c'
  • TM_SEQ IN (a,b,c) where a, b and c are valid TM_SEQ (pricing map) numbers - find all performances using pricing maps 'a', 'b', and 'c'
  • P_SEQ IN(x,y) or TM_SEQ=a this will give you the 2 events 'x' and 'y', along with ANY performance in venue 'a'
  • PB_PERFORM_DATE between date '2017-09-15' and date '2017-10-31' This will give you all performances between Sep 15 2017 and Oct 31 2017
  • PB_PERFORM_DATE=current_date will be a list of today's events
  • PB_PERFORM_DATE<=now()+%2B+interval+'7+days' is a list of everything in the next 7 days. The %2B is an encoded 'plus' sign since plus has special meaning of a space
  • PB_PERF_FLAG in ('A','C') This will give you all performances having either of those two letters in the Theatre Manager performance flag field
  • P_GENRE_FC_SEQ not in (100,101,102) can be used to pick all events that do not have a specific genre that is in the code tables.

An Example link directing patrons to TWO (2) specific events would appear like:

Refer to comments within htdocs/1/WebPages/TMTickets.html for more examples on searching for performances within the Ticketing Page.

To find the Event Sequence #:

  • Click Setup >> Events.

    The Event List window will open.

  • Click the button to populate the Event List.
  • The Event # will be listed in the far left column

    This is the unique sequence number for the event and can be used when creating a P_SEQ link.

To find the Performance Sequence #:

  • Click Setup >> Events.
  • Click the button to populate the Event List.
  • Double-click an Event to open it.
  • Select the Performance tab.
  • The far left column, labeled Perf #, shows the unique performance number for each performance of the Event.

    This number can be used with creating a link that references PB_SEQ.

To find the Venue Sequence #:

  • Click Setup >> Venue Maps.
  • The far left column, labeled Venue #, is the Venue Sequence #.

    The Venue # can be used to create a link with a TM_SEQ reference.

Direct Link Using Performance Flag

https://tickets.yourvenue.org/TheatreManager/1/login?event=0&search=PB_PERF_FLAG='A'

The link above allow a reference to the Performance Flag within the Performance and will only display the Performances with the matching results within the field. The reference within the Performance Flag field will replace the "xx" in the link. To locate or alter the Performance Flag follow the steps below:

  • Click Setup >> Events.
  • Click the button to populate the Event List.
  • Double-click an Event to open it.
  • In the Event Setup Window, select the Performance tab.
  • Double click on the Performance to be included by the link.
  • Select the Web Settings tab.
  • Locate the Performance Flag field.

    This field will contain the value to replace the XX from the link above. If a value is not present one can be added. Multiple values can be referenced at one time by separating multiple 'XX' references with commas and defining the XX with each unique reference.

Direct Link Using Performance Type

https://tickets.yourvenue.org/TheatreManager/1/login?event=0&search=PB_TYPE1_FC_SEQ=27785

 

The above link uses the Sequence number associated with the Performance Type to create a direct link to select Performances. By using this link a defined list of performances can be grouped together and displayed for purchased. To locate the Sequence number references in the link follow the steps below:

  • Click Setup >> System Tables >> Code Tables.
  • Select the Perf Type option in the left column.
  • Locate the Seq # column.

    This column will contain the value to replace the XX in the link above. Multiple values can be referenced at one time by separating multiple XX references with commas and defining the XX with each unique sequence number.

 

To locate or alter the Performance Type for a select Performance follow the steps below:

  • Click Setup >> Events.
  • Click the button to populate the Event List.
  • Double-click an Event to open it.
  • In the Event Setup Window, select the Performance tab.
  • Double click on the Performance to be included by the link.
  • Locate the Perf Type field.

    This field will contain the value referenced by the Performance. The value can be changed using the drop down. The link above will reference all performances where the value within this field matches the sequence number from the link.

 

Direct Link to a Donation

https://tickets.yourvenue.org/TheatreManager/1/login?donation=xx&DD_AMOUNT_PLEDGE=100.00& frequency=0

 

This link will take the patron to the donation page in the online sales.

  • donation=xx represents the Campaign # from within Theatre Manager. This link will ensure that indicated Campaign appears as the default in the drop down. Any additional Campaigns available via the internet will also appear in the drop down. This is a unique sequence number assigned to the Campaign by Theatre Manager. To find the Campaign #:
  • DD_AMOUNT_PLEDGE=100.00 is optional and allows you to set a default amount for the donation if you send people here from an external web site.
  • frequency=1 is optional and suggests the frequency for recurring donations. Values of frequency are:
    • 0 - one time gift (the default)
    • 1 - monthly recurring gift
    • 2 - A Gift Every 2 Weeks
    • 3 - A Gift Every 3 Months (each Quarter)
    • 4 - Annual Gift
    • 5 - Daily Gift
    • 6 - Weekly Gift
    • 7 - A Gift Every 2nd Month
    The web page template file /tmTemplates/setDonationRecurringFrequencyList.html must have the frequencies enabled that you wish to use.
  1. Click Setup >> System Tables >> Donation Campaigns.
  2. Right-click on the column header in the Donation Campaigns List window.
  3. Select Preferences >> Change Columns.

  4. Single click the Seq # option only if it's not already highlighted or checked.
  5. Click the button in the Campaign List window.

    The Donation List window will populate with Donation Campaigns. Replace the "xx" in the link above with the appropriate donation sequence number to create a direct link to the donation.

    For more information on the Donation List widow click here.

Direct Link to a Pass

https://tickets.yourvenue.org/TheatreManager/1/login?pass=0

 

The above link will direct a patron to the pass/Gift Certificate/merchandise page. The patron can then use the drop down options to choose the type of Pass, Gift Certificate or Membership they wish to purchase.

Direct Link to a Package

https://tickets.yourvenue.org/TheatreManager/1/login?package=xx

 

The link above will take the patron directly to the package purchase window in the online sales. The "xx" represents the Package # from within Theatre Manager. This is a unique sequence number assigned to the package by Theatre Manager. To find the Package # for the Package:

  1. Click Setup >> System Tables >> Packages.

    The Package List window will open.

    For more information on the Package List window, click here.

  2. Click the button to populate the list.

    The Package # column will be the first column in the list. Replace the "xx" in the link above with the appropriate package number to create a link to the package.

Direct Link to Mail Lists

https://tickets.yourvenue.org/TheatreManager/1/login&maillistquickadd=xx

 

This link will allow a patron to subscribe to the mail lists indicated by simply adding their first name, last name and email address. This will create a limited profile for the patron in the Theatre Manager database.

To edit the mail list options available the tmMailListQuickAddInsert.html page needs to be altered. This page needs to be updated with the mail list sequence number and the desired name to be displayed for the mail list. The Mail List Sequence number can be found in Theatre Manager by:

  1. Click Setup >> Mail Lists.
  2. Search for the desired Mail List in the Mail Lists window.
  3. Take note of the number in the List # column.

    This is the Mail List number. It can be used in the tmMailListQuickAddInsert.html page as the input value for the mail lists a patron can subscribe to.

 

https://tickets.yourvenue.org/TheatreManager/1/login?maillist

 

This will take the patron directly to the Mail List page within the online sales. Patrons can choose to subscribe and unsubscribe to Mail Lists after they have logged into the online sales.

Accessing Web Page Images

https://tickets.artsman.com/TheatreManager/1/image?event=60

 

You can access the images on the web site for events or venues. They are done in a heirarchy, so that if you ask for the event image and it is not available, you'll get the venue image. If that is not available, you'll get the outlet image.