Skip to content
Mews Open API

Get all resource categories

POST
/api/connector/v1/resourceCategories/getAll

Returns all categories of resources. This operation uses Pagination.

Request Body

Section titled “Request Body ”
ResourceCategoryFilterParameters
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
ResourceCategoryIds

Unique identifiers of Resource categories.

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

Unique identifiers of Services to which the resource categories belong.

Array<string>
>= 1 items <= 1000 items
UpdatedUtc
TimeFilterInterval

Interval in which the resource categories were updated.

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"
  ],
  "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

Section titled “ Responses ”

200

Section titled “200 ”

OK

ResourceCategoryResult
object
ResourceCategories
required

Resource categories of the resources.

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

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

string format: uuid
nullable
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": null
    },
    {
      "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": null
    }
  ],
  "Cursor": "47d6b462-35ec-467e-a565-b00300781a41"
}

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