Evo Voice

<back to all web services

GetAISession

Get the specified session

Requires Authentication
Requires the role:SystemAdministrator
The following routes are available for this service:
GET/ai/sessions/{sessionId}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Voice.Api.AI
Imports Voice.Api

Namespace Global

    Namespace Voice.Api

        Public Partial Class EntityInfo
            '''<Summary>
            '''The ID of the object
            '''</Summary>
            <ApiMember(Description:="The ID of the object")>
            Public Overridable Property Id As String

            '''<Summary>
            '''The date the object was created
            '''</Summary>
            <ApiMember(Description:="The date the object was created")>
            Public Overridable Property DateCreated As String

            '''<Summary>
            '''The date the object was last modified
            '''</Summary>
            <ApiMember(Description:="The date the object was last modified")>
            Public Overridable Property DateLastModified As String

            '''<Summary>
            '''The user that created this object
            '''</Summary>
            <ApiMember(Description:="The user that created this object")>
            Public Overridable Property CreatedBy As String

            '''<Summary>
            '''The user that last modified this object
            '''</Summary>
            <ApiMember(Description:="The user that last modified this object")>
            Public Overridable Property LastModifiedBy As String
        End Class
    End Namespace

    Namespace Voice.Api.AI

        Public Partial Class AISessionInfo
            Inherits EntityInfo
            '''<Summary>
            '''The ID of the account associated with this session
            '''</Summary>
            <ApiMember(Description:="The ID of the account associated with this session")>
            Public Overridable Property AccountId As String

            '''<Summary>
            '''The name of the account associated with this customer
            '''</Summary>
            <ApiMember(Description:="The name of the account associated with this customer")>
            Public Overridable Property AccountName As String

            '''<Summary>
            '''The purpose for this AI session
            '''</Summary>
            <ApiMember(Description:="The purpose for this AI session")>
            Public Overridable Property Purpose As String
        End Class

        '''<Summary>
        '''Get the specified session
        '''</Summary>
        <Api(Description:="Get the specified session")>
        Public Partial Class GetAISession
            Implements IGet
            '''<Summary>
            '''The ID of the session to get
            '''</Summary>
            <ApiMember(Description:="The ID of the session to get")>
            Public Overridable Property SessionId As String
        End Class
    End Namespace
End Namespace

VB.NET GetAISession 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.

GET /ai/sessions/{sessionId} HTTP/1.1 
Host: evovoice.io 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AISessionInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.AI">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</CreatedBy>
  <DateCreated xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateCreated>
  <DateLastModified xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</DateLastModified>
  <Id xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</Id>
  <LastModifiedBy xmlns="http://schemas.datacontract.org/2004/07/Voice.Api">String</LastModifiedBy>
  <AccountId>String</AccountId>
  <AccountName>String</AccountName>
  <Purpose>String</Purpose>
</AISessionInfo>