Evo Voice

EndpointsReport

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

**Requires Authentication**
Requires any of the roles:	SystemAdministrator, Manager, Customer

The following routes are available for this service:
GET	/reports/endpoints

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
Imports Voice.Api.Endpoints

Namespace Global

    Namespace Voice.Api.Endpoints

        Public Enum EndpointTypes
            PhoneNumber
            User
            FaxNumber
            EmailAddress
            Unused_1
            Unused_2
            Unused_3
            Unused_4
            Unused_5
            Team
            Assistant
        End Enum
    End Namespace

    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
            Inherits ReportRequest
            '''<Summary>
            '''The types of endpoints to return
            '''</Summary>
            <ApiMember(Description:="The types of endpoints to return")>
            Public Overridable Property Types As List(Of EndpointTypes)

            '''<Summary>
            '''Filter by specific customer
            '''</Summary>
            <ApiMember(Description:="Filter by specific customer")>
            Public Overridable Property CustomerId As String
        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 Partial Class ReportRequest
            Implements IPost
            '''<Summary>
            '''The account ID this report should be run for
            '''</Summary>
            <ApiMember(Description:="The account ID this report should be run for")>
            Public Overridable Property AccountId As String

            '''<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 Overridable Property EmailAddressToNotify As String

            '''<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 Overridable Property WebhookUrl As String
        End Class

        Public Enum ReportStatuses
            Queued
            Running
            Completed
            [Error]
        End Enum
    End Namespace
End Namespace

VB.NET EndpointsReport 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/endpoints HTTP/1.1 
Host: team.evovoice.io 
Accept: text/jsv

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

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