Evo Voice

<back to all web services

EndpointsReport

This report returns all of the endpoints broken down by type per tab

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.Reports;
using Voice.Api.Endpoints;

namespace Voice.Api.Endpoints
{
    public enum EndpointTypes
    {
        PhoneNumber,
        User,
        FaxNumber,
        EmailAddress,
        Unused_1,
        Unused_2,
        Unused_3,
        Unused_4,
        Unused_5,
        Team,
        Assistant,
    }

}

namespace Voice.Api.Reports
{
    ///<summary>
    ///This report returns all of the endpoints broken down by type per tab
    ///</summary>
    [Api(Description="This report returns all of the endpoints broken down by type per tab")]
    public partial class EndpointsReport
        : ReportRequest
    {
        ///<summary>
        ///The types of endpoints to return
        ///</summary>
        [ApiMember(Description="The types of endpoints to return")]
        public virtual List<EndpointTypes> Types { get; set; }

        ///<summary>
        ///Filter by specific customer
        ///</summary>
        [ApiMember(Description="Filter by specific customer")]
        public virtual string CustomerId { 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 partial class ReportRequest
        : IPost
    {
        ///<summary>
        ///The account ID this report should be run for
        ///</summary>
        [ApiMember(Description="The account ID this report should be run for")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///The email address to notify after the report is run
        ///</summary>
        [ApiMember(Description="The email address to notify after the report is run")]
        public virtual string EmailAddressToNotify { get; set; }

        ///<summary>
        ///The webhook to call after the report is complete with the data from the report
        ///</summary>
        [ApiMember(Description="The webhook to call after the report is complete with the data from the report")]
        public virtual string WebhookUrl { get; set; }
    }

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

}

C# EndpointsReport DTOs

GET /reports/endpoints HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

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