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 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")
    var types:ArrayList<EndpointTypes> = ArrayList<EndpointTypes>()

    /**
    * Filter by specific customer
    */
    @ApiMember(Description="Filter by specific customer")
    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")
    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")
    var emailAddressToNotify:String? = null
}

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

open class ReportInfo
{
    var id:String? = null
    var name:String? = null
    var status:ReportStatuses? = null
    var statusMessage:String? = null
    var dateCreated:String? = null
    var dateUpdated:String? = null
    var downloadLink:String? = null
    var jobId:String? = null
    var emailAddressToNotify:String? = null
    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 .csv suffix or ?format=csv

HTTP + CSV

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: evovoice.io 
Accept: text/csv

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

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