Evo Voice

<back to all web services

ListReports

Returns all of the active/completed reports for the current user

Requires Authentication
Requires any of the roles:SystemAdministrator, Manager, Customer
The following routes are available for this service:
GET/reports
ListReports Parameters:
NameParameterData TypeRequiredDescription
AccountIdquerystringNo
ListReportsResponse Parameters:
NameParameterData TypeRequiredDescription
ReportsformList<ReportInfo>No
ReportInfo Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
NameformstringNo
StatusformReportStatusesNo
StatusMessageformstringNo
DateCreatedformstringNo
DateUpdatedformstringNo
DownloadLinkformstringNo
JobIdformstringNo
EmailAddressToNotifyformstringNo
ServerformstringNo
ReportStatuses Enum:
Queued
Running
Completed
Error

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