Viviot.Api

<back to all web services

UpdateBusinessUserAccess

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, AccessAdmin
The following routes are available for this service:
PUT/BusinessUserAccessUpdates an access for a business user.
UpdateBusinessUserAccess Parameters:
NameParameterData TypeRequiredDescription
BusinessUserAccessIdbodystringYesBusinessUser Access ID
BaseEditBusinessUserAccess Parameters:
NameParameterData TypeRequiredDescription
ValidFromformstringYesAccess comes into effect after this time
ValidToformstringNoTime when access stops. If you don't specify then access is active for undefined end time.
LabelformstringNoAccess label.
SpacesformList<ThingBusinessUserAccessDto>YesList of spaces that the access is granted for.
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
ThingBusinessUserAccessDto Parameters:
NameParameterData TypeRequiredDescription
ThingIdformGuidNo
AccessCountformint?No
FromHourformTimeSpan?No
ToHourformTimeSpan?No
ExclusiveformboolNo
CreateBusinessUserAccessResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuid?No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

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 /BusinessUserAccess HTTP/1.1 
Host: api.4spaces.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateBusinessUserAccess 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>
  <Label>String</Label>
  <Spaces xmlns:d2p1="http://schemas.datacontract.org/2004/07/Viviot.Infrastructure.Dto.Access">
    <d2p1:ThingBusinessUserAccessDto>
      <d2p1:AccessCount>0</d2p1:AccessCount>
      <d2p1:Exclusive>false</d2p1:Exclusive>
      <d2p1:FromHour>PT0S</d2p1:FromHour>
      <d2p1:ThingId>00000000-0000-0000-0000-000000000000</d2p1:ThingId>
      <d2p1:ToHour>PT0S</d2p1:ToHour>
    </d2p1:ThingBusinessUserAccessDto>
  </Spaces>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
  <BusinessUserAccessId>00000000-0000-0000-0000-000000000000</BusinessUserAccessId>
</UpdateBusinessUserAccess>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateBusinessUserAccessResponse 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>
  <Id>00000000-0000-0000-0000-000000000000</Id>
</CreateBusinessUserAccessResponse>