SetSessionTimeZone
Sets the time zone for a Web Services API session.
Usage
This method sets the time zone for a Web services API session.
The LOVLanguageMode argument determines whether the time zone is a language independent code (LIC) or language dependent value (LDV). If the argument has no value or is not supplied, then LDV is assumed.
An example of a LIC time zone value is:
(GMT+2:00) Cairo
The equivalent LDV time zone for Spanish is:
(GMT+2:00) El Cairo
Arguments
The following table describes the arguments taken by the SetSessionTimeZone method.
Name | Description | Required | Default | I/O |
---|---|---|---|---|
TimeZone |
The time zone of the user. |
Yes |
Not applicable |
Input |
LOVLanguageMode |
Whether the time zone is a language independent code (LIC) or language dependent value (LDV). |
No |
LDV |
Input |
CurrentServerTime |
The server time zone. |
Not applicable |
Not applicable |
Output |
Return Value of the Call
The current server time zone as a LIC or LDV.
Sample SOAP Request - SetSessionTimeZone
The following SOAP request updates the timezone for the current session to (GMT -06:00) Central Time (US & Canada).
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<wsse:Security>
<wsse:UsernameToken>
<wsse:Username>%%%USERNAME%%%</wsse:Username>
<wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">%%%PASSWORD%%%</wsse:Password>
</wsse:UsernameToken>
</wsse:Security>
</soap:Header>
<soap:Body>
<TimeWS_SetSessionTimeZone_Input xmlns="urn:crmondemand/ws/time/">
<TimeZone>(GMT-06:00) Central Time (US & Canada)</TimeZone>
</TimeWS_SetSessionTimeZone_Input>
</soap:Body>
</soap:Envelope>
Sample SOAP Response
The following response returns the server time zone set by the request:
<?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:Body>
<ns:TimeWS_SetSessionTimeZone_Output xmlns:ns="urn:crmondemand/ws/time/">
<ns:CurrentServerTime>(GMT-06:00) Central Time (US & Canada)</ns:CurrentServerTime>
</ns:TimeWS_SetSessionTimeZone_Output>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>