Service overbooking limits
Last updated
Was this helpful?
Last updated
Was this helpful?
Restricted!This operation is currently in beta-test and as such it is subject to change.
Returns all service overbooking limits. Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/serviceOverbookingLimits/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.
ServiceIds
array of string
required, max 1000 items
Unique identifiers of Services associated with the service overbooking limits.
ServiceOverbookingLimitIds
array of string
optional, max 1000 items
Unique identifiers of the service overbooking limits.
CollidingUtc
optional
Interval in which the service overbooking limit is active.
UpdatedUtc
optional, max length 3 months
Interval in which the service overbooking limits were updated.
ActivityStates
optional
Whether to return only active, only deleted, or both types of record. If not specified, only active records will be returned.
Limitation
required
Limitation on the quantity of data returned and optional Cursor for the starting point of data.
ServiceOverbookingLimits
required
Service overbooking limits of the default service.
Cursor
string
optional
Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned.
Id
string
required
Unique identifier of the service overbooking limit.
ServiceId
string
required
Unique identifier of the Service.
FirstTimeUnitStartUtc
string
required
LastTimeUnitStartUtc
string
required
Limit
integer
required
Number of overbookings allowed for the Service.
CreatedUtc
string
required
Timestamp in UTC timezone ISO 8601 format when the service overbooking was created.
UpdatedUtc
string
required
Timestamp in UTC timezone ISO 8601 format when the service overbooking was updated.
IsActive
boolean
required
Whether the service overbooking limit is still active.
Restricted!This operation is currently in beta-test and as such it is subject to change.
[PlatformAddress]/api/connector/v1/serviceOverbookingLimits/set
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
ServiceId
string
required
SetServiceOverbookingLimits
required, max 1000 items
Collection of service overbooking limits to be set.
FirstTimeUnitStartUtc
string
required
LastTimeUnitStartUtc
string
required
Limit
integer
required
Number of overbookings allowed for the Service. Must be non-negative.
Restricted!This operation is currently in beta-test and as such it is subject to change.
[PlatformAddress]/api/connector/v1/serviceOverbookingLimits/clear
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseId
string
optional
ServiceId
string
required
ClearServiceOverbookingLimits
required, max 1000 items
Collection of service overbooking limits to be cleared.
FirstTimeUnitStartUtc
string
required
LastTimeUnitStartUtc
string
required
array of
array of
Start of the time interval, expressed as the timestamp for the start of the first , in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the last , in UTC timezone ISO 8601 format.
Adds new service overbooking limits with the specified conditions. Past overbooking limits cannot be updated outside of OperationalEditableHistoryInterval. Care is needed to specify FirstTimeUnitStartUtc and LastTimeUnitStartUtc in the correct format - see . This operation supports .
Unique identifier of the enterprise. Required when using , ignored otherwise.
Unique identifier of the overbooking limits will be set in.
array of
Start of the time interval, expressed as the timestamp for the start of the first , in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the last , in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's : 367 days.
Deletes service overbooking limits that exactly match the specified conditions. This operation is intended to be used alongside serviceOverbookingLimits/set. The specified conditions must be met exactly. The time interval, however, does not need to correspond to an existing service overbooking limit in the system, instead the API uses a splicing algorithm to work out how to divide up any existing service overbooking limit to meet the specified time interval. Past overbooking limits cannot be cleared outside of OperationalEditableHistoryInterval. Care is needed to specify FirstTimeUnitStartUtc and LastTimeUnitStartUtc in the correct format - see . This operation supports .
Unique identifier of the enterprise. Required when using , ignored otherwise.
Unique identifier of the overbooking limits will be set in.
array of
Start of the time interval, expressed as the timestamp for the start of the first , in UTC timezone ISO 8601 format.
End of the time interval, expressed as the timestamp for the start of the last , in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service's time unit: 367 hours if hours, 367 days if days, or 60 months if months.