Skip to content

Get all resource features

POST
/api/connector/v1/resourceFeatures/getAll

Returns all resource features. This operation uses Pagination.

ResourceFeatureFilterParameters
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
ResourceFeatureIds

Unique identifiers of Resource features.

Array<string>
nullable >= 1 items <= 1000 items
ServiceIds
required

Unique identifiers of Services to which the resource features belong.

Array<string>
<= 1000 items
UpdatedUtc
TimeFilterInterval
object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
ActivityStates

Whether to return only active, only deleted or both records.

Array<string>
nullable
Allowed values: Deleted Active
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
}
}

OK

ResourceFeatureResult
object
ResourceFeatures
required

Resource features.

Array<object>
<= 1000 items
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
Cursor

Unique identifier of the last and hence oldest resource features returned. This can be used in Limitation in a subsequent request to fetch the next batch of older resource feature.

string format: uuid
nullable
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"
}

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

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

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

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

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

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

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