Friday, October 14, 2011

Retrieve Used Resources Like Number of Custom Entities and Storage Quota in Microsoft Dynamics CRM 2011 Using .NET or Jscript

This illustration shows how to retrieve used resources for an organization like number of custom entities and storage quota information in Microsoft Dynamics CRM 2011 with RetrieveOrganizationResourcesRequest.   This example will be given in Jscript (SOAP) and in C# (.NET).
    Ok, here is what the code looks like!
    First in C#:

    RetrieveOrganizationResourcesRequest req = new RetrieveOrganizationResourcesRequest();
    RetrieveOrganizationResourcesResponse resp = (RetrieveOrganizationResourcesResponse)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;
               RetrieveOrganizationResourcesRequest: function () {
                   var requestMain = ""
                   requestMain += "<s:Envelope xmlns:s=\"\">";
                   requestMain += "  <s:Body>";
                   requestMain += "    <Execute xmlns=\"\" xmlns:i=\"\">";
                   requestMain += "      <request i:type=\"b:RetrieveOrganizationResourcesRequest\" xmlns:a=\"\" xmlns:b=\"\">";
                   requestMain += "        <a:Parameters xmlns:c=\"\" />";
                   requestMain += "        <a:RequestId i:nil=\"true\" />";
                   requestMain += "        <a:RequestName>RetrieveOrganizationResources</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.RetrieveOrganizationResourcesResponse(req, successCallback, errorCallback); };
           RetrieveOrganizationResourcesResponse: 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.RetrieveOrganizationResourcesRequest function from your form jscript handler.

    Here is an Example of the Response:

    <s:Envelope xmlns:s="">
        <ExecuteResponse xmlns="" xmlns:i="">
          <ExecuteResult i:type="b:RetrieveOrganizationResourcesResponse" xmlns:a="" xmlns:b="">
            <a:Results xmlns:c="">
                <c:value i:type="b:OrganizationResources">
    Thats all there is to it!

    No comments:

    Post a Comment