Skip to content

Set service overbooking limits

POST
/api/connector/v1/serviceOverbookingLimits/set

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 Datetimes. This operation supports Portfolio Access Tokens.

ServiceOverbookingLimitSetParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
EnterpriseId

Unique identifier of the enterprise. Required when using Portfolio Access Tokens, ignored otherwise.

string format: uuid
nullable
ServiceId
required

Unique identifier of the Service overbooking limits will be set in.

string format: uuid
SetServiceOverbookingLimits
required

Collection of service overbooking limits to be set.

Array<object>
>= 1 items <= 1000 items
Service overbooking limits set parameters
object
FirstTimeUnitStartUtc
required

Start of the time interval, expressed as the timestamp for the start of the first time unit, in UTC timezone ISO 8601 format.

string format: date-time
>= 1 characters
LastTimeUnitStartUtc
required

End of the time interval, expressed as the timestamp for the start of the last time unit, in UTC timezone ISO 8601 format. The maximum size of time interval depends on the service’s time unit: 367 days.

string format: date-time
>= 1 characters
Limit
required

Number of overbookings allowed for the Service. Must be non-negative.

integer format: int32
<= 2147483647
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"ServiceId": "bd26d8db-86da-4f96-9efc-e5a4654a4a94",
"SetServiceOverbookingLimits": [
{
"FirstTimeUnitStartUtc": "2024-11-01T00:00:00Z",
"LastTimeUnitStartUtc": "2024-11-30T00:00:00Z",
"Limit": 10
}
],
"EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

OK

object

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see Request timeouts

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Error caused by too many requests sent in a given amount of time. Response contains Retry-After header indicating how long the user agent should wait before making a follow-up request. For more information, see Request limits.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our documentation repository.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable