Resource access tokens

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 Pagination and supports Portfolio Access Tokens.

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
    }
}
PropertyTypeContractDescription

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

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

ResourceAccessTokenIds

array of string

optional, max 1000 items

Unique identifiers of Resource access tokens. Required if no other filter is provided.

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

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

UpdatedUtc

optional, max length 3 months

Interval in which Resource access token was updated.

ActivityStates

array of string Activity state

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"
}
PropertyTypeContractDescription

ResourceAccessTokens

required

Resource access tokens.

Cursor

string

required

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

Resource access token

PropertyTypeContractDescription

Id

string

required

Unique identifier of Resource access token.

EnterpriseId

string

required

Unique identifier of the Enterprise.

ServiceOrderId

string

required

Unique identifier of a reservation.

CompanionshipId

string

optional

Unique identifier of Companionship.

ResourceId

string

optional

Unique identifier of Resource.

Type

required

Type of stored value.

Value

string

required

Value of resource access token

SerialNumber

string

optional

Serial number of Resource access token type.

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

Specify permissions of Resource access token.

Resource access token type

  • PinCode

  • RfidTag

Resource access token permissions

PropertyTypeContractDescription

Bed

bool

required

Specify whether Resource access token grants permission to access bed.

Room

bool

required

Specify whether Resource access token grants permission to access room.

Floor

bool

required

Specify whether Resource access token grants permission to access floor.

Building

bool

required

Specify whether Resource access token grants permission to access building.

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 }
            }
        }
    ]
}
PropertyTypeContractDescription

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

Parameters of Resource access token.

Resource access token parameter

PropertyTypeContractDescription

ServiceOrderId

string

required

Unique identifier of a reservation.

CompanionshipId

string

optional

Unique identifier of Companionship.

ResourceId

string

optional

Unique identifier of Resource.

Type

required

Type of stored value.

Value

string

required

Value of resource access token

SerialNumber

string

optional

Serial number of Resource access token type.

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

Specify permissions of Resource access token.

Resource access token permission parameter

PropertyTypeContractDescription

Bed

optional

Specify whether Resource access token grants permission to access bed.

Room

optional

Specify whether Resource access token grants permission to access room.

Floor

optional

Specify whether Resource access token grants permission to access floor.

Building

optional

Specify whether Resource access token grants permission to access building.

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
            }
        }
    ]
}
PropertyTypeContractDescription

ResourceAccessTokens

required

Resource access tokens.

Update resource access tokens

Updates the Resource access token validity interval and permissions that it grants.

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" },
            "Permissions":
            {
                "Bed": { "Value": true },
                "Room": { "Value": false },
                "Floor": { "Value": false },
                "Building": { "Value": false }
            }
        }
    ]
}
PropertyTypeContractDescription

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

Parameters of Resource access token.

Resource access token update

PropertyTypeContractDescription

ResourceAccessTokenId

required

Unique identifier of Resource access token.

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.

Permissions

optional

Specify permissions of Resource access token.

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
            }
        }
    ]
}
PropertyTypeContractDescription

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"
    ]
}
PropertyTypeContractDescription

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

Unique identifiers of Resource access token.

Response

{}

Last updated