Viviot.Api

UpdateAccessTemplate

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

The following routes are available for this service:
PUT	/access/template	Updates an access template.

**UpdateAccessTemplate** Parameters:
Name	Parameter	Data Type	Required	Description
AccessTemplateId	body	string	Yes	Access template Id (GUID)

**EditAccessTemplate** Parameters:
Name	Parameter	Data Type	Required	Description
Name	form	string	Yes	Access template name
Description	form	string	No	Access template Description
Things	form	array	Yes	IDs and configuration of permitted things
Scope	form	AccessTemplateScope	Yes	Usage scope (who can use the template) Allowable Values All Guest Staff
AccessCodeInitializationStrategy	form	AccessCodeInitializationStrategy	Yes	How the access codes for a reservation from this template will be initialized. Allowable Values Unique Shared

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

**ThingAccessTemplateDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid?	No
OrganizationId	form	Guid	No
ThingId	form	Guid	No
ThingName	form	string	No
ThingTypeName	form	string	No
Exclusive	form	bool	No
AvailableFrom	form	int?	No
AvailableTo	form	int?	No
AccessCount	form	int?	No
AccessLevel	form	string	No
Permission	form	List<string>	No

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

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

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

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.

PUT /access/template HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateAccessTemplate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Business">
  <Version xmlns="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Api.Base">0</Version>
  <AccessCodeInitializationStrategy>Unique</AccessCodeInitializationStrategy>
  <Description>String</Description>
  <Name>String</Name>
  <Scope>All</Scope>
  <Things xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.AccessTemplate">
    <d2p1:ThingAccessTemplateDto>
      <d2p1:AccessCount>0</d2p1:AccessCount>
      <d2p1:AccessLevel>String</d2p1:AccessLevel>
      <d2p1:AvailableFrom>0</d2p1:AvailableFrom>
      <d2p1:AvailableTo>0</d2p1:AvailableTo>
      <d2p1:Exclusive>false</d2p1:Exclusive>
      <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
      <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:ThingId>00000000-0000-0000-0000-000000000000</d2p1:ThingId>
      <d2p1:ThingName>String</d2p1:ThingName>
      <d2p1:ThingTypeName>String</d2p1:ThingTypeName>
    </d2p1:ThingAccessTemplateDto>
  </Things>
  <AccessTemplateId>00000000-0000-0000-0000-000000000000</AccessTemplateId>
</UpdateAccessTemplate>

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

<AccessTemplateResponse 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: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:d3p1="http://schemas.datacontract.org/2004/07/Viviot.Api.ServiceModel.Views.Business.Organization">
      <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
      <d3p1:Name>String</d3p1:Name>
      <d3p1:SubOrganizations>
        <d3p1:OrganizationBasicView>
          <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
          <d3p1:Name>String</d3p1:Name>
          <d3p1:SubOrganizations>
            <d3p1:OrganizationBasicView>
              <d3p1:Id>00000000-0000-0000-0000-000000000000</d3p1:Id>
              <d3p1:Name>String</d3p1:Name>
              <d3p1:SubOrganizations>
                <d3p1:OrganizationBasicView i:nil="true" />
              </d3p1:SubOrganizations>
              <d3p1:Type>Unknown</d3p1:Type>
            </d3p1:OrganizationBasicView>
          </d3p1:SubOrganizations>
          <d3p1:Type>Unknown</d3p1:Type>
        </d3p1:OrganizationBasicView>
      </d3p1:SubOrganizations>
      <d3p1:Type>Unknown</d3p1:Type>
    </d2p1:Organization>
    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
    <d2p1:Permission xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </d2p1:Permission>
    <d2p1:Scope>All</d2p1:Scope>
  </Data>
</AccessTemplateResponse>

Viviot.Api

UpdateAccessTemplate

Allowable Values

Allowable Values

HTTP + XML