openapi: 3.0.4 info: title: Mews Connector API — Resources and Spaces description: General-purpose API that enables partners of Mews to access data and services in Mews Operations This modular spec covers the Resources and Spaces domain (15 operations). termsOfService: https://www.mews.com/en/terms-conditions/partners contact: name: Partner success email: partnersuccess@mews.com version: v1 x-generated-from: documentation x-source-url: https://api.mews.com/Swagger/connector/swagger.json x-last-validated: '2026-06-02' paths: /api/connector/v1/resourceAccessTokens/getAll: post: tags: - Resource access tokens summary: Mews Get All Resource Access Tokens description: "Returns all resource access tokens based on resource access token identifiers, reservations or interval. One of them must be specified in the request. \nNote 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: resourceAccessTokens_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceAccessTokenFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ResourceAccessTokenIds: - 90eff5aa-36b4-4689-80c0-ab3a00bb412e ServiceOrderIds: - 65eff5aa-36b4-4689-80c0-ab3a00bb412e CollidingUtc: StartUtc: '2020-02-15T00:00:00Z' EndUtc: '2020-02-20T00:00:00Z' UpdatedUtc: StartUtc: '2020-01-05T00:00:00Z' EndUtc: '2020-01-10T00:00:00Z' ActivityStates: - Active Limitation: Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceAccessTokenResult' example: ResourceAccessTokens: - Id: 72d4b117-1f84-44a3-1f84-8b2c0635ac60 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceOrderId: 35d4b117-4e60-44a3-9580-c582117eff98 CompanionshipId: 25d4b117-4e60-44a3-9580-c582117eff98 ResourceId: 65d4b117-4e60-44a3-9580-c582117eff98 Type: PinCode Value: 1234# SerialNumber: ValidityStartUtc: '2020-10-09T22:00:00Z' ValidityEndUtc: '2020-10-10T22:00:00Z' CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsActive: true Permissions: Bed: true Room: false Floor: false Building: false '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' examples: ResourceAccessTokensGetAll400Example: summary: Default resourceAccessTokens_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensGetAll401Example: summary: Default resourceAccessTokens_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensGetAll403Example: summary: Default resourceAccessTokens_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensGetAll408Example: summary: Default resourceAccessTokens_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensGetAll204Example: summary: Default resourceAccessTokens_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensGetAll429Example: summary: Default resourceAccessTokens_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensGetAll500Example: summary: Default resourceAccessTokens_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: &id001 delay: 0 dispatcher: FALLBACK /api/connector/v1/resourceAccessTokens/add: post: tags: - Resource access tokens summary: Mews Add Resource Access Tokens description: Adds new resource access tokens with the specified data. operationId: resourceAccessTokens_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleResourceAccessTokenParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceAccessTokenParameters: - ServiceOrderId: 35d4b117-4e60-44a3-9580-c582117eff98 CompanionshipId: 25d4b117-4e60-44a3-9580-c582117eff98 ResourceId: 65d4b117-4e60-44a3-9580-c582117eff98 Type: PinCode Value: 1234# SerialNumber: ValidityStartUtc: '2020-10-09T22:00:00Z' ValidityEndUtc: '2020-10-10T22:00:00Z' Permissions: Bed: Value: true Room: Value: false Floor: Value: false Building: Value: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceAccessTokenAdditionResult' example: ResourceAccessTokens: - Id: 72d4b117-1f84-44a3-1f84-8b2c0635ac60 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceOrderId: 35d4b117-4e60-44a3-9580-c582117eff98 CompanionshipId: 25d4b117-4e60-44a3-9580-c582117eff98 ResourceId: 65d4b117-4e60-44a3-9580-c582117eff98 Type: PinCode Value: 1234# SerialNumber: ValidityStartUtc: '2020-10-09T22:00:00Z' ValidityEndUtc: '2020-10-10T22:00:00Z' CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsActive: true Permissions: Bed: true Room: false Floor: false Building: false '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' examples: ResourceAccessTokensAdd400Example: summary: Default resourceAccessTokens_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensAdd401Example: summary: Default resourceAccessTokens_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensAdd403Example: summary: Default resourceAccessTokens_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensAdd408Example: summary: Default resourceAccessTokens_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensAdd204Example: summary: Default resourceAccessTokens_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensAdd429Example: summary: Default resourceAccessTokens_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensAdd500Example: summary: Default resourceAccessTokens_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceAccessTokens/update: post: tags: - Resource access tokens summary: Mews Update Resource Access Tokens description: Updates the [Resource access token](https://mews-systems.gitbook.io/connector-api/operations/#resource-access-token) validity interval and [permissions](https://mews-systems.gitbook.io/connector-api/operations/#resource-access-token-permission-parameter) that it grants. operationId: resourceAccessTokens_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleResourceAccessTokenUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceAccessTokenUpdates: - ResourceAccessTokenId: 35d4b117-4e60-44a3-9580-c582117eff98 ValidityStartUtc: Value: '2020-10-09T22:00:00Z' ValidityEndUtc: Value: '2020-10-10T22:00:00Z' Permissions: Bed: Value: true Room: Value: false Floor: Value: false Building: Value: false responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceAccessTokenUpdateResult' example: ResourceAccessTokens: - Id: 72d4b117-1f84-44a3-1f84-8b2c0635ac60 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceOrderId: 35d4b117-4e60-44a3-9580-c582117eff98 CompanionshipId: 25d4b117-4e60-44a3-9580-c582117eff98 ResourceId: 65d4b117-4e60-44a3-9580-c582117eff98 Type: PinCode Value: 1234# SerialNumber: ValidityStartUtc: '2020-10-09T22:00:00Z' ValidityEndUtc: '2020-10-10T22:00:00Z' CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' IsActive: true Permissions: Bed: true Room: false Floor: false Building: false '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' examples: ResourceAccessTokensUpdate400Example: summary: Default resourceAccessTokens_update 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensUpdate401Example: summary: Default resourceAccessTokens_update 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensUpdate403Example: summary: Default resourceAccessTokens_update 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensUpdate408Example: summary: Default resourceAccessTokens_update 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensUpdate204Example: summary: Default resourceAccessTokens_update 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensUpdate429Example: summary: Default resourceAccessTokens_update 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensUpdate500Example: summary: Default resourceAccessTokens_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceAccessTokens/delete: post: tags: - Resource access tokens summary: Mews Delete Resource Access Tokens description: Delete specified resource access tokens. operationId: resourceAccessTokens_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceAccessTokenDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 Ids: - 35d4b117-4e60-44a3-9580-c582117eff98 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ResourceAccessTokensDelete200Example: summary: Default resourceAccessTokens_delete 200 response x-microcks-default: true value: {} '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' examples: ResourceAccessTokensDelete400Example: summary: Default resourceAccessTokens_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensDelete401Example: summary: Default resourceAccessTokens_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensDelete403Example: summary: Default resourceAccessTokens_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensDelete408Example: summary: Default resourceAccessTokens_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensDelete204Example: summary: Default resourceAccessTokens_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensDelete429Example: summary: Default resourceAccessTokens_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceAccessTokensDelete500Example: summary: Default resourceAccessTokens_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceBlocks/getAll: post: tags: - Resource blocks summary: Mews Get All Resource Blocks description: "Returns all resource blocks (out of order blocks or internal use blocks). \nNote 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: resourceBlocks_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceBlockParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceBlockIds: - 7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f - 8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b - 63f4ebee-7e36-4ca9-b7d8-6331a8b009e5 AssignedResourceIds: - 20e00c32-d561-4008-8609-82d8aa525714 - 1ec29188-01ca-4294-9983-fac59f85a448 - a1b2c3d4-e5f6-7890-abcd-ef1234567890 ActivityStates: - Active - Deleted CollidingUtc: StartUtc: '2023-06-01T00:00:00Z' EndUtc: '2023-07-31T23:59:59Z' CreatedUtc: StartUtc: '2023-06-01T00:00:00Z' EndUtc: '2023-08-31T00:00:00Z' UpdatedUtc: StartUtc: '2023-06-01T00:00:00Z' EndUtc: '2023-07-31T23:59:59Z' EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceBlockResult' example: ResourceBlocks: - Id: 7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 IsActive: true Type: OutOfOrder StartUtc: '2023-07-15T14:00:00Z' EndUtc: '2023-07-15T18:00:00Z' CreatedUtc: '2023-07-10T09:30:00Z' UpdatedUtc: '2023-07-10T09:30:00Z' DeletedUtc: Name: Maintenance Block - Room 101 Notes: Scheduled maintenance for air conditioning unit - Id: 8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AssignedResourceId: 1ec29188-01ca-4294-9983-fac59f85a448 IsActive: true Type: InternalUse StartUtc: '2023-07-20T10:00:00Z' EndUtc: '2023-07-22T12:00:00Z' CreatedUtc: '2023-07-18T14:20:00Z' UpdatedUtc: '2023-07-18T14:20:00Z' DeletedUtc: Name: Staff Training Session Notes: - Id: 63f4ebee-7e36-4ca9-b7d8-6331a8b009e5 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AssignedResourceId: a1b2c3d4-e5f6-7890-abcd-ef1234567890 IsActive: false Type: OutOfOrder StartUtc: '2023-06-01T20:00:00Z' EndUtc: '2023-06-03T23:59:59Z' CreatedUtc: '2023-06-01T16:45:00Z' UpdatedUtc: '2023-06-04T08:15:00Z' DeletedUtc: '2023-06-04T08:15:00Z' Name: Renovation Block - Suite 1 Notes: Room renovation completed, block removed Cursor: 9f0a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c '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' examples: ResourceBlocksGetAll400Example: summary: Default resourceBlocks_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksGetAll401Example: summary: Default resourceBlocks_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksGetAll403Example: summary: Default resourceBlocks_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksGetAll408Example: summary: Default resourceBlocks_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksGetAll204Example: summary: Default resourceBlocks_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksGetAll429Example: summary: Default resourceBlocks_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksGetAll500Example: summary: Default resourceBlocks_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceBlocks/add: post: tags: - Resource blocks summary: Mews Add Resource Block description: Adds a new resource block to the specified resource for a defined period of time. operationId: resourceBlocks_add requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleResourceBlockAddParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceBlocks: - ResourceId: 20e00c32-d561-4008-8609-82d8aa525714 Name: Maintenance Block - Room 101 Type: OutOfOrder StartUtc: '2023-08-01T14:00:00Z' EndUtc: '2023-08-01T18:00:00Z' Notes: Scheduled maintenance for air conditioning unit - ResourceId: 1ec29188-01ca-4294-9983-fac59f85a448 Name: Staff Training Session Type: InternalUse StartUtc: '2023-08-05T10:00:00Z' EndUtc: '2023-08-05T16:00:00Z' Notes: Internal training session for new staff members - ResourceId: a1b2c3d4-e5f6-7890-abcd-ef1234567890 Name: Deep Cleaning Block Type: OutOfOrder StartUtc: '2023-08-10T09:00:00Z' EndUtc: '2023-08-10T17:00:00Z' Notes: Deep cleaning and sanitization process responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceBlockAdditionResult' example: ResourceBlocks: - Id: 7f8e9d0c-1b2a-3c4d-5e6f-7a8b9c0d1e2f EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AssignedResourceId: 20e00c32-d561-4008-8609-82d8aa525714 IsActive: true Type: OutOfOrder StartUtc: '2023-08-01T14:00:00Z' EndUtc: '2023-08-01T18:00:00Z' CreatedUtc: '2023-07-25T10:30:00Z' UpdatedUtc: '2023-07-25T10:30:00Z' DeletedUtc: Name: Maintenance Block - Room 101 Notes: Scheduled maintenance for air conditioning unit - Id: 8e9f0a1b-2c3d-4e5f-6a7b-8c9d0e1f2a3b EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AssignedResourceId: 1ec29188-01ca-4294-9983-fac59f85a448 IsActive: true Type: InternalUse StartUtc: '2023-08-05T10:00:00Z' EndUtc: '2023-08-05T16:00:00Z' CreatedUtc: '2023-07-25T10:30:00Z' UpdatedUtc: '2023-07-25T10:30:00Z' DeletedUtc: Name: Staff Training Session Notes: Internal training session for new staff members - Id: 9f0a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 AssignedResourceId: a1b2c3d4-e5f6-7890-abcd-ef1234567890 IsActive: true Type: OutOfOrder StartUtc: '2023-08-10T09:00:00Z' EndUtc: '2023-08-10T17:00:00Z' CreatedUtc: '2023-07-25T10:30:00Z' UpdatedUtc: '2023-07-25T10:30:00Z' DeletedUtc: Name: Deep Cleaning Block Notes: Deep cleaning and sanitization process '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' examples: ResourceBlocksAdd400Example: summary: Default resourceBlocks_add 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksAdd401Example: summary: Default resourceBlocks_add 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksAdd403Example: summary: Default resourceBlocks_add 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksAdd408Example: summary: Default resourceBlocks_add 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksAdd204Example: summary: Default resourceBlocks_add 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksAdd429Example: summary: Default resourceBlocks_add 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksAdd500Example: summary: Default resourceBlocks_add 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceBlocks/delete: post: tags: - Resource blocks summary: Mews Delete Resource Blocks description: Removes specified resource blocks from the resources. operationId: resourceBlocks_delete requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceBlockDeleteParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceBlockIds: - 63f4ebee-7e36-4ca9-b7d8-6331a8b009e5 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' examples: ResourceBlocksDelete200Example: summary: Default resourceBlocks_delete 200 response x-microcks-default: true value: {} '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' examples: ResourceBlocksDelete400Example: summary: Default resourceBlocks_delete 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksDelete401Example: summary: Default resourceBlocks_delete 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksDelete403Example: summary: Default resourceBlocks_delete 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksDelete408Example: summary: Default resourceBlocks_delete 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksDelete204Example: summary: Default resourceBlocks_delete 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksDelete429Example: summary: Default resourceBlocks_delete 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceBlocksDelete500Example: summary: Default resourceBlocks_delete 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceCategories/getAll: post: tags: - Resource categories summary: Mews Get All Resource Categories description: Returns all categories of resources. This operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/). operationId: resourceCategories_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceCategoryFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ResourceCategoryIds: - 5c0804f9-d03a-4b13-a57d-b00300781a41 - 47d6b462-35ec-467e-a565-b00300781a41 ServiceIds: - 9b3a6c54-63aa-4383-b50e-b0030078184b - c0f71466-6c0b-4993-88ac-1794f6b7e958 UpdatedUtc: StartUtc: '2023-05-05T00:00:00Z' EndUtc: '2023-05-10T00:00:00Z' ActivityStates: - Active Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCategoryResult' example: ResourceCategories: - Id: 5c0804f9-d03a-4b13-a57d-b00300781a41 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 ServiceId: 9b3a6c54-63aa-4383-b50e-b0030078184b IsActive: true Type: Bed Names: en-US: Bed 1 ShortNames: en-US: Bed 1 Descriptions: {} Ordering: 2 Capacity: 1 ExtraCapacity: 0 ExternalIdentifier: - Id: 47d6b462-35ec-467e-a565-b00300781a41 EnterpriseId: 4d0201db-36f5-428b-8d11-4f0a65e960cc ServiceId: c0f71466-6c0b-4993-88ac-1794f6b7e958 IsActive: true Type: Dorm Names: en-US: Dorm 1 ShortNames: en-US: Dorm 1 Descriptions: {} Ordering: 1 Capacity: 4 ExtraCapacity: 0 ExternalIdentifier: Cursor: 47d6b462-35ec-467e-a565-b00300781a41 '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' examples: ResourceCategoriesGetAll400Example: summary: Default resourceCategories_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoriesGetAll401Example: summary: Default resourceCategories_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoriesGetAll403Example: summary: Default resourceCategories_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoriesGetAll408Example: summary: Default resourceCategories_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoriesGetAll204Example: summary: Default resourceCategories_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoriesGetAll429Example: summary: Default resourceCategories_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoriesGetAll500Example: summary: Default resourceCategories_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceCategoryAssignments/getAll: post: tags: - Resource categories summary: Mews Get All Resource Category Assignments description: Returns all resource category assignments. This operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/). operationId: resourceCategoryAssignments_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceCategoryAssignmentFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceCategoryAssignmentIds: - fb69fc51-c4e9-4ef6-874a-24bcfe74a894 - 28704948-77df-4bb4-8f39-f8380dc8a914 ResourceCategoryIds: - 5c0804f9-d03a-4b13-a57d-b00300781a41 - 47d6b462-35ec-467e-a565-b00300781a41 UpdatedUtc: StartUtc: '2023-11-01T00:00:00Z' EndUtc: '2023-11-30T00:00:00Z' ActivityStates: - Active ResourceIds: - 5ee074b1-6c86-48e8-915f-c7aa4702086f - c32386aa-1cd2-414a-a823-489325842fbe EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 10 Cursor: e7f26210-10e7-462e-9da8-ae8300be8ab7 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCategoryAssignmentResult' example: ResourceCategoryAssignments: - Id: fb69fc51-c4e9-4ef6-874a-24bcfe74a894 ResourceId: e5a34a69-d35e-4e85-a645-a9bc4ee3a80f CategoryId: 5c0804f9-d03a-4b13-a57d-b00300781a41 IsActive: true CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' - Id: 28704948-77df-4bb4-8f39-f8380dc8a914 ResourceId: 90908a65-35fc-4856-b659-106f60b591e5 CategoryId: 47d6b462-35ec-467e-a565-b00300781a41 IsActive: true CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' Cursor: 28704948-77df-4bb4-8f39-f8380dc8a914 '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' examples: ResourceCategoryAssignmentsGetAll400Example: summary: Default resourceCategoryAssignments_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryAssignmentsGetAll401Example: summary: Default resourceCategoryAssignments_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryAssignmentsGetAll403Example: summary: Default resourceCategoryAssignments_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryAssignmentsGetAll408Example: summary: Default resourceCategoryAssignments_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryAssignmentsGetAll204Example: summary: Default resourceCategoryAssignments_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryAssignmentsGetAll429Example: summary: Default resourceCategoryAssignments_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryAssignmentsGetAll500Example: summary: Default resourceCategoryAssignments_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceCategoryImageAssignments/getAll: post: tags: - Resource categories summary: Mews Get All Resource Category Image Assignments description: Returns all resource category image assignments. This operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/). operationId: resourceCategoryImageAssignments_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceCategoryImageAssignmentFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceCategoryImageAssignmentIds: - edb5f556-7afb-4650-8d4e-8c0a6fff784d - 9d18f5fb-cce5-4e70-9561-f7804262344b ResourceCategoryIds: - 773d5e42-de1e-43a0-9ce6-f940faf2303f - 47d6b462-35ec-467e-a565-b00300781a41 UpdatedUtc: StartUtc: '2023-11-01T00:00:00Z' EndUtc: '2023-11-30T00:00:00Z' ActivityStates: - Active EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceCategoryImageAssignmentResult' example: ResourceCategoryImageAssignments: - Id: edb5f556-7afb-4650-8d4e-8c0a6fff784d IsActive: true CategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f ImageId: e910d008-fded-4af5-a84f-c00f92e3947d CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' Ordering: 0 - Id: 9d18f5fb-cce5-4e70-9561-f7804262344b IsActive: true CategoryId: 47d6b462-35ec-467e-a565-b00300781a41 ImageId: 11056cdb-2045-49e0-821f-2b93905ff522 CreatedUtc: '2023-10-01T11:48:57Z' UpdatedUtc: '2023-10-28T11:48:57Z' Ordering: 0 Cursor: 9d18f5fb-cce5-4e70-9561-f7804262344b '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' examples: ResourceCategoryImageAssignmentsGetAll400Example: summary: Default resourceCategoryImageAssignments_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryImageAssignmentsGetAll401Example: summary: Default resourceCategoryImageAssignments_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryImageAssignmentsGetAll403Example: summary: Default resourceCategoryImageAssignments_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryImageAssignmentsGetAll408Example: summary: Default resourceCategoryImageAssignments_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryImageAssignmentsGetAll204Example: summary: Default resourceCategoryImageAssignments_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryImageAssignmentsGetAll429Example: summary: Default resourceCategoryImageAssignments_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceCategoryImageAssignmentsGetAll500Example: summary: Default resourceCategoryImageAssignments_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceFeatureAssignments/getAll: post: tags: - Resource features summary: Mews Get All Resource Feature Assignments description: Returns all resource feature assignments. This operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/). operationId: resourceFeatureAssignments_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceFeatureAssignmentFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ResourceFeatureIds: - a693dd8c-21fe-4dae-b450-ea3bd9ab3bb0 ResourceFeatureAssignmentIds: - ca2b5bf9-24f5-4faa-95ef-b65d38598b08 UpdatedUtc: StartUtc: '2023-11-01T00:00:00Z' EndUtc: '2023-11-30T00:00:00Z' ActivityStates: - Active Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceFeatureAssignmentResult' example: ResourceFeatureAssignments: - Id: ca2b5bf9-24f5-4faa-95ef-b65d38598b08 IsActive: true ResourceId: 18019693-c66f-4be8-a893-c3d89fd291cc FeatureId: a693dd8c-21fe-4dae-b450-ea3bd9ab3bb0 CreatedUtc: '2023-11-03T00:00:00Z' UpdatedUtc: '2023-11-21T00:00:00Z' Cursor: 3d5201ad-4a7b-4cbe-9c22-03dd79c28443 '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' examples: ResourceFeatureAssignmentsGetAll400Example: summary: Default resourceFeatureAssignments_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeatureAssignmentsGetAll401Example: summary: Default resourceFeatureAssignments_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeatureAssignmentsGetAll403Example: summary: Default resourceFeatureAssignments_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeatureAssignmentsGetAll408Example: summary: Default resourceFeatureAssignments_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeatureAssignmentsGetAll204Example: summary: Default resourceFeatureAssignments_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeatureAssignmentsGetAll429Example: summary: Default resourceFeatureAssignments_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeatureAssignmentsGetAll500Example: summary: Default resourceFeatureAssignments_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resourceFeatures/getAll: post: tags: - Resource features summary: Mews Get All Resource Features description: Returns all resource features. This operation uses [Pagination](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/). operationId: resourceFeatures_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceFeatureFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc ServiceIds: - 24e2ead5-65a8-4ed9-8286-abdb00f08a1f ResourceFeatureIds: - 3d5201ad-4a7b-4cbe-9c22-03dd79c28443 UpdatedUtc: StartUtc: '2023-11-01T00:00:00Z' EndUtc: '2023-11-30T00:00:00Z' ActivityStates: - Active Limitation: Count: 10 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceFeatureResult' example: ResourceFeatures: - Id: 3d5201ad-4a7b-4cbe-9c22-03dd79c28443 ServiceId: 24e2ead5-65a8-4ed9-8286-abdb00f08a1f IsActive: true Classification: AccessibleBathroom Names: en-US: Accessible Bathroom ShortNames: en-US: AccessBath Descriptions: {} Cursor: 3d5201ad-4a7b-4cbe-9c22-03dd79c28443 '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' examples: ResourceFeaturesGetAll400Example: summary: Default resourceFeatures_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeaturesGetAll401Example: summary: Default resourceFeatures_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeaturesGetAll403Example: summary: Default resourceFeatures_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeaturesGetAll408Example: summary: Default resourceFeatures_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeaturesGetAll204Example: summary: Default resourceFeatures_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeaturesGetAll429Example: summary: Default resourceFeatures_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourceFeaturesGetAll500Example: summary: Default resourceFeatures_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resources/getAll: post: tags: - Resources summary: Mews Get All Resources description: 'Returns all resources of an enterprise associated with the connector integration. Note that when any of the extents is set to `true`, the response contains the entities that are associated to a resource. If the extent is not associated to a resource (e.g. resource category not assigned to any resource), this information is not returned. 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: resources_getAll requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourceFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceIds: - 20e00c32-d561-4008-8609-82d8aa525714 - 1ec29188-01ca-4294-9983-fac59f85a448 - a1b2c3d4-e5f6-7890-abcd-ef1234567890 Names: - '101' - '102' - Suite 1 Extent: Resources: true ResourceCategories: false ResourceCategoryAssignments: false ResourceCategoryImageAssignments: false ResourceFeatures: false ResourceFeatureAssignments: false Inactive: false CreatedUtc: StartUtc: '2023-01-01T00:00:00Z' EndUtc: '2023-12-31T23:59:59Z' UpdatedUtc: StartUtc: '2023-06-01T00:00:00Z' EndUtc: '2023-06-30T23:59:59Z' EnterpriseIds: - 3fa85f64-5717-4562-b3fc-2c963f66afa6 - 4d0201db-36f5-428b-8d11-4f0a65e960cc Limitation: Count: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourceResult' example: Resources: - Id: 20e00c32-d561-4008-8609-82d8aa525714 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 IsActive: true ParentResourceId: Name: '101' State: Clean Descriptions: en-US: Standard room with city view CreatedUtc: '2023-01-15T10:30:00Z' UpdatedUtc: '2023-06-15T14:20:00Z' Data: Discriminator: Space Value: FloorNumber: '1' LocationNotes: Building A, near elevator ExternalNames: en-US: Room 101 Directions: en-US: Take elevator to first floor, turn right - Id: 1ec29188-01ca-4294-9983-fac59f85a448 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 IsActive: true ParentResourceId: 20e00c32-d561-4008-8609-82d8aa525714 Name: 101A State: Inspected Descriptions: en-US: Bed in room 101 CreatedUtc: '2023-01-15T10:35:00Z' UpdatedUtc: '2023-06-15T14:25:00Z' Data: Discriminator: Object Value: {} ExternalNames: en-US: Bed A Directions: en-US: Located in room 101 - Id: a1b2c3d4-e5f6-7890-abcd-ef1234567890 EnterpriseId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 IsActive: true ParentResourceId: Name: Suite 1 State: Dirty Descriptions: en-US: Luxury suite with ocean view CreatedUtc: '2023-02-01T09:00:00Z' UpdatedUtc: '2023-06-20T16:45:00Z' Data: Discriminator: Space Value: FloorNumber: '5' LocationNotes: Penthouse level, private elevator access ExternalNames: en-US: Presidential Suite Directions: en-US: Private elevator to penthouse level ResourceCategories: ResourceCategoryAssignments: ResourceCategoryImageAssignments: ResourceFeatures: ResourceFeatureAssignments: Cursor: a1b2c3d4-e5f6-7890-abcd-ef1234567890 '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' examples: ResourcesGetAll400Example: summary: Default resources_getAll 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetAll401Example: summary: Default resources_getAll 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetAll403Example: summary: Default resources_getAll 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetAll408Example: summary: Default resources_getAll 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetAll204Example: summary: Default resources_getAll 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetAll429Example: summary: Default resources_getAll 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetAll500Example: summary: Default resources_getAll 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resources/update: post: tags: - Resources summary: Mews Update Resources description: Updates details of the resources. operationId: resources_update requestBody: content: application/json: schema: $ref: '#/components/schemas/MultipleResourceUpdateParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceUpdates: - ResourceId: 20e00c32-d561-4008-8609-82d8aa525714 Name: Value: 101 Updated Data: Discriminator: Space Value: FloorNumber: Value: '2' LocationNotes: Value: Updated location notes State: Value: Inspected StateReason: Value: Room inspection completed - ResourceId: 1ec29188-01ca-4294-9983-fac59f85a448 Name: Value: '102' ParentResourceId: Value: 20e00c32-d561-4008-8609-82d8aa525714 State: Value: Clean - ResourceId: a1b2c3d4-e5f6-7890-abcd-ef1234567890 State: Value: OutOfService StateReason: Value: Maintenance required responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Unit' example: {} '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' examples: ResourcesUpdate400Example: summary: Default resources_update 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesUpdate401Example: summary: Default resources_update 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesUpdate403Example: summary: Default resources_update 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesUpdate408Example: summary: Default resources_update 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesUpdate204Example: summary: Default resources_update 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesUpdate429Example: summary: Default resources_update 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesUpdate500Example: summary: Default resources_update 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-microcks-operation: *id001 /api/connector/v1/resources/getOccupancyState: post: tags: - Resources summary: Mews Get Resources' Occupancy State description: Returns the occupancy state of the specified resources. This operation returns the occupancy state for the current day. Note this operation supports [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property/). operationId: resources_getOccupancyState requestBody: content: application/json: schema: $ref: '#/components/schemas/ResourcesOccupancyStateFilterParameters' example: ClientToken: E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D AccessToken: C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D Client: Sample Client 1.0.0 ResourceCategoryIds: - 773d5e42-de1e-43a0-9ce6-f940faf2303f ResourceStates: - Clean - Inspected OccupancyStates: - Vacant - Reserved responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResourcesOccupancyStateResult' example: ResourceCategoryOccupancyStates: - ResourceCategoryId: 773d5e42-de1e-43a0-9ce6-f940faf2303f ResourceOccupancyStates: - ResourceId: f3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b ResourceState: Inspected OccupancyState: Reserved - ResourceId: c32386aa-1cd2-414a-a823-489325842fbe ResourceState: Inspected OccupancyState: Vacant '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' examples: ResourcesGetOccupancyState400Example: summary: Default resources_getOccupancyState 400 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetOccupancyState401Example: summary: Default resources_getOccupancyState 401 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetOccupancyState403Example: summary: Default resources_getOccupancyState 403 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetOccupancyState408Example: summary: Default resources_getOccupancyState 408 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetOccupancyState204Example: summary: Default resources_getOccupancyState 204 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetOccupancyState429Example: summary: Default resources_getOccupancyState 429 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string '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' examples: ResourcesGetOccupancyState500Example: summary: Default resources_getOccupancyState 500 response x-microcks-default: true value: Message: string RequestId: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: string x-restricted: true x-microcks-operation: *id001 components: schemas: ResourceCategoryOccupancyState: title: Resource category occupancy state required: - ResourceCategoryId - ResourceOccupancyStates type: object properties: ResourceCategoryId: type: string description: Unique identifier of the 'Resource category'. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceOccupancyStates: type: array items: $ref: '#/components/schemas/ResourceOccupancyState' description: The resource occupancy states. additionalProperties: false description: The list of `ResourceOccupancyState`s grouped by resource category. x-schema-id: ResourceCategoryOccupancyState ResourceCategoryImageAssignmentResult: title: ResourceCategoryImageAssignmentResult required: - ResourceCategoryImageAssignments type: object properties: ResourceCategoryImageAssignments: maxItems: 1000 type: array items: $ref: '#/components/schemas/ResourceCategoryImageAssignment' description: Resource category image assignments. Cursor: type: string description: Unique identifier of the last and hence oldest resource category image assignment 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 resource category image assignments. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceCategoryImageAssignmentResult ResourceBlockType: title: Resource block type enum: - OutOfOrder - InternalUse type: string description: Type of the resource block. ResourceOccupancyState: title: Resource occupancy state required: - OccupancyState - ResourceId - ResourceState type: object properties: ResourceId: type: string description: Unique identifier of the resource. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceState: title: Resource state allOf: - $ref: '#/components/schemas/ResourceState' description: 'Resource state of the resource. Dirty Clean Inspected OutOfService OutOfOrder' x-enumNames: - Dirty - Clean - Inspected - OutOfService - OutOfOrder x-enumDescriptions: - '' - '' - '' - '' - '' x-schema-id: ResourceState example: string OccupancyState: title: Occupancy state allOf: - $ref: '#/components/schemas/OccupancyStateEnum' description: 'State of the resource. Vacant ReservedLocked Reserved InternalUse OutOfOrder' x-enumNames: - Vacant - ReservedLocked - Reserved - InternalUse - OutOfOrder x-enumDescriptions: - '' - '' - '' - '' - '' example: string additionalProperties: false description: The occupancy state of a `Resource`. x-schema-id: ResourceOccupancyState ResourceBlock: title: Resource block required: - AssignedResourceId - CreatedUtc - EndUtc - EnterpriseId - Id - IsActive - Name - StartUtc - Type - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the resource block. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the `Enterprise` the resource block belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AssignedResourceId: type: string description: Unique identifier of the assigned `Resource`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the resource block is still active. example: true Type: $ref: '#/components/schemas/ResourceBlockType' StartUtc: minLength: 1 type: string description: Start of the resource block in UTC timezone in ISO 8601 format. example: string EndUtc: minLength: 1 type: string description: End of the resource block in UTC timezone in ISO 8601 format. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the resource block in UTC timezone in ISO 8601 format. example: string UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource block in UTC timezone in ISO 8601 format. example: string DeletedUtc: type: string description: Date and time when the resource block was deleted (for inactive ones) in UTC timezone in ISO 8601 format. nullable: true example: string Name: minLength: 1 type: string description: Name of the resource block. example: Example Name Notes: type: string description: Note describing the resource block. nullable: true example: string additionalProperties: false x-schema-id: ResourceBlock ResourceAccessTokenParameters: title: Resource access token parameter required: - Permissions - ServiceOrderId - Type - ValidityEndUtc - ValidityStartUtc - Value type: object properties: ServiceOrderId: type: string description: Unique identifier of a reservation. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanionshipId: type: string description: Unique identifier of `Companionship`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceId: type: string description: Unique identifier of `Resource`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Value: maxLength: 255 minLength: 1 type: string description: Value of the resource access token. example: string Type: $ref: '#/components/schemas/ResourceAccessTokenType' SerialNumber: type: string description: Serial number of the resource access token. nullable: true example: '1001' ValidityStartUtc: minLength: 1 type: string description: Marks the start of interval in which the resource access token can be used. example: string ValidityEndUtc: minLength: 1 type: string description: Marks the end of interval in which the resource access token can be used. example: string Permissions: title: Resource access token permission parameter allOf: - $ref: '#/components/schemas/ResourceAccessTokenPermissionsParameters' description: Specify permissions of the resource access token. example: string additionalProperties: false x-schema-id: ResourceAccessTokenParameters ResourceAccessTokenPermissionsParameters: title: Resource access token permission parameter type: object properties: Bed: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Specify whether the resource access token grants permission to access bed (or null if not being updated). nullable: true example: string Room: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Specify whether the resource access token grants permission to access room (or null if not being updated). nullable: true example: string Floor: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Specify whether the resource access token grants permission to access floor (or null if not being updated). nullable: true example: string Building: title: Boolean update value allOf: - $ref: '#/components/schemas/BooleanUpdateValue' description: Specify whether the resource access token grants permission to access building (or null if not being updated). nullable: true example: string additionalProperties: false x-schema-id: ResourceAccessTokenPermissionsParameters ResourceCategoryType: title: Resource category type enum: - Room - Bed - Dorm - Apartment - Suite - Villa - Site - Office - MeetingRoom - ParkingSpot - Desk - TeamArea - Membership - Tent - CaravanOrRV - UnequippedCampsite - Bike - ExtraBed - Cot - Crib - ConferenceRoom - Rooftop - Garden - Restaurant - Amphitheater - PrivateSpaces type: string description: Type of the category. ResourceClassification: title: Resource classification enum: - StandardSingle - StandardDouble - SuperiorTwin - SuperiorDouble - JuniorSuite - SharedOrDorm - Other - SuperiorSingle - Triple - Family - StandardTwin - Studio - SuperiorTripleRoom - OneBedroomApartment - ThreeBedroomsApartment - TwoBedroomsApartment type: string description: Classification of the resource category. ResourceAccessTokenUpdateResult: title: ResourceAccessTokenUpdateResult required: - ResourceAccessTokens type: object properties: ResourceAccessTokens: type: array items: $ref: '#/components/schemas/ResourceAccessToken' description: Updated resource access tokens. additionalProperties: false x-schema-id: ResourceAccessTokenUpdateResult TimeFilterInterval: title: Time interval type: object properties: StartUtc: type: string format: date-time nullable: true example: '2026-06-02T14:30:00Z' EndUtc: type: string format: date-time nullable: true example: '2026-06-02T14:30:00Z' 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 ResourceFilterParameters: title: ResourceFilterParameters required: - AccessToken - Client - ClientToken - Extent - Limitation type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ResourceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested resources. nullable: true Names: maxItems: 1000 minItems: 1 type: array items: type: string description: Names of the requested resources. nullable: true Extent: title: Resource extent allOf: - $ref: '#/components/schemas/ResourceExtent' description: Extent of data to be returned. example: string CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resources were created. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resources were updated. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: ResourceFilterParameters ResourceBlockDeleteParameters: title: ResourceBlockDeleteParameters required: - AccessToken - Client - ClientToken - ResourceBlockIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ResourceBlockIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifier of the resource blocks to be removed. additionalProperties: false x-schema-id: ResourceBlockDeleteParameters SpaceData: title: Space resource data required: - FloorNumber type: object properties: FloorNumber: minLength: 1 type: string description: Number of the floor the space is on. example: '1001' LocationNotes: type: string description: Location notes for the space. It can be, for example, Building number the space is located in or the Parking area the particular parking space is at. nullable: true example: string additionalProperties: false x-schema-id: SpaceData ResourceFeatureResult: title: ResourceFeatureResult required: - ResourceFeatures type: object properties: ResourceFeatures: maxItems: 1000 type: array items: $ref: '#/components/schemas/ResourceFeature' description: Resource features. Cursor: type: string description: 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. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceFeatureResult ResourceUpdateParameters: title: Resource update required: - ResourceId type: object properties: ResourceId: type: string description: Unique identifier of the `Resource` which is updated. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: New name of the resource (e.g. room number). nullable: true example: Example Name ParentResourceId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the new parent `Resource`. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Data: title: Resource data update type: object properties: Discriminator: $ref: '#/components/schemas/ResourceDataDiscriminator' Value: oneOf: - $ref: '#/components/schemas/SpaceDataUpdateParameters' - title: Object resource data update type: object additionalProperties: false - title: Person resource data update type: object additionalProperties: false description: Based on `Discriminator`. Currently supported only for `Space` resources with [Space resource data update](https://mews-systems.gitbook.io/connector-api/operations/resources#space-resource-data-update). description: New additional data of the resource. nullable: true x-coproduct: true x-schema-id: ResourceUpdateParametersDataCoproductOfResourceDataDiscriminator State: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: New `ResourceState` except `OutOfOrder`. nullable: true example: string StateReason: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: New reason for the state of the resource. nullable: true example: string additionalProperties: false x-schema-id: ResourceUpdateParameters ResourceCategoryImageAssignment: title: Resource category image assignment required: - CategoryId - CreatedUtc - Id - ImageId - IsActive - Ordering - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the assignment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the assignment is still active. example: true CategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ImageId: type: string description: Unique identifier of the image assigned to the Resource category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' Ordering: type: integer description: Ordering of the image in the resource category. format: int32 example: 1 additionalProperties: false x-schema-id: ResourceCategoryImageAssignment ResourceExtent: title: Resource extent type: object properties: Resources: type: boolean description: Whether the response should contain resources. nullable: true example: true ResourceCategories: type: boolean description: Whether the response should contain categories. nullable: true deprecated: true x-deprecatedMessage: Use [Get all resource categories](https://mews-systems.gitbook.io/connector-api/operations/resourcecategories#get-all-resource-categories) example: true ResourceCategoryAssignments: type: boolean description: Whether the response should contain assignments of the resources to categories. nullable: true deprecated: true x-deprecatedMessage: Use [Get all resource category assignments](https://mews-systems.gitbook.io/connector-api/operations/resourcecategories#get-all-resource-category-assignments) example: true ResourceCategoryImageAssignments: type: boolean description: Whether the response should contain assignments of the images to categories. nullable: true deprecated: true x-deprecatedMessage: Use [Get all resource category image assignments](https://mews-systems.gitbook.io/connector-api/operations/resourcecategories#get-all-resource-category-image-assignments) example: true ResourceFeatures: type: boolean description: Whether the response should contain resource features. nullable: true deprecated: true x-deprecatedMessage: Use [Get all resource features](https://mews-systems.gitbook.io/connector-api/operations/resourcefeatures#get-all-resource-features) example: true ResourceFeatureAssignments: type: boolean description: Whether the response should contain assignments of the resources to features. nullable: true deprecated: true x-deprecatedMessage: Use [Get all resource feature assignments](https://mews-systems.gitbook.io/connector-api/operations/resourcefeatures#get-all-resource-feature-assignments) example: true Inactive: type: boolean description: Whether the response should contain inactive entities. nullable: true example: true additionalProperties: false description: '' x-schema-id: ResourceExtent OccupancyStateEnum: title: Occupancy state enum: - Vacant - ReservedLocked - Reserved - InternalUse - OutOfOrder type: string description: 'Occupancy states of the `Resource`. Vacant ReservedLocked Reserved InternalUse OutOfOrder' x-enumNames: - Vacant - ReservedLocked - Reserved - InternalUse - OutOfOrder x-enumDescriptions: - '' - '' - '' - '' - '' StringUpdateValue: title: String update value type: object properties: Value: type: string description: Value which is to be updated. nullable: true example: string additionalProperties: false x-schema-id: StringUpdateValue GuidNullableUpdateValue: title: Guid update value type: object properties: Value: type: string description: Value which is to be updated. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: GuidNullableUpdateValue ResourceAccessToken: title: Resource access token required: - CreatedUtc - EnterpriseId - Id - IsActive - Permissions - ServiceOrderId - Type - UpdatedUtc - ValidityEndUtc - ValidityStartUtc - Value type: object properties: Id: type: string description: Unique identifier of the resource access token. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceOrderId: type: string description: Unique identifier of `Reservation`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CompanionshipId: type: string description: Unique identifier of `Companionship`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceId: type: string description: Unique identifier of `Resource`. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Type: $ref: '#/components/schemas/ResourceAccessTokenType' Value: minLength: 1 type: string description: Value of the resource access token. example: string SerialNumber: type: string description: Serial number of the resource access token. nullable: true example: '1001' ValidityStartUtc: minLength: 1 type: string description: Marks the start of interval in which the resource access token can be used. format: date-time example: '2026-06-02T14:30:00Z' ValidityEndUtc: minLength: 1 type: string description: Marks the end of interval in which the resource access token can be used. format: date-time example: '2026-06-02T14:30:00Z' Permissions: title: Resource access token permissions allOf: - $ref: '#/components/schemas/ResourceAccessTokenPermissions' description: Permissions of the resource access token. example: string CreatedUtc: minLength: 1 type: string description: Creation date and time of the resource access token in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource access token in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' IsActive: type: boolean description: Whether the resource access token is still active. example: true additionalProperties: false x-schema-id: ResourceAccessToken ConnectorApiExceptionResult: title: ConnectorApiExceptionResult type: object properties: Message: type: string nullable: true example: string RequestId: type: string nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Details: nullable: true example: string additionalProperties: false x-schema-id: ConnectorApiExceptionResult ResourceCategoryAssignmentFilterParameters: title: ResourceCategoryAssignmentFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ResourceCategoryIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ResourceCategoryAssignmentIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of [Resource category assignment](https://mews-systems.gitbook.io/connector-api/operations/resourcecategories/#resource-category-assignment). nullable: true ResourceCategoryIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of [Resource categories](https://mews-systems.gitbook.io/connector-api/operations/#resource-category) to which the resource category assignment belong. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resource category assignments were updated. nullable: true example: string ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted or both records. The `ActivityState` filter applies only to record’s own status. The `IsActive` response property also considers the parent’s status, so some returned records may have `IsActive = false` if their parent is deleted. nullable: true ResourceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of resources to which the resource category assignments belong. nullable: true additionalProperties: false x-schema-id: ResourceCategoryAssignmentFilterParameters SpaceDataUpdateParameters: title: Space resource data update type: object properties: FloorNumber: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: New number of the floor the space is on. nullable: true example: '1001' LocationNotes: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: New location notes for the space. nullable: true example: string additionalProperties: false x-schema-id: SpaceDataUpdateParameters ResourceBlockResult: title: ResourceBlockResult required: - ResourceBlocks type: object properties: ResourceBlocks: maxItems: 1000 type: array items: $ref: '#/components/schemas/ResourceBlock' description: The resource blocks colliding with the interval or matching the filter parameters. Cursor: type: string description: Unique identifier of the last returned resource block. This can be used in `Limitation` in a subsequent request to fetch the next batch of resource blocks. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceBlockResult ResourceBlockParameters: title: Resource block parameters required: - AccessToken - Client - ClientToken - Limitation type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 Extent: title: Resource block extent allOf: - $ref: '#/components/schemas/ResourceBlockExtent' description: Extent of data to be returned. nullable: true deprecated: true x-deprecatedMessage: Use ActivityStates with `["Active", "Deleted"]` instead. example: string ResourceBlockIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested resource block. nullable: true AssignedResourceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the requested Assigned `Resource`. nullable: true ActivityStates: type: array items: $ref: '#/components/schemas/ActivityStates' description: Whether to return only active, only deleted or both records. Defaults to `Active` if not specified. nullable: true CollidingUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resource block is active. nullable: true x-max-interval-in-months: 3 example: string CreatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resource block was created. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resource block was updated. nullable: true x-max-interval-in-months: 3 example: string additionalProperties: false x-schema-id: ResourceBlockParameters ResourcesOccupancyStateResult: title: ResourcesOccupancyStateResult required: - ResourceCategoryOccupancyStates type: object properties: ResourceCategoryOccupancyStates: type: array items: $ref: '#/components/schemas/ResourceCategoryOccupancyState' description: The resource categories. additionalProperties: false x-schema-id: ResourcesOccupancyStateResult ResourceFeatureFilterParameters: title: ResourceFeatureFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ServiceIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ResourceFeatureIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of `ResourceFeature`. nullable: true ServiceIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of `Service` to which the resource features belong. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Last update date and time of the resource feature in UTC timezone in ISO 8601 format. nullable: true x-max-interval-in-months: 3 example: string 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: ResourceFeatureFilterParameters ResourceCategory: title: Resource category required: - Capacity - Classification - Descriptions - EnterpriseId - ExtraCapacity - Id - IsActive - Names - Ordering - ServiceId - ShortNames - Type type: object properties: Id: type: string description: Unique identifier of the category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of the `Service` of the resource category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the category is still active. example: true Type: $ref: '#/components/schemas/ResourceCategoryType' Classification: $ref: '#/components/schemas/ResourceClassification' 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. x-schema-id: LocalizedStrings Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. x-schema-id: LocalizedStrings Ordering: type: integer description: Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed). format: int32 example: 1 Capacity: type: integer description: Capacity that can be served (e.g. bed count). format: int32 example: 1 ExtraCapacity: type: integer description: Extra capacity that can be served (e.g. extra bed count). format: int32 example: 1 ExternalIdentifier: maxLength: 255 type: string description: Identifier of the resource category from external system. nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 AccountingCategoryId: type: string description: Unique identifier of the accounting category. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceCategory ResourceAccessTokenDeleteParameters: title: ResourceAccessTokenDeleteParameters required: - AccessToken - Client - ClientToken - Ids type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Ids: type: array items: type: string format: uuid description: Unique identifiers of the resource access token to delete. additionalProperties: false x-schema-id: ResourceAccessTokenDeleteParameters ResourceAccessTokenType: title: Resource access token type enum: - PinCode - RfidTag type: string description: Type of stored value. ResourcesOccupancyStateFilterParameters: title: ResourcesOccupancyStateFilterParameters required: - AccessToken - Client - ClientToken - ResourceCategoryIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ResourceCategoryIds: maxItems: 5 type: array items: type: string format: uuid description: Unique identifiers of the `ResourceCategory`. ResourceStates: type: array items: $ref: '#/components/schemas/ResourceState' description: States of the `Resource` nullable: true OccupancyStates: type: array items: $ref: '#/components/schemas/OccupancyStateEnum' description: Occupancy states of the `Resource`. nullable: true additionalProperties: false x-schema-id: ResourcesOccupancyStateFilterParameters ResourceResult: title: ResourceResult type: object properties: Resources: type: array items: $ref: '#/components/schemas/Resource' description: The resources of the enterprise. nullable: true ResourceCategories: type: array items: $ref: '#/components/schemas/ResourceCategory' description: Categories of resources in the enterprise. nullable: true deprecated: true ResourceCategoryAssignments: type: array items: $ref: '#/components/schemas/ResourceCategoryAssignment' description: Assignments of resources to categories. nullable: true deprecated: true ResourceCategoryImageAssignments: type: array items: $ref: '#/components/schemas/ResourceCategoryImageAssignment' description: Assignments of images to categories. nullable: true deprecated: true ResourceFeatures: type: array items: $ref: '#/components/schemas/ResourceFeature' description: Features of resources in the enterprise. nullable: true deprecated: true ResourceFeatureAssignments: type: array items: $ref: '#/components/schemas/ResourceFeatureAssignment' description: Assignments of resource features to resources. nullable: true deprecated: true Cursor: type: string description: 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. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceResult ResourceBlockAddParameters: title: Resource block parameters required: - EndUtc - Name - ResourceId - StartUtc - Type type: object properties: ResourceId: type: string description: Unique identifier of `Resource`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name of the resource block. example: Example Name Type: $ref: '#/components/schemas/ResourceBlockType' StartUtc: minLength: 1 type: string description: Start of the interval in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' EndUtc: minLength: 1 type: string description: End of the interval in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' Notes: type: string description: Note describing the resource block. nullable: true example: string additionalProperties: false x-schema-id: ResourceBlockAddParameters ResourceFeatureAssignmentFilterParameters: title: ResourceFeatureAssignmentFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ResourceFeatureIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ResourceFeatureAssignmentIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid nullable: true ResourceFeatureIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Resource features](https://mews-systems.gitbook.io/connector-api/operations/#resource-feature) to which the resource feature assignments belong. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resource feature assignments were updated. nullable: true x-max-interval-in-months: 3 example: string 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: ResourceFeatureAssignmentFilterParameters ResourceFeature: title: Resource feature required: - Classification - CreatedUtc - Descriptions - Id - IsActive - Names - ServiceId - ShortNames - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of `ResourceFeature`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ServiceId: type: string description: Unique identifier of `Service` the resource feature belongs to. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the `ResourceFeature` is active. example: true Classification: $ref: '#/components/schemas/ResourceFeatureClassification' 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. x-schema-id: LocalizedStrings Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. x-schema-id: LocalizedStrings CreatedUtc: minLength: 1 type: string description: Creation date and time of the resource feature in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource feature in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ResourceFeature ResourceFeatureClassification: title: Resource feature classification enum: - SeaView - RiverView - OceanView - TwinBeds - DoubleBed - RollawayBed - UpperBed - LowerBed - Balcony - AccessibleBathroom - AccessibleRoom - ElevatorAccess - HighFloor - Kitchenette - AirConditioning - PrivateJacuzzi - PrivateSauna - EnsuiteRoom - PrivateBathroom - SharedBathroom type: string description: Classification of `ResourceFeature`. ResourceFeatureAssignment: title: Resource feature assignment required: - CreatedUtc - FeatureId - Id - IsActive - ResourceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the assignment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the assignment is still active. example: true ResourceId: type: string description: Unique identifier of the [Resource](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 FeatureId: type: string description: Unique identifier of the [Resource feature](https://mews-systems.gitbook.io/connector-api/operations/#resource-feature) assigned to the Resource. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ResourceFeatureAssignment MultipleResourceAccessTokenUpdateParameters: title: MultipleResourceAccessTokenUpdateParameters required: - AccessToken - Client - ClientToken type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string EnterpriseId: type: string description: Unique identifier of the enterprise. Required when using [Portfolio Access Tokens](https://mews-systems.gitbook.io/connector-api/concepts/multi-property), ignored otherwise. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ResourceAccessTokenUpdates: type: array items: $ref: '#/components/schemas/ResourceAccessTokenUpdateParameters' description: Parameters of resource access token to update. nullable: true additionalProperties: false x-schema-id: MultipleResourceAccessTokenUpdateParameters Unit: type: object additionalProperties: false Resource: title: Resource required: - CreatedUtc - Data - Descriptions - Directions - EnterpriseId - ExternalNames - Id - IsActive - Name - State - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the resource. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the resource is still active. example: true ParentResourceId: type: string description: Identifier of the parent `Resource` (e.g. room of a bed). format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 Name: minLength: 1 type: string description: Name of the resource (e.g. room number). example: Example Name State: $ref: '#/components/schemas/ResourceState' Descriptions: title: Localized text type: object additionalProperties: type: string description: All translations of the description. x-schema-id: LocalizedStrings CreatedUtc: minLength: 1 type: string description: Creation date and time of the resource in UTC timezone in ISO 8601 format. example: string UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource in UTC timezone in ISO 8601 format. example: string Data: title: Resource data type: object properties: Discriminator: $ref: '#/components/schemas/ResourceDataDiscriminator' Value: oneOf: - $ref: '#/components/schemas/SpaceData' - title: Object resource data type: object additionalProperties: false - title: Person resource data type: object additionalProperties: false description: Based on `Discriminator`. Currently present only for `Space` resources with [Space resource data](https://mews-systems.gitbook.io/connector-api/operations/resources#space-resource-data). description: Additional data of the resource. x-coproduct: true x-schema-id: ResourceDataCoproductOfResourceDataDiscriminator ExternalNames: title: Localized text type: object additionalProperties: type: string description: All translations of external name. x-schema-id: LocalizedStrings Directions: title: Localized text type: object additionalProperties: type: string description: All translations of direction. x-schema-id: LocalizedStrings additionalProperties: false x-schema-id: Resource MultipleResourceBlockAddParameters: title: MultipleResourceBlockAddParameters required: - AccessToken - Client - ClientToken - ResourceBlocks type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ResourceBlocks: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ResourceBlockAddParameters' description: Resource block parameters. additionalProperties: false x-schema-id: MultipleResourceBlockAddParameters ResourceCategoryAssignment: title: Resource category assignment required: - CategoryId - CreatedUtc - Id - IsActive - ResourceId - UpdatedUtc type: object properties: Id: type: string description: Unique identifier of the assignment. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 IsActive: type: boolean description: Whether the assignment is still active. example: true ResourceId: type: string description: Unique identifier of the [Resource](https://mews-systems.gitbook.io/connector-api/operations/#resource) assigned to the Resource category. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 CreatedUtc: minLength: 1 type: string description: Creation date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' UpdatedUtc: minLength: 1 type: string description: Last update date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time example: '2026-06-02T14:30:00Z' additionalProperties: false x-schema-id: ResourceCategoryAssignment ResourceCategoryAssignmentResult: title: ResourceCategoryAssignmentResult required: - ResourceCategoryAssignments type: object properties: ResourceCategoryAssignments: maxItems: 1000 type: array items: $ref: '#/components/schemas/ResourceCategoryAssignment' description: Resource category assignments. Cursor: type: string description: Unique identifier of the last and hence oldest resource category assignment 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 resource category assignments. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceCategoryAssignmentResult MultipleResourceUpdateParameters: title: MultipleResourceUpdateParameters required: - AccessToken - Client - ClientToken - ResourceUpdates type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ResourceUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ResourceUpdateParameters' description: Resource updates. additionalProperties: false x-schema-id: MultipleResourceUpdateParameters ResourceAccessTokenPermissions: title: Resource access token permissions type: object properties: Bed: type: boolean description: Specify whether the resource access token grants permission to access bed. example: true Room: type: boolean description: Specify whether the resource access token grants permission to access room. example: true Floor: type: boolean description: Specify whether the resource access token grants permission to access floor. example: true Building: type: boolean description: Specify whether the resource access token grants permission to access building. example: true additionalProperties: false description: '' x-schema-id: ResourceAccessTokenPermissions ResourceAccessTokenAdditionResult: title: ResourceAccessTokenAdditionResult required: - ResourceAccessTokens type: object properties: ResourceAccessTokens: type: array items: $ref: '#/components/schemas/ResourceAccessToken' description: Added resource access tokens. additionalProperties: false x-schema-id: ResourceAccessTokenAdditionResult ResourceAccessTokenUpdateParameters: title: Resource access token update required: - ResourceAccessTokenId type: object properties: ResourceAccessTokenId: type: string description: Unique identifier of the resource access token to update. format: uuid example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 ValidityStartUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Marks the start of interval in which the resource access token can be used (or null if not being updated). nullable: true example: string ValidityEndUtc: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Marks the end of interval in which the resource access token can be used (or null if not being updated). nullable: true example: string Value: title: String update value maxLength: 255 allOf: - $ref: '#/components/schemas/StringUpdateValue' description: Value of the resource access token (or null if not being updated). nullable: true example: string Permissions: title: Resource access token permission parameter allOf: - $ref: '#/components/schemas/ResourceAccessTokenPermissionsParameters' description: Specify permissions of the resource access token (or null if not being updated). nullable: true example: string additionalProperties: false x-schema-id: ResourceAccessTokenUpdateParameters ResourceBlockExtent: title: Resource block extent type: object properties: Inactive: type: boolean description: Whether the response should contain inactive entities. example: true additionalProperties: false description: '' x-schema-id: ResourceBlockExtent BooleanUpdateValue: title: Boolean update value type: object properties: Value: type: boolean description: Value which is to be updated. example: true additionalProperties: false x-schema-id: BooleanUpdateValue ResourceCategoryFilterParameters: title: ResourceCategoryFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ServiceIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ResourceCategoryIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Resource categories](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). nullable: true ServiceIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service) to which the resource categories belong. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resource categories were updated. nullable: true x-max-interval-in-months: 3 example: string 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: ResourceCategoryFilterParameters ResourceCategoryResult: title: ResourceCategoryResult required: - ResourceCategories type: object properties: ResourceCategories: maxItems: 1000 type: array items: $ref: '#/components/schemas/ResourceCategory' description: Resource categories of the resources. Cursor: type: string description: Unique identifier of the last and hence oldest resource category 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 resource categories. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceCategoryResult MultipleResourceAccessTokenParameters: title: MultipleResourceAccessTokenParameters required: - AccessToken - Client - ClientToken - ResourceAccessTokenParameters type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string ResourceAccessTokenParameters: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ResourceAccessTokenParameters' description: Parameters of resource access token. additionalProperties: false x-schema-id: MultipleResourceAccessTokenParameters ResourceBlockAdditionResult: title: ResourceBlockAdditionResult required: - ResourceBlocks type: object properties: ResourceBlocks: maxItems: 1000 type: array items: $ref: '#/components/schemas/ResourceBlock' description: The resource blocks that were added. additionalProperties: false x-schema-id: ResourceBlockAdditionResult ActivityStates: title: Activity state enum: - Deleted - Active type: string description: Activity states used for filtering. ResourceFeatureAssignmentResult: title: ResourceFeatureAssignmentResult required: - ResourceFeatureAssignments type: object properties: ResourceFeatureAssignments: maxItems: 1000 type: array items: $ref: '#/components/schemas/ResourceFeatureAssignment' description: Resource feature assignments. Cursor: type: string description: Unique identifier of the last and hence oldest resource feature assignments 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 resource feature assignments. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceFeatureAssignmentResult ResourceAccessTokenResult: title: ResourceAccessTokenResult required: - ResourceAccessTokens type: object properties: ResourceAccessTokens: type: array items: $ref: '#/components/schemas/ResourceAccessToken' description: Resource access tokens. Cursor: type: string description: Unique identifier of the last and hence oldest item returned. This can be used in `Limitation` in a subsequent request to fetch the next batch of older tokens. If `Limitation` is specified in the request message, then `Cursor` will always be included in the response message. format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false x-schema-id: ResourceAccessTokenResult ResourceCategoryImageAssignmentFilterParameters: title: ResourceCategoryImageAssignmentFilterParameters required: - AccessToken - Client - ClientToken - Limitation - ResourceCategoryIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ResourceCategoryImageAssignmentIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of [Resource category image assignments](https://mews-systems.gitbook.io/connector-api/operations/resourcecategories/#resource-category-image-assignment). nullable: true ResourceCategoryIds: maxItems: 1000 type: array items: type: string format: uuid description: Unique identifiers of [Resource categories](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource-category) to which the resource category image assignments belong. UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resource category image assignments were updated. nullable: true example: string 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: ResourceCategoryImageAssignmentFilterParameters ResourceState: title: Resource state enum: - Dirty - Clean - Inspected - OutOfService - OutOfOrder type: string description: 'State of the resource. Dirty Clean Inspected OutOfService OutOfOrder' x-enumNames: - Dirty - Clean - Inspected - OutOfService - OutOfOrder x-enumDescriptions: - '' - '' - '' - '' - '' x-schema-id: ResourceState ResourceAccessTokenFilterParameters: title: ResourceAccessTokenFilterParameters required: - AccessToken - Client - ClientToken - Limitation type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. example: string AccessToken: minLength: 1 type: string description: Access token of the client application. example: string Client: minLength: 1 type: string description: Name and version of the client application. example: string Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. example: string 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 ResourceAccessTokenIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of resource access token. Required if no other filter is provided. nullable: true ServiceOrderIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of reservations. Required if no other filter is provided. nullable: true CollidingUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which the resource access token is valid. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string UpdatedUtc: title: Time interval allOf: - $ref: '#/components/schemas/TimeFilterInterval' description: Interval in which resource access token was updated. Required if no other filter is provided. nullable: true x-max-interval-in-months: 3 example: string ActivityStates: type: array items: type: string description: Whether to return only active, only deleted or both records. nullable: true additionalProperties: false x-schema-id: ResourceAccessTokenFilterParameters Limitation: title: Limitation required: - Count type: object properties: Count: type: integer format: int32 example: 1 Cursor: type: string format: uuid nullable: true example: 3edd5f9e-7e64-4f2a-9a0e-b3f200e6c111 additionalProperties: false description: Limitation on the quantity of data returned. x-schema-id: Limitation ResourceDataDiscriminator: title: Resource data discriminator enum: - Space - Object - Person type: string description: Whether the resource is space, object, or person. securitySchemes: MewsClientToken: type: apiKey in: header name: ClientToken description: Mews authentication is performed by supplying ClientToken, AccessToken and Client as fields in the JSON request body (not as HTTP headers). This securityScheme is a tooling-compatible representation of the ClientToken credential. ClientToken is unique to your application and identifies the API client. MewsAccessToken: type: apiKey in: header name: AccessToken description: Tooling-compatible representation of the AccessToken credential, which is supplied in the JSON request body. AccessToken is unique to the connection with a property (enterprise) and identifies the property or properties whose data and services you can access. Portfolio Access Tokens enable multi-property access with a single token. servers: - url: https://api.mews.com description: Production - url: https://api.mews-demo.com description: Demo / sandbox security: - MewsClientToken: [] MewsAccessToken: [] tags: - name: Resource access tokens - name: Resource blocks - name: Resource categories - name: Resource features - name: Resources