Resource categories
Get all resource categories
Returns all categories of resources. This operation uses Pagination.
Request
[PlatformAddress]/api/connector/v1/resourceCategories/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 the resource categories for all enterprises within scope of the Access Token. |
| array of string | optional, max 1000 items | Unique identifiers of Resource categories. |
| array of string | required, max 1000 items | Unique identifiers of Services to which the resource categories belong. |
| optional, max length 3 months | Interval in which the resource categories were updated. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of resource categories returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource category | optional | Resource categories of the resources. |
| string | required | Unique identifier of the last and hence oldest resource category returned. This can be used in Limitation in a subsequent request to fetch the next batch of older resource categories. |
Resource category
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the category. |
| string | required | Unique identifier of the Enterprise. |
| string | required | Unique identifier of the Service of the resource category. |
| bool | required | Whether the resource category is still active. |
| string | required | |
| 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. |
Get all resource category assignments
Returns all resource category assignments. This operation uses Pagination.
Request
[PlatformAddress]/api/connector/v1/resourceCategoryAssignments/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 the resource category assignments for all enterprises within scope of the Access Token. |
| array of string | required, max 1000 items | Unique identifiers of Resource categories to which the resource category assignment belong. |
| array of string | optional, max 1000 items | Unique identifiers of Resource category assignment. |
| optional, max length 3 months | Interval in which the resource category assignments were updated. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of resource category assignments returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource category assignment | optional | Resource category assignments. |
| string | required | Unique identifier of the last and hence oldest resource category assignment returned. This can be used in Limitation in a subsequent request to fetch the next batch of older resource category assignments. |
Resource category assignment
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the assignment. |
| bool | required | Whether the assignment is still active. |
| string | required | Unique identifier of the Resource category. |
| string | required | Unique identifier of the Resource assigned to the Resource category. |
| string | required | Creation date and time of the assignment in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the assignment in UTC timezone in ISO 8601 format. |
Get all resource category image assignments
Returns all resource category image assignments. This operation uses Pagination.
Request
[PlatformAddress]/api/connector/v1/resourceCategoryImageAssignments/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 the resource category image assignments for all enterprises within scope of the Access Token. |
| array of string | required, max 1000 items | Unique identifiers of Resource categories to which the resource category image assignments belong. |
| array of string | optional, max 1000 items | Unique identifiers of Resource category image assignments. |
| optional, max length 3 months | Interval in which the resource category image assignments were updated. | |
| array of string Activity state | optional | Whether to return only active, only deleted or both records. |
| required | Limitation on the quantity of resource category image assignments returned. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource category image assignment | optional | Resource category image assignments. |
| string | required | Unique identifier of the last and hence oldest resource category image assignment returned. This can be used in Limitation in a subsequent request to fetch the next batch of older resource category image assignments. |
Resource category image assignment
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the assignment. |
| bool | required | Whether the assignment is still active. |
| string | required | Unique identifier of the Resource category. |
| string | required | Unique identifier of the image assigned to the Resource category. |
| string | required | Creation date and time of the assignment in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the assignment in UTC timezone in ISO 8601 format. |
Resource category type
Room
Bed
Dorm
Apartment
Suite
Villa
Site
Office
MeetingRoom
ParkingSpot
Desk
TeamArea
Membership
Tent
CaravanOrRV
UnequippedCampsite
...
Last updated