API Endpoints

This document outlines the backend API endpoints needed for SeatCurve to function, Each call outlined maps on a one to one basis with a Tessitura V14 REST API call.

For each call you will find:

Index

DELETE calls

GET calls

POST calls

DELETE calls

/Web/Cart/{sessionKey}/Packages/Fixed/{packageId}/{lineItemId}

HTTP Method: DELETE

Tessitura Rest Call: /Web/Cart/{sessionKey}/Packages/Fixed/{packageId}/{lineItemId}

URI Parameters
Parameter Name Notes
sessionKey
packageId Id of the package to remove.
lineItemId Lineitem ID for the package line to remove.
Response

No response body. Please check HTTP status code header for success (200 OK) or failure. If there are errors a collection of ErrorMessages will be returned.

Header Name Override
Cache-Control private

/Web/Cart/{sessionKey}/Tickets/{performanceId}/{lineItemId}

HTTP Method: DELETE

Tessitura Rest Call: /Web/Cart/{sessionKey}/Tickets/{performanceId}/{lineItemId}

URI Parameters
Parameter Name Notes
sessionKey
performanceId A performance Id from the cart
lineItemId The lineitem of the performance to release.
Response

No response body. Please check HTTP status code header for success (200 OK) or failure. If there are errors a collection of ErrorMessages will be returned.

Header Name Override
Cache-Control private

GET calls

/ReferenceData/SeatStatuses

HTTP Method: GET

Tessitura Rest Call: /ReferenceData/SeatStatuses

URI Parameters
Parameter Name Notes
maintenanceMode True/False
Response

The response object is a collection of SeatStatus objects with the following properties.

Property Name Data Type
BackColor integer
CreatedBy string
CreatedDateTime date
CreateLocation string
Description string
ForeColor integer
Id integer
Inactive boolean
StatusCode string
StatusLegend string
StatusPriority byte
Tck string
UpdatedBy string
UpdatedDateTime date

Sample Response

[
  {
    "BackColor": 1,
    "CreatedDateTime": "2018-04-30T15:36:30.1938837Z",
    "CreateLocation": "sample string 2",
    "CreatedBy": "sample string 3",
    "Description": "sample string 4",
    "ForeColor": 5,
    "Id": 1,
    "Inactive": true,
    "UpdatedDateTime": "2018-04-30T15:36:30.1938837Z",
    "UpdatedBy": "sample string 7",
    "StatusCode": "sample string 8",
    "StatusLegend": "sample string 9",
    "StatusPriority": 64,
    "Tck": "sample string 11"
  },
  {
    "BackColor": 1,
    "CreatedDateTime": "2018-04-30T15:36:30.1938837Z",
    "CreateLocation": "sample string 2",
    "CreatedBy": "sample string 3",
    "Description": "sample string 4",
    "ForeColor": 5,
    "Id": 1,
    "Inactive": true,
    "UpdatedDateTime": "2018-04-30T15:36:30.1938837Z",
    "UpdatedBy": "sample string 7",
    "StatusCode": "sample string 8",
    "StatusLegend": "sample string 9",
    "StatusPriority": 64,
    "Tck": "sample string 11"
  }
]
Header Name Override
Cache-Control max-age=4200, stale-while-revalidate=604800, stale-if-error=1209600

/ReferenceData/Sections

HTTP Method: GET

Tessitura Rest Call: /ReferenceData/Sections

URI Parameters
Parameter Name Notes
seatMapId If seatMapId is supplied, only sections located within the specified seat map will be returned.
maintenanceMode True/False
Response

The response object is a collection of Section objects with the following properties.

Property Name Data Type
AdditionalText string
AdditionalText2 string
CreatedBy string
CreatedDateTime date
CreateLocation string
Description string
Id integer
PrintDesc string
PrintSequence byte
SectionLegend string
ShortDesc string
UpdatedBy string
UpdatedDateTime date

Sample Response

[
  {
    "AdditionalText": "sample string 1",
    "AdditionalText2": "sample string 2",
    "CreatedDateTime": "2018-04-30T15:25:51.1634326Z",
    "CreateLocation": "sample string 3",
    "CreatedBy": "sample string 4",
    "Description": "sample string 5",
    "Id": 1,
    "UpdatedDateTime": "2018-04-30T15:25:51.1634326Z",
    "UpdatedBy": "sample string 6",
    "PrintDesc": "sample string 7",
    "PrintSequence": 64,
    "SectionLegend": "sample string 9",
    "ShortDesc": "sample string 10"
  },
  {
    "AdditionalText": "sample string 1",
    "AdditionalText2": "sample string 2",
    "CreatedDateTime": "2018-04-30T15:25:51.1634326Z",
    "CreateLocation": "sample string 3",
    "CreatedBy": "sample string 4",
    "Description": "sample string 5",
    "Id": 1,
    "UpdatedDateTime": "2018-04-30T15:25:51.1634326Z",
    "UpdatedBy": "sample string 6",
    "PrintDesc": "sample string 7",
    "PrintSequence": 64,
    "SectionLegend": "sample string 9",
    "ShortDesc": "sample string 10"
  }
]
Header Name Override
Cache-Control max-age=4200, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Facilities/{facilityId}/Screens

HTTP Method: GET

Tessitura Rest Call: /TXN/Facilities/{facilityId}/Screens

URI Parameters
Parameter Name Notes
facilityId string
Response

The response object is a collection of ScreenMap objects with the following properties.

Property Name Data Type
Description string
Id integer
Screens object

Sample Response

{
  "Id": 1,
  "Description": "sample string 2",
  "Screens": [
    {
      "Id": 1,
      "Description": "sample string 2",
      "RowCount": 3,
      "ColumnCount": 4,
      "ScreenUp": 5,
      "ScreenDown": 6,
      "ScreenLeft": 7,
      "ScreenRight": 8,
      "HouseMapRectangles": [
        {
          "XCoordinate": 1,
          "YCoordinate": 2,
          "Height": 3,
          "Width": 4,
          "BrushColor": 5,
          "PenColor": 6,
          "TextColor": 7,
          "TextXCoordinate": 8,
          "TextYCoordinate": 9,
          "TextText": "sample string 10"
        },
        {
          "XCoordinate": 1,
          "YCoordinate": 2,
          "Height": 3,
          "Width": 4,
          "BrushColor": 5,
          "PenColor": 6,
          "TextColor": 7,
          "TextXCoordinate": 8,
          "TextYCoordinate": 9,
          "TextText": "sample string 10"
        }
      ]
    },
    {
      "Id": 1,
      "Description": "sample string 2",
      "RowCount": 3,
      "ColumnCount": 4,
      "ScreenUp": 5,
      "ScreenDown": 6,
      "ScreenLeft": 7,
      "ScreenRight": 8,
      "HouseMapRectangles": [
        {
          "XCoordinate": 1,
          "YCoordinate": 2,
          "Height": 3,
          "Width": 4,
          "BrushColor": 5,
          "PenColor": 6,
          "TextColor": 7,
          "TextXCoordinate": 8,
          "TextYCoordinate": 9,
          "TextText": "sample string 10"
        },
        {
          "XCoordinate": 1,
          "YCoordinate": 2,
          "Height": 3,
          "Width": 4,
          "BrushColor": 5,
          "PenColor": 6,
          "TextColor": 7,
          "TextXCoordinate": 8,
          "TextYCoordinate": 9,
          "TextText": "sample string 10"
        }
      ]
    }
  ]
}
Header Name Override
Cache-Control max-age=4200, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Packages/{packageId}

HTTP Method: GET

Tessitura Rest Call: /TXN/Packages/{packageId}

URI Parameters
Parameter Name Notes
packageId String
Response

The response object is a collection of Package objects with the following properties.

Property Name Data Type
BestSeatMap object
Campaign object
Code string
ControlGroup object
CreatedBy string
CreatedDateTime date
CreateLocation string
Description string
EditIndicator boolean
Facility object
FixedSeatIndicator boolean
FlexIndicator boolean
Id integer
MaximumPerformances integer
MinimumPerformances integer
PackageDateTime string
RankType date
Season object
SubPackageIndicator boolean
SubPackageOrderId integer
SuperPackageId integer
SuperPackageIndicator boolean
Text1 string
Text2 string
Text3 string
Text4 string
TicketDesign object
Type object
UpdatedBy string
UpdatedDateTime date
ZoneMap object

Sample Response

{
  "BestSeatMap": {
    "Id": 1,
    "Description": "sample string 1"
  },
  "Description": "sample string 1",
  "TicketDesign": {
    "Id": 1,
    "Description": "sample string 1"
  },
  "Facility": {
    "Description": "sample string 1",
    "Id": 1,
    "SeatMap": {
      "Description": "sample string 1",
      "Id": 1
    }
  },
  "FixedSeatIndicator": true,
  "FlexIndicator": true,
  "MaximumPerformances": 1,
  "MinimumPerformances": 1,
  "Code": "sample string 4",
  "Id": 1,
  "PackageDateTime": "2018-04-30T15:43:57.0321091Z",
  "Type": {
    "Id": 1,
    "Description": "sample string 1",
    "Inactive": true
  },
  "RankType": {
    "Id": 1,
    "Description": "sample string 1",
    "Inactive": true,
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "SubPackageIndicator": true,
  "SubPackageOrderId": 1,
  "SuperPackageIndicator": true,
  "SuperPackageId": 7,
  "Text1": "sample string 8",
  "Text2": "sample string 9",
  "Text3": "sample string 10",
  "Text4": "sample string 11",
  "ZoneMap": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "SeatMap": {
      "Description": "sample string 1",
      "Id": 1
    }
  },
  "CreatedDateTime": "2018-04-30T15:43:57.0321091Z",
  "CreateLocation": "sample string 12",
  "CreatedBy": "sample string 13",
  "UpdatedDateTime": "2018-04-30T15:43:57.0321091Z",
  "UpdatedBy": "sample string 14",
  "Campaign": {
    "Id": 1,
    "Description": "sample string 1",
    "FYear": 1,
    "Inactive": true,
    "MembershipOrganization": {
      "Description": "sample string 1",
      "Id": 1,
      "EditIndicator": true
    }
  },
  "ControlGroup": {
    "Description": "sample string 1",
    "Id": 2,
    "Inactive": true
  },
  "Season": {
    "Id": 1,
    "Description": "sample string 1",
    "FYear": 1,
    "Inactive": true
  },
  "EditIndicator": true
}
Header Name Override
Cache-Control max-age=700, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Packages/{packageId}/Prices

HTTP Method: GET

Tessitura Rest Call: /TXN/Packages/{packageId}/Prices

URI Parameters
Parameter Name Notes
packageId String
asOfDateTime pass to get prices effective as of the date and time.
modeOfSaleId String
priceTypeId String
expandPerformancePriceType When set to True, price details for each price layer on the performance are broken out.
includeOnlyBasePrice When set to True, only the price type marked as the base price for the performance is returned.
performanceIds A list of performance IDs for performances in a package to return pricing for.
sourceId When a source code is passed, prices associated with offers tied to that source will be noted in the response with Offer=true.
Response

The response object is a collection of PriceSummary objects with the following properties.

Property Name Data Type
Enabled boolean
IsBase boolean
IsBest boolean
MinPrice decimal
ModeOfSaleOfferId integer
Offer boolean
PackageId integer
ParentPackageId integer
PerformanceId integer
PerformancePriceTypeId integer
Price decimal
PriceTypeId integer
ZoneId integer

Sample Response

[
  {
    "PerformanceId": 1,
    "PackageId": 2,
    "ZoneId": 3,
    "PriceTypeId": 4,
    "Price": 5.0,
    "Enabled": true,
    "IsBase": true,
    "ParentPackageId": 8,
    "PerformancePriceTypeId": 9,
    "MinPrice": 10.0,
    "IsBest": true,
    "Offer": true,
    "ModeOfSaleOfferId": 13
  },
  {
    "PerformanceId": 1,
    "PackageId": 2,
    "ZoneId": 3,
    "PriceTypeId": 4,
    "Price": 5.0,
    "Enabled": true,
    "IsBase": true,
    "ParentPackageId": 8,
    "PerformancePriceTypeId": 9,
    "MinPrice": 10.0,
    "IsBest": true,
    "Offer": true,
    "ModeOfSaleOfferId": 13
  }
]
Header Name Override
Cache-Control max-age=300, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Packages/{packageId}/Seats

HTTP Method: GET

Tessitura Rest Call: /TXN/Packages/{packageId}/Seats

URI Parameters
Parameter Name Notes
packageId ID of the fixed seat package.
modeOfSaleId Required parameter. Must be a valid MOS id.
constituentId Required parameter. Must be a valid constituent ID.
zoneIds zoneIds must be a comma seperated list of valid zone ids.
sectionIds sectionIds must be a comma seperated list of valid section ids.
screenIds screenIds must be a comma seperated list of valid screen ids for the specified performance.
checkPriceTypeIds checkPriceTypeIds must be either a list of valid price types or the token “All”.
returnNonSeats returnNonSeats indicates if locations on the seat map that are not seats should be included.
Response

The response object is a collection of Seat objects with the following properties.

Property Name Data Type
AisleIndicator string
AllocationId integer
DisplayLetter string
HasStairs boolean
HoldCodeId integer
Id integer
IsSeat boolean
LogicalSeatNumber integer
LogicalSeatRow integer
ScreenId integer
SeatNumber string
SeatRow string
SeatStatusId integer
SeatTypeId integer
SectionId integer
XPosition integer
YPosition integer
ZoneId integer

Sample Response

[
  {
    "Id": 1,
    "SectionId": 2,
    "SeatRow": "sample string 3",
    "SeatNumber": "sample string 4",
    "ZoneId": 5,
    "AllocationId": 6,
    "SeatTypeId": 7,
    "LogicalSeatRow": 8,
    "LogicalSeatNumber": 9,
    "XPosition": 10,
    "YPosition": 11,
    "IsSeat": true,
    "SeatStatusId": 13,
    "AisleIndicator": "sample string 14",
    "HasStairs": true,
    "ScreenId": 16,
    "DisplayLetter": "sample string 17",
    "HoldCodeId": 18
  },
  {
    "Id": 1,
    "SectionId": 2,
    "SeatRow": "sample string 3",
    "SeatNumber": "sample string 4",
    "ZoneId": 5,
    "AllocationId": 6,
    "SeatTypeId": 7,
    "LogicalSeatRow": 8,
    "LogicalSeatNumber": 9,
    "XPosition": 10,
    "YPosition": 11,
    "IsSeat": true,
    "SeatStatusId": 13,
    "AisleIndicator": "sample string 14",
    "HasStairs": true,
    "ScreenId": 16,
    "DisplayLetter": "sample string 17",
    "HoldCodeId": 18
  }
]
Header Name Override
Cache-Control max-age=60, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Performances/{performanceId}

HTTP Method: GET

Tessitura Rest Call: /TXN/Performances/{performanceId}

URI Parameters
Parameter Name Notes
performanceId String
Response

The response object is a instance of Performance with the following properties.

Property Name Data Type
AvailSaleIndicator boolean
BestSeatMap object
BudgetAmount decimal
Code string
CreatedBy string
CreatedDateTime date
CreateLocation string
Date date
DefaultEndSaleDateTime date
DefaultStartSaleDateTime date
Description string
DoorsClose date
DoorsOpen date
Duration integer
EditIndicator boolean
Facility integer
Id integer
ProductionSeason object
PublishClientEndDate date
PublishClientStartDate date
PublishWebApiEndDate date
PublishWebApiStartDate date
RankType object
SalesNotes string
SalesNotesRequired boolean
Season object
ShortName string
Status object
Text1 string
Text2 string
Text3 string
Text4 string
TimeSlot object
TvIndicator boolean
Type object
UpdatedBy string
UpdatedDateTime date
ZoneMap object

Sample Response

{
  "AvailSaleIndicator": true,
  "BestSeatMap": {
    "Id": 1,
    "Description": "sample string 1"
  },
  "BudgetAmount": 1.0,
  "DefaultEndSaleDateTime": "2018-04-30T16:18:17.4259476Z",
  "DefaultStartSaleDateTime": "2018-04-30T16:18:17.4259476Z",
  "DoorsClose": "2018-04-30T16:18:17.4259476Z",
  "DoorsOpen": "2018-04-30T16:18:17.4259476Z",
  "Duration": 1,
  "Facility": {
    "Description": "sample string 1",
    "Id": 1,
    "SeatMap": {
      "Description": "sample string 1",
      "Id": 1
    }
  },
  "Code": "sample string 1",
  "Date": "2018-04-30T16:18:17.4259476Z",
  "Id": 1,
  "Status": {
    "Id": 1,
    "Description": "sample string 1"
  },
  "Type": {
    "Id": 1,
    "Description": "sample string 1",
    "Inactive": true
  },
  "ProductionSeason": {
    "Production": {
      "Id": 1,
      "Description": "sample string 1"
    },
    "Id": 1,
    "Description": "sample string 1",
    "Season": {
      "Id": 1,
      "Description": "sample string 1",
      "FYear": 1,
      "Inactive": true
    }
  },
  "PublishClientEndDate": "2018-04-30T16:18:17.4259476Z",
  "PublishClientStartDate": "2018-04-30T16:18:17.4259476Z",
  "PublishWebApiEndDate": "2018-04-30T16:18:17.4259476Z",
  "PublishWebApiStartDate": "2018-04-30T16:18:17.4259476Z",
  "RankType": {
    "Id": 1,
    "Description": "sample string 1",
    "Inactive": true,
    "ControlGroup": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true
    }
  },
  "SalesNotes": "sample string 2",
  "SalesNotesRequired": true,
  "Season": {
    "Id": 1,
    "Description": "sample string 1",
    "FYear": 1,
    "Inactive": true
  },
  "TimeSlot": {
    "Id": 1,
    "Description": "sample string 1",
    "Inactive": true
  },
  "TvIndicator": true,
  "ZoneMap": {
    "Description": "sample string 1",
    "Id": 1,
    "Inactive": true,
    "SeatMap": {
      "Description": "sample string 1",
      "Id": 1
    }
  },
  "CreatedDateTime": "2018-04-30T16:18:17.4259476Z",
  "CreateLocation": "sample string 4",
  "CreatedBy": "sample string 5",
  "UpdatedDateTime": "2018-04-30T16:18:17.4259476Z",
  "UpdatedBy": "sample string 6",
  "EditIndicator": true,
  "Description": "sample string 7",
  "ShortName": "sample string 8",
  "Text1": "sample string 9",
  "Text2": "sample string 10",
  "Text3": "sample string 11",
  "Text4": "sample string 12"
}
Header Name Override
Cache-Control max-age=700, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Performances/{performanceId}/Seats

HTTP Method: GET

Tessitura Rest Call: /TXN/Performances/{performanceId}/Seats

URI Parameters
Parameter Name Notes
performanceId ID of the performance.
modeOfSaleId Required parameter. Must be a valid MOS id.
constituentId Required parameter. Must be a valid constituent ID.
zoneIds zoneIds must be a comma seperated list of valid zone ids.
sectionIds sectionIds must be a comma seperated list of valid section ids.
screenIds screenIds must be a comma seperated list of valid screen ids for the specified performance.
checkPriceTypeIds checkPriceTypeIds must be either a list of valid price types or the token “All”.
returnNonSeats returnNonSeats indicates if locations on the seat map that are not seats should be included.
Response

The response object is a collection of Seat objects with the following properties.

Property Name Data Type
AvailSaleIndicator string
AllocationId integer
DisplayLetter string
HasStairs boolean
HoldCodeId integer
Id date
IsSeat boolean
LogicalSeatNumber integer
LogicalSeatRow integer
ScreenId integer
SeatNumber string
SeatRow string
SeatStatusId integer
SeatTypeId integer
SectionId integer
XPosition integer
YPosition integer
ZoneId integer

Sample Response

[
  {
    "Id": 1,
    "SectionId": 2,
    "SeatRow": "sample string 3",
    "SeatNumber": "sample string 4",
    "ZoneId": 5,
    "AllocationId": 6,
    "SeatTypeId": 7,
    "LogicalSeatRow": 8,
    "LogicalSeatNumber": 9,
    "XPosition": 10,
    "YPosition": 11,
    "IsSeat": true,
    "SeatStatusId": 13,
    "AisleIndicator": "sample string 14",
    "HasStairs": true,
    "ScreenId": 16,
    "DisplayLetter": "sample string 17",
    "HoldCodeId": 18
  },
  {
    "Id": 1,
    "SectionId": 2,
    "SeatRow": "sample string 3",
    "SeatNumber": "sample string 4",
    "ZoneId": 5,
    "AllocationId": 6,
    "SeatTypeId": 7,
    "LogicalSeatRow": 8,
    "LogicalSeatNumber": 9,
    "XPosition": 10,
    "YPosition": 11,
    "IsSeat": true,
    "SeatStatusId": 13,
    "AisleIndicator": "sample string 14",
    "HasStairs": true,
    "ScreenId": 16,
    "DisplayLetter": "sample string 17",
    "HoldCodeId": 18
  }
]
Header Name Override
Cache-Control max-age=60, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Performances/Summary

HTTP Method: GET

Tessitura Rest Call: /TXN/Performances/Summary

URI Parameters
Parameter Name Notes
performanceIds One or more performance IDs.
seasonId A single season ID, optional.
productionSeasonId A single production season ID, optional.
Response

The response object is a collection of PerformanceSummary objects with the following properties.

Property Name Data Type
Code string
DefaultEndSaleDateTime date
DefaultStartSaleDateTime date
Description string
Duration integer
FacilityId integer
Id integer
PerformanceDateTime date
ProductionSeason object
Season object
TimeSlot object
ZoneMapId integer

Sample Response

[
  {
    "Id": 1,
    "Code": "sample string 1",
    "DefaultEndSaleDateTime": "2018-04-30T16:44:00.6767825Z",
    "DefaultStartSaleDateTime": "2018-04-30T16:44:00.6767825Z",
    "PerformanceDateTime": "2018-04-30T16:44:00.6767825Z",
    "ProductionSeason": {
      "Id": 1
    },
    "Duration": 1,
    "TimeSlot": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "ZoneMapId": 3,
    "FacilityId": 4,
    "Description": "sample string 5",
    "Season": {
      "Id": 1,
      "Description": "sample string 1",
      "FYear": 1,
      "Inactive": true
    }
  },
  {
    "Id": 1,
    "Code": "sample string 1",
    "DefaultEndSaleDateTime": "2018-04-30T16:44:00.6767825Z",
    "DefaultStartSaleDateTime": "2018-04-30T16:44:00.6767825Z",
    "PerformanceDateTime": "2018-04-30T16:44:00.6767825Z",
    "ProductionSeason": {
      "Id": 1
    },
    "Duration": 1,
    "TimeSlot": {
      "Id": 1,
      "Description": "sample string 1",
      "Inactive": true
    },
    "ZoneMapId": 3,
    "FacilityId": 4,
    "Description": "sample string 5",
    "Season": {
      "Id": 1,
      "Description": "sample string 1",
      "FYear": 1,
      "Inactive": true
    }
  }
]
Header Name Override
Cache-Control max-age=700, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Performances/Prices

HTTP Method: GET

Tessitura Rest Call: /TXN/Performances/Prices

URI Parameters
Parameter Name Notes
performanceIds comma separated list of performance Ids.
asOfDateTime pass to get prices effective as of the date and time.
modeOfSaleId String
priceTypeId String
expandPerformancePriceType When set to True, price details for each price layer on the performance are broken out.
includeOnlyBasePrice When set to True, only the price type marked as the base price for the performance is returned.
sourceId When a source code is passed, prices associated with offers tied to that source will be noted in the response with Offer=true.
Response

The response object is a collection of PriceSummary objects with the following properties.

Property Name Data Type
Enabled boolean
IsBase boolean
IsBest boolean
MinPrice number
ModeOfSaleOfferId integer
Offer boolean
PackageId integer
ParentPackageId integer
PerformanceId integer
PerformancePriceTypeId integer
Price number
PriceTypeId integer
ZoneId integer

Sample Response

[
  {
    "PerformanceId": 1,
    "PackageId": 2,
    "ZoneId": 3,
    "PriceTypeId": 4,
    "Price": 5.0,
    "Enabled": true,
    "IsBase": true,
    "ParentPackageId": 8,
    "PerformancePriceTypeId": 9,
    "MinPrice": 10.0,
    "IsBest": true,
    "Offer": true,
    "ModeOfSaleOfferId": 13
  },
  {
    "PerformanceId": 1,
    "PackageId": 2,
    "ZoneId": 3,
    "PriceTypeId": 4,
    "Price": 5.0,
    "Enabled": true,
    "IsBase": true,
    "ParentPackageId": 8,
    "PerformancePriceTypeId": 9,
    "MinPrice": 10.0,
    "IsBest": true,
    "Offer": true,
    "ModeOfSaleOfferId": 13
  }
]
Header Name Override
Cache-Control max-age=300, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/Performances/ZoneAvailabilities

HTTP Method: GET

Tessitura Rest Call: /TXN/Performances/ZoneAvailabilities

URI Parameters
Parameter Name Notes
performanceIds A list of valid performance Ids.
modeOfSaleId Required if constituentId is provided.
constituentId The constituent to use to calculate allocation availability based on the constituent rank and MOS. Required if modeOfSale is specified.
Response

The response object is a collection of PerformanceZoneAvailabilityWithConstituent objects with the following properties.

Property Name Data Type
AvailableCount integer
ConstituentAvailableCount integer
Id integer
PerformanceId integer
Zone object

Sample Response

[
  {
    "Id": 1,
    "Zone": {
      "Id": 1,
      "Description": "sample string 2",
      "ShortDescription": "sample string 3",
      "Rank": 4,
      "ZoneMapId": 5,
      "ZoneTime": "sample string 6",
      "Abbreviation": "sample string 7",
      "ZoneLegend": "sample string 8",
      "ZoneGroup": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true,
        "Rank": 2
      }
    },
    "PerformanceId": 2,
    "AvailableCount": 3,
    "ConstituentAvailableCount": 4
  },
  {
    "Id": 1,
    "Zone": {
      "Id": 1,
      "Description": "sample string 2",
      "ShortDescription": "sample string 3",
      "Rank": 4,
      "ZoneMapId": 5,
      "ZoneTime": "sample string 6",
      "Abbreviation": "sample string 7",
      "ZoneLegend": "sample string 8",
      "ZoneGroup": {
        "Id": 1,
        "Description": "sample string 1",
        "Inactive": true,
        "Rank": 2
      }
    },
    "PerformanceId": 2,
    "AvailableCount": 3,
    "ConstituentAvailableCount": 4
  }
]
Header Name Override
Cache-Control max-age=60, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/PriceTypes/Details

HTTP Method: GET

Tessitura Rest Call: /TXN/PriceTypes/Details

URI Parameters
Parameter Name Notes
performanceIds String
packageId String
modeOfSaleId String
sourceId String
orderDateTime String
Response

The response object is a collection of PriceTypeDetail objects with the following properties.

Property Name Data Type
DefaultIndicator boolean
Description String
IsBest boolean
MaxSeats integer
Offer boolean
PackageId integer
PerformanceId integer
PriceTypeId integer
Rank integer
ReasonIndicator boolean
ShortDescription string
SuperPackageId integer
Terms string
Zones Array

Sample Response

[
  {
    "PriceTypeId": 1,
    "PerformanceId": 2,
    "PackageId": 3,
    "SuperPackageId": 4,
    "Description": "sample string 5",
    "ReasonIndicator": true,
    "ShortDescription": "sample string 7",
    "DefaultIndicator": true,
    "IsBest": true,
    "Offer": true,
    "Rank": 11,
    "MaxSeats": 12,
    "Terms": "sample string 13",
    "Zones": [
      {
        "Id": 1,
        "Description": "sample string 2",
        "ShortDescription": "sample string 3",
        "Rank": 4,
        "ZoneMapId": 5,
        "ZoneTime": "sample string 6",
        "Abbreviation": "sample string 7",
        "ZoneLegend": "sample string 8",
        "ZoneGroup": {
          "Id": 1,
          "Description": "sample string 1",
          "Inactive": true,
          "Rank": 2
        }
      },
      {
        "Id": 1,
        "Description": "sample string 2",
        "ShortDescription": "sample string 3",
        "Rank": 4,
        "ZoneMapId": 5,
        "ZoneTime": "sample string 6",
        "Abbreviation": "sample string 7",
        "ZoneLegend": "sample string 8",
        "ZoneGroup": {
          "Id": 1,
          "Description": "sample string 1",
          "Inactive": true,
          "Rank": 2
        }
      }
    ]
  },
  {
    "PriceTypeId": 1,
    "PerformanceId": 2,
    "PackageId": 3,
    "SuperPackageId": 4,
    "Description": "sample string 5",
    "ReasonIndicator": true,
    "ShortDescription": "sample string 7",
    "DefaultIndicator": true,
    "IsBest": true,
    "Offer": true,
    "Rank": 11,
    "MaxSeats": 12,
    "Terms": "sample string 13",
    "Zones": [
      {
        "Id": 1,
        "Description": "sample string 2",
        "ShortDescription": "sample string 3",
        "Rank": 4,
        "ZoneMapId": 5,
        "ZoneTime": "sample string 6",
        "Abbreviation": "sample string 7",
        "ZoneLegend": "sample string 8",
        "ZoneGroup": {
          "Id": 1,
          "Description": "sample string 1",
          "Inactive": true,
          "Rank": 2
        }
      },
      {
        "Id": 1,
        "Description": "sample string 2",
        "ShortDescription": "sample string 3",
        "Rank": 4,
        "ZoneMapId": 5,
        "ZoneTime": "sample string 6",
        "Abbreviation": "sample string 7",
        "ZoneLegend": "sample string 8",
        "ZoneGroup": {
          "Id": 1,
          "Description": "sample string 1",
          "Inactive": true,
          "Rank": 2
        }
      }
    ]
  }
]
Header Name Override
Cache-Control max-age=700, stale-while-revalidate=604800, stale-if-error=1209600

/TXN/WebContents

HTTP Method: GET

Tessitura Rest Call: /TXN/WebContents

URI Parameters
Parameter Name Notes
productionElementIds A comma separated list of IDs of production elements. (must be supplied if packageIds is not supplied).
packageIds A comma separated list of package IDs (must be supplied if productionElementIds is not supplied).
contentTypeIds A comma separated list of content type IDs.
showAll Whether to return web content of the same content type from all levels of the production hierarchy.
Response

The response object is a collection of WebContentResult objects with the following properties.

Property Name Data Type
RequestedOwner object
WebContents object

Sample Response

[
  {
    "RequestedOwner": {
      "ElementId": 1,
      "Type": 0
    },
    "WebContents": [
      {
        "Owner": {
          "ElementId": 1,
          "Type": 0
        },
        "Type": {
          "Id": 1,
          "Description": "sample string 2"
        },
        "Value": "sample string 1"
      },
      {
        "Owner": {
          "ElementId": 1,
          "Type": 0
        },
        "Type": {
          "Id": 1,
          "Description": "sample string 2"
        },
        "Value": "sample string 1"
      }
    ]
  },
  {
    "RequestedOwner": {
      "ElementId": 1,
      "Type": 0
    },
    "WebContents": [
      {
        "Owner": {
          "ElementId": 1,
          "Type": 0
        },
        "Type": {
          "Id": 1,
          "Description": "sample string 2"
        },
        "Value": "sample string 1"
      },
      {
        "Owner": {
          "ElementId": 1,
          "Type": 0
        },
        "Type": {
          "Id": 1,
          "Description": "sample string 2"
        },
        "Value": "sample string 1"
      }
    ]
  }
]
Header Name Override
Cache-Control max-age=3200, stale-while-revalidate=604800, stale-if-error=1209600

/Web/Session/{sessionKey}

HTTP Method: GET

Tessitura Rest Call: /Web/Session/{sessionKey}

URI Parameters
Parameter Name Notes
sessionKey string
Response

The response object is a collection of Session objects with the following properties.

Property Name Data Type
BusinessFacing boolean
CartInfo object
IsLoggedIn boolean
LoginInfo object
ModeOfSaleId integer
OrderId integer
OriginalModeOfSaleId integer
SourceId integer

Sample Response

{
  "OrderId": 1,
  "IsLoggedIn": true,
  "ModeOfSaleId": 3,
  "OriginalModeOfSaleId": 4,
  "SourceId": 5,
  "LoginInfo": {
    "ConstituentId": 1,
    "OriginalConstituentId": 2,
    "UserId": "sample string 3",
    "Status": "sample string 4",
    "FailedAttempts": 5,
    "LockedDate": "2018-05-01T11:29:55.2308817Z",
    "ElectronicAddress": "sample string 6"
  },
  "CartInfo": {
    "PerformanceCount": 1,
    "PackageCount": 2,
    "ContributionCount": 3,
    "MembershipCount": 4,
    "UserDefinedFeeCount": 5,
    "GiftCertificateCount": 6,
    "PaymentCount": 7,
    "FirstSeatAddedDateTime": "2018-05-01T11:29:55.2308817Z"
  },
  "BusinessFacing": true
}
Header Name Override
Cache-Control private

/Web/Cart/{sessionKey}

HTTP Method: GET

Tessitura Rest Call: /Web/Cart/{sessionKey}

URI Parameters
Parameter Name Notes
sessionKey Unique user Identifier
messageTypes A comma delimited list of valid message type ids (/ReferenceData/PricingRuleMessageTypes).
savedCart Pass True if Checkout has already been called for the cart.
Response

The response object is a Cart object with the following properties.

Property Name Data Type
AmountPaidNow number
AmountPaidPreviously number
Appeal object
BalanceToCharge number
BatchId integer
BookingId integer
CartAmount number
CartFirstChoiceAmount number
CartPrimaryAmount number
CartWasPriced boolean
Constituent object
CustomDataItems object
DbStatus integer
DeliveryMethod object
FeesAmount number
FirstSeatAddedDateTime date
Id integer
Initiator object
Messages object
ModeOfSale object
OrderCategory object
OrderDateTime date
OrderFees object
PaymentPlans object
Payments object
Products object
SessionKey string
Solicitor string
Source object
SubTotal number

Sample Response

{
  "SessionKey": "sample string 1",
  "Id": 2,
  "BatchId": 1,
  "Solicitor": "sample string 3",
  "OrderCategory": {
    "Id": 1,
    "Description": "sample string 1",
    "Inactive": true
  },
  "DbStatus": 1,
  "OrderDateTime": "2018-05-01T11:34:28.8365312Z",
  "FirstSeatAddedDateTime": "2018-05-01T11:34:28.8365312Z",
  "CartPrimaryAmount": 1.0,
  "CartFirstChoiceAmount": 1.0,
  "CartAmount": 1.0,
  "AmountPaidPreviously": 1.0,
  "AmountPaidNow": 1.0,
  "BalanceToCharge": 1.0,
  "SubTotal": 1.0,
  "FeesAmount": 1.0,
  "BookingId": 1,
  "CustomDataItems": [
    {
      "Name": "sample string 1",
      "Index": 1,
      "KeywordId": 1,
      "IsDropdown": true,
      "Value": "sample string 2",
      "DataType": "sample string 3",
      "Description": "sample string 4",
      "EditIndicator": true
    }
  ],
  "CartWasPriced": true,
  "Constituent": {
    "Id": 1,
    "SortName": "sample string 1",
    "DisplayName": "sample string 2"
  },
  "Initiator": {
    "Id": 1,
    "SortName": "sample string 1",
    "DisplayName": "sample string 2"
  },
  "DeliveryMethod": {
    "Id": 1,
    "Description": "sample string 2"
  },
  "ModeOfSale": {
    "Id": 1,
    "Description": "sample string 2"
  },
  "Source": {
    "Id": 1,
    "Description": "sample string 2"
  },
  "Appeal": {
    "Id": 1,
    "Description": "sample string 2"
  },
  "PaymentPlans": [
    {
      "Id": 1,
      "AmountDue": 2.0,
      "AccountId": 3,
      "DateDue": "2018-05-01T11:34:28.8365312Z",
      "BillingType": {
        "Id": 1,
        "Description": "sample string 2"
      },
      "Card": {
        "PaymentMethodGroupId": 1,
        "Name": "sample string 1",
        "Number": "sample string 2",
        "ExpiryMonth": 3,
        "ExpiryYear": 4
      }
    }
  ],
  "OrderFees": [
    {
      "Id": 1,
      "LineItemId": 2,
      "SubLineItemId": 3,
      "FeeSummary": {
        "FeeId": 1,
        "Description": "sample string 2",
        "Category": {
          "Id": 1,
          "Description": "sample string 2"
        }
      },
      "Amount": 4.0,
      "OverrideIndicator": "sample string 5",
      "OverrideAmount": 6.0,
      "DbStatus": 7
    }
  ],
  "Payments": [
    {
      "Id": 1,
      "Amount": 2.0,
      "TenderedAmount": 3.0,
      "PaymentMethod": {
        "Id": 1,
        "Description": "sample string 2",
        "AccountType": {
          "Id": 1,
          "Description": "sample string 2"
        }
      },
      "LastFourCreditCardNumber": "sample string 4",
      "PayerName": "sample string 5",
      "CheckNumber": "sample string 6",
      "GiftCertificateNumber": "sample string 7",
      "Applied": true,
      "Notes": "sample string 9"
    }
  ],
  "Messages": [
    {
      "Id": 1,
      "Message": "sample string 2",
      "IsMessageOnlyRule": true,
      "NewRuleIndicator": "sample string 4",
      "MessageType": {
        "Id": 1,
        "Description": "sample string 2"
      },
      "PricingRule": {
        "Id": 1,
        "Description": "sample string 2",
        "RuleAction": 3
      }
    }
  ],
  "Products": [
    {
      "ProductClass": {
        "Id": 1,
        "Description": "sample string 2"
      },
      "Performance": {
        "Id": 1,
        "LineItem": {
          "AlternateLineItems": [
            {
              "Id": 1,
              "LineItemGroupId": 2,
              "PackageLineItemId": 3,
              "SuperPackageId": 4,
              "AlternateUpgrade": "sample string 5",
              "Primary": true,
              "DbStatus": 7,
              "Package": {
                "Id": 1,
                "Code": "sample string 2",
                "Description": "sample string 3",
                "Season": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "Type": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "FixedPackage": true,
                "NFSPackage": true,
                "SuperPackage": true,
                "SubPackage": true,
                "Date": "2018-05-01T11:34:28.8521558Z"
              },
              "Performance": {
                "Id": 1,
                "Code": "sample string 2",
                "Description": "sample string 3",
                "Facility": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "PerformanceDateTime": "2018-05-01T11:34:28.8521558Z",
                "Duration": 1,
                "ProductionSeason": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "Season": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "TimeSlot": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "Type": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "ZoneMap": {
                  "Id": 1,
                  "Description": "sample string 2",
                  "SeatMap": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "Inactive": true
                }
              },
              "SubLineItems": [
                {
                  "Id": 1,
                  "ApplyPricing": true,
                  "DbStatus": 3,
                  "PriceType": {
                    "Id": 1,
                    "Description": "sample string 2",
                    "ShortDescription": "sample string 3",
                    "Category": {
                      "Id": 1,
                      "Description": "sample string 2"
                    },
                    "PriceTypeReason": {
                      "Id": 1,
                      "Description": "sample string 2"
                    }
                  },
                  "OriginalPriceType": {
                    "Id": 1,
                    "Description": "sample string 2",
                    "ShortDescription": "sample string 3",
                    "Category": {
                      "Id": 1,
                      "Description": "sample string 2"
                    },
                    "PriceTypeReason": {
                      "Id": 1,
                      "Description": "sample string 2"
                    }
                  },
                  "StatusId": 4,
                  "SubLineItemDetails": [
                    {
                      "Id": 1,
                      "BenevolentIndicator": true,
                      "CampaignId": 3,
                      "DiscountType": {
                        "Id": 1,
                        "Description": "sample string 2"
                      },
                      "DueAmount": 4.0,
                      "PaidAmount": 5.0,
                      "OriginalPrice": 6.0,
                      "PerformancePriceTypeLayerId": 7
                    }
                  ],
                  "Zone": {
                    "Id": 1,
                    "Description": "sample string 2",
                    "ZoneGroupId": 3,
                    "ShortDescription": "sample string 4",
                    "Abbreviation": "sample string 5",
                    "Rank": 6,
                    "ZoneTime": "sample string 7"
                  },
                  "Seat": {
                    "Id": 1,
                    "Row": "sample string 2",
                    "Number": "sample string 3",
                    "Section": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "ShortDescription": "sample string 3",
                      "PrintDescription": "sample string 4"
                    }
                  },
                  "Recipient": {
                    "Id": 1,
                    "SortName": "sample string 1",
                    "DisplayName": "sample string 2"
                  },
                  "DueAmount": 5.0,
                  "PaidAmount": 6.0,
                  "SubLineItemFees": [
                    {
                      "Id": 1,
                      "LineItemId": 2,
                      "SubLineItemId": 3,
                      "FeeSummary": {
                        "FeeId": 1,
                        "Description": "sample string 2",
                        "Category": {
                          "Id": 1,
                          "Description": "sample string 2"
                        }
                      },
                      "Amount": 4.0,
                      "OverrideIndicator": "sample string 5",
                      "OverrideAmount": 6.0,
                      "DbStatus": 7
                    }
                  ],
                  "NewRuleIndicator": "sample string 7",
                  "RuleIndicator": "sample string 8",
                  "PricingRule": {
                    "Id": 1,
                    "Description": "sample string 2",
                    "RuleAction": 3
                  }
                }
              ],
              "SpecialRequest": {
                "StartPrice": 1.0,
                "EndPrice": 1.0,
                "WheelchairSeats": 1,
                "AisleSeat": "sample string 1",
                "ContiguousSeats": 1,
                "StartingRow": "sample string 2",
                "EndingRow": "sample string 3",
                "StartingSeat": "sample string 4",
                "EndingSeat": "sample string 5",
                "HoldCode": 1,
                "NoStairs": true,
                "LeaveSingleSeats": true,
                "Notes": "sample string 6",
                "Category": {
                  "Id": 1,
                  "Description": "sample string 2"
                }
              },
              "TotalDue": 8.0,
              "DueAmount": 9.0
            }
          ],
          "Id": 1,
          "LineItemGroupId": 2,
          "PackageLineItemId": 3,
          "SuperPackageId": 4,
          "AlternateUpgrade": "sample string 5",
          "Primary": true,
          "DbStatus": 7,
          "Source": {
            "Id": 1,
            "Description": "sample string 2"
          },
          "Package": {
            "Id": 1,
            "Code": "sample string 2",
            "Description": "sample string 3",
            "Season": {
              "Id": 1,
              "Description": "sample string 2"
            },
            "Type": {
              "Id": 1,
              "Description": "sample string 2"
            },
            "FixedPackage": true,
            "NFSPackage": true,
            "SuperPackage": true,
            "SubPackage": true,
            "Date": "2018-05-01T11:34:28.8521558Z"
          },
          "Performance": {
            "Id": 1,
            "Code": "sample string 2",
            "Description": "sample string 3",
            "Facility": {
              "Id": 1,
              "Description": "sample string 2"
            },
            "PerformanceDateTime": "2018-05-01T11:34:28.8521558Z",
            "Duration": 1,
            "ProductionSeason": {
              "Id": 1,
              "Description": "sample string 2"
            },
            "Season": {
              "Id": 1,
              "Description": "sample string 2"
            },
            "TimeSlot": {
              "Id": 1,
              "Description": "sample string 2"
            },
            "Type": {
              "Id": 1,
              "Description": "sample string 2"
            },
            "ZoneMap": {
              "Id": 1,
              "Description": "sample string 2",
              "SeatMap": {
                "Id": 1,
                "Description": "sample string 2"
              },
              "Inactive": true
            }
          },
          "SubLineItems": [
            {
              "Id": 1,
              "ApplyPricing": true,
              "DbStatus": 3,
              "PriceType": {
                "Id": 1,
                "Description": "sample string 2",
                "ShortDescription": "sample string 3",
                "Category": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "PriceTypeReason": {
                  "Id": 1,
                  "Description": "sample string 2"
                }
              },
              "OriginalPriceType": {
                "Id": 1,
                "Description": "sample string 2",
                "ShortDescription": "sample string 3",
                "Category": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "PriceTypeReason": {
                  "Id": 1,
                  "Description": "sample string 2"
                }
              },
              "StatusId": 4,
              "SubLineItemDetails": [
                {
                  "Id": 1,
                  "BenevolentIndicator": true,
                  "CampaignId": 3,
                  "DiscountType": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "DueAmount": 4.0,
                  "PaidAmount": 5.0,
                  "OriginalPrice": 6.0,
                  "PerformancePriceTypeLayerId": 7
                },
                {
                  "Id": 1,
                  "BenevolentIndicator": true,
                  "CampaignId": 3,
                  "DiscountType": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "DueAmount": 4.0,
                  "PaidAmount": 5.0,
                  "OriginalPrice": 6.0,
                  "PerformancePriceTypeLayerId": 7
                }
              ],
              "Zone": {
                "Id": 1,
                "Description": "sample string 2",
                "ZoneGroupId": 3,
                "ShortDescription": "sample string 4",
                "Abbreviation": "sample string 5",
                "Rank": 6,
                "ZoneTime": "sample string 7"
              },
              "Seat": {
                "Id": 1,
                "Row": "sample string 2",
                "Number": "sample string 3",
                "Section": {
                  "Id": 1,
                  "Description": "sample string 2",
                  "ShortDescription": "sample string 3",
                  "PrintDescription": "sample string 4"
                }
              },
              "Recipient": {
                "Id": 1,
                "SortName": "sample string 1",
                "DisplayName": "sample string 2"
              },
              "DueAmount": 5.0,
              "PaidAmount": 6.0,
              "SubLineItemFees": [
                {
                  "Id": 1,
                  "LineItemId": 2,
                  "SubLineItemId": 3,
                  "FeeSummary": {
                    "FeeId": 1,
                    "Description": "sample string 2",
                    "Category": {
                      "Id": 1,
                      "Description": "sample string 2"
                    }
                  },
                  "Amount": 4.0,
                  "OverrideIndicator": "sample string 5",
                  "OverrideAmount": 6.0,
                  "DbStatus": 7
                }
              ],
              "NewRuleIndicator": "sample string 7",
              "RuleIndicator": "sample string 8",
              "PricingRule": {
                "Id": 1,
                "Description": "sample string 2",
                "RuleAction": 3
              }
            }
          ],
          "SpecialRequest": {
            "StartPrice": 1.0,
            "EndPrice": 1.0,
            "WheelchairSeats": 1,
            "AisleSeat": "sample string 1",
            "ContiguousSeats": 1,
            "StartingRow": "sample string 2",
            "EndingRow": "sample string 3",
            "StartingSeat": "sample string 4",
            "EndingSeat": "sample string 5",
            "HoldCode": 1,
            "NoStairs": true,
            "LeaveSingleSeats": true,
            "Notes": "sample string 6",
            "Category": {
              "Id": 1,
              "Description": "sample string 2"
            }
          },
          "TotalDue": 8.0,
          "DueAmount": 9.0
        }
      },
      "Package": {
        "Id": 1,
        "LineItems": [
          {
            "AlternateLineItems": [
              {
                "Id": 1,
                "LineItemGroupId": 2,
                "PackageLineItemId": 3,
                "SuperPackageId": 4,
                "AlternateUpgrade": "sample string 5",
                "Primary": true,
                "DbStatus": 7,
                "Package": {
                  "Id": 1,
                  "Code": "sample string 2",
                  "Description": "sample string 3",
                  "Season": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "Type": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "FixedPackage": true,
                  "NFSPackage": true,
                  "SuperPackage": true,
                  "SubPackage": true,
                  "Date": "2018-05-01T11:34:28.8521558Z"
                },
                "Performance": {
                  "Id": 1,
                  "Code": "sample string 2",
                  "Description": "sample string 3",
                  "Facility": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "PerformanceDateTime": "2018-05-01T11:34:28.8521558Z",
                  "Duration": 1,
                  "ProductionSeason": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "Season": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "TimeSlot": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "Type": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "ZoneMap": {
                    "Id": 1,
                    "Description": "sample string 2",
                    "SeatMap": {
                      "Id": 1,
                      "Description": "sample string 2"
                    },
                    "Inactive": true
                  }
                },
                "SubLineItems": [
                  {
                    "Id": 1,
                    "ApplyPricing": true,
                    "DbStatus": 3,
                    "PriceType": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "ShortDescription": "sample string 3",
                      "Category": {
                        "Id": 1,
                        "Description": "sample string 2"
                      },
                      "PriceTypeReason": {
                        "Id": 1,
                        "Description": "sample string 2"
                      }
                    },
                    "OriginalPriceType": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "ShortDescription": "sample string 3",
                      "Category": {
                        "Id": 1,
                        "Description": "sample string 2"
                      },
                      "PriceTypeReason": {
                        "Id": 1,
                        "Description": "sample string 2"
                      }
                    },
                    "StatusId": 4,
                    "SubLineItemDetails": [
                      {
                        "Id": 1,
                        "BenevolentIndicator": true,
                        "CampaignId": 3,
                        "DiscountType": {
                          "Id": 1,
                          "Description": "sample string 2"
                        },
                        "DueAmount": 4.0,
                        "PaidAmount": 5.0,
                        "OriginalPrice": 6.0,
                        "PerformancePriceTypeLayerId": 7
                      }
                    ],
                    "Zone": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "ZoneGroupId": 3,
                      "ShortDescription": "sample string 4",
                      "Abbreviation": "sample string 5",
                      "Rank": 6,
                      "ZoneTime": "sample string 7"
                    },
                    "Seat": {
                      "Id": 1,
                      "Row": "sample string 2",
                      "Number": "sample string 3",
                      "Section": {
                        "Id": 1,
                        "Description": "sample string 2",
                        "ShortDescription": "sample string 3",
                        "PrintDescription": "sample string 4"
                      }
                    },
                    "Recipient": {
                      "Id": 1,
                      "SortName": "sample string 1",
                      "DisplayName": "sample string 2"
                    },
                    "DueAmount": 5.0,
                    "PaidAmount": 6.0,
                    "SubLineItemFees": [
                      {
                        "Id": 1,
                        "LineItemId": 2,
                        "SubLineItemId": 3,
                        "FeeSummary": {
                          "FeeId": 1,
                          "Description": "sample string 2",
                          "Category": {
                            "Id": 1,
                            "Description": "sample string 2"
                          }
                        },
                        "Amount": 4.0,
                        "OverrideIndicator": "sample string 5",
                        "OverrideAmount": 6.0,
                        "DbStatus": 7
                      }
                    ],
                    "NewRuleIndicator": "sample string 7",
                    "RuleIndicator": "sample string 8",
                    "PricingRule": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "RuleAction": 3
                    }
                  }
                ],
                "SpecialRequest": {
                  "StartPrice": 1.0,
                  "EndPrice": 1.0,
                  "WheelchairSeats": 1,
                  "AisleSeat": "sample string 1",
                  "ContiguousSeats": 1,
                  "StartingRow": "sample string 2",
                  "EndingRow": "sample string 3",
                  "StartingSeat": "sample string 4",
                  "EndingSeat": "sample string 5",
                  "HoldCode": 1,
                  "NoStairs": true,
                  "LeaveSingleSeats": true,
                  "Notes": "sample string 6",
                  "Category": {
                    "Id": 1,
                    "Description": "sample string 2"
                  }
                },
                "TotalDue": 8.0,
                "DueAmount": 9.0
              },
              {
                "Id": 1,
                "LineItemGroupId": 2,
                "PackageLineItemId": 3,
                "SuperPackageId": 4,
                "AlternateUpgrade": "sample string 5",
                "Primary": true,
                "DbStatus": 7,
                "Package": {
                  "Id": 1,
                  "Code": "sample string 2",
                  "Description": "sample string 3",
                  "Season": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "Type": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "FixedPackage": true,
                  "NFSPackage": true,
                  "SuperPackage": true,
                  "SubPackage": true,
                  "Date": "2018-05-01T11:34:28.8521558Z"
                },
                "Performance": {
                  "Id": 1,
                  "Code": "sample string 2",
                  "Description": "sample string 3",
                  "Facility": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "PerformanceDateTime": "2018-05-01T11:34:28.8521558Z",
                  "Duration": 1,
                  "ProductionSeason": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "Season": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "TimeSlot": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "Type": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "ZoneMap": {
                    "Id": 1,
                    "Description": "sample string 2",
                    "SeatMap": {
                      "Id": 1,
                      "Description": "sample string 2"
                    },
                    "Inactive": true
                  }
                },
                "SubLineItems": [
                  {
                    "Id": 1,
                    "ApplyPricing": true,
                    "DbStatus": 3,
                    "PriceType": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "ShortDescription": "sample string 3",
                      "Category": {
                        "Id": 1,
                        "Description": "sample string 2"
                      },
                      "PriceTypeReason": {
                        "Id": 1,
                        "Description": "sample string 2"
                      }
                    },
                    "OriginalPriceType": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "ShortDescription": "sample string 3",
                      "Category": {
                        "Id": 1,
                        "Description": "sample string 2"
                      },
                      "PriceTypeReason": {
                        "Id": 1,
                        "Description": "sample string 2"
                      }
                    },
                    "StatusId": 4,
                    "SubLineItemDetails": [
                      {
                        "Id": 1,
                        "BenevolentIndicator": true,
                        "CampaignId": 3,
                        "DiscountType": {
                          "Id": 1,
                          "Description": "sample string 2"
                        },
                        "DueAmount": 4.0,
                        "PaidAmount": 5.0,
                        "OriginalPrice": 6.0,
                        "PerformancePriceTypeLayerId": 7
                      }
                    ],
                    "Zone": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "ZoneGroupId": 3,
                      "ShortDescription": "sample string 4",
                      "Abbreviation": "sample string 5",
                      "Rank": 6,
                      "ZoneTime": "sample string 7"
                    },
                    "Seat": {
                      "Id": 1,
                      "Row": "sample string 2",
                      "Number": "sample string 3",
                      "Section": {
                        "Id": 1,
                        "Description": "sample string 2",
                        "ShortDescription": "sample string 3",
                        "PrintDescription": "sample string 4"
                      }
                    },
                    "Recipient": {
                      "Id": 1,
                      "SortName": "sample string 1",
                      "DisplayName": "sample string 2"
                    },
                    "DueAmount": 5.0,
                    "PaidAmount": 6.0,
                    "SubLineItemFees": [
                      {
                        "Id": 1,
                        "LineItemId": 2,
                        "SubLineItemId": 3,
                        "FeeSummary": {
                          "FeeId": 1,
                          "Description": "sample string 2",
                          "Category": {
                            "Id": 1,
                            "Description": "sample string 2"
                          }
                        },
                        "Amount": 4.0,
                        "OverrideIndicator": "sample string 5",
                        "OverrideAmount": 6.0,
                        "DbStatus": 7
                      }
                    ],
                    "NewRuleIndicator": "sample string 7",
                    "RuleIndicator": "sample string 8",
                    "PricingRule": {
                      "Id": 1,
                      "Description": "sample string 2",
                      "RuleAction": 3
                    }
                  }
                ],
                "SpecialRequest": {
                  "StartPrice": 1.0,
                  "EndPrice": 1.0,
                  "WheelchairSeats": 1,
                  "AisleSeat": "sample string 1",
                  "ContiguousSeats": 1,
                  "StartingRow": "sample string 2",
                  "EndingRow": "sample string 3",
                  "StartingSeat": "sample string 4",
                  "EndingSeat": "sample string 5",
                  "HoldCode": 1,
                  "NoStairs": true,
                  "LeaveSingleSeats": true,
                  "Notes": "sample string 6",
                  "Category": {
                    "Id": 1,
                    "Description": "sample string 2"
                  }
                },
                "TotalDue": 8.0,
                "DueAmount": 9.0
              }
            ],
            "Id": 1,
            "LineItemGroupId": 2,
            "PackageLineItemId": 3,
            "SuperPackageId": 4,
            "AlternateUpgrade": "sample string 5",
            "Primary": true,
            "DbStatus": 7,
            "Source": {
              "Id": 1,
              "Description": "sample string 2"
            },
            "Package": {
              "Id": 1,
              "Code": "sample string 2",
              "Description": "sample string 3",
              "Season": {
                "Id": 1,
                "Description": "sample string 2"
              },
              "Type": {
                "Id": 1,
                "Description": "sample string 2"
              },
              "FixedPackage": true,
              "NFSPackage": true,
              "SuperPackage": true,
              "SubPackage": true,
              "Date": "2018-05-01T11:34:28.8521558Z"
            },
            "Performance": {
              "Id": 1,
              "Code": "sample string 2",
              "Description": "sample string 3",
              "Facility": {
                "Id": 1,
                "Description": "sample string 2"
              },
              "PerformanceDateTime": "2018-05-01T11:34:28.8521558Z",
              "Duration": 1,
              "ProductionSeason": {
                "Id": 1,
                "Description": "sample string 2"
              },
              "Season": {
                "Id": 1,
                "Description": "sample string 2"
              },
              "TimeSlot": {
                "Id": 1,
                "Description": "sample string 2"
              },
              "Type": {
                "Id": 1,
                "Description": "sample string 2"
              },
              "ZoneMap": {
                "Id": 1,
                "Description": "sample string 2",
                "SeatMap": {
                  "Id": 1,
                  "Description": "sample string 2"
                },
                "Inactive": true
              }
            },
            "SubLineItems": [
              {
                "Id": 1,
                "ApplyPricing": true,
                "DbStatus": 3,
                "PriceType": {
                  "Id": 1,
                  "Description": "sample string 2",
                  "ShortDescription": "sample string 3",
                  "Category": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "PriceTypeReason": {
                    "Id": 1,
                    "Description": "sample string 2"
                  }
                },
                "OriginalPriceType": {
                  "Id": 1,
                  "Description": "sample string 2",
                  "ShortDescription": "sample string 3",
                  "Category": {
                    "Id": 1,
                    "Description": "sample string 2"
                  },
                  "PriceTypeReason": {
                    "Id": 1,
                    "Description": "sample string 2"
                  }
                },
                "StatusId": 4,
                "SubLineItemDetails": [
                  {
                    "Id": 1,
                    "BenevolentIndicator": true,
                    "CampaignId": 3,
                    "DiscountType": {
                      "Id": 1,
                      "Description": "sample string 2"
                    },
                    "DueAmount": 4.0,
                    "PaidAmount": 5.0,
                    "OriginalPrice": 6.0,
                    "PerformancePriceTypeLayerId": 7
                  },
                  {
                    "Id": 1,
                    "BenevolentIndicator": true,
                    "CampaignId": 3,
                    "DiscountType": {
                      "Id": 1,
                      "Description": "sample string 2"
                    },
                    "DueAmount": 4.0,
                    "PaidAmount": 5.0,
                    "OriginalPrice": 6.0,
                    "PerformancePriceTypeLayerId": 7
                  }
                ],
                "Zone": {
                  "Id": 1,
                  "Description": "sample string 2",
                  "ZoneGroupId": 3,
                  "ShortDescription": "sample string 4",
                  "Abbreviation": "sample string 5",
                  "Rank": 6,
                  "ZoneTime": "sample string 7"
                },
                "Seat": {
                  "Id": 1,
                  "Row": "sample string 2",
                  "Number": "sample string 3",
                  "Section": {
                    "Id": 1,
                    "Description": "sample string 2",
                    "ShortDescription": "sample string 3",
                    "PrintDescription": "sample string 4"
                  }
                },
                "Recipient": {
                  "Id": 1,
                  "SortName": "sample string 1",
                  "DisplayName": "sample string 2"
                },
                "DueAmount": 5.0,
                "PaidAmount": 6.0,
                "SubLineItemFees": [
                  {
                    "Id": 1,
                    "LineItemId": 2,
                    "SubLineItemId": 3,
                    "FeeSummary": {
                      "FeeId": 1,
                      "Description": "sample string 2",
                      "Category": {
                        "Id": 1,
                        "Description": "sample string 2"
                      }
                    },
                    "Amount": 4.0,
                    "OverrideIndicator": "sample string 5",
                    "OverrideAmount": 6.0,
                    "DbStatus": 7
                  },
                  {
                    "Id": 1,
                    "LineItemId": 2,
                    "SubLineItemId": 3,
                    "FeeSummary": {
                      "FeeId": 1,
                      "Description": "sample string 2",
                      "Category": {
                        "Id": 1,
                        "Description": "sample string 2"
                      }
                    },
                    "Amount": 4.0,
                    "OverrideIndicator": "sample string 5",
                    "OverrideAmount": 6.0,
                    "DbStatus": 7
                  }
                ],
                "NewRuleIndicator": "sample string 7",
                "RuleIndicator": "sample string 8",
                "PricingRule": {
                  "Id": 1,
                  "Description": "sample string 2",
                  "RuleAction": 3
                }
              }
            ],
            "SpecialRequest": {
              "StartPrice": 1.0,
              "EndPrice": 1.0,
              "WheelchairSeats": 1,
              "AisleSeat": "sample string 1",
              "ContiguousSeats": 1,
              "StartingRow": "sample string 2",
              "EndingRow": "sample string 3",
              "StartingSeat": "sample string 4",
              "EndingSeat": "sample string 5",
              "HoldCode": 1,
              "NoStairs": true,
              "LeaveSingleSeats": true,
              "Notes": "sample string 6",
              "Category": {
                "Id": 1,
                "Description": "sample string 2"
              }
            },
            "TotalDue": 8.0,
            "DueAmount": 9.0
          }
        ]
      },
      "Contribution": {
        "Id": 1,
        "DbStatus": 2,
        "Amount": 3.0,
        "Fund": {
          "Id": 1,
          "Description": "sample string 2"
        },
        "CustomDataItems": [
          {
            "Name": "sample string 1",
            "Index": 1,
            "KeywordId": 1,
            "IsDropdown": true,
            "Value": "sample string 2",
            "DataType": "sample string 3",
            "Description": "sample string 4",
            "EditIndicator": true
          }
        ],
        "OnAccountPaymentMethodId": 1
      },
      "Membership": {
        "Id": 1,
        "DbStatus": 2,
        "Amount": 3.0,
        "Fund": {
          "Id": 1,
          "Description": "sample string 2"
        },
        "MembershipOrganization": {
          "Id": 1,
          "Description": "sample string 2"
        },
        "MembershipLevel": {
          "Id": 1,
          "Description": "sample string 2"
        },
        "CustomDataItems": [
          {
            "Name": "sample string 1",
            "Index": 1,
            "KeywordId": 1,
            "IsDropdown": true,
            "Value": "sample string 2",
            "DataType": "sample string 3",
            "Description": "sample string 4",
            "EditIndicator": true
          }
        ],
        "OnAccountPaymentMethodId": 1
      },
      "GiftCertificate": {
        "PaymentId": 1,
        "GiftCertificateNumber": "sample string 2",
        "Amount": 3.0,
        "Notes": "sample string 4",
        "Name": "sample string 5",
        "Applied": true
      },
      "UserDefinedFee": {
        "Id": 1,
        "LineItemId": 2,
        "SubLineItemId": 3,
        "FeeSummary": {
          "FeeId": 1,
          "Description": "sample string 2",
          "Category": {
            "Id": 1,
            "Description": "sample string 2"
          }
        },
        "Amount": 4.0,
        "OverrideIndicator": "sample string 5",
        "OverrideAmount": 6.0,
        "DbStatus": 7
      },
      "ProductGrouping": "sample string 1"
    }
  ]
}
Header Name Override
Cache-Control private

POST calls

/Web/Cart/{sessionKey}/Packages/Fixed

HTTP Method: POST

Tessitura Rest Call: /Web/Cart/{sessionKey}/Packages/Fixed

URI Parameters
Parameter Name Notes
sessionKey String
Request Body
Parameter Name Notes
LeaveSingleSeats When set to True, the best seating function is allowed to reserve seats that would leave a single contiguous seat available. When set to False, the best seating function will not reserve seats that would leave a single contiguous seat available.
NumberOfSeats The number of seats to be added to the cart for the request.
PackageId The ID number of package to be added to the cart. Must be a fixed seat package.
ParentPackageLineItemId If the line item being added is primary (a new package) pass 0 for this parameter. If the line item being added is an alternate/upgrade line item pass the line item ID of parent package line item.
PriceType The price type for the package. If multiple seats are being requested different price types can be used for each seat by passing a comma separated list of price types.When using multiple price types, a price type must be specified for each seat even if some seats are using the same price type.For example, if there are 4 seats, two at the Adult and two at the Child price type, 4 price type IDs must be passed. The price types passed must be valid for the current mode of sale.
PriceTypeReason Price Type reasons (Comp Codes) for use with price types that require them. If multiple seats are being requested with different price types, the price type reasons can be specified in a list, matching the price types.
RequestedSeats The ID numbers (seat_no) of specific seats to reserve. Multiple seat numbers can be passed as a comma separated list. If no value is passed seats are reserved using the best seating function.
Unseated Setting this as True will create an unseated package lineitem.
ZoneId The ID number of the desired price zone for the request. A value of 0 can be passed When reserving specific seats, the zone of the specified seats overrides whatever zone value is passed here.As the parameter is required but essentially irrelevant, you can pass a value of 0 to meet the requirement.

Sample Request Body

{
  "PriceType": "sample string 1",
  "PriceTypeReason": "sample string 2",
  "PackageId": 3,
  "NumberOfSeats": 4,
  "ZoneId": 5,
  "RequestedSeats": "sample string 6",
  "LeaveSingleSeats": true,
  "ParentPackageLineItemId": 8,
  "Unseated": true
}
Response

The response object is a collection of AddPackageItemResponse objects with the following properties.

Property Name Data Type
LineItemId integer
SeatsReserved integer

Sample Response

{
  "LineItemId": 1,
  "SeatsReserved": 2
}
Header Name Override
Cache-Control private

/Web/Cart/{sessionKey}/Tickets

HTTP Method: POST

Tessitura Rest Call: /Web/Cart/{sessionKey}/Tickets

URI Parameters
Parameter Name Notes
sessionKey string
Request Body
Parameter Name Notes
NumberOfSeats The number of seats to be added to the cart for the request.
PerformanceId The ID of the performance number to be added to the cart.
PriceType The price type for the performance. If multiple seats are being requested different price types can be used for each seat by passing a comma separated list of price types. When using multiple price types, a price type must be specified for each seat even if some seats are using the same price type.For example, if there are 4 seats, two at the Adult and two at the Child price type, 4 price type IDs must be passed. The price types passed must be valid for the current mode of sale.
PriceTypeReason Price Type reasons (Comp Codes) for use with price types that require them. If multiple seats are being requested with different price types, the price type reasons can be specified in a list, matching the price types.
RequestedSeats The ID numbers (seat_no) of specific seats to reserve. Muliple seat numbers can be passed as a comma separated list. Seats must be in the specificed performance and available.
SpecialRequests Used to refine which seats are selected by the best seat function (including reserving seats held with a hold code). Special requests are passed as a string of name-value pairs formatted as follows: name1=value1andname2=value2. See the special requests section for valid special request names and values.
Unseated If True, the tickets will be added to the cart unseated.
ZoneId The ID number of the desired price zone for the request. A value of 0 can be passed When reserving specific seats, the zone of the specified seats overrides whatever zone value is passed here.As the parameter is required but essentially irrelevant, you can pass a value of 0 to meet the requirement.

Sample Request Body

{
  "PriceType": "sample string 1",
  "PriceTypeReason": "sample string 2",
  "PerformanceId": 3,
  "NumberOfSeats": 4,
  "ZoneId": 5,
  "SpecialRequests": "sample string 6",
  "Unseated": true,
  "RequestedSeats": "sample string 8"
}
Response

The response object is a collection of ReserveTicketsResponse objects with the following properties.

Property Name Data Type
LineItemId integer
SeatsReserved integer

Sample Response

{
  "LineItemId": 1,
  "SeatsReserved": 2
}
Header Name Override
Cache-Control private

/Web/Session

HTTP Method: POST

Tessitura Rest Call: /Web/Session

Request Body
Parameter Name Notes
BusinessUnitId The business unit for this session.
IpAddress Specifies the IP Address to be stored in the T_WEB_SESSION_SESSION table.
Organization The organization name for this session. Must match the description column for a row in TR_ORGANIZATION.

Sample Request Body

{
  "IpAddress": "sample string 1",
  "BusinessUnitId": 2,
  "Organization": "sample string 3"
}
Response

The response object is a collection of WebPromoCode objects with the following properties.

Property Name Data Type
SessionKey string

Sample Response

{
  "SessionKey": "sample string 1"
}
Header Name Override
Cache-Control private

/Web/Session/{sessionKey}/PromoCode

HTTP Method: POST

Tessitura Rest Call: /Web/Session/{sessionKey}/PromoCode

URI Parameters
Parameter Name Notes
sessionKey string
Request Body
Parameter Name Notes
PromoCode The numeric promo code (source) to return. Either the PromoCodeString or the PromoCode is required.
PromoCodeString The text promo code to return. Either the PromoCodeString or the PromoCode is required.

Sample Request Body

{
  "PromoCodeString": "sample string 1",
  "PromoCode": 1
}
Response

The response object is a collection of WebPromoCode objects with the following properties.

Property Name Data Type
ModeOfSaleId integer
OverrideRankIndicator string
PromoCode string
PromotionDate date
Source object
Text1 string
Text2 string
Text3 string
Text4 string
Text5 string
Text6 string

Sample Response

[
  {
    "ModeOfSaleId": 1,
    "OverrideRankIndicator": "sample string 2",
    "PromoCode": "sample string 3",
    "PromotionDate": "2018-05-01T14:02:37.7088862Z",
    "Source": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true,
      "Appeal": {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      }
    },
    "Text1": "sample string 4",
    "Text2": "sample string 5",
    "Text3": "sample string 6",
    "Text4": "sample string 7",
    "Text5": "sample string 8",
    "Text6": "sample string 9"
  },
  {
    "ModeOfSaleId": 1,
    "OverrideRankIndicator": "sample string 2",
    "PromoCode": "sample string 3",
    "PromotionDate": "2018-05-01T14:02:37.7088862Z",
    "Source": {
      "Description": "sample string 1",
      "Id": 1,
      "Inactive": true,
      "Appeal": {
        "Description": "sample string 1",
        "Id": 1,
        "Inactive": true
      }
    },
    "Text1": "sample string 4",
    "Text2": "sample string 5",
    "Text3": "sample string 6",
    "Text4": "sample string 7",
    "Text5": "sample string 8",
    "Text6": "sample string 9"
  }
]
Header Name Override
Cache-Control private