---
title: "Get resources' occupancy state"
method: POST
path: "/api/connector/v1/resources/getOccupancyState"
tags: ["Resources"]
---

# Get resources' occupancy state

`POST /api/connector/v1/resources/getOccupancyState`

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/).

## Request body

- ResourcesOccupancyStateFilterParameters
  - `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.
  - `ResourceCategoryIds` string[], required — Unique identifiers of the `ResourceCategory`.
  - `ResourceStates` ResourceState[], nullable — States of the `Resource`
  - `OccupancyStates` OccupancyStateEnum[], nullable — Occupancy states of the `Resource`.

## Response `200`

OK

- ResourcesOccupancyStateResult
  - `ResourceCategoryOccupancyStates` ResourceCategoryOccupancyState[], required — The resource categories.
    - `ResourceCategoryId` string, uuid, required — Unique identifier of the 'Resource category'.
    - `ResourceOccupancyStates` ResourceOccupancyState[], required — The resource occupancy states.
      - `ResourceId` string, uuid, required — Unique identifier of the resource.
      - `ResourceState` 'Dirty' | 'Clean' | 'Inspected' | 'OutOfService' | 'OutOfOrder', required — State of the resource. Dirty Clean Inspected OutOfService OutOfOrder
      - `OccupancyState` 'Vacant' | 'ReservedLocked' | 'Reserved' | 'InternalUse' | 'OutOfOrder', required — Occupancy states of the `Resource`. Vacant ReservedLocked Reserved InternalUse OutOfOrder

## 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/revisions/4bf95cbc375f/schema)