Bookshelf v7.8: About the Session Access Service

The Session Access Web service provides external Web applications access to operations for starting sessions and accessing profile attributes associated with a session. The published Web service is named SessionAccessWS and is based on the Session Access Service business service.

Table 9 lists the methods exposed by the Session Access Web service and lists the arguments used with each method.

Table 9. SessionAccessService Methods and Arguments
Method Name	Description	Arguments
		Type	Name	Description
Ping	Returns a fixed value. Used as a null operation	Input	MsgIn	Optional. Ignored if set.
Ping	Returns a fixed value. Used as a null operation	Output	MsgOut	A fixed string value of "1".
Echo	Returns the input value as the output value.	Input	MsgIn	Required. Any arbitrary string input.
Echo	Returns the input value as the output value.	Output	MsgOut	Copy of the MsgIn argument.
GetProfileAttr	Retrieves the value of a specified profile attribute from the current object manager session.	Input	Name	Required. Name of the profile attribute.
GetProfileAttr		Output	Value	Value of the profile attribute.
SetProfileAttr	Sets the value of a specified profile attribute	Input	Name	Required. Name of the profile attribute.
SetProfileAttr	Sets the value of a specified profile attribute	Input	Value	Value of the profile attribute.

Example of a Session Access Service Request

The following example demonstrates invoking the SessionAccess service and using the Ping method.

NOTE: For more information about the Siebel session management and authentication SOAP headers shown in the following example (SessionType, UsernameToken, and Password Text), see Integration Platform Technologies: Siebel Enterprise Application Integration.

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soapenv:Header>
      <ns1:SessionType soapenv:mustUnderstand="0" xsi:type="xsd:string" xmlns:ns1="http://siebel.com/webservices">Stateless</ns1:SessionType>
      <ns2:UsernameToken soapenv:mustUnderstand="0" xsi:type="xsd:string" xmlns:ns2="http://siebel.com/webservices">SADMIN</ns2:UsernameToken>
      <ns3:PasswordText soapenv:mustUnderstand="0" xsi:type="xsd:string" xmlns:ns3="http://siebel.com/webservices">MSSQL</ns3:PasswordText>
   </soapenv:Header>
   <soapenv:Body>
      <SessionAccessService_SessionAccessPing_Input xsi:nil="true" xmlns="http://www.siebel.com/xml/SessionAccess"/>
   </soapenv:Body>
</soapenv:Envelope>

Example of a Session Access Service Response

The following example shows an example response from the Session Access Service.

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
   <SOAP-ENV:Header>
   <siebel-header:SessionToken xmlns:siebel-header="http://siebel.com/webservices">HwopiOF3X.iNGKb9YCsDLJT1JxtOv.CCSOjsHIWHbX.nvGleXekmiIDHbSXQHG0zXlDaPcc4UeX66l.k-eVqEpjWhjq4qglvWd1dWXxJderIbn2rYAQTZynx1XD9JmsMZHDgRbp2iMKjad-RwtrCPVY7IlH6bGmmrVWCX3MyPIY_</siebel-header:SessionToken>
   </SOAP-ENV:Header>
   <SOAP-ENV:Body>
      <ns:SessionAccessService_SessionAccessPing_Output xmlns:ns="http://www.siebel.com/xml/SessionAccess">
      <ns:MsgOut>1</ns:MsgOut>
      </ns:SessionAccessService_SessionAccessPing_Output>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>