Requires any of the roles: | SystemAdministrator, Manager, Customer |
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
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /reports HTTP/1.1 Host: team.evovoice.io Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"reports":[{"id":"String","name":"String","status":"Queued","statusMessage":"String","dateCreated":"String","dateUpdated":"String","downloadLink":"String","jobId":"String","emailAddressToNotify":"String","server":"String"}]}