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 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

/**
* Gets alerts filtered by date
*/
// @Api(Description="Gets alerts filtered by date")
class ListAlerts implements IGet, IConvertible
{
    /**
    * The account ID you are listing for
    */
    // @ApiMember(Description="The account ID you are listing for")
    String? accountId;

    /**
    * The start date to retrieve alerts for (YYYY-MM-DD)
    */
    // @ApiMember(Description="The start date to retrieve alerts for (YYYY-MM-DD)")
    String? startDate;

    /**
    * The end date to retrieve alerts for (YYYY-MM-DD)
    */
    // @ApiMember(Description="The end date to retrieve alerts for (YYYY-MM-DD)")
    String? endDate;

    ListAlerts({this.accountId,this.startDate,this.endDate});
    ListAlerts.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        accountId = json['accountId'];
        startDate = json['startDate'];
        endDate = json['endDate'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'accountId': accountId,
        'startDate': startDate,
        'endDate': endDate
    };

    getTypeName() => "ListAlerts";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'evovoice.io', types: <String, TypeInfo> {
    'ListAlerts': TypeInfo(TypeOf.Class, create:() => ListAlerts()),
});

Dart ListAlerts DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"sid":"String","text":"String","dateGenerated":"String","errorCode":"String","logLevel":"String","moreInfo":"String","requestVariables":"String","requestUrl":"String","requestMethod":"String"}]