Share via

Walkthrough: Use the Modern app SOAP endpoint with JavaScript

  • Article

 

Applies To: Dynamics CRM 2013

This walkthrough demonstrates creating a JavaScript library for use with the SOAP endpoint with web resources. At this time Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online doesn’t provide JavaScript libraries that you can use to call messages available using the SOAP endpoint. This walkthrough shows how to create a JScript library for the Assign message using the Organization Service Execute method. Any other message using the Execute method will follow a similar pattern. To create a JavaScript library for any message will require a similar process. For an example of a JavaScript library developed using this process, see Sample: Retrieve entity metadata using JavaScript.

The process consists of capturing the HTTP requests and responses sent from a managed code console application and then creating a JavaScript library with functions to send the same requests and process similar responses. It is common to use an application like Fiddler to capture HTTP requests and responses but Fiddler and similar applications cannot capture the encrypted HTTP traffic used for on-premises Microsoft Dynamics CRM 2013. The SOAPLogger sample solution provided captures the HTTP requests before they are encrypted and the HTTP responses after they have been decrypted. The SOAPLogger sample solution works for both Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online. SOAPLogger also filters out any HTTP traffic that is not relevant to the task of creating a JScript library.

This walkthrough guides you through the following tasks:

  1. In Capture sample HTTP Request and Response you will edit the Run method of the SOAPLogger sample to perform an Assign request using managed code.

  2. Then you will run the SOAPLogger solution to generate information about the HTTP requests sent and responses received.

  3. In Create a JScript library you will create a JScript library based on the captured HTTP traffic to send and receive the Assign message using the Organization Service Execute method.

  4. In Test the JScript library you will test the JScript library to confirm it can be used to assign records.

  5. In Create an Interactive Web Resource you will create an HTML web resource that uses the library to assign Account records to a selected user as shown in the following screenshot.

    Assign Accounts Page

A managed solution representing this completed walkthrough is available in the SDK package at SDK\SampleCode\JS\SOAPForJScript\SOAPEndpointforJScript_1_0_0_1_managed.zip. Download the Microsoft Dynamics CRM SDK package. You can install (import) this solution and view the completed results. Because it is a managed solution you can easily uninstall (delete) it to completely remove it from your system.

The SDK\SampleCode\JS\SOAPForJScript\SOAPForJScript.sln is a Visual Studio solution containing the HTML and JS files with the code in this walkthrough.

Prerequisites

  • You must be able to write managed code corresponding to the functions you want to perform using JScript.

  • You need access to the SOAPLogger sample available with the SDK download files at SDK\SampleCode\CS\Client\SOAPLogger.

    Note

    The SOAPLogger sample in the Microsoft Dynamics CRM SDK is only available for Microsoft Visual C#. If you prefer a Microsoft Visual Basic .NET version, see Microsoft Dynamics CRM 2011 SOAP Logger for VB.NET on MSDN.

  • You need Microsoft Visual Studio to run the SOAPLogger solution.

  • You need a good knowledge of JScript and asynchronous programming using XMLHttpRequest.

Capture sample HTTP Request and Response

Edit the SOAPLogger solution to add code to perform an AssignRequest using the SoapLoggerOrganizationService. The SoapLoggerOrganizationService inherits from the IOrganizationService and adds the capability to generate a log file that displays the relevant HTTP traffic sent and received.

  1. Using Microsoft Visual Studio, open the SOAPLogger solution located at SDK\SampleCode\CS\Client\SOAPLogger\SOAPLogger.sln.

  2. In the SoapLogger.cs file, locate the Run method as shown in the following example:

    
public void Run(ServerConnection.Configuration serverConfig)
{
 try
 {

  // Connect to the Organization service. 
  // The using statement assures that the service proxy will be properly disposed.
  using (_serviceProxy = ServerConnection.GetOrganizationProxy(serverConfig))
  {
   // This statement is required to enable early-bound type support.
   _serviceProxy.EnableProxyTypes();

   IOrganizationService service = (IOrganizationService)_serviceProxy;


   using (StreamWriter output = new StreamWriter("output.txt"))
   {

    SoapLoggerOrganizationService slos = new SoapLoggerOrganizationService(serverConfig.OrganizationUri, service, output);

    //Add the code you want to test here:
    // You must use the SoapLoggerOrganizationService 'slos' proxy rather than the IOrganizationService proxy you would normally use.



   }


  }

 }

 // Catch any service fault exceptions that Microsoft Dynamics CRM throws.
 catch (FaultException<Microsoft.Xrm.Sdk.OrganizationServiceFault>)
 {
  // You can handle an exception here or pass it back to the calling method.
  throw;
 }
}

  3. Identify a valid id for a SystemUser record and the ID of an Account record not assigned to that user.

    Tip

    To get the Id from any record in the application, open that record and use the Copy a Link command. Paste the link into Notepad and isolate the portion that contains the id parameter value excluding the encoded brackets (“%7b” = “{”) and (“%7d” = “}”). For example, the following represents a URL for an Account record. <your organization root url>/main.aspx?etc=1&id=%7bF2CA52DE-552D-E011-A8FB-00155DB059BE%7d&pagetype=entityrecord>. The id value is F2CA52DE-552D-E011-A8FB-00155DB059BE.

    Use those values to replace the placeholder values in the code below and add the code to the run method where indicated. For more information about the Assign request see AssignRequest.

    Guid userId = new Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
Guid accountId = new Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");

AssignRequest assign = new AssignRequest
{
Assignee = new EntityReference(SystemUser.EntityLogicalName, userId),
Target = new EntityReference(Account.EntityLogicalName, accountId)
};
AssignResponse assignResp = (AssignResponse)slos.Execute(assign);

  4. Press F5 to debug the application. Enter information about the server and your authentication credentials. If the code runs successfully the account record will now be assigned to the user you specified. For more information about running sample code, see Run a simple program using Microsoft Dynamics CRM 2013 web services

  5. In the SOAPLogger project folders, navigate to the bin and Debug folders and look for the output.txt file.

  6. Open the output.txt file and review the contents. They should look something like the following except actual GUID values will replace the placeholder “XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX”.

    HTTP REQUEST
--------------------------------------------------
POST <your server root>/XRMServices/2011/Organization.svc/web
Content-Type: text/xml; charset=utf-8
SOAPAction: https://schemas.microsoft.com/xrm/2011/Contracts/Services/IOrganizationService/Execute

<s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">
 <s:Body>
  <Execute xmlns="https://schemas.microsoft.com/xrm/2011/Contracts/Services"
           xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <request i:type="b:AssignRequest"
            xmlns:a="https://schemas.microsoft.com/xrm/2011/Contracts"
            xmlns:b="https://schemas.microsoft.com/crm/2011/Contracts">
    <a:Parameters xmlns:c="http://schemas.datacontract.org/2004/07/System.Collections.Generic">
     <a:KeyValuePairOfstringanyType>
      <c:key>Target</c:key>
      <c:value i:type="a:EntityReference">
       <a:Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</a:Id>
       <a:LogicalName>account</a:LogicalName>
       <a:Name i:nil="true" />
      </c:value>
     </a:KeyValuePairOfstringanyType>
     <a:KeyValuePairOfstringanyType>
      <c:key>Assignee</c:key>
      <c:value i:type="a:EntityReference">
       <a:Id>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</a:Id>
       <a:LogicalName>systemuser</a:LogicalName>
       <a:Name i:nil="true" />
      </c:value>
     </a:KeyValuePairOfstringanyType>
    </a:Parameters>
    <a:RequestId i:nil="true" />
    <a:RequestName>Assign</a:RequestName>
   </request>
  </Execute>
 </s:Body>
</s:Envelope>
--------------------------------------------------

HTTP RESPONSE
--------------------------------------------------
<s:Envelope xmlns:s="https://schemas.xmlsoap.org/soap/envelope/">
 <s:Body>
  <ExecuteResponse xmlns="https://schemas.microsoft.com/xrm/2011/Contracts/Services"
                   xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <ExecuteResult i:type="b:AssignResponse"
                  xmlns:a="https://schemas.microsoft.com/xrm/2011/Contracts"
                  xmlns:b="https://schemas.microsoft.com/crm/2011/Contracts">
    <a:ResponseName>Assign</a:ResponseName>
    <a:Results xmlns:c="http://schemas.datacontract.org/2004/07/System.Collections.Generic" />
   </ExecuteResult>
  </ExecuteResponse>
 </s:Body>
</s:Envelope>
--------------------------------------------------

  7. Note the location of the variables you passed in using your code, including the logical name of the Account entity.

You have successfully captured the relevant portions of the HTTP traffic that performed the assign operation.

Create a JScript library

Exactly how you wish to construct your library is up to you. Each JScript should have the following elements:

  • A strategy to help ensure that the name of any function is unique.

  • A means to retrieve the URL to the SOAP endpoint for web resources.

  • Separate methods to send the request and receive the response asynchronously.

  • A function to process any WCF faults returned.

The following JScript library includes these elements and includes the assignRequest and assignResponse functions to use the Assign message based on the HTTP requests and responses captured using the SOAPLogger.


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.SOAPSamples = {
 _getClientUrl: function () {
  ///<summary>
  /// Returns the URL for the SOAP endpoint using the context information available in the form
  /// or HTML Web resource.
  ///</summary
  var OrgServicePath = "/XRMServices/2011/Organization.svc/web";
  var clientUrl = "";
  if (typeof GetGlobalContext == "function") {
   var context = GetGlobalContext();
   clientUrl = context.getClientUrl();
  }
  else {
   if (typeof Xrm.Page.context == "object") {
    clientUrl = Xrm.Page.context.getClientUrl();
   }
   else
   { throw new Error("Unable to access the server URL"); }
  }

  return clientUrl + OrgServicePath;
 },
 assignRequest: function (Assignee, Target, Type, successCallback, errorCallback) {
  ///<summary>
  /// Sends the Assign Request
  ///</summary>
  this._parameterCheck(Assignee, "GUID", "The SDK.SOAPSamples.assignRequest method Assignee parameter must be a string Representing a GUID value.");
  ///<param name="Assignee" Type="String">
  /// The GUID representing the  System user that the record will be assigned to.
  ///</param>
  this._parameterCheck(Target, "GUID", "The SDK.SOAPSamples.assignRequest method Target parameter must be a string Representing a GUID value.");
  ///<param name="Target" Type="String">
  /// The GUID representing the user-owned entity record that will be assigne to the Assignee.
  ///</param>
  this._parameterCheck(Type, "String", "The SDK.SOAPSamples.assignRequest method Type parameter must be a string value.");
  Type = Type.toLowerCase();
  ///<param name="Type" Type="String">
  /// The Logical name of the user-owned entity. For example, 'account'.
  ///</param>
  if (successCallback != null)
  this._parameterCheck(successCallback, "Function", "The SDK.SOAPSamples.assignRequest method successCallback parameter must be a function.");
  ///<param name="successCallback" Type="Function">
  /// The function to perform when an successfult response is returned.
  ///</param>
  this._parameterCheck(errorCallback, "Function", "The SDK.SOAPSamples.assignRequest method errorCallback parameter must be a function.");
  ///<param name="errorCallback" Type="Function">
  /// The function to perform when an error is returned.
  ///</param>
  //The request is simply the soap envelope captured by the SOAPLogger with variables added for the 
  // values passed. All quotations must be escaped to create valid JScript strings.
  var request = [];

     request.push("<s:Envelope xmlns:s=\"https://schemas.xmlsoap.org/soap/envelope/\">");
     request.push("<s:Body>");
     request.push("<Execute xmlns=\"https://schemas.microsoft.com/xrm/2011/Contracts/Services\"");
     request.push(" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">");
     request.push("<request i:type=\"b:AssignRequest\"");
     request.push(" xmlns:a=\"https://schemas.microsoft.com/xrm/2011/Contracts\"");
     request.push(" xmlns:b=\"https://schemas.microsoft.com/crm/2011/Contracts\">");
     request.push("<a:Parameters xmlns:c=\"http://schemas.datacontract.org/2004/07/System.Collections.Generic\">");
     request.push("<a:KeyValuePairOfstringanyType>");
     request.push("<c:key>Target</c:key>");
     request.push("<c:value i:type=\"a:EntityReference\">");
     request.push("<a:Id>" + this._xmlEncode(Target) + "</a:Id>");
     request.push("<a:LogicalName>" + this._xmlEncode(Type) + "</a:LogicalName>");
     request.push("<a:Name i:nil=\"true\" />");
     request.push("</c:value>");
     request.push("</a:KeyValuePairOfstringanyType>");
     request.push("<a:KeyValuePairOfstringanyType>");
     request.push("<c:key>Assignee</c:key>");
     request.push("<c:value i:type=\"a:EntityReference\">");
     request.push("<a:Id>" + this._xmlEncode(Assignee) + "</a:Id>");
     request.push("<a:LogicalName>systemuser</a:LogicalName>");
     request.push("<a:Name i:nil=\"true\" />");
     request.push("</c:value>");
     request.push("</a:KeyValuePairOfstringanyType>");
     request.push("</a:Parameters>");
     request.push("<a:RequestId i:nil=\"true\" />");
     request.push("<a:RequestName>Assign</a:RequestName>");
     request.push("</request>");
     request.push("</Execute>");
     request.push("</s:Body>");
     request.push("</s:Envelope>");

  var req = new XMLHttpRequest();
  req.open("POST", SDK.SOAPSamples._getClientUrl(), 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", "https://schemas.microsoft.com/xrm/2011/Contracts/Services/IOrganizationService/Execute");
  req.onreadystatechange = function () { SDK.SOAPSamples.assignResponse(req, successCallback, errorCallback); };
  req.send(request.join(""));

 },
 assignResponse: function (req, successCallback, errorCallback) {
  ///<summary>
  /// Recieves the assign response
  ///</summary>
  ///<param name="req" Type="XMLHttpRequest">
  /// The XMLHttpRequest response
  ///</param>
  ///<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>
  ///<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
  ///</param>
     if (req.readyState == 4) {
         req.onreadystatechange = null; //avoids memory leaks
   if (req.status == 200) {
    if (successCallback != null)
    { successCallback(); }
   }
   else {
    errorCallback(SDK.SOAPSamples._getError(req.responseXML));
   }
  }
 },
 _getError: function (faultXml) {
  ///<summary>
  /// Parses the WCF fault returned in the event of an error.
  ///</summary>
  ///<param name="faultXml" Type="XML">
  /// The responseXML property of the XMLHttpRequest response.
  ///</param>
  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;
        break;
       }
      }
      break;
     }
    }
   }
   catch (e) { };
  }
  return new Error(errorMessage);
 },
 _xmlEncode: function (strInput) {
  var c;
  var XmlEncode = '';

  if (strInput == null) {
   return null;
  }
  if (strInput == '') {
   return '';
  }

  for (var cnt = 0; cnt < strInput.length; cnt++) {
   c = strInput.charCodeAt(cnt);

   if (((c > 96) &amp;&amp; (c < 123)) ||
            ((c > 64) &amp;&amp; (c < 91)) ||
            (c == 32) ||
            ((c > 47) &amp;&amp; (c < 58)) ||
            (c == 46) ||
            (c == 44) ||
            (c == 45) ||
            (c == 95)) {
    XmlEncode = XmlEncode + String.fromCharCode(c);
   }
   else {
    XmlEncode = XmlEncode + '&amp;#' + c + ';';
   }
  }

  return XmlEncode;
 },
 _parameterCheck: function (parameter, type, errorMessage) {
  switch (type) {
   case "String":
    if (typeof parameter != "string") {
     throw new Error(errorMessage);
    }
    break;
   case "Function":
    if (typeof parameter != "function") {
     throw new Error(errorMessage);
    }
    break;
   case "EntityFilters":
    var found = false;
    for (x in this.EntityFilters) {
     if (this.EntityFilters[x] == parameter) {
      found = true;
      break;
     }
    }
    if (!found) {
     throw new Error(errorMessage);
    }
    break;
   case "Boolean":
    if (typeof parameter != "boolean") {
     throw new Error(errorMessage);
    }
    break;
   case "GUID":
    var re = new RegExp("[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}");
    if (!(typeof parameter == "string" &amp;&amp; re.test(parameter))) {
     throw new Error(errorMessage);
    }

    break;
   default:
    throw new Error("An invalid type parameter value was passed to the SDK.MetaData._parameterCheck function.");
    break;
  }
 },
 __namespace: true
};

Test the JScript library

After you have prepared your JScript library you should perform some initial testing to confirm that it works as you expect. Because authentication only occurs within the application you must create a script web resource in Microsoft Dynamics CRM 2013 using the contents of your library. To use the functions in your library you will need some UI element, either a form or an HTML web resource to call the JScript functions in your library. The following procedure describes using a simple HTML web resource to test the functions in the library.

  1. Create an HTML document using the following code:

    
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
 <title>Assign Test</title>
  <script src="../ClientGlobalContext.js.aspx" type="text/javascript"></script>
 <script src="Scripts/SDK.REST.js" type="text/javascript"></script>
 <script src="Scripts/SDK.SOAPSample.Assign.js" type="text/javascript"></script>
 <script src="Scripts/json2.js" type="text/javascript"></script>
 <script type="text/javascript">
  var resultsArea = null;
  var userid;
  var accountid;
  var userLookup;
  var accountLookup;
  var accountsToShow = 10;
  var usersToShow = 10;
  var users = [];
  var accounts = [];

  document.onreadystatechange = function () {
   ///<summary>
   /// Initializes the sample when the document is ready
   ///</summary>
   if (document.readyState == "complete") {
    userid = document.getElementById("userid");
    accountid = document.getElementById("accountid");
    resultsArea = document.getElementById("results");
    userLookup = document.getElementById("userLookup");
    accountLookup = document.getElementById("accountLookup");

    populateUserLookup();
    populateAccountLookup();

   }
  }

  function testAssign() {
   //The field to enter the user id of the person the account record should be assigned to.
   userid.value;
   // The field to enter the account id of the account record to assign to the user
   accountid.value;
   // Since the response does not include any data to parse, simply display a success message.
   var successCallback = function () { setText(resultsArea, "Success!"); };
   // Display the error from the message passed back from the response.
   var errorCallback = function (error) { setText(resultsArea,"errorCallback error: "+error.message); };
   // Call the function
   try {
    SDK.SOAPSamples.assignRequest(userid.value, accountid.value, "account", successCallback, errorCallback);
   }
   catch (e) {
    setText(resultsArea, e.message);
   }

  }

  function populateUserLookup() {
   SDK.REST.retrieveMultipleRecords("SystemUser",
   "$top=" + usersToShow + "&amp;$select=FullName,SystemUserId&amp;$filter=FullName ne 'INTEGRATION' and FullName ne 'SYSTEM'",
   function (results) {
    for (var i = 0; i < results.length; i++) {
     users.push(results[i]);
    }
   },
   function (error) {
    alert(error.message);
   },
   function () {
    for (var i = 0; i < users.length; i++) {
     var user = users[i];
     userLookup.options[i] = new Option(user.FullName, user.SystemUserId);
    }
    userid.value = userLookup.options[0].value;

    userLookup.onchange = function () {
     userid.value = userLookup.options[userLookup.selectedIndex].value;
     clearMessage();
    };

   });
  }

  function populateAccountLookup() {
   SDK.REST.retrieveMultipleRecords("Account",
    "$top=" + accountsToShow + "&amp;$select=AccountId,Name,OwnerId",
   function (results) {
    for (var i = 0; i < results.length; i++) {
     accounts.push(results[i]);

    }
   },
   function (error) {
    alert(error.message);
   },
   function () {
    for (var i = 0; i < accounts.length; i++) {
     var account = accounts[i];
     accountLookup.options[i] = new Option(account.Name + " : " + account.OwnerId.Name, account.AccountId);

    }
    accountid.value = accountLookup.options[0].value;

    accountLookup.onchange = function () {
     accountid.value = accountLookup.options[accountLookup.selectedIndex].value;
     clearMessage();
    };
   });
  }

  function clearMessage() {
   setText(resultsArea, "");
  }

  function setText(element, text) {
   if (typeof (element.innerText) != "undefined") {
    element.innerText = text;
   }
   else {
    element.textContent = text;
   }

  }

 </script>
</head>
<body>
 <table>
  <tr>
   <td>
    <label for="userid">
     SystemUserId:</label>
   </td>
   <td>
    <input id="userid" type="text" style="width:270px;"  />
   </td>
   <td>
   <select id="userLookup"></select>
   </td>
  </tr>
  <tr>
   <td>
    <label for="accountid">
     AccountId:</label>
   </td>
   <td>
    <input id="accountid" type="text" style="width:270px;" />
   </td>
      <td>
   <select id="accountLookup"></select>
   </td>
  </tr>
 </table>

 <button id="testAssign" title="Click this button to test the testAssign function." onclick="testAssign();">
  Test Assign</button>
 <div id="results">
  &amp;nbsp;</div>
</body>
</html>

  2. Create an HTML web resource using this code. The full name of the HTML web resource will depend on the customization prefix of your solution. Assuming your solution customization prefix is ”new”, name this HTML web resource “new_/AssignTest.htm”. The specific customization prefix used has no effect on this example as long as all the web resources use the same customization prefix.

  3. Create a script web resource using the content of the JScript library. Name this web resource “new_/Scripts/SDK.SOAPSample.Assign.js”.

  4. Publish all customizations and open the new_/AssignTest.htm web resource. Click the Preview button.

  5. Using the same process you used in step three of the procedure, identify valid System User and Account record Id values and paste them into the page. Then click Test Assign to confirm you get a success response.

  6. Enter invalid values to confirm that the error is being parsed properly.

    For example, if you enter “A Store (sample)” rather than the Id for an account you should expect the following error message:

    The formatter threw an exception while trying to deserialize the message: 
There was an error while trying to deserialize parameter https://schemas.microsoft.com/xrm/2011/Contracts/Services:request. 
The InnerException message was 'There was an error deserializing the object of type Microsoft.Xrm.Sdk.OrganizationRequest. 
The value 'A Store (sample)' cannot be parsed as the type 'Guid'.'.  Please see InnerException for more details.

    If there is not an account record for the AccountId, the message you would expect is:

    Account With Id = 883c3084-1f2f-e011-ad66-00155dba3814 Does Not Exist

Create an Interactive Web Resource

The next step is to use your JScript library in a form script, a Ribbon command or a web resource. The following code sample represents an HTML web resource that uses the REST endpoint to retrieve lists of SystemUser and Account records to provide an interactive user interface to assign account records to users. This page uses the Scripts/SDK.SOAPSample.Assign.js script web resource and a script web resource using the json2.js library to support the use of JSON objects with the REST endpoint. The SDK.REST.js library is used to retrieve data using the REST endpoint.


<html lang="en-us">
<head>
 <title>Assign Accounts Page</title>
 <style type="text/css">
  body
  {
   font-family: Segoe UI;
   background-color: #EFF2F6;
  }
  .dataTable
  {
   border-collapse: collapse;
   border: 1px solid black;
  }
  .tableHead
  {
   background-color: #C0C0C0;
   width: 100%;
  }
  .grid
  {
   border-bottom: 1px solid black;
  }
  td
  {
   padding-left: 5px;
   padding-right: 5px;
  }
  #accountList
  {
   background-color: White;
  }
  #checkboxCol
  {
   border-right: 1px solid black;
   width: 20px;
  }
  #nameCol
  {
   border-right: 1px solid black;
   width: 300px;
  }
  #ownerCol
  {
   width: 300px;
  }
 </style>
 <script src="../ClientGlobalContext.js.aspx" type="text/javascript"></script>
 <script src="Scripts/SDK.REST.js" type="text/javascript"></script>
 <script src="Scripts/json2.js" type="text/javascript"></script>
 <script src="Scripts/SDK.SOAPSample.Assign.js" type="text/javascript"></script>
 <script type="text/javascript">
  //Set variables for page elements
  var userSelect; //The select control used to select the user to assign records to.
  var accountList; //The tbody element that rows will be added to for each retrieved account
  var selectAll; //The checkbox to select all the retrieved accounts
  var btnAssign; //The button to assign assign the accounts
  var tableCaption; //A label hidden on load
  var dataTable; //the table element hidden on load
  var alertFlag; // Alert flag to indicate the changes
  var users = []; //SystemUser records retrieved
  var accounts = []; //Accounts not assigned to the currently selected user.
  var accountsToShow = 5;
  var accountsToAssign = 0;
  var suppressRetrievedAccountsAlert = false;

  function startSample() {
   ///<summary>
   /// Starts the sample
   ///</summary>
    alertFlag = document.getElementById("dispalert");
    userSelect = document.getElementById("userList");
    //A new set of a 5 accounts will be retrieved when the user changes
    userSelect.onchange = getAccounts;

    accountList = document.getElementById("accountList");
    selectAll = document.getElementById("selectAll");
    //When the select all checkbox is clicked, toggle the selection for each row of the table.
    selectAll.onclick = toggleSelectAllRecords;
    btnAssign = document.getElementById("btnAssign");
    //Add a helper function to enable or disable the assign button.
    btnAssign.setEnabled = setEnabled;
    //Set the event handler to the Assign button
    btnAssign.onclick = assignAccounts;
    tableCaption = document.getElementById("tableCaption");
    dataTable = document.getElementById("dataTable");
    var divSample = document.getElementById("divSample");
    //Load the list of users
    getUsers();
    divSample.style.display = "block";

    document.getElementById("btnStart").setAttribute("disabled", "disabled");

  }
  function getUsers() {
   SDK.REST.retrieveMultipleRecords("SystemUser",
   "$select=FullName,SystemUserId&amp;$filter=FullName ne 'INTEGRATION' and FullName ne 'SYSTEM'",
   function (results) {
    for (var i = 0; i < results.length; i++) {
     users.push(results[i]);
    }
   },
   function (error) {
    showMessage(error.message);
   },
   function () {
    if (users.length > 1) {
     for (var i = 0; i < users.length; i++) {
      var user = users[i];
      userSelect.options[i + 1] = new Option(user.FullName, user.SystemUserId);
     }
     userSelect.removeAttribute("disabled");

     if (alertFlag.checked == true) {
      alert(users.length + " system users retrieved");
     }

    }
    else {
     var notification = "This sample requires that more than one user is available in the organization.";
     showMessage(notification);
     if (alertFlag.checked == true) { 
     alert("This sample requires that more than one user is available in the organization.");
     }

    }
   });
  }
  function getAccounts() {
   //Clear out any records displayed in the table
   clearAccountList();
   var selectedUserId = userSelect.options[userSelect.selectedIndex].value;
   if (selectedUserId != "none") {

    SDK.REST.retrieveMultipleRecords("Account",
    "$top=" + accountsToShow + "&amp;$select=AccountId,Name,OwnerId&amp;$filter=OwnerId/Id ne (guid'" + encodeURIComponent(selectedUserId) + "')",
    function (results) {
     accounts.length = 0;
     for (var i = 0; i < results.length; i++) {
      accounts.push(results[i]);
     }
    },
    function (error) {
     showMessage(error.message);
    },
    function () {
     //onComplete
     if (accounts.length > 0) {

      for (var i = 0; i < accounts.length; i++) {
       var account = accounts[i];

       var row = document.createElement("tr");
       row.setAttribute("class", "grid");
       row.setAttribute("id", account.AccountId);
       var checkboxCell = document.createElement("td");
       var checkbox = document.createElement("input");
       checkbox.setAttribute("type", "checkbox");
       checkbox.onclick = validateAssignButton;
       checkboxCell.appendChild(checkbox);
       row.appendChild(checkboxCell);
       var nameCell = document.createElement("td");
       setText(nameCell, account.Name);
       row.appendChild(nameCell);
       var userNameCell = document.createElement("td");
       setText(userNameCell, account.OwnerId.Name);
       row.appendChild(userNameCell);
       accountList.appendChild(row);



      }

      if (alertFlag.checked == true &amp;&amp; !suppressRetrievedAccountsAlert) {
       alert(accounts.length + " account records retrieved.");
       suppressRetrievedAccountsAlert = false;

      }
     }
     else {
      //If no records are returned display a message.
      clearAccountList();
      var row = document.createElement("tr");
      var cell = document.createElement("td");
      cell.setAttribute("colSpan", "3");
      setText(cell, "No Accounts were retrieved");
      row.appendChild(cell);
      accountList.appendChild(row);

     }
     //Show any of the UI elements that are initially hidden
     setVisibleUIElements(true);
    });
   }
   else
   { setVisibleUIElements(false); }
  }
  function assignAccounts() {
   ///<summary>
   /// Use the SDK.SOAPSamples.assignRequest method in the SDK.SOAPSamples.js file to assign account records.
   ///</summary>
   accountsToAssign = 0;

   var userId = userSelect.options[userSelect.selectedIndex].value;

   var checkboxes = accountList.getElementsByTagName("input");
   for (var i = checkboxes.length - 1; i >= 0; i--) {
    if (checkboxes[i].checked) {
     accountsToAssign++;
     var accountId = checkboxes[i].parentElement.parentElement.id;
     SDK.SOAPSamples.assignRequest(userId,
         accountId,
         "account",
         function () {
          accountsToAssign--;
          if (accountsToAssign == 0) {
           //re-load the table after all have been assigned.
           suppressRetrievedAccountsAlert = true;
           getAccounts();
           btnAssign.setEnabled(false)
           if (alertFlag.checked == true) {
            alert("Record assignment completed and next set of records retrieved.");
           }
          }
         },
         function (error) {
          showMessage("There was an error assigning the account with Id :" + accountId + ". The error message is " + error.message + ".");
         });
    }
   }

   selectAll.checked = false;



  }
  function showMessage(message) {
   ///<summary>
   /// Helper function to display message on the page if necessary.
   ///</summary
   var dvMessage = document.createElement("div");
   dvMessage.innerHTML = SDK.SOAPSamples._xmlEncode(message);
   document.getElementById("status").appendChild(dvMessage);
  }
  function clearAccountList() {
   ///<summary>
   /// Helper function remove rows from the Account List table.
   ///</summary
   for (var i = (accountList.rows.length - 1); i >= 0; i--) {
    accountList.deleteRow(i);
   }
   accounts.length = 0;

  }
  function toggleSelectAllRecords() {
   ///<summary>
   /// Helper function to toggle all selected rows in the account list table.
   ///</summary
   var checkboxes = accountList.getElementsByTagName("input");
   for (var i = 0; i < checkboxes.length; i++) {
    checkboxes[i].checked = this.checked;
   }
   btnAssign.setEnabled(this.checked);

  }
  function validateAssignButton() {
   ///<summary>
   /// Helper function to enable the Assign Records button when rows are selected.
   ///</summary
   if (this.checked == true)
   { btnAssign.setEnabled(true); }
   else {
    selectAll.checked = false;
    var checkboxes = accountList.getElementsByTagName("input");
    var checked = false;
    for (var i = 0; i < checkboxes.length; i++) {
     if (checkboxes[i].checked == true) {
      checked = true;
      break;
     }
    }
    btnAssign.setEnabled(checked);
   }
  }
  function setEnabled(bool) {
   ///<summary>
   /// Helper method attached to the Assign button to make it easier to enable/disable the button.
   ///</summary
   if (bool)
   { this.removeAttribute("disabled"); }
   else
   { this.setAttribute("disabled", "disabled"); }
  }
  function setVisibleUIElements(display) {
   ///<summary>
   /// Helper function to show those UI elements initially hidden.
   ///</summary
   if (display) {
    show(tableCaption);
    show(dataTable);
    show(btnAssign);
   }
   else {
    hide(tableCaption);
    hide(dataTable);
    hide(btnAssign);
   }

  }
  function show(element) {
   if (element.tagName.toLowerCase() == "table") {
    element.style.display = "table";
   }
   else { 
   element.style.display = "block";
   }

  }
  function hide(element) {
   element.style.display = "none";
  }
  // setText  mitigate differences in how browsers set or get text content.
  function setText(node, text) {
   if (typeof (node.innerText) != "undefined") {
    node.innerText = text;
   }
   else {
    node.textContent = text;
   }

  }

 </script>
</head>
<body>
 <h1>
  Assign Accounts Sample</h1>
 <p>
  This page requires JavaScript and will update dynamically.</p>
 <p>
  <input id="dispalert" name="dispalert" type="checkbox" value="alert" /><label for="dispalert">Display alert window when data changes.</label></p>
 <p>
  Click the <b>Start</b> button to begin the sample.</p>
 <input type="button" id="btnStart" name="btnStart" value="Start" onclick="startSample()" />
 <div id="divSample" style="display: none">
  <label for="userList">
   User:
  </label>
  <select id="userList" name="userList" title="Select a system user from this list." disabled>
   <option value="none">Select a User...</option>
  </select>
  <p id="tableCaption" style="display: none;">
   Top 5 Accounts not assigned to the selected user:</p>
  <table class="dataTable" id="dataTable" style="display: none; width: 100%;">
   <thead>
    <tr class="tableHead">
     <th scope="col" id="checkboxCol">
      <input id="selectAll" name="selectAll" title="Select this to select all records" type="checkbox" /><label for="selectAll">Select&amp;nbsp;All</label>
     </th>
     <th scope="col" id="nameCol">
      Name
     </th>
     <th scope="col" id="ownerCol">
      Owner
     </th>
    </tr>
   </thead>
   <tbody id="accountList">
   </tbody>
  </table>

  <label style="display: none;" for="btnAssign">
   Click to assign selected records
  </label>
  <button id="btnAssign" name="btnAssign" disabled style="display: none; float: right;">
   Assign Records</button>
  <label style="display: none;" for="btnAssign">
   Click to assign selected records
  </label>
  <button id="Button1" name="btnAssign" disabled style="display: none; float: right;">
   Assign Records</button>
 </div>
 <div id="status">
  &amp;nbsp;</div>
</body>
</html>

See Also

AssignRequest
Sample: Retrieve entity metadata using JavaScript
Use the Modern app SOAP endpoint for modern applications with web resources
Use web service data in web resources (OData and Modern app SOAP endpoint)
Write applications and server extensions
JavaScript libraries for Microsoft Dynamics CRM 2013
Technical Article: Using Option Set Options with the REST Endpoint - JScript