Evo Voice

<back to all web services

ListAutoCompleteValues

Requires Authentication
The following routes are available for this service:
All Verbs/ui/autocomplete/values
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Voice.Api.UI;
using Voice.Api.Flows.Data;

namespace Voice.Api.Flows.Data
{
    public 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,
    }

}

namespace Voice.Api.UI
{
    public partial class AutoCompleteValue
    {
        ///<summary>
        ///Display name
        ///</summary>
        [ApiMember(Description="Display name")]
        public virtual string DisplayName { get; set; }

        ///<summary>
        ///Value
        ///</summary>
        [ApiMember(Description="Value")]
        public virtual string Value { get; set; }
    }

    public partial class ListAutoCompleteValues
    {
        ///<summary>
        ///Account ID
        ///</summary>
        [ApiMember(Description="Account ID")]
        public virtual string AccountId { get; set; }

        ///<summary>
        ///Filter by customer ID
        ///</summary>
        [ApiMember(Description="Filter by customer ID")]
        public virtual string CustomerId { get; set; }

        ///<summary>
        ///The type of value
        ///</summary>
        [ApiMember(Description="The type of value")]
        public virtual ValueTypes Type { get; set; }

        ///<summary>
        ///The query text to search for
        ///</summary>
        [ApiMember(Description="The query text to search for")]
        public virtual string Query { get; set; }

        ///<summary>
        ///Type specific filter
        ///</summary>
        [ApiMember(Description="Type specific filter")]
        public virtual string TypeSpecificFilter { get; set; }

        ///<summary>
        ///The value to search for (will only return one result)
        ///</summary>
        [ApiMember(Description="The value to search for (will only return one result)")]
        public virtual string Value { get; set; }

        ///<summary>
        ///Should the results be sent back in plain text or with embedded HTML?
        ///</summary>
        [ApiMember(Description="Should the results be sent back in plain text or with embedded HTML?")]
        public virtual bool PlainText { get; set; }

        ///<summary>
        ///Include full info?
        ///</summary>
        [ApiMember(Description="Include full info?")]
        public virtual bool FullInfo { get; set; }

        ///<summary>
        ///List all values, only use for small lists.
        ///</summary>
        [ApiMember(Description="List all values, only use for small lists.")]
        public virtual bool All { get; set; }
    }

    public partial class ListAutoCompleteValuesResponse
    {
        public ListAutoCompleteValuesResponse()
        {
            Values = new List<AutoCompleteValue>{};
        }

        public virtual List<AutoCompleteValue> Values { get; set; }
    }

}

C# ListAutoCompleteValues 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.

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

<ListAutoCompleteValues xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.UI">
  <AccountId>String</AccountId>
  <All>false</All>
  <CustomerId>String</CustomerId>
  <FullInfo>false</FullInfo>
  <PlainText>false</PlainText>
  <Query>String</Query>
  <Type>NotSpecified</Type>
  <TypeSpecificFilter>String</TypeSpecificFilter>
  <Value>String</Value>
</ListAutoCompleteValues>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ListAutoCompleteValuesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.UI">
  <Values>
    <AutoCompleteValue>
      <DisplayName>String</DisplayName>
      <Value>String</Value>
    </AutoCompleteValue>
  </Values>
</ListAutoCompleteValuesResponse>