BookingLimitService provides operations for creating and managing booking limits.

activateDefaultBookingLimitByPartnerRuleId

Activate a default booking limit (specified by partner rule ID).

Changed in: Version 15.0.0
Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
partnerRuleID	long	The ID of the partner rule associated with the default booking limit to activate.	Req

Response

BookingLimitResponse - The response, which indicates if the operation succeeded or failed, and the (activated) default booking limit.

addBookingLimit

Add a booking limit.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimit	BookingLimit	The booking limit to add.	Req

Response

BookingLimitResponse - The response, which indicates if the operation succeeded or failed, and the booking limit.

addBookingLimits

Add a list of booking limits.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimits	BookingLimit[]	The list of booking limits to add.	Req

Response

BookingLimitResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of booking limits.

addDefaultBookingLimit

Add a default booking limit.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimit	BookingLimit	The default booking limit to add.	Req

Response

BookingLimitResponse - The response, which indicates if the operation succeeded or failed, and the default booking limit.

deactivateDefaultBookingLimitByPartnerRuleId

Deactivate the default booking limit (specified by partner rule ID).

Changed in: Version 15.0.0
Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
partnerRuleID	long	The ID of the partner rule associated with the default booking limit to deactivate.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteBookingLimit

Delete a booking limit (specified by ID).

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimitID	long	The ID of the booking limit to delete.	Req

Response

BasicResponse - The response, which indicates if the operation succeeded or failed.

deleteBookingLimits

Delete a list of booking limits (specified by IDs).

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimitIDs	long[]	The IDs of the booking limits to delete.	Req

Response

BasicResponse - The list of responses, which indicate if the operations succeeded or failed.

getBookingLimit

Get a booking limit (specified by ID).

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimitID	long	The ID of the booking limit to retrieve.	Req

Response

BookingLimitResponse - The response, which indicates if the operation succeeded or failed, and the booking limit.

getBookingLimits

Get a list of booking limits (specified by IDs).

Quota is charged for each object in the request.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimitIDs	long[]	The IDs of the booking limits to retrieve.	Req

Response

BookingLimitResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of booking limits.

getBookingLimitsByFilter

Get the booking limits using a filter.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
filter	BookingLimitFilter	The filter to filter booking limits by.	Req
startElement	int	The first element to retrieve (0-based; if a value <= 0 is entered, it will default to 0).	Req
numElements	int	The number of elements to retrieve (1000 maximum; if a value <=0 is entered, it will default to 1000).	Req

Response

BookingLimitResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of booking limits.

getBookingLimitsCountByFilter

Get a count of the booking limits matching a filter criteria.

Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
filter	BookingLimitFilter	The filter to filter booking limits by.	Req

Response

int - The number of booking limits.

getDefaultBookingLimitByPartnerRuleId

Retrieve a default booking limit (specified by partner rule ID).

Changed in: Version 15.0.0
Capability required: YieldRead
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
partnerRuleID	long	The ID of the partner rule associated with the default booking limit to retrieve.	Req

Response

BookingLimitResponse - The response, which indicates if the operation succeeded or failed, and the default booking limit associated with the given partner rule (ID).

getSupportedTargetingAttributeTypes

Get the list of targeting attribute types supported in a booking limit.

Capability required: YieldRead
License command group: Inventory

Parameters

none

Response

TargetingAttributeType[] - The list of targeting attribute types.

updateBookingLimit

Update a booking limit.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimit	BookingLimit	The booking limit to update.	Req

Response

BookingLimitResponse - The response, which indicates if the operation succeeded or failed, and the (updated) booking limit.

updateBookingLimits

Update a list of booking limits.

Quota is charged for each object in the request.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimits	BookingLimit[]	The list of booking limits to update.	Req

Response

BookingLimitResponse[] - The list of responses, which indicate if the operations succeeded or failed, and the list of (updated) booking limits.

updateDefaultBookingLimit

Update default booking limit.

Capability required: YieldWrite
License command group: Inventory

Parameters

Parameter	Data Type	Description	Restriction
bookingLimit	BookingLimit	The default booking limit to update.	Req

Response

BookingLimitResponse - The response, which indicates if the operation succeeded or failed, and the (updated) default booking limit.