| Requires the role: | SystemAdministrator |
| POST | /ai/sessions/{sessionId}/apply |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
/**
* Applies all changes for the specified session
*/
@Api(Description="Applies all changes for the specified session")
open class ApplyAISession : IPost
{
/**
* The ID of the session to apply
*/
@ApiMember(Description="The ID of the session to apply")
open var sessionId:String? = null
}
open class AISessionInfo : EntityInfo()
{
/**
* The ID of the account associated with this session
*/
@ApiMember(Description="The ID of the account associated with this session")
open var accountId:String? = null
/**
* The name of the account associated with this customer
*/
@ApiMember(Description="The name of the account associated with this customer")
open var accountName:String? = null
/**
* The purpose for this AI session
*/
@ApiMember(Description="The purpose for this AI session")
open var purpose:String? = null
/**
* The actions performed in this session
*/
@ApiMember(Description="The actions performed in this session")
open var actions:ArrayList<AISessionActionInfo>? = null
}
open class EntityInfo
{
/**
* The ID of the object
*/
@ApiMember(Description="The ID of the object")
open var id:String? = null
/**
* The date the object was created
*/
@ApiMember(Description="The date the object was created")
open var dateCreated:String? = null
/**
* The date the object was last modified
*/
@ApiMember(Description="The date the object was last modified")
open var dateLastModified:String? = null
/**
* The user that created this object
*/
@ApiMember(Description="The user that created this object")
open var createdBy:String? = null
/**
* The user that last modified this object
*/
@ApiMember(Description="The user that last modified this object")
open var lastModifiedBy:String? = null
}
open class AISessionActionInfo
{
open var date:String? = null
open var id:String? = null
open var functionName:String? = null
open var arguments:String? = null
open var description:String? = null
open var canBeApplied:Boolean? = null
}
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 /ai/sessions/{sessionId}/apply HTTP/1.1
Host: evovoice.io
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ApplyAISession xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Voice.Api.AI">
<SessionId>String</SessionId>
</ApplyAISession>
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>
<Actions>
<AISessionActionInfo>
<Arguments>String</Arguments>
<CanBeApplied>false</CanBeApplied>
<Date>String</Date>
<Description>String</Description>
<FunctionName>String</FunctionName>
<Id>String</Id>
</AISessionActionInfo>
</Actions>
<Purpose>String</Purpose>
</AISessionInfo>