Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /reports |
---|
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.Reports
Namespace Global
Namespace Voice.Api.Reports
'''<Summary>
'''Returns all of the active/completed reports for the current user
'''</Summary>
<Api(Description:="Returns all of the active/completed reports for the current user")>
Public Partial Class ListReports
Public Overridable Property AccountId As String
End Class
Public Partial Class ListReportsResponse
Public Overridable Property Reports As List(Of ReportInfo)
End Class
Public Partial Class ReportInfo
Public Overridable Property Id As String
Public Overridable Property Name As String
Public Overridable Property Status As ReportStatuses
Public Overridable Property StatusMessage As String
Public Overridable Property DateCreated As String
Public Overridable Property DateUpdated As String
Public Overridable Property DownloadLink As String
Public Overridable Property JobId As String
Public Overridable Property EmailAddressToNotify As String
Public Overridable Property Server As String
End Class
Public Enum ReportStatuses
Queued
Running
Completed
[Error]
End Enum
End Namespace
End Namespace
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"}]}