Skip to content
Mews Open API

Get all resource blocks

POST
/api/connector/v1/resourceBlocks/getAll

Returns all resource blocks (out of order blocks or internal use blocks). Note this operation uses Pagination and supports Portfolio Access Tokens.

Request Body

Section titled “Request Body ”
ResourceBlockParameters
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
Extent
ResourceBlockExtent

Extent of data to be returned.

object
Inactive
boolean
ResourceBlockIds

Unique identifiers of the requested Resource blocks.

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

Unique identifiers of the requested Assigned Resources.

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

Whether to return only active, only deleted or both records. Defaults to Active if not specified.

Array<string>
nullable
Allowed values: Deleted Active
CollidingUtc
TimeFilterInterval
object
StartUtc
string format: date-time
nullable
EndUtc
string format: date-time
nullable
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"
  ],
  "ResourceBlockIds": [
    "c478f1b3-7edb-4ccc-8f07-dd32fae1ca70"
  ],
  "AssignedResourceIds": [
    "b64f088d-49b5-4d5f-9766-2e27c4b75e27"
  ],
  "CollidingUtc": {
    "StartUtc": "2020-01-25T00:00:00Z",
    "EndUtc": "2020-01-30T00:00:00Z"
  },
  "CreatedUtc": {
    "StartUtc": "2020-01-05T00:00:00Z",
    "EndUtc": "2020-01-10T00:00:00Z"
  },
  "UpdatedUtc": {
    "StartUtc": "2020-01-15T00:00:00Z",
    "EndUtc": "2020-01-20T00:00:00Z"
  },
  "Extent": {
    "Inactive": true
  },
  "Limitation": {
    "Count": 10
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

ResourceBlockResult
object
ResourceBlocks
required

Resource blocks added.

Array<object>
<= 1000 items
Resource block
object
Id
required

Unique identifier of the block.

string format: uuid
EnterpriseId
required
string format: uuid
AssignedResourceId
required

Unique identifier of the assigned Resource.

string format: uuid
IsActive
required

Whether the block is still active.

boolean
Type
required
string
Allowed values: OutOfOrder InternalUse
StartUtc
required

Start of the block in UTC timezone in ISO 8601 format.

string
>= 1 characters
EndUtc
required

End of the block in UTC timezone in ISO 8601 format.

string
>= 1 characters
CreatedUtc
required

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

string
>= 1 characters
UpdatedUtc
required

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

string
>= 1 characters
DeletedUtc

Date and time when the block was deleted (for inactive ones) in UTC timezone in ISO 8601 format.

string
nullable
Name
required

Name of the resource block.

string
>= 1 characters
Notes

Note describing the resource block.

string
nullable
Cursor
string format: uuid
nullable
Example
{
  "ResourceBlocks": [
    {
      "Id": "0913bd1d-69fc-4bcb-82d3-5a40520c8fb0",
      "AssignedResourceId": "0d71d44e-3d85-4506-9b6f-aab500b69c52",
      "Name": "Resource block 1",
      "StartUtc": "2019-10-15T10:00:00Z",
      "EndUtc": "2019-10-20T10:00:00Z",
      "Type": "OutOfOrder",
      "CreatedUtc": "2016-06-01T15:14:06Z",
      "UpdatedUtc": "2016-06-01T15:14:06Z"
    },
    {
      "Id": "4d98ad40-a726-409e-8bf3-2c12ff3c0331",
      "AssignedResourceId": "f7c4b4f5-ac83-4977-a41a-63d27cc6e3e9",
      "Name": "Resource block 2",
      "StartUtc": "2019-10-15T10:00:00Z",
      "EndUtc": "2019-10-20T10:00:00Z",
      "Type": "InternalUse",
      "CreatedUtc": "2016-06-01T15:14:06Z",
      "UpdatedUtc": "2016-06-01T15:14:06Z"
    }
  ]
}

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