Evo Voice

<back to all web services

PatchAISession

Update a specific session

Requires Authentication
Requires the role:SystemAdministrator
The following routes are available for this service:
PATCH/ai/sessions/{sessionId}
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class EntityInfo:
    # @ApiMember(Description="The ID of the object")
    id: Optional[str] = None
    """
    The ID of the object
    """


    # @ApiMember(Description="The date the object was created")
    date_created: Optional[str] = None
    """
    The date the object was created
    """


    # @ApiMember(Description="The date the object was last modified")
    date_last_modified: Optional[str] = None
    """
    The date the object was last modified
    """


    # @ApiMember(Description="The user that created this object")
    created_by: Optional[str] = None
    """
    The user that created this object
    """


    # @ApiMember(Description="The user that last modified this object")
    last_modified_by: Optional[str] = None
    """
    The user that last modified this object
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AISessionInfo(EntityInfo):
    # @ApiMember(Description="The ID of the account associated with this session")
    account_id: Optional[str] = None
    """
    The ID of the account associated with this session
    """


    # @ApiMember(Description="The name of the account associated with this customer")
    account_name: Optional[str] = None
    """
    The name of the account associated with this customer
    """


    # @ApiMember(Description="The purpose for this AI session")
    purpose: Optional[str] = None
    """
    The purpose for this AI session
    """


# @Api(Description="Update a specific session")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PatchAISession(IPatch):
    """
    Update a specific session
    """

    # @ApiMember(Description="The ID of the session you want to update")
    session_id: Optional[str] = None
    """
    The ID of the session you want to update
    """


    # @ApiMember(Description="The purpose of this session")
    purpose: Optional[str] = None
    """
    The purpose of this session
    """

Python PatchAISession 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.

PATCH /ai/sessions/{sessionId} HTTP/1.1 
Host: evovoice.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PatchAISession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.AI">
  <Purpose>String</Purpose>
  <SessionId>String</SessionId>
</PatchAISession>
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>