Evo Voice

<back to all web services

ListAlerts

Gets alerts filtered by date

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager
The following routes are available for this service:
GET/alerts
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Dashboard

Namespace Global

    Namespace Voice.Api.Dashboard

        '''<Summary>
        '''Gets alerts filtered by date
        '''</Summary>
        <Api(Description:="Gets alerts filtered by date")>
        Public Partial Class ListAlerts
            Implements IGet
            '''<Summary>
            '''The account ID you are listing for
            '''</Summary>
            <ApiMember(Description:="The account ID you are listing for")>
            Public Overridable Property AccountId As String

            '''<Summary>
            '''The start date to retrieve alerts for (YYYY-MM-DD)
            '''</Summary>
            <ApiMember(Description:="The start date to retrieve alerts for (YYYY-MM-DD)")>
            Public Overridable Property StartDate As String

            '''<Summary>
            '''The end date to retrieve alerts for (YYYY-MM-DD)
            '''</Summary>
            <ApiMember(Description:="The end date to retrieve alerts for (YYYY-MM-DD)")>
            Public Overridable Property EndDate As String
        End Class
    End Namespace
End Namespace

VB.NET ListAlerts 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.

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>