Skip to content
Mews Open API

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 and supports Portfolio Access Tokens.

Request Body

Section titled “Request Body ”
ResourceFilterParameters
object
ClientToken
required

Token identifying the client application.

string
>= 1 characters
AccessToken
required

Access token of the client application.

string
>= 1 characters
Client
required

Name and version of the client application.

string
>= 1 characters
Limitation
required

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

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

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

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

Unique identifiers of the requested Resources.

Array<string>
nullable >= 1 items <= 1000 items
Names
Array<string>
nullable >= 1 items <= 1000 items
Extent
ResourceExtent

Extent of data to be returned.

object
Resources
boolean
ResourceCategories
boolean
ResourceCategoryAssignments
boolean
ResourceCategoryImageAssignments
boolean
ResourceFeatures
boolean
ResourceFeatureAssignments
boolean
Inactive
boolean
CreatedUtc
TimeFilterInterval
object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
UpdatedUtc
TimeFilterInterval
object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
Example
{
  "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
  "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
  "Client": "Sample Client 1.0.0",
  "EnterpriseIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "4d0201db-36f5-428b-8d11-4f0a65e960cc"
  ],
  "ResourceIds": [
    "5ee074b1-6c86-48e8-915f-c7aa4702086f",
    "c32386aa-1cd2-414a-a823-489325842fbe"
  ],
  "CreatedUtc": {
    "StartUtc": "2022-10-15T00:00:00Z",
    "EndUtc": "2022-10-20T00:00:00Z"
  },
  "UpdatedUtc": {
    "StartUtc": "2022-10-15T00:00:00Z",
    "EndUtc": "2022-10-20T00:00:00Z"
  },
  "Extent": {
    "Resources": true,
    "ResourceCategories": false,
    "ResourceCategoryAssignments": false,
    "ResourceCategoryImageAssignments": false,
    "ResourceFeatures": false,
    "ResourceFeatureAssignments": false,
    "Inactive": false
  },
  "Limitation": {
    "Count": 10
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

ResourceResult
object
Resources

The resources of the enterprise.

Array<object>
nullable
Resource
object
Id
required

Unique identifier of the resource.

string format: uuid
EnterpriseId
required

Unique identifier of the Enterprise.

string format: uuid
IsActive
required

Whether the resource is still active.

boolean
ParentResourceId

Identifier of the parent Resource (e.g. room of a bed).

string format: uuid
nullable
Name
required

Name of the resource (e.g. room number).

string
>= 1 characters
State
required

State of the resource.

string
>= 1 characters
Descriptions
required
Localized text

All translations of the description.

object
key
additional properties
string
CreatedUtc
required

Creation date and time of the resource in UTC timezone in ISO 8601 format.

string
>= 1 characters
UpdatedUtc
required

Last update date and time of the resource in UTC timezone in ISO 8601 format.

string
>= 1 characters
Data
required
Data

Additional data of the resource.

object
Discriminator
string
Value
One of:
SpaceData
object
FloorNumber
required
string
>= 1 characters
LocationNotes
string
nullable
ExternalNames
required
Localized text

All translations of external name.

object
key
additional properties
string
Directions
required
Localized text

All translations of direction.

object
key
additional properties
string
ResourceCategories

Categories of resources in the enterprise. Deprecated!

Array<object>
nullable
Resource category
object
Id
required

Unique identifier of the category.

string format: uuid
EnterpriseId
required

Unique identifier of the Enterprise.

string format: uuid
ServiceId
required

Unique identifier of the Service of the resource category.

string format: uuid
IsActive
required

Whether the category is still active.

boolean
Type
required
Resource category type
string
Allowed values: 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
Classification
required
string
Allowed values: StandardSingle StandardDouble SuperiorTwin SuperiorDouble JuniorSuite SharedOrDorm Other SuperiorSingle Triple Family StandardTwin Studio SuperiorTripleRoom OneBedroomApartment ThreeBedroomsApartment TwoBedroomsApartment
Names
required
Localized text

All translations of the name.

object
key
additional properties
string
ShortNames
required
Localized text

All translations of the short name.

object
key
additional properties
string
Descriptions
required
Localized text

All translations of the description.

object
key
additional properties
string
Ordering
required
integer format: int32
Capacity
required
integer format: int32
ExtraCapacity
required

Extra capacity that can be served (e.g. extra bed count).

integer format: int32
ExternalIdentifier

Identifier of the resource category from external system.

string
nullable <= 255 characters
AccountingCategoryId
string format: uuid
nullable
ResourceCategoryAssignments

Assignments of resources to categories. Deprecated!

Array<object>
nullable
Resource category assignment
object
Id
required

Unique identifier of the assignment.

string format: uuid
IsActive
required

Whether the assignment is still active.

boolean
ResourceId
required

Unique identifier of the Resource assigned to the Resource category.

string format: uuid
CategoryId
required

Unique identifier of the Resource category.

string format: uuid
CreatedUtc
required

Creation date and time of the assignment in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the assignment in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
ResourceCategoryImageAssignments

Assignments of images to categories. Deprecated!

Array<object>
nullable
Resource category image assignment
object
Id
required

Unique identifier of the assignment.

string format: uuid
IsActive
required

Whether the assignment is still active.

boolean
CategoryId
required

Unique identifier of the Resource category.

string format: uuid
ImageId
required

Unique identifier of the image assigned to the Resource category.

string format: uuid
CreatedUtc
required

Creation date and time of the assignment in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the assignment in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
ResourceFeatures

Features of resources in the enterprise. Deprecated!

Array<object>
nullable
Resource feature
object
Id
required

Unique identifier of the feature.

string format: uuid
ServiceId
required

Unique identifier of the Service.

string format: uuid
IsActive
required

Whether the resource feature is still active.

boolean
Classification
required
Resource Feature Classification
string
Allowed values: SeaView RiverView OceanView TwinBeds DoubleBed RollawayBed UpperBed LowerBed Balcony AccessibleBathroom AccessibleRoom ElevatorAccess HighFloor Kitchenette AirConditioning PrivateJacuzzi PrivateSauna EnsuiteRoom PrivateBathroom SharedBathroom
Names
required
Localized text

All translations of the name.

object
key
additional properties
string
ShortNames
required
Localized text

All translations of the short name.

object
key
additional properties
string
Descriptions
required
Localized text

All translations of the description.

object
key
additional properties
string
CreatedUtc
required
string format: date-time
>= 1 characters
UpdatedUtc
required
string format: date-time
>= 1 characters
ResourceFeatureAssignments

Assignments of resource features to resources. Deprecated!

Array<object>
nullable
Resource feature assignment
object
Id
required

Unique identifier of the assignment.

string format: uuid
IsActive
required

Whether the assignment is still active.

boolean
ResourceId
required

Unique identifier of the Resource.

string format: uuid
FeatureId
required

Unique identifier of the Resource feature assigned to the Resource.

string format: uuid
CreatedUtc
required

Creation date and time of the assignment in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
UpdatedUtc
required

Last update date and time of the assignment in UTC timezone in ISO 8601 format.

string format: date-time
>= 1 characters
Cursor

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.

string format: uuid
nullable
Example
{
  "Resources": [
    {
      "Id": "5ee074b1-6c86-48e8-915f-c7aa4702086f",
      "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "IsActive": true,
      "Name": "101",
      "ParentResourceId": null,
      "State": "Dirty",
      "Descriptions": {},
      "Data": {
        "Discriminator": "Space",
        "Value": {
          "FloorNumber": "3",
          "LocationNotes": "A1"
        }
      },
      "CreatedUtc": "2016-03-29T15:14:06Z",
      "UpdatedUtc": "2016-03-29T15:14:06Z"
    },
    {
      "Id": "c32386aa-1cd2-414a-a823-489325842fbe",
      "EnterpriseId": "4d0201db-36f5-428b-8d11-4f0a65e960cc",
      "IsActive": true,
      "Name": "102",
      "ParentResourceId": null,
      "State": "Inspected",
      "Descriptions": {
        "en-US": "Resource description"
      },
      "Data": {
        "Discriminator": "Space",
        "Value": {
          "FloorNumber": "3",
          "LocationNotes": "B2"
        }
      },
      "CreatedUtc": "2016-03-29T15:14:06Z",
      "UpdatedUtc": "2016-03-29T15:14:06Z"
    }
  ],
  "ResourceCategories": [
    {
      "Id": "aaed6e21-1c1f-4644-9872-e53f96a21bf9"
    },
    {
      "ServiceId": "24e2ead5-65a8-4ed9-8286-abdb00f08a1f"
    },
    {
      "IsActive": true
    },
    {
      "Names": {
        "en-US": "Best Room"
      }
    },
    {
      "ShortNames": {
        "en-US": "BR"
      }
    },
    {
      "Descriptions": {}
    },
    {
      "Ordering": 0
    },
    {
      "Capacity": 2
    },
    {
      "ExtraCapacity": 0
    },
    {
      "ExternalIdentifier": "RT001-BestRoom"
    }
  ],
  "ResourceCategoryAssignments": [
    {
      "Id": "032298ad-b1b8-4936-9420-415a2152304a",
      "IsActive": true,
      "ResourceId": "5ee074b1-6c86-48e8-915f-c7aa4702086f",
      "CategoryId": "aaed6e21-1c1f-4644-9872-e53f96a21bf9",
      "CreatedUtc": "2016-03-29T15:14:06Z",
      "UpdatedUtc": "2016-03-29T15:14:06Z"
    }
  ],
  "ResourceCategoryImageAssignments": [
    {
      "Id": "f3475243-5962-4fb5-bdfd-958f9c65520e",
      "IsActive": true,
      "CategoryId": "aaed6e21-1c1f-4644-9872-e53f96a21bf9",
      "ImageId": "8cd435e0-f024-44a0-84fd-abe300b8ae1c",
      "CreatedUtc": "2016-03-29T15:14:06Z",
      "UpdatedUtc": "2016-03-29T15:14:06Z"
    }
  ],
  "ResourceFeatures": [
    {
      "Id": "a693dd8c-21fe-4dae-b450-ea3bd9ab3bb0",
      "ServiceId": "24e2ead5-65a8-4ed9-8286-abdb00f08a1f",
      "IsActive": true,
      "Classification": "AccessibleBathroom",
      "Names": {
        "en-US": "Accessible Bathroom"
      },
      "ShortNames": {
        "en-US": "AccessBath"
      },
      "Descriptions": {}
    }
  ],
  "ResourceFeatureAssignments": [
    {
      "Id": "ca2b5bf9-24f5-4faa-95ef-b65d38598b08",
      "IsActive": true,
      "ResourceId": "18019693-c66f-4be8-a893-c3d89fd291cc",
      "FeatureId": "a693dd8c-21fe-4dae-b450-ea3bd9ab3bb0",
      "CreatedUtc": "2016-03-29T15:14:06Z",
      "UpdatedUtc": "2016-03-29T15:14:06Z"
    }
  ],
  "Cursor": "c32386aa-1cd2-414a-a823-489325842fbe"
}

204

Section titled “204 ”

Server has successfully fulfilled the request and there is no additional information to send back.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

400

Section titled “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).

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

401

Section titled “401 ”

Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

403

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

408

Section titled “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

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

429

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable

500

Section titled “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.

ConnectorApiExceptionResult
object
Message
string
nullable
RequestId
string
nullable
Details
nullable