| Requires any of the roles: | SystemAdministrator, Manager, Customer |
| GET | /reports |
|---|
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
class ReportStatuses(str, Enum):
QUEUED = 'Queued'
RUNNING = 'Running'
COMPLETED = 'Completed'
ERROR = 'Error'
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ReportInfo:
id: Optional[str] = None
name: Optional[str] = None
status: Optional[ReportStatuses] = None
status_message: Optional[str] = None
date_created: Optional[str] = None
date_updated: Optional[str] = None
download_link: Optional[str] = None
job_id: Optional[str] = None
email_address_to_notify: Optional[str] = None
server: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListReportsResponse:
reports: Optional[List[ReportInfo]] = None
# @Api(Description="Returns all of the active/completed reports for the current user")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ListReports:
"""
Returns all of the active/completed reports for the current user
"""
account_id: Optional[str] = None
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 /reports HTTP/1.1 Host: evovoice.io Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ListReportsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports">
<Reports>
<ReportInfo>
<DateCreated>String</DateCreated>
<DateUpdated>String</DateUpdated>
<DownloadLink>String</DownloadLink>
<EmailAddressToNotify>String</EmailAddressToNotify>
<Id>String</Id>
<JobId>String</JobId>
<Name>String</Name>
<Server>String</Server>
<Status>Queued</Status>
<StatusMessage>String</StatusMessage>
</ReportInfo>
</Reports>
</ListReportsResponse>