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

import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* This report returns all of the endpoints broken down by type per tab
*/
@Api(Description="This report returns all of the endpoints broken down by type per tab")
open class EndpointsReport : ReportRequest()
{
    /**
    * The types of endpoints to return
    */
    @ApiMember(Description="The types of endpoints to return")
    open var types:ArrayList<EndpointTypes>? = null

    /**
    * Filter by specific customer
    */
    @ApiMember(Description="Filter by specific customer")
    open var customerId:String? = null
}

open class ReportRequest : IPost
{
    /**
    * The account ID this report should be run for
    */
    @ApiMember(Description="The account ID this report should be run for")
    open var accountId:String? = null

    /**
    * The email address to notify after the report is run
    */
    @ApiMember(Description="The email address to notify after the report is run")
    open var emailAddressToNotify:String? = null

    /**
    * The webhook to call after the report is complete with the data from the report
    */
    @ApiMember(Description="The webhook to call after the report is complete with the data from the report")
    open var webhookUrl:String? = null
}

enum class EndpointTypes
{
    PhoneNumber,
    User,
    FaxNumber,
    EmailAddress,
    Unused1,
    Unused2,
    Unused3,
    Unused4,
    Unused5,
    Team,
    Assistant,
}

open class ReportInfo
{
    open var id:String? = null
    open var name:String? = null
    open var status:ReportStatuses? = null
    open var statusMessage:String? = null
    open var dateCreated:String? = null
    open var dateUpdated:String? = null
    open var downloadLink:String? = null
    open var jobId:String? = null
    open var emailAddressToNotify:String? = null
    open var server:String? = null
}

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

Kotlin EndpointsReport DTOs

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReportInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.Reports">
  <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>