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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AccessTemplatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Business.AccessTemplate">
    <d2p1:AccessTemplateView>
      <d2p1:AccessCodeInitializationStrategy>Unique</d2p1:AccessCodeInitializationStrategy>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Organization xmlns:d4p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Business.Organization">
        <d4p1:Id>00000000-0000-0000-0000-000000000000</d4p1:Id>
        <d4p1:Name>String</d4p1:Name>
        <d4p1:SubOrganizations>
          <d4p1:OrganizationBasicView>
            <d4p1:Id>00000000-0000-0000-0000-000000000000</d4p1:Id>
            <d4p1:Name>String</d4p1:Name>
            <d4p1:SubOrganizations>
              <d4p1:OrganizationBasicView>
                <d4p1:Id>00000000-0000-0000-0000-000000000000</d4p1:Id>
                <d4p1:Name>String</d4p1:Name>
                <d4p1:SubOrganizations>
                  <d4p1:OrganizationBasicView i:nil="true" />
                </d4p1:SubOrganizations>
                <d4p1:Type>Unknown</d4p1:Type>
              </d4p1:OrganizationBasicView>
            </d4p1:SubOrganizations>
            <d4p1:Type>Unknown</d4p1:Type>
          </d4p1:OrganizationBasicView>
        </d4p1:SubOrganizations>
        <d4p1:Type>Unknown</d4p1:Type>
      </d2p1:Organization>
      <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
      <d2p1:Permission xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Permission>
      <d2p1:Scope>All</d2p1:Scope>
    </d2p1:AccessTemplateView>
  </Data>
</AccessTemplatesResponse>