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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| 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. |
| array of string | optional, max 1000 items | Unique identifiers of Resource access tokens. Required if no other filter is provided. |
| array of string | optional, max 1000 items | Unique identifiers of reservations. Required if no other filter is provided. |
| optional, max length 3 months | Interval in which the Resource access token is valid. Required if no other filter is provided. | |
| optional, max length 3 months | Interval in which Resource access token was updated. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of tokens returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource access token | required | Resource access tokens. |
| 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 |
Resource access token
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of Resource access token. |
| string | required | Unique identifier of the Enterprise. |
| string | required | Unique identifier of a reservation. |
| string | optional | Unique identifier of Companionship. |
| string | optional | Unique identifier of Resource. |
| required | Type of stored value. | |
| string | required | Value of resource access token |
| string | optional | Serial number of Resource access token type. |
| string | required | Marks the start of interval in which the resource access token can be used. |
| string | required | Marks the end of interval in which the resource access token can be used. |
| string | required | Creation date and time of the resource access token in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the resource access token in UTC timezone in ISO 8601 format. |
| boolean | required | Whether the resource access token is still active. |
| required | Specify permissions of Resource access token. |
Resource access token type
PinCode
RfidTag
Resource access token permissions
Property | Type | Contract | Description |
---|---|---|---|
| bool | required | Specify whether Resource access token grants permission to access bed. |
| bool | required | Specify whether Resource access token grants permission to access room. |
| bool | required | Specify whether Resource access token grants permission to access floor. |
| 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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| Array of Resource access token parameter | required, max 1000 items | Parameters of Resource access token. |
Resource access token parameter
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of a reservation. |
| string | optional | Unique identifier of Companionship. |
| string | optional | Unique identifier of Resource. |
| required | Type of stored value. | |
| string | required | Value of resource access token |
| string | optional | Serial number of Resource access token type. |
| string | required | Marks the start of interval in which the resource access token can be used. |
| string | required | Marks the end of interval in which the resource access token can be used. |
| required | Specify permissions of Resource access token. |
Resource access token permission parameter
Property | Type | Contract | Description |
---|---|---|---|
| optional | Specify whether Resource access token grants permission to access bed. | |
| optional | Specify whether Resource access token grants permission to access room. | |
| optional | Specify whether Resource access token grants permission to access floor. | |
| optional | Specify whether Resource access token grants permission to access building. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource access token | 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
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| Array of Resource access token update | required | Parameters of Resource access token. |
Resource access token update
Property | Type | Contract | Description |
---|---|---|---|
| required | Unique identifier of Resource access token. | |
| optional | Marks the start of interval in which the resource access token can be used. | |
| optional | Marks the end of interval in which the resource access token can be used. | |
| optional | Specify permissions of Resource access token. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource access token | required | Resource access tokens. |
Delete resource access tokens
Delete specified resource access tokens.
Request
[PlatformAddress]/api/connector/v1/resourceAccessTokens/delete
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| Array of string | required | Unique identifiers of Resource access token. |
Response
Last updated