All Verbs | /ui/autocomplete/values |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.UI
Imports Voice.Api.Flows.Data
Namespace Global
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
End Enum
End Namespace
Namespace Voice.Api.UI
Public Partial Class AutoCompleteValue
'''<Summary>
'''Display name
'''</Summary>
<ApiMember(Description:="Display name")>
Public Overridable Property DisplayName As String
'''<Summary>
'''Value
'''</Summary>
<ApiMember(Description:="Value")>
Public Overridable Property Value As String
End Class
Public Partial Class ListAutoCompleteValues
'''<Summary>
'''Account ID
'''</Summary>
<ApiMember(Description:="Account ID")>
Public Overridable Property AccountId As String
'''<Summary>
'''Filter by customer ID
'''</Summary>
<ApiMember(Description:="Filter by customer ID")>
Public Overridable Property CustomerId As String
'''<Summary>
'''The type of value
'''</Summary>
<ApiMember(Description:="The type of value")>
Public Overridable Property Type As ValueTypes
'''<Summary>
'''The query text to search for
'''</Summary>
<ApiMember(Description:="The query text to search for")>
Public Overridable Property Query As String
'''<Summary>
'''Type specific filter
'''</Summary>
<ApiMember(Description:="Type specific filter")>
Public Overridable Property TypeSpecificFilter As String
'''<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 Overridable Property Value As String
'''<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 Overridable Property PlainText As Boolean
'''<Summary>
'''Include full info?
'''</Summary>
<ApiMember(Description:="Include full info?")>
Public Overridable Property FullInfo As Boolean
'''<Summary>
'''List all values, only use for small lists.
'''</Summary>
<ApiMember(Description:="List all values, only use for small lists.")>
Public Overridable Property All As Boolean
End Class
Public Partial Class ListAutoCompleteValuesResponse
Public Sub New()
Values = New List(Of AutoCompleteValue)
End Sub
Public Overridable Property Values As List(Of AutoCompleteValue)
End Class
End Namespace
End Namespace
VB.NET ListAutoCompleteValues DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=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>