Skip to content

Logoff Service

The SERNET logoff service takes as input the TSO user ID for the Web client user to be logged off the host. The logoff service returns status information stating whether or not logoff was successful.

Logoff Request

<logoff> Service Tag

A SERNET logoff request contains the top-level <logoff> service tag, which in turn encloses a <request> method tag. The method tag in turn encloses parameter tags.

Syntax Example

The following example logoff request shows fully qualified ZMF Web Services tag names with values, wrapped in a SOAP envelope. 

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/ envelope/" xmlns:ser="http://wsdl.zmf.serena.com/services/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:logoff>
         <ser:request>
            <ser:user>USER01</ser:user>
         </ser:request>  
      </ser:logoff>
   </soapenv:Body>
</soapenv:Envelope>

...

<response> Parameter Tags

The following parameter tags are supported within the logoff <request> tag:

Parameter Tag Use Occurs Data Type & Length Values & Dependencies
<user> Required 1 String (8) TSO user ID for Web client

Logoff Response

Syntax Example

The logoff <response> method tag returns a host-originated status message, return code, and reason code describing the status of the host logoff request. The same syntax is used by all SERNET Web Services <response> methods.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/ envelope/" xmlns:ser="http://wsdl.zmf.serena.com/services/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:logoff>
         <ser:response>
            <ser:statusMessage>Logon successful</ser:statusMessage>
            <ser:statusReturnCode>00</ser:statusReturnCode>
            <ser:statusReasonCode>0000</ser:statusReasonCode>
         </ser:response>
      </ser:logoff>
   </soapenv:Body>
</soapenv:Envelope>

...

<response> Parameter Tags

The following parameter tags are supported within the logoff <response> tag:

Parameter Tag Use Occurs Data Type & Length Values & Dependencies
statusMessage Required 1 String (255) Free-format status message returned by host or ZMF
statusReasonCode Required 1 String (4) Diagnostic reason code
statusReturnCode Required 1 String (4) Status severity code. Typical values:
00 - Normal completion
04 - Completed using default overrides for minor error conditions
08 - Some job steps failed
12 or higher - Severe error