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.
Request Body
Section titled “Request Body ”object
Token identifying the client application.
Access token of the client application.
Name and version of the client application.
Unique identifiers of the Resource category.
States of the Resource
Occupancy states of the Resource.
Example
{ "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D", "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D", "Client": "Sample Client 1.0.0", "ResourceCategoryIds": [ "773d5e42-de1e-43a0-9ce6-f940faf2303f" ], "ResourceStates": [ "Clean", "Inspected" ], "OccupancyStates": [ "Vacant", "Reserved" ]}Responses
Section titled “ Responses ”OK
object
The resource categories.
The list of ResourceOccupancyStates grouped by resource category.
object
Unique identifier of the ‘Resource category’.
The resource occupancy states.
The occupancy state of a Resource.
object
Unique identifier of the resource.
Resource state of the resource.
Dirty
Clean
Inspected
OutOfService
OutOfOrder
State of the resource.
Vacant
ReservedLocked
Reserved
InternalUse
OutOfOrder
Example
{ "ResourceCategoryOccupancyStates": [ { "ResourceCategoryId": "773d5e42-de1e-43a0-9ce6-f940faf2303f", "ResourceOccupancyStates": [ { "ResourceId": "f3b3b3b3-3b3b-3b3b-3b3b-3b3b3b3b3b3b", "ResourceState": "Inspected", "OccupancyState": "Reserved" }, { "ResourceId": "c32386aa-1cd2-414a-a823-489325842fbe", "ResourceState": "Inspected", "OccupancyState": "Vacant" } ] } ]}Server has successfully fulfilled the request and there is no additional information to send back.
object
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).
object
Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint.
object
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.
object
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
object
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.
object
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.