Mews Availability blocks API
The Availability blocks API from Mews — 4 operation(s) for availability blocks.
The Availability blocks API from Mews — 4 operation(s) for availability blocks.
openapi: 3.0.4
info:
title: Connector Account notes Availability blocks API
description: General-purpose API that enables partners of Mews to access data and services in Mews Operations
termsOfService: https://www.mews.com/en/terms-conditions/partners
contact:
name: Partner success
email: partnersuccess@mews.com
version: v1
servers:
- url: https://api.mews.com
tags:
- name: Availability blocks
paths:
/api/connector/v1/availabilityBlocks/delete:
post:
tags:
- Availability blocks
summary: Delete availability blocks
description: Delete availability blocks. Note that an availability block containing active reservations (reservations which are not Canceled) cannot be deleted. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
operationId: availabilityBlocks_delete
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityBlockDeleteParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
AvailabilityBlockIds:
- 5ee074b1-6c86-48e8-915f-c7aa4702086f
- c32386aa-1cd2-414a-a823-489325842fbe
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/Unit'
'400':
description: 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).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'403':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'408':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'429':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'500':
description: 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](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
/api/connector/v1/availabilityBlocks/getAll:
post:
tags:
- Availability blocks
summary: Get all availability blocks
description: Returns all availability blocks filtered by services, unique identifiers and other filters. Note this operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/) and supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
operationId: availabilityBlocks_getAll
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityBlockParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
Extent:
AvailabilityBlocks: true
Adjustments: true
ServiceOrders: false
Rates: false
ServiceIds:
- bd26d8db-86da-4f96-9efc-e5a4654a4a94
AvailabilityBlockIds:
- 5ee074b1-6c86-48e8-915f-c7aa4702086f
CreatedUtc:
StartUtc: '2020-11-04T00:00:00Z'
EndUtc: '2020-11-05T00:00:00Z'
UpdatedUtc:
StartUtc: '2020-11-04T00:00:00Z'
EndUtc: '2020-11-05T00:00:00Z'
CollidingUtc:
StartUtc: '2020-11-04T00:00:00Z'
EndUtc: '2020-11-05T00:00:00Z'
ReleasedUtc:
StartUtc: '2020-11-04T00:00:00Z'
EndUtc: '2020-11-05T00:00:00Z'
ExternalIdentifiers:
- Block-0001
States:
- Confirmed
ActivityStates:
- Active
Limitation:
Count: 100
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityBlockResult'
example:
AvailabilityBlocks:
- Id: 5ee074b1-6c86-48e8-915f-c7aa4702086f
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda
VoucherId: null
BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72
CompanyId: null
TravelAgencyId: null
Budget:
Currency: USD
Value: 48.0
Net: null
Tax: null
TaxRate: null
State: Confirmed
ReservationPurpose: Leisure
CreatedUtc: '2020-11-04T13:00:00Z'
UpdatedUtc: '2020-11-04T13:00:00Z'
FirstTimeUnitStartUtc: '2020-11-04T13:00:00Z'
LastTimeUnitStartUtc: '2020-11-04T13:00:00Z'
ReleasedUtc: '2020-11-04T13:00:00Z'
RollingReleaseOffset: null
ExternalIdentifier: Block-0001
Name: Wedding group
Notes: Have a nice stay
PickupDistribution: AllInOneGroup
IsActive: false
QuoteId: null
AvailabilityBlockNumber: '478'
ReleaseStrategy: FixedRelease
PurchaseOrderNumber: XX-123
BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed
CanceledUtc: null
CancellationReason: null
CancellationReasonDetail: null
- Id: c32386aa-1cd2-414a-a823-489325842fbe
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda
VoucherId: null
BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72
CompanyId: null
TravelAgencyId: null
Budget:
Currency: USD
Value: 48.0
Net: null
Tax: null
TaxRate: null
State: Confirmed
ReservationPurpose: Leisure
CreatedUtc: '2022-10-11T13:32:32Z'
UpdatedUtc: '2022-10-11T13:32:32Z'
FirstTimeUnitStartUtc: '2022-10-14T00:00:00Z'
LastTimeUnitStartUtc: '2022-11-17T00:00:00Z'
ReleasedUtc: null
RollingReleaseOffset: P-3DT4H
ExternalIdentifier: Block-0002
Name: Rolling release
Notes: null
PickupDistribution: AllInOneGroup
IsActive: false
QuoteId: 67eaf3c8-81e0-4ffb-b5f2-2b61803feb9c
AvailabilityBlockNumber: '479'
ReleaseStrategy: RollingRelease
PurchaseOrderNumber: null
BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed
CanceledUtc: null
CancellationReason: null
CancellationReasonDetail: null
ServiceOrders: null
Adjustments:
- Id: e19297af-373e-4701-b4ea-afae0129bded
AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f
ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f
StartUtc: null
EndUtc: null
FirstTimeUnitStartUtc: '2021-10-14T00:00:00Z'
LastTimeUnitStartUtc: '2021-10-17T00:00:00Z'
UnitCount: 6
ActivityState: Active
ReleaseOverrideUtc: '2021-10-13T00:00:00Z'
UpdatedUtc: '2021-10-21T13:32:32Z'
IsActive: false
PaxCounts: null
FirstTimeUnitReleaseUtc: '2021-10-13T00:00:00Z'
Rates: null
Cursor: c32386aa-1cd2-414a-a823-489325842fbe
'400':
description: 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).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'403':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'408':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'429':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'500':
description: 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](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
/api/connector/v1/availabilityBlocks/add:
post:
tags:
- Availability blocks
summary: Add availability blocks
description: Adds availability blocks which are used to group related `Availability updates`. This makes limiting public availability easier and more organized. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
operationId: availabilityBlocks_add
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleAvailabilityBlockAddParameters'
example:
ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D
AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D
Client: Sample Client 1.0.0
AvailabilityBlocks:
- ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda
FirstTimeUnitStartUtc: '2020-11-05T00:00:00Z'
LastTimeUnitStartUtc: '2020-11-06T00:00:00Z'
ReleasedUtc: '2020-11-04T00:00:00Z'
Name: Mr. Smith's block
Budget:
Currency: USD
Value: 48.0
ExternalIdentifier: Block-0001
State: Confirmed
- ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda
FirstTimeUnitStartUtc: '2021-11-05T00:00:00Z'
LastTimeUnitStartUtc: '2021-11-06T00:00:00Z'
Name: Rolling release block
Budget:
Currency: USD
Value: 48.0
ExternalIdentifier: Block-0002
State: Confirmed
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityBlockAddResult'
example:
AvailabilityBlocks:
- Id: 5ee074b1-6c86-48e8-915f-c7aa4702086f
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda
VoucherId: null
BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72
CompanyId: null
TravelAgencyId: null
Budget:
Currency: USD
Value: 48.0
Net: null
Tax: null
TaxRate: null
State: Confirmed
ReservationPurpose: Leisure
CreatedUtc: '2020-11-04T13:00:00Z'
UpdatedUtc: '2020-11-04T13:00:00Z'
FirstTimeUnitStartUtc: '2020-11-04T13:00:00Z'
LastTimeUnitStartUtc: '2020-11-04T13:00:00Z'
ReleasedUtc: '2020-11-04T13:00:00Z'
RollingReleaseOffset: null
ExternalIdentifier: Block-0001
Name: Wedding group
Notes: Have a nice stay
PickupDistribution: AllInOneGroup
IsActive: false
QuoteId: null
AvailabilityBlockNumber: '478'
ReleaseStrategy: FixedRelease
PurchaseOrderNumber: XX-123
BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed
CanceledUtc: null
CancellationReason: null
CancellationReasonDetail: null
- Id: c32386aa-1cd2-414a-a823-489325842fbe
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda
VoucherId: null
BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72
CompanyId: null
TravelAgencyId: null
Budget:
Currency: USD
Value: 48.0
Net: null
Tax: null
TaxRate: null
State: Confirmed
ReservationPurpose: Leisure
CreatedUtc: '2022-10-11T13:32:32Z'
UpdatedUtc: '2022-10-11T13:32:32Z'
FirstTimeUnitStartUtc: '2022-10-14T00:00:00Z'
LastTimeUnitStartUtc: '2022-11-17T00:00:00Z'
ReleasedUtc: null
RollingReleaseOffset: P-3DT4H
ExternalIdentifier: Block-0002
Name: Rolling release
Notes: null
PickupDistribution: AllInOneGroup
IsActive: false
QuoteId: 67eaf3c8-81e0-4ffb-b5f2-2b61803feb9c
AvailabilityBlockNumber: '479'
ReleaseStrategy: RollingRelease
PurchaseOrderNumber: null
BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed
CanceledUtc: null
CancellationReason: null
CancellationReasonDetail: null
ServiceOrders: null
Adjustments:
- Id: e19297af-373e-4701-b4ea-afae0129bded
AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f
ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f
StartUtc: null
EndUtc: null
FirstTimeUnitStartUtc: '2021-10-14T00:00:00Z'
LastTimeUnitStartUtc: '2021-10-17T00:00:00Z'
UnitCount: 6
ActivityState: Active
ReleaseOverrideUtc: '2021-10-13T00:00:00Z'
UpdatedUtc: '2021-10-21T13:32:32Z'
IsActive: false
PaxCounts: null
FirstTimeUnitReleaseUtc: '2021-10-13T00:00:00Z'
Rates: null
Cursor: c32386aa-1cd2-414a-a823-489325842fbe
'400':
description: 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).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'403':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'408':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'429':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'500':
description: 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](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
/api/connector/v1/availabilityBlocks/update:
post:
tags:
- Availability blocks
summary: Update availability blocks
description: Updates information about the specified `Availability block`. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/).
operationId: availabilityBlocks_update
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MultipleAvailabilityBlockUpdateParameters'
example:
AvailabilityBlocks:
- AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f
Name:
Value: Mr. Smith's block
FirstTimeUnitStartUtc:
Value: '2021-07-05T00:00:00Z'
LastTimeUnitStartUtc:
Value: '2021-07-15T00:00:00Z'
ExternalIdentifier:
Value: Block-1002
State:
Value: Confirmed
ReservationPurpose:
Value: Business
BookerId:
Value: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72
Notes:
Value: Welcome to Washington
Budget:
Value:
Currency: USD
Value: 48.0
ReleasedUtc:
Value: '2021-07-04T00:00:00Z'
QuoteId: {}
BusinessSegmentId:
Value: dc9188f6-fb61-412c-b3fd-af32dab082ed
- AvailabilityBlockId: c32386aa-1cd2-414a-a823-489325842fbe
State:
Value: Canceled
CancellationReason:
Value: ForceMajeure
CancellationReasonDetail:
Value: Event was canceled due to rain.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/AvailabilityBlockAddResult'
example:
AvailabilityBlocks:
- Id: 5ee074b1-6c86-48e8-915f-c7aa4702086f
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda
VoucherId: null
BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72
CompanyId: null
TravelAgencyId: null
Budget:
Currency: USD
Value: 48.0
Net: null
Tax: null
TaxRate: null
State: Confirmed
ReservationPurpose: Business
CreatedUtc: '2020-11-04T13:00:00Z'
UpdatedUtc: '2020-11-05T16:11:38Z'
FirstTimeUnitStartUtc: '2021-07-05T00:00:00Z'
LastTimeUnitStartUtc: '2021-07-15T00:00:00Z'
ReleasedUtc: '2021-07-04T00:00:00Z'
RollingReleaseOffset: null
ExternalIdentifier: Block-1002
Name: Mr. Smith's block
Notes: Welcome to Washington
PickupDistribution: AllInOneGroup
IsActive: false
QuoteId: null
AvailabilityBlockNumber: '478'
ReleaseStrategy: FixedRelease
PurchaseOrderNumber: XX-123
BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed
CanceledUtc: null
CancellationReason: null
CancellationReasonDetail: null
- Id: c32386aa-1cd2-414a-a823-489325842fbe
EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94
RateId: ed4b660b-19d0-434b-9360-a4de2ea42eda
VoucherId: null
BookerId: ebd507c5-6bfd-4ca9-96aa-ffed6fa94f72
CompanyId: null
TravelAgencyId: null
Budget:
Currency: USD
Value: 48.0
Net: null
Tax: null
TaxRate: null
State: Canceled
ReservationPurpose: Leisure
CreatedUtc: '2022-10-11T13:32:32Z'
UpdatedUtc: '2022-10-11T13:32:32Z'
FirstTimeUnitStartUtc: '2022-10-14T00:00:00Z'
LastTimeUnitStartUtc: '2022-11-17T00:00:00Z'
ReleasedUtc: null
RollingReleaseOffset: P-3DT4H
ExternalIdentifier: Block-0002
Name: Rolling release
Notes: null
PickupDistribution: AllInOneGroup
IsActive: false
QuoteId: 67eaf3c8-81e0-4ffb-b5f2-2b61803feb9c
AvailabilityBlockNumber: '479'
ReleaseStrategy: RollingRelease
PurchaseOrderNumber: null
BusinessSegmentId: dc9188f6-fb61-412c-b3fd-af32dab082ed
CanceledUtc: '2022-10-12T15:12:49Z'
CancellationReason: ForceMajeure
CancellationReasonDetail: Event was canceled due to rain.
ServiceOrders: null
Adjustments:
- Id: e19297af-373e-4701-b4ea-afae0129bded
AvailabilityBlockId: 5ee074b1-6c86-48e8-915f-c7aa4702086f
ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f
StartUtc: null
EndUtc: null
FirstTimeUnitStartUtc: '2021-10-14T00:00:00Z'
LastTimeUnitStartUtc: '2021-10-17T00:00:00Z'
UnitCount: 6
ActivityState: Active
ReleaseOverrideUtc: '2021-10-13T00:00:00Z'
UpdatedUtc: '2021-10-21T13:32:32Z'
IsActive: false
PaxCounts: null
FirstTimeUnitReleaseUtc: '2021-10-13T00:00:00Z'
Rates: null
Cursor: c32386aa-1cd2-414a-a823-489325842fbe
'400':
description: 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).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'401':
description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'403':
description: 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.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'408':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts)
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'204':
description: Server has successfully fulfilled the request and there is no additional information to send back.
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'429':
description: 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](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
'500':
description: 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](https://github.com/MewsSystems/gitbook-connector-api).
content:
application/json:
schema:
$ref: '#/components/schemas/ConnectorApiExceptionResult'
components:
schemas:
Unit:
type: object
additionalProperties: false
Limitation:
title: Limitation
required:
- Count
type: object
properties:
Count:
type: integer
format: int32
Cursor:
type: string
format: uuid
nullable: true
additionalProperties: false
description: Limitation on the quantity of data returned.
x-schema-id: Limitation
AvailabilityBlockParameters:
title: AvailabilityBlockParameters
required:
- AccessToken
- Client
- ClientToken
- Extent
- Limitation
type: object
properties:
ClientToken:
minLength: 1
type: string
description: Token identifying the client application.
AccessToken:
minLength: 1
type: string
description: Access token of the client application.
Client:
minLength: 1
type: string
description: Name and version of the client application.
Limitation:
# --- truncated at 32 KB (89 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/mews/refs/heads/main/openapi/mews-availability-blocks-api-openapi.yml