Products Test
TXN/Products/Describe
Get product descriptions
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/Products/Describe

URI Parameters

This resource has no URI (Query) parameters.

Request Body

Request object type : ProductDescribeRequest

Request object type ProductDescribeRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
PackageIds string
PackageTypeIds string
PerformanceIds string
ProductionSeasonIds string 
{
  "ProductionSeasonIds": "sample string 1",
  "PerformanceIds": "sample string 2",
  "PackageTypeIds": "sample string 3",
  "PackageIds": "sample string 4"
}
<ProductDescribeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <PackageIds>sample string 4</PackageIds>
  <PackageTypeIds>sample string 3</PackageTypeIds>
  <PerformanceIds>sample string 2</PerformanceIds>
  <ProductionSeasonIds>sample string 1</ProductionSeasonIds>
</ProductDescribeRequest>

Response object type : Collection of ProductDescribeResponse

Response object type Collection of ProductDescribeResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
ProductCode string
ProductDate date
ProductDescription string
ProductId integer
ProductTypeId integer
SeasonDescription string
SeasonId integer 
[
  {
    "ProductTypeId": 1,
    "SeasonId": 2,
    "SeasonDescription": "sample string 3",
    "ProductId": 4,
    "ProductDescription": "sample string 5",
    "ProductDate": "2025-04-24T05:30:26.7176946-07:00",
    "ProductCode": "sample string 7"
  },
  {
    "ProductTypeId": 1,
    "SeasonId": 2,
    "SeasonDescription": "sample string 3",
    "ProductId": 4,
    "ProductDescription": "sample string 5",
    "ProductDate": "2025-04-24T05:30:26.7176946-07:00",
    "ProductCode": "sample string 7"
  }
]
<ProductDescribeResponses xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ProductDescribeResponse>
    <ProductCode>sample string 7</ProductCode>
    <ProductDate>2025-04-24T05:30:26.7176946-07:00</ProductDate>
    <ProductDescription>sample string 5</ProductDescription>
    <ProductId>4</ProductId>
    <ProductTypeId>1</ProductTypeId>
    <SeasonDescription>sample string 3</SeasonDescription>
    <SeasonId>2</SeasonId>
  </ProductDescribeResponse>
  <ProductDescribeResponse>
    <ProductCode>sample string 7</ProductCode>
    <ProductDate>2025-04-24T05:30:26.7176946-07:00</ProductDate>
    <ProductDescription>sample string 5</ProductDescription>
    <ProductId>4</ProductId>
    <ProductTypeId>1</ProductTypeId>
    <SeasonDescription>sample string 3</SeasonDescription>
    <SeasonId>2</SeasonId>
  </ProductDescribeResponse>
</ProductDescribeResponses>

No entries in change log for this operation.