Resource access tokens
Last updated
Was this helpful?
Last updated
Was this helpful?
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 .
[PlatformAddress]/api/connector/v1/resourceAccessTokens/getAll
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.
ResourceAccessTokens
required
Resource access tokens.
Cursor
string
required
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
PinCode
RfidTag
Bed
bool
required
Room
bool
required
Floor
bool
required
Building
bool
required
Adds new resource access tokens with the specified data.
[PlatformAddress]/api/connector/v1/resourceAccessTokens/add
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
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
Bed
optional
Room
optional
Floor
optional
Building
optional
ResourceAccessTokens
required
Resource access tokens.
[PlatformAddress]/api/connector/v1/resourceAccessTokens/update
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
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
ResourceAccessTokens
required
Resource access tokens.
Delete specified resource access tokens.
[PlatformAddress]/api/connector/v1/resourceAccessTokens/delete
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 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 .