Resources
Get all resources
Returns all resources of an enterprise associated with the connector integration. Note that when any of the extents is set to true
, the response contains the entities that are associated to a resource. If the extent is not associated to a resource (e.g. resource category not assigned to any resource), this information is not returned. Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/resources/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 the requested Resources. |
| optional, max length 3 months | Interval in which the Resources were created. | |
| optional, max length 3 months | Interval in which the Resources were updated. | |
| required | Extent of data to be returned. | |
| required | Limitation on the quantity of data returned. |
Resource extent
Property | Type | Contract | Description |
---|---|---|---|
| bool | optional | Whether the response should contain resources. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| bool | optional | Whether the response should contain inactive entities. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource | optional | The resources of the enterprise. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| string | optional | Unique identifier of the item one newer in time order than the items to be returned. If Cursor is not specified, i.e. null, then the latest or most recent items will be returned. |
Resource
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the resource. |
| string | required | Unique identifier of the Enterprise. |
| bool | required | Whether the resource is still active. |
| string | required | Name of the resource (e.g. room number). |
| string | optional | Identifier of the parent Resource (e.g. room of a bed). |
| string Resource state | required | State of the resource. |
| required | Additional data of the resource. | |
| string | required | Creation date and time of the resource in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the resource in UTC timezone in ISO 8601 format. |
Resource state
Dirty
Clean
Inspected
OutOfService
OutOfOrder
Resource data
Property | Type | Contract | Description |
---|---|---|---|
| string Resource data discriminator | required | If resource is space, object or person. |
| object | required | Based on Resource data discriminator, e.g. Space resource data |
Resource data discriminator
Space
Object
Person
Space resource data
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Number of the floor the space is on. |
| string | optional | Location notes for the space. It can be eg. Building number the space is located in or the Parking area the particular parking space is at. |
Object resource data
Person resource data
Resource category
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the category. |
| bool | required | Whether the category is still active. |
| string Resource category type | required | Type of the category. |
| required | All translations of the name. | |
| required | All translations of the short name. | |
| required | All translations of the description. | |
| number | required | Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed). |
| number | required | Extra capacity that can be served (e.g. extra bed count). |
| string | optional, max 255 characters | Identifier of the resource category from external system. |
Resource category type
Room
Dorm
Bed
...
Update resources
Updates details of the resources.
Request
[PlatformAddress]/api/connector/v1/resources/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 update | required | Resource updates. |
Resource update
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the Resource which is updated. |
| optional | New name of the resource (e.g. room number). | |
| optional | Identifier of the new parent Resource. | |
| optional | New additional data of the resource. | |
| optional | New Resource state except | |
| optional | New reason for the state of the resource. |
Resource data update
Property | Type | Contract | Description |
---|---|---|---|
| string Resource data discriminator | required | Defines the type of the resource. |
| object | required | Based on Resource data discriminator, e.g. Space resource data update |
Space resource data update
Property | Type | Contract | Description |
---|---|---|---|
| required | New number of the floor the space is on. | |
| optional | New location notes for the space. |
Response
Last updated