Evo Voice

PatchAlert

Update a specific alert

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
PATCH	/alerts/{alertId}

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* Update a specific alert
*/
@Api(Description="Update a specific alert")
open class PatchAlert : IPatch
{
    /**
    * The ID of the alert you want to update
    */
    @ApiMember(Description="The ID of the alert you want to update")
    open var alertId:String? = null

    /**
    * The name for the alert
    */
    @ApiMember(Description="The name for the alert")
    open var name:String? = null

    /**
    * The trigger alert
    */
    @ApiMember(Description="The trigger alert")
    open var trigger:AlertTriggers? = null

    /**
    * The number of hours for the window over which the alert will trigger
    */
    @ApiMember(Description="The number of hours for the window over which the alert will trigger")
    open var windowHours:Double? = null

    /**
    * The value at which the alert will trigger
    */
    @ApiMember(Description="The value at which the alert will trigger")
    open var threshold:Double? = null

    /**
    * The email addresses (one per line) to notify
    */
    @ApiMember(Description="The email addresses (one per line) to notify")
    open var notificationEmailAddresses:String? = null

    /**
    * Customer selection for this alert
    */
    @ApiMember(Description="Customer selection for this alert")
    open var customerSelection:AlertCustomerSelection? = null

    /**
    * The list of customer IDs for the selection model
    */
    @ApiMember(Description="The list of customer IDs for the selection model")
    open var customerIds:ArrayList<String>? = null
}

enum class AlertTriggers
{
    CallSpend,
    CallCount,
}

enum class AlertCustomerSelection
{
    AllCustomers,
    ExcludeCustomers,
    IncludeCustomers,
}

open class AlertInfo : EntityInfo()
{
    /**
    * The ID of the account associated with this alert
    */
    @ApiMember(Description="The ID of the account associated with this alert")
    open var accountId:String? = null

    /**
    * The name of the alert
    */
    @ApiMember(Description="The name of the alert")
    open var name:String? = null

    /**
    * The trigger alert
    */
    @ApiMember(Description="The trigger alert")
    open var trigger:AlertTriggers? = null

    /**
    * The number of hours for the window over which the alert will trigger
    */
    @ApiMember(Description="The number of hours for the window over which the alert will trigger")
    open var windowHours:Double? = null

    /**
    * The value at which the alert will trigger
    */
    @ApiMember(Description="The value at which the alert will trigger")
    open var threshold:Double? = null

    /**
    * The email addresses (one per line) to notify
    */
    @ApiMember(Description="The email addresses (one per line) to notify")
    open var notificationEmailAddresses:String? = null

    /**
    * Customer selection for this alert
    */
    @ApiMember(Description="Customer selection for this alert")
    open var customerSelection:AlertCustomerSelection? = null

    /**
    * The list of customer IDs for the selection model
    */
    @ApiMember(Description="The list of customer IDs for the selection model")
    open var customerIds:ArrayList<String>? = null
}

open class EntityInfo
{
    /**
    * The ID of the object
    */
    @ApiMember(Description="The ID of the object")
    open var id:String? = null

    /**
    * The date the object was created
    */
    @ApiMember(Description="The date the object was created")
    open var dateCreated:String? = null

    /**
    * The date the object was last modified
    */
    @ApiMember(Description="The date the object was last modified")
    open var dateLastModified:String? = null

    /**
    * The user that created this object
    */
    @ApiMember(Description="The user that created this object")
    open var createdBy:String? = null

    /**
    * The user that last modified this object
    */
    @ApiMember(Description="The user that last modified this object")
    open var lastModifiedBy:String? = null
}

Kotlin PatchAlert DTOs

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.

PATCH /alerts/{alertId} HTTP/1.1 
Host: team.evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchAlert xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Alerts">
  <AlertId>String</AlertId>
  <CustomerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CustomerIds>
  <CustomerSelection>AllCustomers</CustomerSelection>
  <Name>String</Name>
  <NotificationEmailAddresses>String</NotificationEmailAddresses>
  <Threshold>0</Threshold>
  <Trigger>CallSpend</Trigger>
  <WindowHours>0</WindowHours>
</PatchAlert>

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

<AlertInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Alerts">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
  <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
  <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
  <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
  <AccountId>String</AccountId>
  <CustomerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </CustomerIds>
  <CustomerSelection>AllCustomers</CustomerSelection>
  <Name>String</Name>
  <NotificationEmailAddresses>String</NotificationEmailAddresses>
  <Threshold>0</Threshold>
  <Trigger>CallSpend</Trigger>
  <WindowHours>0</WindowHours>
</AlertInfo>