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
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


# @Api(Description="Gets alerts filtered by date")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListAlerts(IGet):
    """
    Gets alerts filtered by date
    """

    # @ApiMember(Description="The account ID you are listing for")
    account_id: Optional[str] = None
    """
    The account ID you are listing for
    """


    # @ApiMember(Description="The start date to retrieve alerts for (YYYY-MM-DD)")
    start_date: Optional[str] = None
    """
    The start date to retrieve alerts for (YYYY-MM-DD)
    """


    # @ApiMember(Description="The end date to retrieve alerts for (YYYY-MM-DD)")
    end_date: Optional[str] = None
    """
    The end date to retrieve alerts for (YYYY-MM-DD)
    """

Python 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>