Viviot.Api

<back to all web services

GetAccessTemplate

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessTemplateAdmin
The following routes are available for this service:
GET/access/templateGet access template.
GetAccessTemplate Parameters:
NameParameterData TypeRequiredDescription
AccessTemplateIdquerystringYesAccess templateId Id (GUID)
LoadOrganizationquerybooleanNoInclude organization object in the response
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
AccessTemplatesResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<AccessTemplateView>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AccessTemplateView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
OrganizationformOrganizationBasicViewNo
NameformstringNo
PermissionformList<string>No
DescriptionformstringNo
ScopeformAccessTemplateScopeNo
AccessCodeInitializationStrategyformAccessCodeInitializationStrategyNo
OrganizationBasicView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
TypeformOrganizationTypeNo
SubOrganizationsformList<OrganizationBasicView>No
OrganizationType Enum:
NameValue
Unknown0
Admin10
Tenant20
Location30
AccessTemplateScope Enum:
NameValue
All0
Guest1
Staff2
AccessCodeInitializationStrategy Enum:
NameValue
Unique0
Shared1

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /access/template HTTP/1.1 
Host: api.4spaces.io 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{Unable to show example output for type 'AccessTemplatesResponse' using the custom 'csv' filter}One or more errors occurred. (Unable to cast object of type 'ServiceStack.Host.BasicResponse' to type 'ServiceStack.Host.NetCore.NetCoreResponse'.)