Wednesday, November 23, 2011

Get a Time Zone Code Based on Time Zone Name in Microsoft Dynamics CRM 2011 Using .NET or Jscript

This illustration shows how to get a time zone code based  in Microsoft Dynamics CRM 2011 with GetTimeZoneCodeByLocalizedNameRequest.  This example will be given in Jscript (SOAP) and in C# (.NET).

Interesting Notes:  This request felt like sort of an odd duck.  I am not really sure about the actual utility of this request, but it works.  I provided the localized standard name for the time zone based on the locale ID which I also provided, and in return all it gave me a response that contained only an integer value of 20.  This value appears to correspond a Microsoft SQL Server proprietary time zone code for which I was able to find an old reference here:
If you look at the table on the linked page you will see that 20 does correspond with Central Time, so if anyone has really found a use for this request, please comment below and let me know what it is.  Thanks!
    Ok, here is what the code looks like!
    First in C#:

    GetTimeZoneCodeByLocalizedNameRequest req = new GetTimeZoneCodeByLocalizedNameRequest();
    req.LocaleId = 1033;
    req.LocalizedStandardName = "Central Standard Time";
    GetTimeZoneCodeByLocalizedNameResponse resp = (GetTimeZoneCodeByLocalizedNameResponse)slos.Execute(req);

    If you need help instantiating a service object in .NET within a plugin check out this post:

    Now here is the Jscript nicely formatted by the CRM 2011 SOAP formatter. Available at:

    Now in Jscript

    This example is asynchronous, if you want to learn how to make JScript SOAP calls synchronously please visit this post

    if (typeof (SDK) == "undefined")
       { SDK = { __namespace: true }; }
           //This will establish a more unique namespace for functions in this library. This will reduce the 
           // potential for functions to be overwritten due to a duplicate name when the library is loaded.
           SDK.SAMPLES = {
               _getServerUrl: function () {
                   /// Returns the URL for the SOAP endpoint using the context information available in the form
                   /// or HTML Web resource.
                   var OrgServicePath = "/XRMServices/2011/Organization.svc/web";
                   var serverUrl = "";
                   if (typeof GetGlobalContext == "function") {
                       var context = GetGlobalContext();
                       serverUrl = context.getServerUrl();
                   else {
                       if (typeof Xrm.Page.context == "object") {
                             serverUrl = Xrm.Page.context.getServerUrl();
                       { throw new Error("Unable to access the server URL"); }
                      if (serverUrl.match(/\/$/)) {
                           serverUrl = serverUrl.substring(0, serverUrl.length - 1);
                       return serverUrl + OrgServicePath;
               GetTimeZoneCodeByLocalizedNameRequest: function () {
                   var requestMain = ""
                   requestMain += "<s:Envelope xmlns:s=\"\">";
                   requestMain += "  <s:Body>";
                   requestMain += "    <Execute xmlns=\"\" xmlns:i=\"\">";
                   requestMain += "      <request i:type=\"b:GetTimeZoneCodeByLocalizedNameRequest\" xmlns:a=\"\" xmlns:b=\"\">";
                   requestMain += "        <a:Parameters xmlns:c=\"\">";
                   requestMain += "          <a:KeyValuePairOfstringanyType>";
                   requestMain += "            <c:key>LocalizedStandardName</c:key>";
                   requestMain += "            <c:value i:type=\"d:string\" xmlns:d=\"\">Central Standard Time</c:value>";
                   requestMain += "          </a:KeyValuePairOfstringanyType>";
                   requestMain += "          <a:KeyValuePairOfstringanyType>";
                   requestMain += "            <c:key>LocaleId</c:key>";
                   requestMain += "            <c:value i:type=\"d:int\" xmlns:d=\"\">1033</c:value>";
                   requestMain += "          </a:KeyValuePairOfstringanyType>";
                   requestMain += "        </a:Parameters>";
                   requestMain += "        <a:RequestId i:nil=\"true\" />";
                   requestMain += "        <a:RequestName>GetTimeZoneCodeByLocalizedName</a:RequestName>";
                   requestMain += "      </request>";
                   requestMain += "    </Execute>";
                   requestMain += "  </s:Body>";
                   requestMain += "</s:Envelope>";
                   var req = new XMLHttpRequest();
         "POST", SDK.SAMPLES._getServerUrl(), true)
                   // Responses will return XML. It isn't possible to return JSON.
                   req.setRequestHeader("Accept", "application/xml, text/xml, */*");
                   req.setRequestHeader("Content-Type", "text/xml; charset=utf-8");
                   req.setRequestHeader("SOAPAction", "");
                   var successCallback = null;
                   var errorCallback = null;
                   req.onreadystatechange = function () { SDK.SAMPLES.GetTimeZoneCodeByLocalizedNameResponse(req, successCallback, errorCallback); };
           GetTimeZoneCodeByLocalizedNameResponse: function (req, successCallback, errorCallback) {
                   /// Recieves the assign response
                   ///<param name="req" Type="XMLHttpRequest">
                   /// The XMLHttpRequest response
                   ///<param name="successCallback" Type="Function">
                   /// The function to perform when an successfult response is returned.
                   /// For this message no data is returned so a success callback is not really necessary.
                   ///<param name="errorCallback" Type="Function">
                   /// The function to perform when an error is returned.
                   /// This function accepts a JScript error returned by the _getError function
                   if (req.readyState == 4) {
                   if (req.status == 200) {
                   if (successCallback != null)
                   { successCallback(); }
                   else {
           _getError: function (faultXml) {
               /// Parses the WCF fault returned in the event of an error.
               ///<param name="faultXml" Type="XML">
               /// The responseXML property of the XMLHttpRequest response.
               var errorMessage = "Unknown Error (Unable to parse the fault)";
               if (typeof faultXml == "object") {
                   try {
                       var bodyNode = faultXml.firstChild.firstChild;
                       //Retrieve the fault node
                       for (var i = 0; i < bodyNode.childNodes.length; i++) {
                           var node = bodyNode.childNodes[i];
                           //NOTE: This comparison does not handle the case where the XML namespace changes
                           if ("s:Fault" == node.nodeName) {
                           for (var j = 0; j < node.childNodes.length; j++) {
                               var faultStringNode = node.childNodes[j];
                               if ("faultstring" == faultStringNode.nodeName) {
                                   errorMessage = faultStringNode.text;
               catch (e) { };
            return new Error(errorMessage);
     __namespace: true

    To understand how to parse the response please review my post on using the DOM parser.
    Now you can call the SDK.SAMPLES.GetTimeZoneCodeByLocalizedNameRequest function from your form jscript handler.

    Thats all there is to it!


    1. I am curious Ismail, did this post actually help you? I had a little trouble figuring out what the true value of this particular SDK message might be. If it did help, may I ask what you used it for?

    2. Hi Jamie, I had a problem about getting time data with Odata service. Researching how to solve, I saw your post I said maybe I could use but not used really.I solved the problem by calling custom SQL function from LINQ.Thanks for everything.I can't always try your posts because you publish a lot of writing.:)