All the request parameters are optional. If no parameters are specified, all the valid products would be returned.
| Property Name | Data Type | Length | Required | Readonly | Notes |
|---|---|---|---|---|---|
| ConstituentId | integer | N | |||
| FK: T_CUSTOMER.customer_no Resource: Constituents | |||||
| TitleId | integer | N | |||
| FK: T_TITLE.title_no Resource: Titles | |||||
| StartDateRange | date | ||||
| EndDateRange | date | ||||
| TimeSlotId | integer | N | |||
| FK: TR_TIME_SLOT.id Resource: TimeSlots | |||||
| ComposerId | integer | N | |||
| FK: TR_COMPOSER.id Resource: Composers | |||||
| LanguageId | integer | N | |||
| FK: TR_LANG.id Resource: Languages | |||||
| ArtistId | integer | N | |||
| FK: TR_LANG.id Resource: Languages | |||||
| KeywordId | integer | N | |||
| FK: TR_TKW.id | |||||
| FacilityId | integer | N | |||
| FK: T_FACILITY.facil_no Resource: Facilities | |||||
| OneOrAllPerformancesInPackage | string | Possible values are ONE, ALL, PKG. Do not send a value for performance search. PKG : Search based on package criteria. ONE : Search for packages with performance criteria and include packages where at least one of the performances in the package matches. ALL : Search for packages with performance criteria and include packages where all the performances in the package match. | |||
| DayOfWeek | string | One of SUN, MON, TUE, WED, THU, FRI, SAT. | |||
| SeasonIds | string | N | A list of valid season Ids. | ||
| FK: TR_SEASON.id Resource: Seasons | |||||
| SeasonId | integer | N | |||
| FK: TR_SEASON.id Resource: Seasons | |||||
| ModeOfSaleId | integer | N | |||
| FK: TR_MOS.id Resource: ModesOfSale | |||||
| OnSaleOnly | boolean | If a value of true is sent, only the products on sale would be returned. | |||
| ShowGrossAvailability | boolean | If a value of true is sent, Total product availability will be included in the response. | |||
| ShowConstituentAvailability | boolean | If a value of true is sent, Total product availability for the specified constituent (ConstituentId parameter) will be included in the response. | |||
| BusinessUnitId | integer | N | |||
| FK: TR_BU.id Resource: BusinessUnits | |||||
| ProductionSeasonIds | string | N | A list of valid product seasons ids. | ||
| FK: T_PROD_SEASON.prod_season_no Resource: ProductionSeasons | |||||
| ProductionSeasonId | integer | ||||
| PerformanceIds | string | N | A list of valid performances ids. | ||
| FK: T_PERF.perf_no Resource: Performances | |||||
| PackageSeasonId | integer | N | |||
| FK: TR_SEASON.id Resource: Seasons | |||||
| PackageIds | string | N | A list of valid package Ids. | ||
| FK: T_PACKAGE.pkg_no Resource: Packages | |||||
| PackageId | integer | N | |||
| FK: T_PKG.pkg_no Resource: Packages | |||||
| PackageTypeId | integer | N | |||
| FK: TR_PKG_TYPE.id Resource: PackageTypes | |||||
| StartDateRangePackage | date | ||||
| EndDateRangePackage | date | ||||
| Keywords | string | N | Comma separated list of keywords. If a keyword number is passed in KeywordId or a string of Keywords is passed in Keywords and PackageId related search fileds are specified, the package will be returned if the production elements for the performance contain the keyword OR if the package contains the keyword. | ||
| FK: TR_TKW.id | |||||
| KeywordAndOr | integer | 1 = OR and 2 = AND. | |||
| KeywordDescriptions | string | N | Comma separated list of keyword descriptions. | ||
| FK: TR_TKW.id | |||||
| ShowAll | boolean | Overrides the publish dates for Season Maintenance. | |||
| FullText | string | ||||
| FullTextType | string | The default is 'F' (FreeTextTable). You can pass a value of 'C' to search using ContainsTable. | |||
| IsWebSearch | boolean | Controls filtering by Web Publish dates on performances. When this flag is passed as True, performances where the current date is outside the web publish date range will not be returned or considered to be in packages. | |||