Skip to content

Get all reservation groups

POST
/api/connector/v1/reservationGroups/getAll

Returns all reservation groups, filtered by unique identifiers and other filters. Note this operation uses Pagination and supports Portfolio Access Tokens.

ReservationGroupFilterParameters
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
Limitation
required

Limitation on the quantity of data returned and optional Cursor for the starting point of data.

object
Count
required
integer format: int32
Cursor
string format: uuid
nullable
EnterpriseIds

Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token.

Array<string>
nullable >= 1 items <= 1000 items
ReservationGroupIds

Unique identifiers of the Reservation Group. Required if no other filter is provided.

Array<string>
nullable >= 1 items <= 1000 items
UpdatedUtc
TimeFilterInterval
object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
Example
{
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
"Client": "Sample Client 1.0.0",
"EnterpriseIds": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"4d0201db-36f5-428b-8d11-4f0a65e960cc"
],
"ReservationGroupIds": [
"fe795f96-0b64-445b-89ed-c032563f2bac"
],
"UpdatedUtc": {
"StartUtc": "2023-04-27T11:48:57Z",
"EndUtc": "2023-04-27T11:48:57Z"
},
"Limitation": {
"Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7",
"Count": 100
}
}

OK

ReservationGroupResult
object
ReservationGroups
required

The filtered reservation groups.

Array<object>
<= 1000 items
Reservation Group
object
Id
required

Unique identifier of the reservation group.

string format: uuid
Name
required

Name of the reservation group, might be empty or same for multiple groups.

string
>= 1 characters
ChannelManager

Name of the corresponding channel manager.

string
nullable
ChannelManagerGroupNumber

Identifier of the channel manager.

string
nullable
EnterpriseId
required

Unique identifier of the Enterprise the reservation group belongs to.

string format: uuid
Cursor

Unique identifier of the last and hence oldest reservation group returned. This can be used in Limitation in a subsequent request to fetch the next batch of older reservation groups.

string format: uuid
nullable
Example
{
"ReservationGroups": [
{
"Id": "769fc613-838f-41a7-ac2a-aff100c3189f",
"EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"Name": "Mr and Mrs smith wedding",
"ChannelManager": "2023-04-27T11:48:57Z",
"ChannelManagerGroupNumber": "152fg645-834f-63a7-he6a-vsy845c4753a"
}
],
"Cursor": "723jd664-235f-36a4-tg6d-gfy850c645f"
}

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