POST api/GetPerformances

Returns a list of Tessitura performances.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type
StartDate	Start boundary for search. If omitted, today's date will be used.	date
EndDate	End boundary for search. If omitted, today's date plus the config value of GetPerformancesDefaultEndDays will be used.	date
Keywords	Comma separated list of Tessitura Keyword Ids. If present any or all of the Keywords (based on AllKeywordsRequired) must be assigned to the performance.	string
AllKeywordsRequired	If true all of the Keywords must be assigned to a performance for a match. Pass false or null for default 'any' behavior.	boolean
VenueId	If provided the value must be assigned as the venue of a performance for a match. Pass null for all venues.	integer
ModeOfSale	If provided only performances in the specified Mode Of Sale will be returned. Pass null to use the DefaultModeOfSale config value.	integer
SeasonIds	Comma separated list of Season Ids. Only data for performances assigned a Season Id in this list will be returned.	string
SessionKey	Currently optional. If provided it must be an authenticated session for the call to return any data.	string

Request Formats

application/json, text/json

Sample:

{
  "StartDate": "2024-09-19T19:59:10.8628608+00:00",
  "EndDate": "2024-09-19T19:59:10.8628608+00:00",
  "Keywords": "sample string 1",
  "AllKeywordsRequired": true,
  "VenueId": 1,
  "ModeOfSale": 1,
  "SeasonIds": "sample string 2",
  "SessionKey": "sample string 3"
}

application/xml, text/xml

Sample:

<GetPerformancesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Performance">
  <AllKeywordsRequired>true</AllKeywordsRequired>
  <EndDate>2024-09-19T19:59:10.8628608+00:00</EndDate>
  <Keywords>sample string 1</Keywords>
  <ModeOfSale>1</ModeOfSale>
  <SeasonIds>sample string 2</SeasonIds>
  <SessionKey>sample string 3</SessionKey>
  <StartDate>2024-09-19T19:59:10.8628608+00:00</StartDate>
  <VenueId>1</VenueId>
</GetPerformancesRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GetPerformancesRequest'.

Response Information

Resource Description

GetPerformancesResult object

ApiSuccessOfGetPerformancesResult

Name	Description	Type	Additional information
Success		boolean
Data		GetPerformancesResult

Response Formats

application/json, text/json

Sample:

{
  "Success": true,
  "Data": {
    "Performances": [
      {
        "ID": 1,
        "Date": "2024-09-19T19:59:10.878457+00:00",
        "StartDate": "2024-09-19T19:59:10.878457+00:00",
        "EndDate": "2024-09-19T19:59:10.878457+00:00",
        "FirstDate": "2024-09-19T19:59:10.878457+00:00",
        "LastDate": "2024-09-19T19:59:10.878457+00:00",
        "GrossAvailability": 7,
        "FacilityDescription": "sample string 8",
        "Facility": 9,
        "Title": "sample string 10",
        "OnSale": true,
        "BusinessUnit": 12,
        "ProductionSeason": 13,
        "ProductionType": 14,
        "ProductionTypeDescription": "sample string 15",
        "Season": 16,
        "Status": 17,
        "StatusDescription": "sample string 18",
        "WebContentList": [
          {
            "ID": 1,
            "Value": "sample string 2"
          },
          {
            "ID": 1,
            "Value": "sample string 2"
          }
        ]
      },
      {
        "ID": 1,
        "Date": "2024-09-19T19:59:10.878457+00:00",
        "StartDate": "2024-09-19T19:59:10.878457+00:00",
        "EndDate": "2024-09-19T19:59:10.878457+00:00",
        "FirstDate": "2024-09-19T19:59:10.878457+00:00",
        "LastDate": "2024-09-19T19:59:10.878457+00:00",
        "GrossAvailability": 7,
        "FacilityDescription": "sample string 8",
        "Facility": 9,
        "Title": "sample string 10",
        "OnSale": true,
        "BusinessUnit": 12,
        "ProductionSeason": 13,
        "ProductionType": 14,
        "ProductionTypeDescription": "sample string 15",
        "Season": 16,
        "Status": 17,
        "StatusDescription": "sample string 18",
        "WebContentList": [
          {
            "ID": 1,
            "Value": "sample string 2"
          },
          {
            "ID": 1,
            "Value": "sample string 2"
          }
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<ApiSuccessOfGetPerformancesResultMuoEL63e xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Api">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities.Performance">
    <d2p1:Performances>
      <d2p1:Performance>
        <d2p1:BusinessUnit>12</d2p1:BusinessUnit>
        <d2p1:Date>2024-09-19T19:59:10.878457+00:00</d2p1:Date>
        <d2p1:EndDate>2024-09-19T19:59:10.878457+00:00</d2p1:EndDate>
        <d2p1:Facility>9</d2p1:Facility>
        <d2p1:FacilityDescription>sample string 8</d2p1:FacilityDescription>
        <d2p1:FirstDate>2024-09-19T19:59:10.878457+00:00</d2p1:FirstDate>
        <d2p1:GrossAvailability>7</d2p1:GrossAvailability>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:LastDate>2024-09-19T19:59:10.878457+00:00</d2p1:LastDate>
        <d2p1:OnSale>true</d2p1:OnSale>
        <d2p1:ProductionSeason>13</d2p1:ProductionSeason>
        <d2p1:ProductionType>14</d2p1:ProductionType>
        <d2p1:ProductionTypeDescription>sample string 15</d2p1:ProductionTypeDescription>
        <d2p1:Season>16</d2p1:Season>
        <d2p1:StartDate>2024-09-19T19:59:10.878457+00:00</d2p1:StartDate>
        <d2p1:Status>17</d2p1:Status>
        <d2p1:StatusDescription>sample string 18</d2p1:StatusDescription>
        <d2p1:Title>sample string 10</d2p1:Title>
        <d2p1:WebContentList xmlns:d5p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities">
          <d5p1:WebContent>
            <d5p1:ID>1</d5p1:ID>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:WebContent>
          <d5p1:WebContent>
            <d5p1:ID>1</d5p1:ID>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:WebContent>
        </d2p1:WebContentList>
      </d2p1:Performance>
      <d2p1:Performance>
        <d2p1:BusinessUnit>12</d2p1:BusinessUnit>
        <d2p1:Date>2024-09-19T19:59:10.878457+00:00</d2p1:Date>
        <d2p1:EndDate>2024-09-19T19:59:10.878457+00:00</d2p1:EndDate>
        <d2p1:Facility>9</d2p1:Facility>
        <d2p1:FacilityDescription>sample string 8</d2p1:FacilityDescription>
        <d2p1:FirstDate>2024-09-19T19:59:10.878457+00:00</d2p1:FirstDate>
        <d2p1:GrossAvailability>7</d2p1:GrossAvailability>
        <d2p1:ID>1</d2p1:ID>
        <d2p1:LastDate>2024-09-19T19:59:10.878457+00:00</d2p1:LastDate>
        <d2p1:OnSale>true</d2p1:OnSale>
        <d2p1:ProductionSeason>13</d2p1:ProductionSeason>
        <d2p1:ProductionType>14</d2p1:ProductionType>
        <d2p1:ProductionTypeDescription>sample string 15</d2p1:ProductionTypeDescription>
        <d2p1:Season>16</d2p1:Season>
        <d2p1:StartDate>2024-09-19T19:59:10.878457+00:00</d2p1:StartDate>
        <d2p1:Status>17</d2p1:Status>
        <d2p1:StatusDescription>sample string 18</d2p1:StatusDescription>
        <d2p1:Title>sample string 10</d2p1:Title>
        <d2p1:WebContentList xmlns:d5p1="http://schemas.datacontract.org/2004/07/SFMOMA.Data.Entities">
          <d5p1:WebContent>
            <d5p1:ID>1</d5p1:ID>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:WebContent>
          <d5p1:WebContent>
            <d5p1:ID>1</d5p1:ID>
            <d5p1:Value>sample string 2</d5p1:Value>
          </d5p1:WebContent>
        </d2p1:WebContentList>
      </d2p1:Performance>
    </d2p1:Performances>
  </Data>
</ApiSuccessOfGetPerformancesResultMuoEL63e>