--- title: "Get all resources" method: POST path: "/api/connector/v1/resources/getAll" tags: ["Resources"] --- # Get all resources `POST /api/connector/v1/resources/getAll` 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). ## Request body - ResourceFilterParameters - `ClientToken` string, required — Token identifying the client application. - `AccessToken` string, required — Access token of the client application. - `Client` string, required — Name and version of the client application. - `Limitation` Limitation, required — Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable - `EnterpriseIds` string[], nullable — Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. - `ResourceIds` string[], nullable — Unique identifiers of the requested resources. - `Names` string[], nullable — Names of the requested resources. - `Extent` ResourceExtent, required - `Resources` boolean, nullable — Whether the response should contain resources. - `ResourceCategories` boolean, nullable — Whether the response should contain categories. - `ResourceCategoryAssignments` boolean, nullable — Whether the response should contain assignments of the resources to categories. - `ResourceCategoryImageAssignments` boolean, nullable — Whether the response should contain assignments of the images to categories. - `ResourceFeatures` boolean, nullable — Whether the response should contain resource features. - `ResourceFeatureAssignments` boolean, nullable — Whether the response should contain assignments of the resources to features. - `Inactive` boolean, nullable — Whether the response should contain inactive entities. - `CreatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable - `UpdatedUtc` TimeFilterInterval — When a time interval is used for **filtering** (for example in parameters such as `CreatedUtc.StartUtc` / `CreatedUtc.EndUtc`), the following rules apply: - **Start equals End (equality mode)** If `StartUtc` and `EndUtc` are exactly the same timestamp, the filter is treated as an equality check for that precise moment in time: ``` CreatedUtc == StartUtc ``` This does not represent an interval; only records with `CreatedUtc` equal to that exact instant are returned. - **Start differs from End (interval mode)** If `StartUtc` and `EndUtc` are different, the filter is evaluated as a half-open interval: ``` StartUtc <= CreatedUtc < EndUtc ``` In other words, the start is inclusive and the end is exclusive. Make sure your integration takes inclusive Start / exclusive End behavior of time intervals into account so that no records at the boundaries are omitted. - `StartUtc` string, date-time, nullable - `EndUtc` string, date-time, nullable ## Response `200` OK - ResourceResult - `Resources` Resource[], nullable — The resources of the enterprise. - `Id` string, uuid, required — Unique identifier of the resource. - `EnterpriseId` string, uuid, required — Unique identifier of the `Enterprise`. - `IsActive` boolean, required — Whether the resource is still active. - `ParentResourceId` string, uuid, nullable — Identifier of the parent `Resource` (e.g. room of a bed). - `Name` string, required — Name of the resource (e.g. room number). - `State` 'Dirty' | 'Clean' | 'Inspected' | 'OutOfService' | 'OutOfOrder', required — State of the resource. Dirty Clean Inspected OutOfService OutOfOrder - `Descriptions` object, required — All translations of the description. - `CreatedUtc` string, required — Creation date and time of the resource in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, required — Last update date and time of the resource in UTC timezone in ISO 8601 format. - `Data` object, required — Additional data of the resource. - `Discriminator` 'Space' | 'Object' | 'Person' — Whether the resource is space, object, or person. - `Value` union — 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). - SpaceData - `FloorNumber` string, required — Number of the floor the space is on. - `LocationNotes` string, nullable — 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. - object - object - `ExternalNames` object, required — All translations of external name. - `Directions` object, required — All translations of direction. - `ResourceCategories` ResourceCategory[], nullable — Categories of resources in the enterprise. - `Id` string, uuid, required — Unique identifier of the category. - `EnterpriseId` string, uuid, required — Unique identifier of the `Enterprise`. - `ServiceId` string, uuid, required — Unique identifier of the `Service` of the resource category. - `IsActive` boolean, required — Whether the category is still active. - `Type` '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', required — Type of the category. - `Classification` 'StandardSingle' | 'StandardDouble' | 'SuperiorTwin' | 'SuperiorDouble' | 'JuniorSuite' | 'SharedOrDorm' | 'Other' | 'SuperiorSingle' | 'Triple' | 'Family' | 'StandardTwin' | 'Studio' | 'SuperiorTripleRoom' | 'OneBedroomApartment' | 'ThreeBedroomsApartment' | 'TwoBedroomsApartment', required — Classification of the resource category. - `Names` object, required — All translations of the name. - `ShortNames` object, required — All translations of the short name. - `Descriptions` object, required — All translations of the description. - `Ordering` integer, required — Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed). - `Capacity` integer, required — Capacity that can be served (e.g. bed count). - `ExtraCapacity` integer, required — Extra capacity that can be served (e.g. extra bed count). - `ExternalIdentifier` string, nullable — Identifier of the resource category from external system. - `AccountingCategoryId` string, uuid, nullable — Unique identifier of the accounting category. - `ResourceCategoryAssignments` ResourceCategoryAssignment[], nullable — Assignments of resources to categories. - `Id` string, uuid, required — Unique identifier of the assignment. - `IsActive` boolean, required — Whether the assignment is still active. - `ResourceId` string, uuid, required — Unique identifier of the [Resource](https://mews-systems.gitbook.io/connector-api/operations/#resource) assigned to the Resource category. - `CategoryId` string, uuid, required — Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). - `CreatedUtc` string, date-time, required — Creation date and time of the assignment in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the assignment in UTC timezone in ISO 8601 format. - `ResourceCategoryImageAssignments` ResourceCategoryImageAssignment[], nullable — Assignments of images to categories. - `Id` string, uuid, required — Unique identifier of the assignment. - `IsActive` boolean, required — Whether the assignment is still active. - `CategoryId` string, uuid, required — Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). - `ImageId` string, uuid, required — Unique identifier of the image assigned to the Resource category. - `CreatedUtc` string, date-time, required — Creation date and time of the assignment in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the assignment in UTC timezone in ISO 8601 format. - `Ordering` integer, required — Ordering of the image in the resource category. - `ResourceFeatures` ResourceFeature[], nullable — Features of resources in the enterprise. - `Id` string, uuid, required — Unique identifier of `ResourceFeature`. - `ServiceId` string, uuid, required — Unique identifier of `Service` the resource feature belongs to. - `IsActive` boolean, required — Whether the `ResourceFeature` is active. - `Classification` 'SeaView' | 'RiverView' | 'OceanView' | 'TwinBeds' | 'DoubleBed' | 'RollawayBed' | 'UpperBed' | 'LowerBed' | 'Balcony' | 'AccessibleBathroom' | 'AccessibleRoom' | 'ElevatorAccess' | 'HighFloor' | 'Kitchenette' | 'AirConditioning' | 'PrivateJacuzzi' | 'PrivateSauna' | 'EnsuiteRoom' | 'PrivateBathroom' | 'SharedBathroom', required — Classification of `ResourceFeature`. - `Names` object, required — All translations of the name. - `ShortNames` object, required — All translations of the short name. - `Descriptions` object, required — All translations of the description. - `CreatedUtc` string, date-time, required — Creation date and time of the resource feature in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the resource feature in UTC timezone in ISO 8601 format. - `ResourceFeatureAssignments` ResourceFeatureAssignment[], nullable — Assignments of resource features to resources. - `Id` string, uuid, required — Unique identifier of the assignment. - `IsActive` boolean, required — Whether the assignment is still active. - `ResourceId` string, uuid, required — Unique identifier of the [Resource](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource). - `FeatureId` string, uuid, required — Unique identifier of the [Resource feature](https://mews-systems.gitbook.io/connector-api/operations/#resource-feature) assigned to the Resource. - `CreatedUtc` string, date-time, required — Creation date and time of the assignment in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the assignment in UTC timezone in ISO 8601 format. - `Cursor` string, uuid, nullable — 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. ## Other responses - `204` — Server has successfully fulfilled the request and there is no additional information to send back. - `400` — 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). - `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. - `403` — 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. - `408` — 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) - `429` — 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). - `500` — 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). --- [API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/versions/81933a8ff730/schema)