Requires any of the roles: | SystemAdministrator, Manager |
GET | /alerts |
---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
/** @description Gets alerts filtered by date */
// @Api(Description="Gets alerts filtered by date")
class ListAlerts implements IGet, JsonSerializable
{
public function __construct(
/** @description The account ID you are listing for */
// @ApiMember(Description="The account ID you are listing for")
/** @var string|null */
public ?string $accountId=null,
/** @description The start date to retrieve alerts for (YYYY-MM-DD) */
// @ApiMember(Description="The start date to retrieve alerts for (YYYY-MM-DD)")
/** @var string|null */
public ?string $startDate=null,
/** @description The end date to retrieve alerts for (YYYY-MM-DD) */
// @ApiMember(Description="The end date to retrieve alerts for (YYYY-MM-DD)")
/** @var string|null */
public ?string $endDate=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['accountId'])) $this->accountId = $o['accountId'];
if (isset($o['startDate'])) $this->startDate = $o['startDate'];
if (isset($o['endDate'])) $this->endDate = $o['endDate'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->accountId)) $o['accountId'] = $this->accountId;
if (isset($this->startDate)) $o['startDate'] = $this->startDate;
if (isset($this->endDate)) $o['endDate'] = $this->endDate;
return empty($o) ? new class(){} : $o;
}
}
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: team.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>