Evo Voice

<back to all web services

ListAutoCompleteValues

Requires Authentication
The following routes are available for this service:
All Verbs/ui/autocomplete/values
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class ListAutoCompleteValues
{
    /**
    * Account ID
    */
    @ApiMember(Description="Account ID")
    var accountId:String? = null

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

    /**
    * The type of value
    */
    @ApiMember(Description="The type of value")
    @SerializedName("type") var Type:ValueTypes? = null

    /**
    * The query text to search for
    */
    @ApiMember(Description="The query text to search for")
    var query:String? = null

    /**
    * Type specific filter
    */
    @ApiMember(Description="Type specific filter")
    var typeSpecificFilter:String? = null

    /**
    * The value to search for (will only return one result)
    */
    @ApiMember(Description="The value to search for (will only return one result)")
    var value:String? = null

    /**
    * Should the results be sent back in plain text or with embedded HTML?
    */
    @ApiMember(Description="Should the results be sent back in plain text or with embedded HTML?")
    var plainText:Boolean? = null

    /**
    * Include full info?
    */
    @ApiMember(Description="Include full info?")
    var fullInfo:Boolean? = null

    /**
    * List all values, only use for small lists.
    */
    @ApiMember(Description="List all values, only use for small lists.")
    var all:Boolean? = null
}

enum class ValueTypes
{
    NotSpecified,
    String,
    Boolean,
    Number,
    List,
    Struct,
    Transition,
    Custom,
    Date,
    AudioFile,
    TimeZoneId,
    PhoneNumber,
    User,
    Endpoint,
    Time,
    File,
    FaxNumber,
    EmailAccount,
    Customer,
    Flow,
    Team,
    FlowReference,
    Integration,
}

open class ListAutoCompleteValuesResponse
{
    var values:ArrayList<AutoCompleteValue> = ArrayList<AutoCompleteValue>()
}

open class AutoCompleteValue
{
    /**
    * Display name
    */
    @ApiMember(Description="Display name")
    var displayName:String? = null

    /**
    * Value
    */
    @ApiMember(Description="Value")
    var value:String? = null
}

Kotlin ListAutoCompleteValues 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.

POST /ui/autocomplete/values HTTP/1.1 
Host: evovoice.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	accountId: String,
	customerId: String,
	type: NotSpecified,
	query: String,
	typeSpecificFilter: String,
	value: String,
	plainText: False,
	fullInfo: False,
	all: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	values: 
	[
		{
			displayName: String,
			value: String
		}
	]
}