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.*;

public class dtos
{

    public static class ListAutoCompleteValues
    {
        /**
        * Account ID
        */
        @ApiMember(Description="Account ID")
        public String accountId = null;

        /**
        * Filter by customer ID
        */
        @ApiMember(Description="Filter by customer ID")
        public String customerId = null;

        /**
        * The type of value
        */
        @ApiMember(Description="The type of value")
        public ValueTypes type = null;

        /**
        * The query text to search for
        */
        @ApiMember(Description="The query text to search for")
        public String query = null;

        /**
        * Type specific filter
        */
        @ApiMember(Description="Type specific filter")
        public String typeSpecificFilter = null;

        /**
        * The value to search for (will only return one result)
        */
        @ApiMember(Description="The value to search for (will only return one result)")
        public String value = 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?")
        public Boolean plainText = null;

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

        /**
        * List all values, only use for small lists.
        */
        @ApiMember(Description="List all values, only use for small lists.")
        public Boolean all = null;
        
        public String getAccountId() { return accountId; }
        public ListAutoCompleteValues setAccountId(String value) { this.accountId = value; return this; }
        public String getCustomerId() { return customerId; }
        public ListAutoCompleteValues setCustomerId(String value) { this.customerId = value; return this; }
        public ValueTypes getType() { return type; }
        public ListAutoCompleteValues setType(ValueTypes value) { this.type = value; return this; }
        public String getQuery() { return query; }
        public ListAutoCompleteValues setQuery(String value) { this.query = value; return this; }
        public String getTypeSpecificFilter() { return typeSpecificFilter; }
        public ListAutoCompleteValues setTypeSpecificFilter(String value) { this.typeSpecificFilter = value; return this; }
        public String getValue() { return value; }
        public ListAutoCompleteValues setValue(String value) { this.value = value; return this; }
        public Boolean isPlainText() { return plainText; }
        public ListAutoCompleteValues setPlainText(Boolean value) { this.plainText = value; return this; }
        public Boolean isFullInfo() { return fullInfo; }
        public ListAutoCompleteValues setFullInfo(Boolean value) { this.fullInfo = value; return this; }
        public Boolean isAll() { return all; }
        public ListAutoCompleteValues setAll(Boolean value) { this.all = value; return this; }
    }

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

    public static class ListAutoCompleteValuesResponse
    {
        public ArrayList<AutoCompleteValue> values = null;
        
        public ArrayList<AutoCompleteValue> getValues() { return values; }
        public ListAutoCompleteValuesResponse setValues(ArrayList<AutoCompleteValue> value) { this.values = value; return this; }
    }

    public static class AutoCompleteValue
    {
        /**
        * Display name
        */
        @ApiMember(Description="Display name")
        public String displayName = null;

        /**
        * Value
        */
        @ApiMember(Description="Value")
        public String value = null;
        
        public String getDisplayName() { return displayName; }
        public AutoCompleteValue setDisplayName(String value) { this.displayName = value; return this; }
        public String getValue() { return value; }
        public AutoCompleteValue setValue(String value) { this.value = value; return this; }
    }

}

Java 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
		}
	]
}