Viviot.Api

<back to all web services

UpdateAutomation

Requires Authentication
Requires any of the roles:Admin, TenantAdmin, WorkflowAdmin
The following routes are available for this service:
PUT/automationUpdates automation configuration.
UpdateAutomation Parameters:
NameParameterData TypeRequiredDescription
IdbodystringYesAutomation Id (GUID)
NamebodystringYesAutomation name
EventbodyEventTypeYesAutomation event type

Allowable Values

  • AccessExpired
  • PaymentDeclined
  • ServiceRating
  • ServiceProblemReport
  • SensorValue
  • TaskListCompleted
  • Access
  • TaskListNotStarted
  • ReservationCheckout
  • TaskListExpiring
  • ReservationCheckin
EventParametersbodystringYesAutomation event parameters
ActionParametersbodystringYesAutomation action parameters
ActionbodyActionTypeYesAutomation action type

Allowable Values

  • TaskList
  • Alarm
  • IoT
  • DeactivateAlarm
  • Email
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
VersionformintegerNoApi version
EventType Enum:
NameValue
AccessExpired1
PaymentDeclined2
ServiceRating3
ServiceProblemReport4
SensorValue5
TaskListCompleted6
Access7
TaskListNotStarted8
ReservationCheckout9
TaskListExpiring10
ReservationCheckin11
ActionType Enum:
NameValue
TaskList1
Alarm2
IoT3
DeactivateAlarm4
Email5
AutomationResponse Parameters:
NameParameterData TypeRequiredDescription
DataformAutomationViewNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
AutomationView Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
OrganizationIdformGuidNo
NameformstringNo
EventformEventTypeNo
EventParametersformstringNo
ActionParametersformstringNo
ActionformActionTypeNo
AlarmConfigIdformGuid?No
TaskListTemplateIdformGuid?No
TaskListAllottedTimeformTimeSpan?No

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

<UpdateAutomation 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>
  <Action>TaskList</Action>
  <ActionParameters>String</ActionParameters>
  <Event>AccessExpired</Event>
  <EventParameters>String</EventParameters>
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Name>String</Name>
</UpdateAutomation>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AutomationResponse 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.Automation">
    <d2p1:Action>TaskList</d2p1:Action>
    <d2p1:ActionParameters>String</d2p1:ActionParameters>
    <d2p1:AlarmConfigId>00000000-0000-0000-0000-000000000000</d2p1:AlarmConfigId>
    <d2p1:Event>AccessExpired</d2p1:Event>
    <d2p1:EventParameters>String</d2p1:EventParameters>
    <d2p1:Id>00000000-0000-0000-0000-000000000000</d2p1:Id>
    <d2p1:Name>String</d2p1:Name>
    <d2p1:OrganizationId>00000000-0000-0000-0000-000000000000</d2p1:OrganizationId>
    <d2p1:TaskListAllottedTime>PT0S</d2p1:TaskListAllottedTime>
    <d2p1:TaskListTemplateId>00000000-0000-0000-0000-000000000000</d2p1:TaskListTemplateId>
  </Data>
</AutomationResponse>