Viviot.Api

GetAccessTemplate

**Requires Authentication**
Requires any of the roles:	Admin, TenantAdmin, AccessTemplateAdmin

The following routes are available for this service:
GET	/access/template	Get access template.

**GetAccessTemplate** Parameters:
Name	Parameter	Data Type	Required	Description
AccessTemplateId	query	string	Yes	Access templateId Id (GUID)
LoadOrganization	query	boolean	No	Include organization object in the response

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	integer	No	Api version

**AccessTemplatesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Data	form	List<AccessTemplateView>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No

**AccessTemplateView** Parameters:
Name	Parameter	Data Type	Required
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

**OrganizationBasicView** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Name	form	string	No
Type	form	OrganizationType	No
SubOrganizations	form	List<OrganizationBasicView>	No

**OrganizationType** Enum:
Name	Value
Unknown	0
Admin	10
Tenant	20
Location	30

**AccessTemplateScope** Enum:
Name	Value
All	0
Guest	1
Staff	2

**AccessCodeInitializationStrategy** Enum:
Name	Value
Unique	0
Shared	1

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}