Requires any of the roles: | SystemAdministrator, Manager, Customer |
GET | /reports |
---|
namespace Voice.Api.Reports
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
type ReportStatuses =
| Queued = 0
| Running = 1
| Completed = 2
| Error = 3
[<AllowNullLiteral>]
type ReportInfo() =
member val Id:String = null with get,set
member val Name:String = null with get,set
member val Status:ReportStatuses = new ReportStatuses() with get,set
member val StatusMessage:String = null with get,set
member val DateCreated:String = null with get,set
member val DateUpdated:String = null with get,set
member val DownloadLink:String = null with get,set
member val JobId:String = null with get,set
member val EmailAddressToNotify:String = null with get,set
member val Server:String = null with get,set
[<AllowNullLiteral>]
type ListReportsResponse() =
member val Reports:ResizeArray<ReportInfo> = new ResizeArray<ReportInfo>() with get,set
///<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")>]
[<AllowNullLiteral>]
type ListReports() =
member val AccountId:String = null with get,set
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>