Evo Voice

GetAlert

Get a specific alert

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

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

import Foundation
import ServiceStack

/**
* Get a specific alert
*/
// @Api(Description="Get a specific alert")
public class GetAlert : IGet, Codable
{
    /**
    * The ID of the alert you want to get
    */
    // @ApiMember(Description="The ID of the alert you want to get")
    public var alertId:String

    required public init(){}
}

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

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

    /**
    * The trigger alert
    */
    // @ApiMember(Description="The trigger alert")
    public var trigger:AlertTriggers

    /**
    * 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")
    public var windowHours:Double

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

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

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case accountId
        case name
        case trigger
        case windowHours
        case threshold
        case notificationEmailAddresses
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        accountId = try container.decodeIfPresent(String.self, forKey: .accountId)
        name = try container.decodeIfPresent(String.self, forKey: .name)
        trigger = try container.decodeIfPresent(AlertTriggers.self, forKey: .trigger)
        windowHours = try container.decodeIfPresent(Double.self, forKey: .windowHours)
        threshold = try container.decodeIfPresent(Double.self, forKey: .threshold)
        notificationEmailAddresses = try container.decodeIfPresent(String.self, forKey: .notificationEmailAddresses)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if accountId != nil { try container.encode(accountId, forKey: .accountId) }
        if name != nil { try container.encode(name, forKey: .name) }
        if trigger != nil { try container.encode(trigger, forKey: .trigger) }
        if windowHours != nil { try container.encode(windowHours, forKey: .windowHours) }
        if threshold != nil { try container.encode(threshold, forKey: .threshold) }
        if notificationEmailAddresses != nil { try container.encode(notificationEmailAddresses, forKey: .notificationEmailAddresses) }
    }
}

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

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

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

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

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

    required public init(){}
}

public enum AlertTriggers : String, Codable
{
    case CallSpend
}

Swift GetAlert DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"accountId":"String","name":"String","trigger":"CallSpend","windowHours":0,"threshold":0,"notificationEmailAddresses":"String","id":"String","dateCreated":"String","dateLastModified":"String","createdBy":"String","lastModifiedBy":"String"}