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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Reports;

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 virtual string AccountId { get; set; }
    }

    public partial class ListReportsResponse
    {
        public ListReportsResponse()
        {
            Reports = new List<ReportInfo>{};
        }

        public virtual List<ReportInfo> Reports { get; set; }
    }

    public partial class ReportInfo
    {
        public virtual string Id { get; set; }
        public virtual string Name { get; set; }
        public virtual ReportStatuses Status { get; set; }
        public virtual string StatusMessage { get; set; }
        public virtual string DateCreated { get; set; }
        public virtual string DateUpdated { get; set; }
        public virtual string DownloadLink { get; set; }
        public virtual string JobId { get; set; }
        public virtual string EmailAddressToNotify { get; set; }
        public virtual string Server { get; set; }
    }

    public enum ReportStatuses
    {
        Queued,
        Running,
        Completed,
        Error,
    }

}

C# ListReports DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	reports: 
	[
		{
			id: String,
			name: String,
			status: Queued,
			statusMessage: String,
			dateCreated: String,
			dateUpdated: String,
			downloadLink: String,
			jobId: String,
			emailAddressToNotify: String,
			server: String
		}
	]
}