Terminating Session

Use the terminate operation to close a specified session.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet terminating a specified session includes the terminate operation node:

<packet version="1.5.0.0">
<session>
   <termination>
...
   </termination>
</session>
</packet>

 

The terminate node is presented by type SessionTerminateInput (session.xsd) and has the following graphical representation:

Termination_RPS

 

Response Packet Structure

The terminate node of the output XML packet is presented by type SessionTerminateOutput (session.xsd) and structured as follows:

 

 

Samples

The request packet terminating the session win ID a66734b looks as follows:

<packet>
<session>
   <terminate>
      <session-id>a66734b</session-id>
   </terminate>
</session>
</packet>

Response:

<packet>
<session>
   <terminate>
      <result>
         <status>ok</status>
      </result>
   </terminate>
</session>
</packet>

 

If the session was not found on the server, the response looks as follows:

<packet>
<session>
   <terminate>
      <result>
         <status>error</status>
         <errcode>1013</errcode>
         <errtext>Session does not exist</errtext>
      </result>
   </terminate>
</session>
</packet>