Requires any of the roles: | SystemAdministrator, Manager |
GET | /alerts |
---|
namespace Voice.Api.Dashboard
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
///<summary>
///Gets alerts filtered by date
///</summary>
[<Api(Description="Gets alerts filtered by date")>]
[<AllowNullLiteral>]
type ListAlerts() =
interface IGet
///<summary>
///The account ID you are listing for
///</summary>
[<ApiMember(Description="The account ID you are listing for")>]
member val AccountId:String = null with get,set
///<summary>
///The start date to retrieve alerts for (YYYY-MM-DD)
///</summary>
[<ApiMember(Description="The start date to retrieve alerts for (YYYY-MM-DD)")>]
member val StartDate:String = null with get,set
///<summary>
///The end date to retrieve alerts for (YYYY-MM-DD)
///</summary>
[<ApiMember(Description="The end date to retrieve alerts for (YYYY-MM-DD)")>]
member val EndDate:String = null with get,set
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 HTTP/1.1 Host: evovoice.io Accept: application/xml
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ArrayOfAlertInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Dashboard"> <AlertInfo> <DateGenerated>String</DateGenerated> <ErrorCode>String</ErrorCode> <LogLevel>String</LogLevel> <MoreInfo>String</MoreInfo> <RequestMethod>String</RequestMethod> <RequestUrl>String</RequestUrl> <RequestVariables>String</RequestVariables> <Sid>String</Sid> <Text>String</Text> </AlertInfo> </ArrayOfAlertInfo>