| Requires the role: | SystemAdministrator |
| GET | /ai/sessions/{sessionId} |
|---|
import Foundation
import ServiceStack
/**
* Get the specified session
*/
// @Api(Description="Get the specified session")
public class GetAISession : IGet, Codable
{
/**
* The ID of the session to get
*/
// @ApiMember(Description="The ID of the session to get")
public var sessionId: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(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
accountId: String,
accountName: String,
purpose: String,
id: String,
dateCreated: String,
dateLastModified: String,
createdBy: String,
lastModifiedBy: String
}