| Requires any of the roles: | Admin, TenantAdmin, AccessAdmin, Receptionist |
| GET | /reservation/accessTemplates | Gets a list of access templates with corresponding smartspaces and availability status for the reservation screen. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AvailableFrom | query | string | Yes | Gets or sets the available from time in UTC. |
| AvailableTo | query | string | No | Gets or sets the available to time in UTC. |
| ThingTypeId | query | string | No | Filter result by thing type ID (optional). |
| AvailableOnly | query | string | No | Whether to return access templates with available things only. Default FALSE. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | List<ReservationAccessTemplateView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No | |
| Description | form | string | No | |
| IsAvailable | form | bool | No | |
| Tags | form | List<TagDto> | No | |
| Smartspaces | form | List<ReservationSmartSpaceDto> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No | |
| TagGroupId | form | Guid | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No | |
| AccessFrom | form | TimeSpan? | No | |
| AccessTo | form | TimeSpan? | No | |
| AccessCount | form | int? | No | |
| AccessCardNumbers | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reservation/accessTemplates HTTP/1.1 Host: api.4spaces.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
data:
[
{
id: 00000000000000000000000000000000,
name: String,
description: String,
isAvailable: False,
tags:
[
{
id: 00000000000000000000000000000000,
name: String,
tagGroupId: 00000000000000000000000000000000
}
],
smartspaces:
[
{
id: 00000000000000000000000000000000,
name: String,
accessFrom: PT0S,
accessTo: PT0S,
accessCount: 0,
accessCardNumbers: String
}
]
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}