openapi: 3.0.4 info: title: Connector Account notes Resources API description: General-purpose API that enables partners of Mews to access data and services in Mews Operations termsOfService: https://www.mews.com/en/terms-conditions/partners contact: name: Partner success email: partnersuccess@mews.com version: v1 servers: - url: https://api.mews.com tags: - name: Resources paths: /api/connector/v1/resources/getAll: post: tags: - Resources summary: 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: null 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: null 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: null ResourceCategoryAssignments: null ResourceCategoryImageAssignments: null ResourceFeatures: null ResourceFeatureAssignments: null 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' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/resources/update: post: tags: - Resources summary: 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' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' /api/connector/v1/resources/getOccupancyState: post: tags: - Resources summary: 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' '401': description: Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '403': description: Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '408': description: Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '204': description: Server has successfully fulfilled the request and there is no additional information to send back. content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '429': description: Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' '500': description: Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). content: application/json: schema: $ref: '#/components/schemas/ConnectorApiExceptionResult' x-restricted: true components: schemas: Unit: type: object additionalProperties: false 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 IsActive: type: boolean description: Whether the assignment is still active. 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 CategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). format: uuid CreatedUtc: minLength: 1 type: string description: Creation date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time additionalProperties: false x-schema-id: ResourceCategoryAssignment Limitation: title: Limitation required: - Count type: object properties: Count: type: integer format: int32 Cursor: type: string format: uuid nullable: true additionalProperties: false description: Limitation on the quantity of data returned. x-schema-id: Limitation 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 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 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid IsActive: type: boolean description: Whether the resource is still active. ParentResourceId: type: string description: Identifier of the parent `Resource` (e.g. room of a bed). format: uuid nullable: true Name: minLength: 1 type: string description: Name of the resource (e.g. room number). 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. UpdatedUtc: minLength: 1 type: string description: Last update date and time of the resource in UTC timezone in ISO 8601 format. 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 TimeFilterInterval: title: Time interval type: object properties: StartUtc: type: string format: date-time nullable: true EndUtc: type: string format: date-time nullable: true additionalProperties: false description: "When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply:\r\n\r\n- **Start equals End (equality mode)** \r\n If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time:\r\n \r\n ```\r\n CreatedUtc == StartUtc\r\n ```\r\n \r\n This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned.\r\n\r\n- **Start differs from End (interval mode)** \r\n If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval:\r\n \r\n ```\r\n StartUtc <= CreatedUtc < EndUtc\r\n ```\r\n \r\n In other words, the start is inclusive and the end is exclusive.\r\n\r\nMake sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted." x-schema-id: TimeFilterInterval 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 IsActive: type: boolean description: Whether the assignment is still active. ResourceId: type: string description: Unique identifier of the [Resource](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource). format: uuid 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 CreatedUtc: minLength: 1 type: string description: Creation date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time additionalProperties: false x-schema-id: ResourceFeatureAssignment 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 EnterpriseId: type: string description: Unique identifier of the `Enterprise`. format: uuid ServiceId: type: string description: Unique identifier of the `Service` of the resource category. format: uuid IsActive: type: boolean description: Whether the category is still active. 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 Capacity: type: integer description: Capacity that can be served (e.g. bed count). format: int32 ExtraCapacity: type: integer description: Extra capacity that can be served (e.g. extra bed count). format: int32 ExternalIdentifier: maxLength: 255 type: string description: Identifier of the resource category from external system. nullable: true AccountingCategoryId: type: string description: Unique identifier of the accounting category. format: uuid nullable: true additionalProperties: false x-schema-id: ResourceCategory ResourceExtent: title: Resource extent type: object properties: Resources: type: boolean description: Whether the response should contain resources. nullable: 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) 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) 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) 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) 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) Inactive: type: boolean description: Whether the response should contain inactive entities. nullable: true additionalProperties: false description: '' x-schema-id: ResourceExtent ResourceOccupancyState: title: Resource occupancy state required: - OccupancyState - ResourceId - ResourceState type: object properties: ResourceId: type: string description: Unique identifier of the resource. format: uuid 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 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: - '' - '' - '' - '' - '' additionalProperties: false description: The occupancy state of a `Resource`. x-schema-id: ResourceOccupancyState ResourceFilterParameters: title: ResourceFilterParameters required: - AccessToken - Client - ClientToken - Extent - Limitation type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. Limitation: allOf: - $ref: '#/components/schemas/Limitation' description: Limitation on the quantity of data returned and optional Cursor for the starting point of data. EnterpriseIds: maxItems: 1000 minItems: 1 type: array items: type: string format: uuid description: Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. nullable: true 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. 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 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 additionalProperties: false x-schema-id: ResourceFilterParameters 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. 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 LocationNotes: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: New location notes for the space. nullable: true additionalProperties: false x-schema-id: SpaceDataUpdateParameters GuidNullableUpdateValue: title: Guid update value type: object properties: Value: type: string description: Value which is to be updated. format: uuid nullable: true additionalProperties: false x-schema-id: GuidNullableUpdateValue ResourceCategoryOccupancyState: title: Resource category occupancy state required: - ResourceCategoryId - ResourceOccupancyStates type: object properties: ResourceCategoryId: type: string description: Unique identifier of the 'Resource category'. format: uuid 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 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`. 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 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 IsActive: type: boolean description: Whether the assignment is still active. CategoryId: type: string description: Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). format: uuid ImageId: type: string description: Unique identifier of the image assigned to the Resource category. format: uuid CreatedUtc: minLength: 1 type: string description: Creation date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time UpdatedUtc: minLength: 1 type: string description: Last update date and time of the assignment in UTC timezone in ISO 8601 format. format: date-time Ordering: type: integer description: Ordering of the image in the resource category. format: int32 additionalProperties: false x-schema-id: ResourceCategoryImageAssignment ResourcesOccupancyStateFilterParameters: title: ResourcesOccupancyStateFilterParameters required: - AccessToken - Client - ClientToken - ResourceCategoryIds type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. 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 ResourceDataDiscriminator: title: Resource data discriminator enum: - Space - Object - Person type: string description: Whether the resource is space, object, or person. 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: - '' - '' - '' - '' - '' ConnectorApiExceptionResult: title: ConnectorApiExceptionResult type: object properties: Message: type: string nullable: true RequestId: type: string nullable: true Details: nullable: true additionalProperties: false x-schema-id: ConnectorApiExceptionResult 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 ServiceId: type: string description: Unique identifier of `Service` the resource feature belongs to. format: uuid IsActive: type: boolean description: Whether the `ResourceFeature` is active. 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 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 additionalProperties: false x-schema-id: ResourceFeature 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. MultipleResourceUpdateParameters: title: MultipleResourceUpdateParameters required: - AccessToken - Client - ClientToken - ResourceUpdates type: object properties: ClientToken: minLength: 1 type: string description: Token identifying the client application. AccessToken: minLength: 1 type: string description: Access token of the client application. Client: minLength: 1 type: string description: Name and version of the client application. ResourceUpdates: maxItems: 1000 minItems: 1 type: array items: $ref: '#/components/schemas/ResourceUpdateParameters' description: Resource updates. additionalProperties: false x-schema-id: MultipleResourceUpdateParameters StringUpdateValue: title: String update value type: object properties: Value: type: string description: Value which is to be updated. nullable: true additionalProperties: false x-schema-id: StringUpdateValue SpaceData: title: Space resource data required: - FloorNumber type: object properties: FloorNumber: minLength: 1 type: string description: Number of the floor the space is on. 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 additionalProperties: false x-schema-id: SpaceData ResourceUpdateParameters: title: Resource update required: - ResourceId type: object properties: ResourceId: type: string description: Unique identifier of the `Resource` which is updated. format: uuid Name: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: New name of the resource (e.g. room number). nullable: true ParentResourceId: title: Guid update value allOf: - $ref: '#/components/schemas/GuidNullableUpdateValue' description: Identifier of the new parent `Resource`. nullable: true 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 StateReason: title: String update value allOf: - $ref: '#/components/schemas/StringUpdateValue' description: New reason for the state of the resource. nullable: true additionalProperties: false x-schema-id: ResourceUpdateParameters 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 additionalProperties: false x-schema-id: ResourceResult