Packages Test
TXN/Packages/Search
Search for packages
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/Packages/Search

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : PackageSearchRequest

Request object type PackageSearchRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
ArtistIds string N A comma seperated list of artist Ids. Only packages with at least one performance with a credit for the passed artists will be returned.
FK: T_ARTIST.art_no   Resource: Artists
BusinessUnitId integer N Only packages assigned to this business unit (which is based on season) will be included in the result set.
FK: TR_BU.id   Resource: BusinessUnits
ConstituentId integer N If passed, is used to calculate a 'weight' for each production season, based on production keywords and constituent interests.
FK: T_CUSTOMER.customer_no   Resource: Constituents
FullTextSearch string Full Text search criteria, using the FreetextTable syntax.
MatchAllPerformances boolean N If True, packages are returned if all their performances match the Perf Start date, Perf End date, Perf Keyword, FullText and Artist filters. If False, packages are returned if any of their performances match these criteria.
ModeOfSaleId integer N Only packages with this mode of sale will be included in the result set.
FK: TR_MOS.id   Resource: ModesOfSale
PackageEndDate date Searches for packages on or before the passed date.
PackageFacilityIds string N A comma seperated list of facility IDs. Only fixed seat packages in the passed facilities will be returned.
FK: T_FACILITY.facil_no   Resource: Facilities
PackageKeywordAndOr string N Send 'And' to require packages to have all the keywords specified. Send 'Or' to require the packagesto have only one of the keywords.
PackageKeywordIds string N A comma seperated list of keyword Ids. Only packages with a passed keyword will be returned. The PackageKeywordAndOr parameter controls if all keywords or only one must be present.
FK: TR_TKW.id   Resource: ProductKeywords
PackageStartDate date Searches for packages on or after the passed date.
PackageTypeIds string N Only packages fo the specified type will be returned.
FK: TR_PACKAGE_TYPE.id   Resource: PackageTypes
PerformanceEndDate date Searches for packages with performances on or before the passed date.
PerformanceFacilityIds string N A comma seperated list of facility IDs. Only packages with at least one performance in the passed facilities will be returned.
FK: T_FACILITY.facil_no   Resource: Facilities
PerformanceKeywordAndOr string N Send 'And' to require performances to have all the keywords specified. Send 'Or' to require the performances to have only one of the keywords.
PerformanceKeywordIds string N A comma seperated list of keyword Ids. Only packages with at least one performance with a passed keyword will be returned. The PerformanceKeywordAndOr parameter controls if all keywords or only one must be present.
FK: TR_TKW.id   Resource: ProductKeywords
PerformanceStartDate date Searches for packages with performances on or after the passed date.
SeasonIds string N A comma-delimited list of season IDs. Only production seasons in one of the passed seasons will be returned.
FK: TR_SEASON.id   Resource: Seasons 
{
  "ArtistIds": "sample string 1",
  "BusinessUnitId": 1,
  "ConstituentId": 1,
  "PackageFacilityIds": "sample string 2",
  "PerformanceFacilityIds": "sample string 3",
  "FullTextSearch": "sample string 4",
  "PerformanceKeywordAndOr": "sample string 5",
  "PerformanceKeywordIds": "sample string 6",
  "PackageKeywordAndOr": "sample string 7",
  "PackageKeywordIds": "sample string 8",
  "MatchAllPerformances": true,
  "ModeOfSaleId": 1,
  "PackageEndDate": "2025-04-24T05:03:21.3109811-07:00",
  "PackageStartDate": "2025-04-24T05:03:21.3109811-07:00",
  "PackageTypeIds": "sample string 9",
  "PerformanceEndDate": "2025-04-24T05:03:21.3109811-07:00",
  "PerformanceStartDate": "2025-04-24T05:03:21.3109811-07:00",
  "SeasonIds": "sample string 10"
}
<PackageSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ArtistIds>sample string 1</ArtistIds>
  <BusinessUnitId>1</BusinessUnitId>
  <ConstituentId>1</ConstituentId>
  <FullTextSearch>sample string 4</FullTextSearch>
  <MatchAllPerformances>true</MatchAllPerformances>
  <ModeOfSaleId>1</ModeOfSaleId>
  <PackageEndDate>2025-04-24T05:03:21.3109811-07:00</PackageEndDate>
  <PackageFacilityIds>sample string 2</PackageFacilityIds>
  <PackageKeywordAndOr>sample string 7</PackageKeywordAndOr>
  <PackageKeywordIds>sample string 8</PackageKeywordIds>
  <PackageStartDate>2025-04-24T05:03:21.3109811-07:00</PackageStartDate>
  <PackageTypeIds>sample string 9</PackageTypeIds>
  <PerformanceEndDate>2025-04-24T05:03:21.3109811-07:00</PerformanceEndDate>
  <PerformanceFacilityIds>sample string 3</PerformanceFacilityIds>
  <PerformanceKeywordAndOr>sample string 5</PerformanceKeywordAndOr>
  <PerformanceKeywordIds>sample string 6</PerformanceKeywordIds>
  <PerformanceStartDate>2025-04-24T05:03:21.3109811-07:00</PerformanceStartDate>
  <SeasonIds>sample string 10</SeasonIds>
</PackageSearchRequest>

Response object type : Collection of PackageSearchResponse

Response object type Collection of PackageSearchResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
ConstituentInterestWeight integer
Facility EntitySummary
FacilityDescription (DEPRECATED) string Obsolete: Will be removed in V16. Use Facility property instead
FirstPerformanceDateTime date
FixedSeatIndicator boolean
FlexIndicator boolean
LastPerformanceDateTime date
MaximumPerformances integer
MinimumPerformances integer
ModeOfSale EntitySummary
ModeOfSaleDescription (DEPRECATED) string Obsolete: Will be removed in V16. Use ModeOfSale property instead
ModeOfSaleEndDate date
ModeOfSaleStartDate date
PackageCode string
PackageDateTime date
PackageDescription string
PackageId integer
PackageType PackageTypeSummary
RankType EntitySummary
RankTypeDescription (DEPRECATED) string Obsolete: Will be removed in V16. Use RankType property instead
Season SeasonSummary
SuperPackageIndicator boolean
Text1 string
Text2 string
Text3 string
Text4 string
ZoneMap EntitySummary
ZoneMapDescription (DEPRECATED) string Obsolete: Will be removed in V16. Use ZoneMap property instead 
[
  {
    "PackageId": 1,
    "PackageCode": "sample string 2",
    "PackageDescription": "sample string 3",
    "PackageType": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "PackageDateTime": "2025-04-24T05:03:21.3266108-07:00",
    "Facility": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "FacilityDescription": "sample string 4",
    "FirstPerformanceDateTime": "2025-04-24T05:03:21.3266108-07:00",
    "LastPerformanceDateTime": "2025-04-24T05:03:21.3266108-07:00",
    "FixedSeatIndicator": true,
    "FlexIndicator": true,
    "MinimumPerformances": 7,
    "MaximumPerformances": 8,
    "RankType": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "RankTypeDescription": "sample string 9",
    "Season": {
      "Id": 1,
      "Description": "sample string 1",
      "FYear": 1,
      "Inactive": true
    },
    "SuperPackageIndicator": true,
    "Text1": "sample string 11",
    "Text2": "sample string 12",
    "Text3": "sample string 13",
    "Text4": "sample string 14",
    "ConstituentInterestWeight": 1,
    "ZoneMap": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "ZoneMapDescription": "sample string 15",
    "ModeOfSale": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "ModeOfSaleDescription": "sample string 16",
    "ModeOfSaleStartDate": "2025-04-24T05:03:21.3266108-07:00",
    "ModeOfSaleEndDate": "2025-04-24T05:03:21.3266108-07:00"
  },
  {
    "PackageId": 1,
    "PackageCode": "sample string 2",
    "PackageDescription": "sample string 3",
    "PackageType": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "PackageDateTime": "2025-04-24T05:03:21.3266108-07:00",
    "Facility": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "FacilityDescription": "sample string 4",
    "FirstPerformanceDateTime": "2025-04-24T05:03:21.3266108-07:00",
    "LastPerformanceDateTime": "2025-04-24T05:03:21.3266108-07:00",
    "FixedSeatIndicator": true,
    "FlexIndicator": true,
    "MinimumPerformances": 7,
    "MaximumPerformances": 8,
    "RankType": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "RankTypeDescription": "sample string 9",
    "Season": {
      "Id": 1,
      "Description": "sample string 1",
      "FYear": 1,
      "Inactive": true
    },
    "SuperPackageIndicator": true,
    "Text1": "sample string 11",
    "Text2": "sample string 12",
    "Text3": "sample string 13",
    "Text4": "sample string 14",
    "ConstituentInterestWeight": 1,
    "ZoneMap": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "ZoneMapDescription": "sample string 15",
    "ModeOfSale": {
      "Id": 1,
      "Description": "sample string 2"
    },
    "ModeOfSaleDescription": "sample string 16",
    "ModeOfSaleStartDate": "2025-04-24T05:03:21.3266108-07:00",
    "ModeOfSaleEndDate": "2025-04-24T05:03:21.3266108-07:00"
  }
]
<PackageSearchResponses xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PackageSearchResponse>
    <ConstituentInterestWeight>1</ConstituentInterestWeight>
    <Facility>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </Facility>
    <FacilityDescription>sample string 4</FacilityDescription>
    <FirstPerformanceDateTime>2025-04-24T05:03:21.3266108-07:00</FirstPerformanceDateTime>
    <FixedSeatIndicator>true</FixedSeatIndicator>
    <FlexIndicator>true</FlexIndicator>
    <LastPerformanceDateTime>2025-04-24T05:03:21.3266108-07:00</LastPerformanceDateTime>
    <MaximumPerformances>8</MaximumPerformances>
    <MinimumPerformances>7</MinimumPerformances>
    <ModeOfSale>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </ModeOfSale>
    <ModeOfSaleDescription>sample string 16</ModeOfSaleDescription>
    <ModeOfSaleEndDate>2025-04-24T05:03:21.3266108-07:00</ModeOfSaleEndDate>
    <ModeOfSaleStartDate>2025-04-24T05:03:21.3266108-07:00</ModeOfSaleStartDate>
    <PackageCode>sample string 2</PackageCode>
    <PackageDateTime>2025-04-24T05:03:21.3266108-07:00</PackageDateTime>
    <PackageDescription>sample string 3</PackageDescription>
    <PackageId>1</PackageId>
    <PackageType>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </PackageType>
    <RankType>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </RankType>
    <RankTypeDescription>sample string 9</RankTypeDescription>
    <Season>
      <Description>sample string 1</Description>
      <FYear>1</FYear>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Season>
    <SuperPackageIndicator>true</SuperPackageIndicator>
    <Text1>sample string 11</Text1>
    <Text2>sample string 12</Text2>
    <Text3>sample string 13</Text3>
    <Text4>sample string 14</Text4>
    <ZoneMap>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </ZoneMap>
    <ZoneMapDescription>sample string 15</ZoneMapDescription>
  </PackageSearchResponse>
  <PackageSearchResponse>
    <ConstituentInterestWeight>1</ConstituentInterestWeight>
    <Facility>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </Facility>
    <FacilityDescription>sample string 4</FacilityDescription>
    <FirstPerformanceDateTime>2025-04-24T05:03:21.3266108-07:00</FirstPerformanceDateTime>
    <FixedSeatIndicator>true</FixedSeatIndicator>
    <FlexIndicator>true</FlexIndicator>
    <LastPerformanceDateTime>2025-04-24T05:03:21.3266108-07:00</LastPerformanceDateTime>
    <MaximumPerformances>8</MaximumPerformances>
    <MinimumPerformances>7</MinimumPerformances>
    <ModeOfSale>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </ModeOfSale>
    <ModeOfSaleDescription>sample string 16</ModeOfSaleDescription>
    <ModeOfSaleEndDate>2025-04-24T05:03:21.3266108-07:00</ModeOfSaleEndDate>
    <ModeOfSaleStartDate>2025-04-24T05:03:21.3266108-07:00</ModeOfSaleStartDate>
    <PackageCode>sample string 2</PackageCode>
    <PackageDateTime>2025-04-24T05:03:21.3266108-07:00</PackageDateTime>
    <PackageDescription>sample string 3</PackageDescription>
    <PackageId>1</PackageId>
    <PackageType>
      <Description>sample string 1</Description>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </PackageType>
    <RankType>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </RankType>
    <RankTypeDescription>sample string 9</RankTypeDescription>
    <Season>
      <Description>sample string 1</Description>
      <FYear>1</FYear>
      <Id>1</Id>
      <Inactive>true</Inactive>
    </Season>
    <SuperPackageIndicator>true</SuperPackageIndicator>
    <Text1>sample string 11</Text1>
    <Text2>sample string 12</Text2>
    <Text3>sample string 13</Text3>
    <Text4>sample string 14</Text4>
    <ZoneMap>
      <Description>sample string 2</Description>
      <Id>1</Id>
    </ZoneMap>
    <ZoneMapDescription>sample string 15</ZoneMapDescription>
  </PackageSearchResponse>
</PackageSearchResponses>
Change Version Description Contract Old New
Property Deprecated 15.1.0 FacilityDescription has been marked as deprecated. PackageSearchResponse Deprecated
Property Deprecated 15.1.0 ModeOfSaleDescription has been marked as deprecated. PackageSearchResponse Deprecated
Property Deprecated 15.1.0 RankTypeDescription has been marked as deprecated. PackageSearchResponse Deprecated
Property Deprecated 15.1.0 ZoneMapDescription has been marked as deprecated. PackageSearchResponse Deprecated
Property Added 15.1.0 Facility has been added to PackageSearchResponse PackageSearchResponse PackageSearchResponse.Facility
Property Added 15.1.0 ModeOfSale has been added to PackageSearchResponse PackageSearchResponse PackageSearchResponse.ModeOfSale
Property Added 15.1.0 RankType has been added to PackageSearchResponse PackageSearchResponse PackageSearchResponse.RankType
Property Added 15.1.0 ZoneMap has been added to PackageSearchResponse PackageSearchResponse PackageSearchResponse.ZoneMap