Connector API
  • Mews Connector API
  • Getting started
  • Usage guidelines
    • Authentication
    • Requests
    • Responses
    • Environments
    • Serialization
    • Pagination
    • Best practices
  • Concepts
    • Multi-property
    • Restrictions
    • Taxation
    • Time units
  • Use cases
    • 'How to' use cases
    • Accounting
    • Customer loyalty
    • Customer management
    • Customer messaging
    • Data export
    • Device integration
    • Events
    • Guest technology
    • Housekeeping
    • Kiosk
    • Mews Payment Terminals
    • Payment automation
    • Point of sale
    • Reputation management
    • Revenue management
    • Upsell
  • API Operations
    • Common objects
    • Accounting categories
    • Accounting items
    • Accounts
    • Account notes
    • Addresses
    • Age categories
    • Availability adjustments
    • Availability blocks
    • Bills
    • Business segments
    • Cancellation policies
    • Cashiers
    • Cashier transactions
    • Commands
    • Companies
    • Companionships
    • Company contracts
    • Configuration
    • Counters
    • Countries
    • Credit cards
    • Currencies
    • Customers
    • Departments
    • Devices
    • Enterprises
    • Exchange rates
    • Exports
    • Identity documents
    • Images
    • Languages
    • Loyalty memberships
    • Loyalty programs
    • Loyalty tiers
    • Messages
    • Message threads
    • Order items
    • Orders
    • Outlet bills
    • Outlet items
    • Outlets
    • Payments
    • Payment requests
    • Preauthorizations
    • Product categories
    • Product service orders
    • Products
    • Rates
    • Rate groups
    • Reservations
    • Reservation groups
    • Resource access tokens
    • Resource blocks
    • Resources
    • Resource categories
    • Resource features
    • Restrictions
    • Routing rules
    • Rules
    • Service order notes
    • Service overbooking limits
    • Services
    • Source assignments
    • Sources
    • Tasks
    • Tax environments
    • Taxations
    • Vouchers
    • Voucher codes
  • API Events
    • Ways to communicate
    • General Webhooks
    • Integration Webhooks
    • Webhooks FAQ
    • WebSockets
  • Your integration journey
    • Certification
  • Deprecations
    • Migration guide: Get all reservations
  • Changelog
    • Changelog 2024
    • Changelog 2023
    • Changelog 2022
    • Changelog 2021
    • Changelog 2020
    • Changelog 2019
    • Changelog 2018
    • Changelog 2017
    • Changelog 2016
Powered by GitBook
On this page
  • Get all resource access tokens
  • Request
  • Response
  • Add resource access tokens
  • Request
  • Response
  • Update resource access tokens
  • Request
  • Response
  • Delete resource access tokens
  • Request
  • Response

Was this helpful?

  1. API Operations

Resource access tokens

PreviousReservation groupsNextResource blocks

Last updated 3 months ago

Was this helpful?

Get all resource access tokens

Returns all resource access tokens based on resource access token identifiers, reservations or interval. One of them must be specified in the request. Note this operation uses and supports .

Request

[PlatformAddress]/api/connector/v1/resourceAccessTokens/getAll

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "EnterpriseIds": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "4d0201db-36f5-428b-8d11-4f0a65e960cc"
    ],
    "ResourceAccessTokenIds": [
        "90eff5aa-36b4-4689-80c0-ab3a00bb412e"
    ],
    "ServiceOrderIds": [
        "65eff5aa-36b4-4689-80c0-ab3a00bb412e"
    ],
    "CollidingUtc": {
        "StartUtc": "2020-02-15T00:00:00Z",
        "EndUtc": "2020-02-20T00:00:00Z"
    },
    "UpdatedUtc": {
        "StartUtc": "2020-01-05T00:00:00Z",
        "EndUtc": "2020-01-10T00:00:00Z"
    },
    "ActivityStates": [
        "Active"
    ],
    "Limitation": {
        "Cursor": "e7f26210-10e7-462e-9da8-ae8300be8ab7",
        "Count": 10
    }
}
Property
Type
Contract
Description

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.

EnterpriseIds

array of string

optional, max 1000 items

ResourceAccessTokenIds

array of string

optional, max 1000 items

ServiceOrderIds

array of string

optional, max 1000 items

Unique identifiers of reservations. Required if no other filter is provided.

CollidingUtc

optional, max length 3 months

UpdatedUtc

optional, max length 3 months

ActivityStates

optional

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

Limitation

required

Limitation on the quantity of tokens returned.

Response

{
    "ResourceAccessTokens": [
        {
            "Id": "72d4b117-1f84-44a3-1f84-8b2c0635ac60",
            "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ServiceOrderId": "35d4b117-4e60-44a3-9580-c582117eff98",
            "CompanionshipId": "25d4b117-4e60-44a3-9580-c582117eff98",
            "ResourceId": "65d4b117-4e60-44a3-9580-c582117eff98",
            "Type": "PinCode",
            "Value": "1234#",
            "SerialNumber": null,
            "ValidityStartUtc": "2020-10-09T22:00:00Z",
            "ValidityEndUtc": "2020-10-10T22:00:00Z",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "IsActive": true,
            "Permissions":
            {
                "Bed": true,
                "Room": false,
                "Floor": false,
                "Building": false
            }
        }
    ],
    "Cursor": "8d02142f-31cf-4115-90bf-ae5200c7a1ba"
}
Property
Type
Contract
Description

ResourceAccessTokens

required

Resource access tokens.

Cursor

string

required

Resource access token

Property
Type
Contract
Description

Id

string

required

EnterpriseId

string

required

ServiceOrderId

string

required

Unique identifier of a reservation.

CompanionshipId

string

optional

ResourceId

string

optional

Type

required

Type of stored value.

Value

string

required

Value of resource access token

SerialNumber

string

optional

ValidityStartUtc

string

required

Marks the start of interval in which the resource access token can be used.

ValidityEndUtc

string

required

Marks the end of interval in which the resource access token can be used.

CreatedUtc

string

required

Creation date and time of the resource access token in UTC timezone in ISO 8601 format.

UpdatedUtc

string

required

Last update date and time of the resource access token in UTC timezone in ISO 8601 format.

IsActive

boolean

required

Whether the resource access token is still active.

Permissions

required

Resource access token type

  • PinCode

  • RfidTag

Resource access token permissions

Property
Type
Contract
Description

Bed

bool

required

Room

bool

required

Floor

bool

required

Building

bool

required

Add resource access tokens

Adds new resource access tokens with the specified data.

Request

[PlatformAddress]/api/connector/v1/resourceAccessTokens/add

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ResourceAccessTokenParameters": [
        {
            "ServiceOrderId": "35d4b117-4e60-44a3-9580-c582117eff98",
            "CompanionshipId": "25d4b117-4e60-44a3-9580-c582117eff98",
            "ResourceId": "65d4b117-4e60-44a3-9580-c582117eff98",
            "Type": "PinCode",
            "Value": "1234#",
            "SerialNumber": null,
            "ValidityStartUtc": "2020-10-09T22:00:00Z",
            "ValidityEndUtc": "2020-10-10T22:00:00Z",
            "Permissions":
            {
                "Bed": { "Value": true },
                "Room": { "Value": false },
                "Floor": { "Value": false },
                "Building": { "Value": false }
            }
        }
    ]
}
Property
Type
Contract
Description

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.

ResourceAccessTokenParameters

required, max 1000 items

Resource access token parameter

Property
Type
Contract
Description

ServiceOrderId

string

required

Unique identifier of a reservation.

CompanionshipId

string

optional

ResourceId

string

optional

Type

required

Type of stored value.

Value

string

required

Value of resource access token

SerialNumber

string

optional

ValidityStartUtc

string

required

Marks the start of interval in which the resource access token can be used.

ValidityEndUtc

string

required

Marks the end of interval in which the resource access token can be used.

Permissions

required

Resource access token permission parameter

Property
Type
Contract
Description

Bed

optional

Room

optional

Floor

optional

Building

optional

Response

{
    "ResourceAccessTokens": [
        {
            "Id": "72d4b117-1f84-44a3-1f84-8b2c0635ac60",
            "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ServiceOrderId": "35d4b117-4e60-44a3-9580-c582117eff98",
            "CompanionshipId": "25d4b117-4e60-44a3-9580-c582117eff98",
            "ResourceId": "65d4b117-4e60-44a3-9580-c582117eff98",
            "Type": "PinCode",
            "Value": "1234#",
            "SerialNumber": null,
            "ValidityStartUtc": "2020-10-09T22:00:00Z",
            "ValidityEndUtc": "2020-10-10T22:00:00Z",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "IsActive": true,
            "Permissions":
            {
                "Bed": true,
                "Room": false,
                "Floor": false,
                "Building": false
            }
        }
    ]
}
Property
Type
Contract
Description

ResourceAccessTokens

required

Resource access tokens.

Update resource access tokens

Request

[PlatformAddress]/api/connector/v1/resourceAccessTokens/update

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "ResourceAccessTokenUpdates": [
        {
            "ResourceAccessTokenId": "35d4b117-4e60-44a3-9580-c582117eff98",
            "ValidityStartUtc": { "Value": "2020-10-09T22:00:00Z" },
            "ValidityEndUtc": { "Value": "2020-10-10T22:00:00Z" },
            "Value": { "Value": "1234#" },
            "Permissions":
            {
                "Bed": { "Value": true },
                "Room": { "Value": false },
                "Floor": { "Value": false },
                "Building": { "Value": false }
            }
        }
    ]
}
Property
Type
Contract
Description

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.

ResourceAccessTokenUpdates

required

Resource access token update

Property
Type
Contract
Description

ResourceAccessTokenId

required

ValidityStartUtc

optional

Marks the start of interval in which the resource access token can be used.

ValidityEndUtc

optional

Marks the end of interval in which the resource access token can be used.

Value

optional

Value of resource access token.

Permissions

optional

Response

{
    "ResourceAccessTokens": [
        {
            "Id": "72d4b117-1f84-44a3-1f84-8b2c0635ac60",
            "EnterpriseId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "ServiceOrderId": "35d4b117-4e60-44a3-9580-c582117eff98",
            "CompanionshipId": "25d4b117-4e60-44a3-9580-c582117eff98",
            "ResourceId": "65d4b117-4e60-44a3-9580-c582117eff98",
            "Type": "PinCode",
            "Value": "1234#",
            "SerialNumber": null,
            "ValidityStartUtc": "2020-10-09T22:00:00Z",
            "ValidityEndUtc": "2020-10-10T22:00:00Z",
            "CreatedUtc": "2023-10-01T11:48:57Z",
            "UpdatedUtc": "2023-10-28T11:48:57Z",
            "IsActive": true,
            "Permissions":
            {
                "Bed": true,
                "Room": false,
                "Floor": false,
                "Building": false
            }
        }
    ]
}
Property
Type
Contract
Description

ResourceAccessTokens

required

Resource access tokens.

Delete resource access tokens

Delete specified resource access tokens.

Request

[PlatformAddress]/api/connector/v1/resourceAccessTokens/delete

{
    "ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
    "AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
    "Client": "Sample Client 1.0.0",
    "Ids": [
        "35d4b117-4e60-44a3-9580-c582117eff98"
    ]
}
Property
Type
Contract
Description

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.

Ids

Array of string

required

Response

{}

Unique identifiers of the . If not specified, the operation returns data for all enterprises within scope of the Access Token.

Unique identifiers of . Required if no other filter is provided.

Interval in which the is valid. Required if no other filter is provided.

Interval in which was updated.

array of string

array of

Unique identifier of the last and hence oldest item returned. This can be used in in a subsequent request to fetch the next batch of older tokens. If is specified in the request message, then Cursor will always be included in the response message.

Unique identifier of .

Unique identifier of the .

Unique identifier of .

Unique identifier of .

Serial number of .

Specify permissions of .

Specify whether grants permission to access bed.

Specify whether grants permission to access room.

Specify whether grants permission to access floor.

Specify whether grants permission to access building.

Array of

Parameters of .

Unique identifier of .

Unique identifier of .

Serial number of .

Specify permissions of .

Specify whether grants permission to access bed.

Specify whether grants permission to access room.

Specify whether grants permission to access floor.

Specify whether grants permission to access building.

array of

Updates the validity interval and that it grants.

Array of

Parameters of .

Unique identifier of .

Specify permissions of .

array of

Unique identifiers of .

Pagination
Portfolio Access Tokens
Resource access token
permissions
Resource access tokens
Resource access token
Resource access token
Resource access token
Resource access token
Resource access token type
Resource access token type
Resource access token permissions
Resource access token
Resource access token
Resource access token
Resource access token
Resource access token
Resource access token parameter
Resource access token
Resource access token type
Resource access token type
Resource access token permission parameter
Resource access token
Resource access token
Resource access token
Resource access token
Resource access token
Resource access token
Resource access token update
Resource access token
Resource access token
Resource access token permission parameter
Resource access token
Resource access token
Resource access token
Limitation
Limitation
Limitation
Enterprises
Enterprise
Resource
Resource
Time interval
Time interval
Activity state
Bool update value
Bool update value
Bool update value
Bool update value
String update value
String update value
String update value
String update value
Companionship
Companionship