Cart Test
Web/Cart/{sessionKey}/Packages/Nfs
Adds a new nfs package item to the cart

This method adds a seated or unseated non fixed seat (NFS) or flex package to the cart by adding the component performances. When the package is seated, the best seating function can be used or specific seat numbers can be passed for use with SYOS functionality.

A NFS or flex package line item is created when the first component performance is added to the cart.The ID number from the package line item is required when the remaining component performances are added. It is returned as NFSPackageLineItemId in the method's response.

/Web/Cart/Validation can be called at any time, setting the ValidateNFSPackages boolean to true, to determine whether all of the rules for the package have been met with items in the shopping cart.

This method will allow the reservation of held seats. To enable this functionality, add the key ''Reserve Held Seats' to T_DEFAULTS with a value of 'Yes' under the "Tessitura Web" parent table (or organization name if operating in a consortium environment).
Http Verb POST
Resource URL https://ts-stg-appgw.calacademy.org/TessituraService/Web/Cart/{sessionKey}/Packages/Nfs

URI Parameters

Parameter Name Data Type Required Notes
sessionKey string Y

Request Body

Request object type : AddNFSPackagePerformanceItemRequest

Request object type AddNFSPackagePerformanceItemRequest has the following properties.
Property Name Data Type Length Required Readonly Notes
LeaveSingleSeats boolean Y 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.
NFSPackageLineItemId integer Y The line item ID of the package to which the performances are being added. For the first performance added the value should be 0. The package line item is generated then and its ID returned for use with the remaining performances.
NumberOfSeats integer Y The number of seats to be added to the cart for the request.
PackageId integer Y The ID number of the package to to which the performance being added belongs. The same package ID must be passed for each performance.
FK: T_PKG.pkg_no   Resource: Packages
PerformanceGroupId integer Y The ID of the performance group to which the performance being added belongs. The performance group must be associtated with the requested package.
FK: T_PERF_GROUP.perf_group_no   Resource: PerformanceGroups
PerformanceId integer Y The ID number of the performance to be added to the cart. Performances must be associated with the package passed in PackageId parameter.
FK: T_PERF.perf_no   Resource: Performances
PriceType string Y 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.
FK: TR_PRICE_TYPE.id   Resource: PriceTypes
PriceTypeReason string N 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.
FK: TR_COMP_CODE.id   Resource: PriceTypeReasons
RequestedSeats string N The ID numbers (seat_no) of specific seats to reserve. Muliple seat numbers can be passed as a comma separated list. If no value is passed seats are reserved using the best seating function.
SpecialRequests string N 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 boolean Y When set to True, seats will not be assigned. When set to False, seats will be assigned.
ZoneId integer Y 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.
FK: T_ZONE.zone_no   Resource: Zones 
{
  "NFSPackageLineItemId": 1,
  "PriceType": "sample string 2",
  "PriceTypeReason": "sample string 3",
  "PackageId": 4,
  "PerformanceId": 5,
  "PerformanceGroupId": 6,
  "NumberOfSeats": 7,
  "ZoneId": 8,
  "RequestedSeats": "sample string 9",
  "LeaveSingleSeats": true,
  "SpecialRequests": "sample string 11",
  "Unseated": true
}
<AddNFSPackagePerformanceItemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <LeaveSingleSeats>true</LeaveSingleSeats>
  <NFSPackageLineItemId>1</NFSPackageLineItemId>
  <NumberOfSeats>7</NumberOfSeats>
  <PackageId>4</PackageId>
  <PerformanceGroupId>6</PerformanceGroupId>
  <PerformanceId>5</PerformanceId>
  <PriceType>sample string 2</PriceType>
  <PriceTypeReason>sample string 3</PriceTypeReason>
  <RequestedSeats>sample string 9</RequestedSeats>
  <SpecialRequests>sample string 11</SpecialRequests>
  <Unseated>true</Unseated>
  <ZoneId>8</ZoneId>
</AddNFSPackagePerformanceItemRequest>

Response object type : AddNFSPackagePerformanceItemResponse

Response object type AddNFSPackagePerformanceItemResponse has the following properties.
Property Name Data Type Length Required Readonly Notes
LineItemId integer
NFSPackageLineItemId integer
SeatsReserved integer 
{
  "LineItemId": 1,
  "NFSPackageLineItemId": 2,
  "SeatsReserved": 3
}
<AddNFSPackagePerformanceItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <LineItemId>1</LineItemId>
  <NFSPackageLineItemId>2</NFSPackageLineItemId>
  <SeatsReserved>3</SeatsReserved>
</AddNFSPackagePerformanceItemResponse>
Change Version Description Contract Old New
Parameter Changed 15.0.0 sessionKey has been marked as required. Required