ProductKeywords Test
TXN/ProductKeywords?productionElementIds={productionElementIds}&packageIds={packageIds}&keywordIds={keywordIds}&showAll={showAll}
Returns keywords for the requested production elements or packages.



For Production Elements: If the keyword is found, returns the keyword and the lowest level at which it was found in the production hierarchy (Title, Production, Production Season, Performance) for the requested element. Optionally, all matching keywords anywhere above the requested element in the production hierarchy can be returned with the ShowAll parameter.
Http Verb GET
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/TXN/ProductKeywords?productionElementIds={productionElementIds}&packageIds={packageIds}&keywordIds={keywordIds}&showAll={showAll}

URI Parameters

Parameter Name Data Type Required Notes
productionElementIds string N Must be a list of valid perf, prod season, prod or title Ids (must be supplied if packageIds is not supplied).
packageIds string N Must be a list of valid package ids (must be supplied if productionElementIds is not supplied).
keywordIds string N Must be a comma delimited string of valid keyword ids.
showAll boolean N Indicates if keywords from ‘parent’ requested element(s) is desired. This parameter is ignored for packages.

Request Body

None.
No request body.

Response object type : Collection of KeywordResult

Response object type Collection of KeywordResult has the following properties.
Property Name Data Type Length Required Readonly Notes
Keywords Collection of KeywordResultKeyword A collection of keyword details for each keyword returned. Details include ID, description, owner (the production element or package to which the keyword is associated), and keyword category.
RequestedOwner Owner The production element or package to which the keywords belong. 
[
  {
    "RequestedOwner": {
      "ElementId": 1,
      "Type": 0
    },
    "Keywords": [
      {
        "Id": 1,
        "Description": "sample string 2",
        "Owner": {
          "ElementId": 1,
          "Type": 0
        },
        "Category": {
          "Id": 1,
          "Description": "sample string 2"
        }
      },
      {
        "Id": 1,
        "Description": "sample string 2",
        "Owner": {
          "ElementId": 1,
          "Type": 0
        },
        "Category": {
          "Id": 1,
          "Description": "sample string 2"
        }
      }
    ]
  },
  {
    "RequestedOwner": {
      "ElementId": 1,
      "Type": 0
    },
    "Keywords": [
      {
        "Id": 1,
        "Description": "sample string 2",
        "Owner": {
          "ElementId": 1,
          "Type": 0
        },
        "Category": {
          "Id": 1,
          "Description": "sample string 2"
        }
      },
      {
        "Id": 1,
        "Description": "sample string 2",
        "Owner": {
          "ElementId": 1,
          "Type": 0
        },
        "Category": {
          "Id": 1,
          "Description": "sample string 2"
        }
      }
    ]
  }
]
<KeywordResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <KeywordResult>
    <Keywords>
      <KeywordResultKeyword>
        <Category>
          <Description>sample string 2</Description>
          <Id>1</Id>
        </Category>
        <Description>sample string 2</Description>
        <Id>1</Id>
        <Owner>
          <ElementId>1</ElementId>
          <Type>Performance</Type>
        </Owner>
      </KeywordResultKeyword>
      <KeywordResultKeyword>
        <Category>
          <Description>sample string 2</Description>
          <Id>1</Id>
        </Category>
        <Description>sample string 2</Description>
        <Id>1</Id>
        <Owner>
          <ElementId>1</ElementId>
          <Type>Performance</Type>
        </Owner>
      </KeywordResultKeyword>
    </Keywords>
    <RequestedOwner>
      <ElementId>1</ElementId>
      <Type>Performance</Type>
    </RequestedOwner>
  </KeywordResult>
  <KeywordResult>
    <Keywords>
      <KeywordResultKeyword>
        <Category>
          <Description>sample string 2</Description>
          <Id>1</Id>
        </Category>
        <Description>sample string 2</Description>
        <Id>1</Id>
        <Owner>
          <ElementId>1</ElementId>
          <Type>Performance</Type>
        </Owner>
      </KeywordResultKeyword>
      <KeywordResultKeyword>
        <Category>
          <Description>sample string 2</Description>
          <Id>1</Id>
        </Category>
        <Description>sample string 2</Description>
        <Id>1</Id>
        <Owner>
          <ElementId>1</ElementId>
          <Type>Performance</Type>
        </Owner>
      </KeywordResultKeyword>
    </Keywords>
    <RequestedOwner>
      <ElementId>1</ElementId>
      <Type>Performance</Type>
    </RequestedOwner>
  </KeywordResult>
</KeywordResults>

No entries in change log for this operation.