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 Foundation
import ServiceStack

/**
* Update a specific session
*/
// @Api(Description="Update a specific session")
public class PatchAISession : IPatch, Codable
{
    /**
    * The ID of the session you want to update
    */
    // @ApiMember(Description="The ID of the session you want to update")
    public var sessionId:String

    /**
    * The purpose of this session
    */
    // @ApiMember(Description="The purpose of this session")
    public var purpose:String

    required public init(){}
}

public class AISessionInfo : EntityInfo
{
    /**
    * The ID of the account associated with this session
    */
    // @ApiMember(Description="The ID of the account associated with this session")
    public var accountId:String

    /**
    * The name of the account associated with this customer
    */
    // @ApiMember(Description="The name of the account associated with this customer")
    public var accountName:String

    /**
    * The purpose for this AI session
    */
    // @ApiMember(Description="The purpose for this AI session")
    public var purpose:String

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case accountId
        case accountName
        case purpose
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        accountId = try container.decodeIfPresent(String.self, forKey: .accountId)
        accountName = try container.decodeIfPresent(String.self, forKey: .accountName)
        purpose = try container.decodeIfPresent(String.self, forKey: .purpose)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if accountId != nil { try container.encode(accountId, forKey: .accountId) }
        if accountName != nil { try container.encode(accountName, forKey: .accountName) }
        if purpose != nil { try container.encode(purpose, forKey: .purpose) }
    }
}

public class EntityInfo : Codable
{
    /**
    * The ID of the object
    */
    // @ApiMember(Description="The ID of the object")
    public var id:String

    /**
    * The date the object was created
    */
    // @ApiMember(Description="The date the object was created")
    public var dateCreated:String

    /**
    * The date the object was last modified
    */
    // @ApiMember(Description="The date the object was last modified")
    public var dateLastModified:String

    /**
    * The user that created this object
    */
    // @ApiMember(Description="The user that created this object")
    public var createdBy:String

    /**
    * The user that last modified this object
    */
    // @ApiMember(Description="The user that last modified this object")
    public var lastModifiedBy:String

    required public init(){}
}


Swift 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>