openapi: 3.0.4 info: title: BookingEngineApi Account notes Rate groups API version: v1 servers: - url: https://api.mews.com tags: - name: Rate groups paths: /api/connector/v1/rateGroups/getAll: post: tags: - Rate groups summary: Get all rate groups description: Returns all rate groups, filtered by 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: rateGroups_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/RateGroupFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 RateGroupIds: - 6b3f718a-b537-45b0-a8ee-d30897723834 ServiceIds: - bd26d8db-86da-4f96-9efc-e5a4654a4a94 ExternalIdentifiers: - RG-001 UpdatedUtc: StartUtc: '2024-01-27T11:48:57Z' EndUtc: '2024-02-27T11:48:57Z' ActivityStates: - Active EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 1000 Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RateGroupResult' example: RateGroups: - Id: 6b3f718a-b537-45b0-a8ee-d30897723834 ServiceId: bd26d8db-86da-4f96-9efc-e5a4654a4a94 IsActive: true CreatedUtc: '2023-01-11T13:32:32Z' UpdatedUtc: '2023-01-13T15:27:28Z' Ordering: 0 Names: en-US: Default group ShortNames: en-US: Default group Descriptions: en-US: Default group ExternalIdentifier: RG-001 Cursor: 6b3f718a-b537-45b0-a8ee-d30897723834 '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: RateGroup: title: Rate Group required: - CreatedUtc - Id - IsActive - Names - Ordering - ServiceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the rate group. format: uuid ServiceId: type: string description: Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service) the rate group belongs to. format: uuid IsActive: type: boolean description: Whether the rate group is still active. CreatedUtc: minLength: 1 type: string description: Creation date and time of the rate group in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the rate group in UTC timezone in ISO 8601 format. format: date-time Ordering: type: integer description: Ordering of the rate group. format: int32 Names: title: Localized text type: object additionalProperties: type: string description: All translations of the name. x-schema-id: LocalizedStrings ShortNames: title: Localized text type: object additionalProperties: type: string description: All translations of the short name. nullable: true x-schema-id: LocalizedStrings Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. nullable: true x-schema-id: LocalizedStrings ExternalIdentifier: maxLength: 255 type: string description: Identifier of the rate group from external system. nullable: true additionalProperties: false x-schema-id: RateGroup RateGroupResult: title: RateGroupResult required: - RateGroups type: object properties: RateGroups: maxItems: 1000 type: array items: $ref: '#/components/schemas/RateGroup' description: The filtered rate groups. Cursor: type: string description: Unique identifier of the last and hence oldest rate group returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older rate groups. format: uuid nullable: true additionalProperties: false x-schema-id: RateGroupResult ActivityStates: title: Activity state enum: - Deleted - Active type: string description: Activity states used for filtering. ConnectorApiExceptionResult: title: ConnectorApiExceptionResult type: object properties: Message: type: string nullable: true RequestId: type: string nullable: true Details: nullable: true additionalProperties: false x-schema-id: ConnectorApiExceptionResult TimeFilterInterval: title: Time interval type: object properties: StartUtc: type: string format: date-time nullable: true EndUtc: type: string format: date-time nullable: true additionalProperties: false description: "When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:\r\n\r\n- **Start equals End (equality mode)** \r\n If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\r\n \r\n ```\r\n CreatedUtc == StartUtc\r\n ```\r\n \r\n This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\r\n\r\n- **Start differs from End (interval mode)** \r\n If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\r\n \r\n ```\r\n StartUtc <= CreatedUtc < EndUtc\r\n ```\r\n \r\n In other words, the start is inclusive and the end is exclusive.\r\n\r\nMake sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted." x-schema-id: TimeFilterInterval RateGroupFilterParameters: title: RateGroupFilterParameters required: - AccessToken - Client - ClientToken - 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: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. nullable: true RateGroupIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Rate group](https://mews-systems.gitbook.io/connector-api/operations/#rate-group). Required if ServiceIds filter is not provided. nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service). Required if RateGroupIds filter is not provided. nullable: true ExternalIdentifiers: maxItems: 1000 minItems: 1 type: array items: type: string description: Identifiers of [Rate group](https://mews-systems.gitbook.io/connector-api/operations/#rate-group) from external systems. nullable: true UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the rate groups were updated. nullable: true x-max-interval-in-months: 3 ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted or both records. nullable: true additionalProperties: false x-schema-id: RateGroupFilterParameters 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