|
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.
|
|
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 |
|
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 |
|
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 |
|
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 |
|
NumberOfSeats
|
integer
|
|
Y
|
|
The number of seats to be added to the cart for the request.
|
|
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 |
|
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.
|
|
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.
|
|
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.
|