Viviot.Api

<back to all web services

UpdateAccessTemplate

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessTemplateAdmin
The following routes are available for this service:
PUT/access/templateUpdates an access template.
UpdateAccessTemplate Parameters:
NameParameterData TypeRequiredDescription
AccessTemplateIdbodystringYesAccess template Id (GUID)
EditAccessTemplate Parameters:
NameParameterData TypeRequiredDescription
NameformstringYesAccess template name
DescriptionformstringNoAccess template Description
ThingsformarrayYesIDs and configuration of permitted things
ScopeformAccessTemplateScopeYesUsage scope (who can use the template)

Allowable Values

  • All
  • Guest
  • Staff
AccessCodeInitializationStrategyformAccessCodeInitializationStrategyYesHow the access codes for a reservation from this template will be initialized.

Allowable Values

  • Unique
  • Shared
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ThingAccessTemplateDto Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
OrganizationIdformGuidNo
ThingIdformGuidNo
ThingNameformstringNo
ThingTypeNameformstringNo
ExclusiveformboolNo
AvailableFromformint?No
AvailableToformint?No
AccessCountformint?No
AccessLevelformstringNo
PermissionformList<string>No
AccessTemplateScope Enum:
NameValue
All0
Guest1
Staff2
AccessCodeInitializationStrategy Enum:
NameValue
Unique0
Shared1
AccessTemplateResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAccessTemplateViewNo
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

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.

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

{"accessTemplateId":"00000000000000000000000000000000","name":"String","description":"String","things":[{"id":"00000000000000000000000000000000","organizationId":"00000000000000000000000000000000","thingId":"00000000000000000000000000000000","thingName":"String","thingTypeName":"String","exclusive":false,"availableFrom":0,"availableTo":0,"accessCount":0,"accessLevel":"String","permission":["String"]}],"scope":0,"accessCodeInitializationStrategy":0,"version":0}

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