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
import Foundation
import ServiceStack

/**
* Returns all of the active/completed reports for the current user
*/
// @Api(Description="Returns all of the active/completed reports for the current user")
public class ListReports : Codable
{
    public var accountId:String?

    required public init(){}
}

public class ListReportsResponse : Codable
{
    public var reports:[ReportInfo] = []

    required public init(){}
}

public class ReportInfo : Codable
{
    public var id:String?
    public var name:String?
    public var status:ReportStatuses?
    public var statusMessage:String?
    public var dateCreated:String?
    public var dateUpdated:String?
    public var downloadLink:String?
    public var jobId:String?
    public var emailAddressToNotify:String?
    public var server:String?

    required public init(){}
}

public enum ReportStatuses : String, Codable
{
    case Queued
    case Running
    case Completed
    case Error
}


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