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
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.
Resource extent
Resources
bool
optional
Whether the response should contain resources.
ResourceCategories
bool
optional
Whether the response should contain categories. Deprecated! Please use Get all resource categories
ResourceCategoryAssignments
bool
optional
Whether the response should contain assignments of the resources to categories. Deprecated! Please use Get all resource category assignments
ResourceCategoryImageAssignments
bool
optional
Whether the response should contain assignments of the images to categories. Deprecated! Please use Get all resource category image assignments
ResourceFeatures
bool
optional
Whether the response should contain resource features. Deprecated! Please use Get all resource features
ResourceFeatureAssignments
bool
optional
Whether the response should contain assignments of the resources to features. Deprecated! Please use Get all resource feature assignments
Inactive
bool
optional
Whether the response should contain inactive entities.
Response
ResourceCategories
array of Resource category
optional
Categories of resources in the enterprise. Deprecated!
ResourceCategoryAssignments
array of Resource category assignment
optional
Assignments of resources to categories. Deprecated!
ResourceCategoryImageAssignments
array of Resource category image assignment
optional
Assignments of images to categories. Deprecated!
ResourceFeatures
array of Resource feature
optional
Features of resources in the enterprise. Deprecated!
ResourceFeatureAssignments
array of Resource feature assignment
optional
Assignments of resource features to resources. Deprecated!
Cursor
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
Id
string
required
Unique identifier of the resource.
IsActive
bool
required
Whether the resource is still active.
Name
string
required
Name of the resource (e.g. room number).
CreatedUtc
string
required
Creation date and time of the resource in UTC timezone in ISO 8601 format.
UpdatedUtc
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
Resource data discriminator
Space
Object
Person
Space resource data
FloorNumber
string
required
Number of the floor the space is on.
LocationNotes
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
Id
string
required
Unique identifier of the category.
IsActive
bool
required
Whether the category is still active.
Ordering
number
required
Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed).
ExtraCapacity
number
required
Extra capacity that can be served (e.g. extra bed count).
ExternalIdentifier
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
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.
Resource update
Resource data update
Space resource data update
Response
Last updated