| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /alerts/{alertId} |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Get a specific alert
*/
@Api(Description="Get a specific alert")
open class GetAlert : IGet
{
/**
* The ID of the alert you want to get
*/
@ApiMember(Description="The ID of the alert you want to get")
open var alertId:String? = null
}
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
}
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
}
enum class AlertTriggers
{
CallSpend,
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /alerts/{alertId} HTTP/1.1
Host: evovoice.io
Accept: application/xml
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> <Name>String</Name> <NotificationEmailAddresses>String</NotificationEmailAddresses> <Threshold>0</Threshold> <Trigger>CallSpend</Trigger> <WindowHours>0</WindowHours> </AlertInfo>