| Requires any of the roles: | Admin, TenantAdmin, AccessTemplateAdmin, AccessAdmin |
| GET | /access/templates | Get access templates. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OnlyTemplatesWhereSmartSpaceUsesQueues | query | boolean | No | Whether the list of access templates should contain only those templates that include a smartspace which is configured to use queues. |
| Scope | query | AccessTemplateScope | No | Usage scope (who can use the template)Allowable Values
|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Version | form | integer | No | Api version |
| Name | Value |
|---|---|
| All | 0 |
| Guest | 1 |
| Staff | 2 |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Data | form | List<AccessTemplateView> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| OrganizationId | form | Guid | No | |
| Organization | form | OrganizationBasicView | No | |
| Name | form | string | No | |
| Permission | form | List<string> | No | |
| Description | form | string | No | |
| Scope | form | AccessTemplateScope | No | |
| AccessCodeInitializationStrategy | form | AccessCodeInitializationStrategy | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| Name | form | string | No | |
| Type | form | OrganizationType | No | |
| SubOrganizations | form | List<OrganizationBasicView> | No |
| Name | Value |
|---|---|
| Unknown | 0 |
| Admin | 10 |
| Tenant | 20 |
| Location | 30 |
| Name | Value |
|---|---|
| Unique | 0 |
| Shared | 1 |
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 /access/templates 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,
organizationId: 00000000000000000000000000000000,
organization:
{
id: 00000000000000000000000000000000,
name: String,
type: 0,
organizations:
[
{
id: 00000000000000000000000000000000,
name: String,
type: 0,
organizations:
[
{
id: 00000000000000000000000000000000,
name: String,
type: 0,
organizations:
[
{
}
]
}
]
}
]
},
name: String,
permission:
[
String
],
description: String,
scope: 0,
accessCodeInitializationStrategy: 0
}
],
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}