Friday, June 8, 2012

Book an Appointment in Microsoft Dynamics CRM 2011 Using C# or Jscript

This illustration shows how to book an appointment in Microsoft Dynamics CRM 2011 with BookRequest.  This example will be given in Jscript (SOAP) and in C# (.NET).
    Ok, here is what the code looks like!
    First in C#:

    WhoAmIRequest userRequest = new WhoAmIRequest();
    WhoAmIResponse userResponse = (WhoAmIResponse)_serviceProxy.Execute(userRequest);
    
    // Create the ActivityParty instance.
    ActivityParty party = new ActivityParty
    {
        PartyId = new EntityReference(SystemUser.EntityLogicalName, userResponse.UserId)
    };
    
    // Create the appointment instance.
    Appointment appointment = new Appointment
    {
        Subject = "Test Appointment",
        Description = "Test Appointment created using the BookRequest Message.",
        ScheduledStart = DateTime.Now.AddHours(1),
        ScheduledEnd = DateTime.Now.AddHours(2),
        Location = "Office",
        RequiredAttendees = new ActivityParty[] { party },
        Organizer = new ActivityParty[] { party }
    };
    
    // Use the Book request message.
    BookRequest req = new BookRequest
    {
        Target = appointment
    };
    BookResponse resp = (BookResponse)service.Execute(req);
    Guid _appointmentId = resp.ValidationResult.ActivityId;
    
    
    This C# code was adapted from MSDN examples located at http://msdn.microsoft.com/en-us/library/microsoft.crm.sdk.messages.bookrequest.aspx

    If you need help instantiating a service object in .NET within a plugin check out this post:
    http://mileyja.blogspot.com/2011/04/instantiating-service-object-within.html

    Now here is the Jscript nicely formatted by the CRM 2011 SOAP formatter. Available at: http://crm2011soap.codeplex.com/

    Now in Jscript


    This example is asynchronous, if you want to learn how to make JScript SOAP calls synchronously please visit this posthttp://mileyja.blogspot.com/2011/07/using-jscript-to-access-soap-web.html

    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 () {
                   ///<summary>
                   /// Returns the URL for the SOAP endpoint using the context information available in the form
                   /// or HTML Web resource.
                   ///</summary>
                   var ServicePath = "/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();
                       }
                       else
                       { throw new Error("Unable to access the server URL"); }
                       }
                      if (serverUrl.match(/\/$/)) {
                           serverUrl = serverUrl.substring(0, serverUrl.length - 1);
                       } 
                       return serverUrl + ServicePath;
                   }, 
               BookRequest: function () {
                   var requestMain = ""
                   requestMain += "<s:Envelope xmlns:s=\"http://schemas.xmlsoap.org/soap/envelope/\">";
                   requestMain += "  <s:Body>";
                   requestMain += "    <Execute xmlns=\"http://schemas.microsoft.com/xrm/2011/Contracts/Services\" xmlns:i=\"http://www.w3.org/2001/XMLSchema-instance\">";
                   requestMain += "      <request i:type=\"b:BookRequest\" xmlns:a=\"http://schemas.microsoft.com/xrm/2011/Contracts\" xmlns:b=\"http://schemas.microsoft.com/crm/2011/Contracts\">";
                   requestMain += "        <a:Parameters xmlns:c=\"http://schemas.datacontract.org/2004/07/System.Collections.Generic\">";
                   requestMain += "          <a:KeyValuePairOfstringanyType>";
                   requestMain += "            <c:key>Target</c:key>";
                   requestMain += "            <c:value i:type=\"a:Entity\">";
                   requestMain += "              <a:Attributes>";
                   requestMain += "                <a:KeyValuePairOfstringanyType>";
                   requestMain += "                  <c:key>subject</c:key>";
                   requestMain += "                  <c:value i:type=\"d:string\" xmlns:d=\"http://www.w3.org/2001/XMLSchema\">Test Appointment</c:value>";
                   requestMain += "                </a:KeyValuePairOfstringanyType>";
                   requestMain += "                <a:KeyValuePairOfstringanyType>";
                   requestMain += "                  <c:key>description</c:key>";
                   requestMain += "                  <c:value i:type=\"d:string\" xmlns:d=\"http://www.w3.org/2001/XMLSchema\">Test Appointment created using the BookRequest Message.</c:value>";
                   requestMain += "                </a:KeyValuePairOfstringanyType>";
                   requestMain += "                <a:KeyValuePairOfstringanyType>";
                   requestMain += "                  <c:key>scheduledstart</c:key>";
                   requestMain += "                  <c:value i:type=\"d:dateTime\" xmlns:d=\"http://www.w3.org/2001/XMLSchema\">2012-06-08T09:42:45.8655676-05:00</c:value>";
                   requestMain += "                </a:KeyValuePairOfstringanyType>";
                   requestMain += "                <a:KeyValuePairOfstringanyType>";
                   requestMain += "                  <c:key>scheduledend</c:key>";
                   requestMain += "                  <c:value i:type=\"d:dateTime\" xmlns:d=\"http://www.w3.org/2001/XMLSchema\">2012-06-08T10:42:45.8655676-05:00</c:value>";
                   requestMain += "                </a:KeyValuePairOfstringanyType>";
                   requestMain += "                <a:KeyValuePairOfstringanyType>";
                   requestMain += "                  <c:key>location</c:key>";
                   requestMain += "                  <c:value i:type=\"d:string\" xmlns:d=\"http://www.w3.org/2001/XMLSchema\">Office</c:value>";
                   requestMain += "                </a:KeyValuePairOfstringanyType>";
                   requestMain += "                <a:KeyValuePairOfstringanyType>";
                   requestMain += "                  <c:key>requiredattendees</c:key>";
                   requestMain += "                  <c:value i:type=\"a:EntityCollection\">";
                   requestMain += "                    <a:Entities>";
                   requestMain += "                      <a:Entity>";
                   requestMain += "                        <a:Attributes>";
                   requestMain += "                          <a:KeyValuePairOfstringanyType>";
                   requestMain += "                            <c:key>partyid</c:key>";
                   requestMain += "                            <c:value i:type=\"a:EntityReference\">";
                   requestMain += "                              <a:Id>6e219f51-0310-4c4d-8c60-1c524e2ba7b3</a:Id>";
                   requestMain += "                              <a:LogicalName>systemuser</a:LogicalName>";
                   requestMain += "                              <a:Name i:nil=\"true\" />";
                   requestMain += "                            </c:value>";
                   requestMain += "                          </a:KeyValuePairOfstringanyType>";
                   requestMain += "                        </a:Attributes>";
                   requestMain += "                        <a:EntityState i:nil=\"true\" />";
                   requestMain += "                        <a:FormattedValues />";
                   requestMain += "                        <a:Id>00000000-0000-0000-0000-000000000000</a:Id>";
                   requestMain += "                        <a:LogicalName>activityparty</a:LogicalName>";
                   requestMain += "                        <a:RelatedEntities />";
                   requestMain += "                      </a:Entity>";
                   requestMain += "                    </a:Entities>";
                   requestMain += "                    <a:EntityName i:nil=\"true\" />";
                   requestMain += "                    <a:MinActiveRowVersion i:nil=\"true\" />";
                   requestMain += "                    <a:MoreRecords>false</a:MoreRecords>";
                   requestMain += "                    <a:PagingCookie i:nil=\"true\" />";
                   requestMain += "                    <a:TotalRecordCount>0</a:TotalRecordCount>";
                   requestMain += "                    <a:TotalRecordCountLimitExceeded>false</a:TotalRecordCountLimitExceeded>";
                   requestMain += "                  </c:value>";
                   requestMain += "                </a:KeyValuePairOfstringanyType>";
                   requestMain += "                <a:KeyValuePairOfstringanyType>";
                   requestMain += "                  <c:key>organizer</c:key>";
                   requestMain += "                  <c:value i:type=\"a:EntityCollection\">";
                   requestMain += "                    <a:Entities>";
                   requestMain += "                      <a:Entity>";
                   requestMain += "                        <a:Attributes>";
                   requestMain += "                          <a:KeyValuePairOfstringanyType>";
                   requestMain += "                            <c:key>partyid</c:key>";
                   requestMain += "                            <c:value i:type=\"a:EntityReference\">";
                   requestMain += "                              <a:Id>6e219f51-0310-4c4d-8c60-1c524e2ba7b3</a:Id>";
                   requestMain += "                              <a:LogicalName>systemuser</a:LogicalName>";
                   requestMain += "                              <a:Name i:nil=\"true\" />";
                   requestMain += "                            </c:value>";
                   requestMain += "                          </a:KeyValuePairOfstringanyType>";
                   requestMain += "                        </a:Attributes>";
                   requestMain += "                        <a:EntityState i:nil=\"true\" />";
                   requestMain += "                        <a:FormattedValues />";
                   requestMain += "                        <a:Id>00000000-0000-0000-0000-000000000000</a:Id>";
                   requestMain += "                        <a:LogicalName>activityparty</a:LogicalName>";
                   requestMain += "                        <a:RelatedEntities />";
                   requestMain += "                      </a:Entity>";
                   requestMain += "                    </a:Entities>";
                   requestMain += "                    <a:EntityName i:nil=\"true\" />";
                   requestMain += "                    <a:MinActiveRowVersion i:nil=\"true\" />";
                   requestMain += "                    <a:MoreRecords>false</a:MoreRecords>";
                   requestMain += "                    <a:PagingCookie i:nil=\"true\" />";
                   requestMain += "                    <a:TotalRecordCount>0</a:TotalRecordCount>";
                   requestMain += "                    <a:TotalRecordCountLimitExceeded>false</a:TotalRecordCountLimitExceeded>";
                   requestMain += "                  </c:value>";
                   requestMain += "                </a:KeyValuePairOfstringanyType>";
                   requestMain += "              </a:Attributes>";
                   requestMain += "              <a:EntityState i:nil=\"true\" />";
                   requestMain += "              <a:FormattedValues />";
                   requestMain += "              <a:Id>00000000-0000-0000-0000-000000000000</a:Id>";
                   requestMain += "              <a:LogicalName>appointment</a:LogicalName>";
                   requestMain += "              <a:RelatedEntities />";
                   requestMain += "            </c:value>";
                   requestMain += "          </a:KeyValuePairOfstringanyType>";
                   requestMain += "        </a:Parameters>";
                   requestMain += "        <a:RequestId i:nil=\"true\" />";
                   requestMain += "        <a:RequestName>Book</a:RequestName>";
                   requestMain += "      </request>";
                   requestMain += "    </Execute>";
                   requestMain += "  </s:Body>";
                   requestMain += "</s:Envelope>";
                   var req = new XMLHttpRequest();
                   req.open("POST", SDK.SAMPLES._getServerUrl(), true)
                   req.setRequestHeader("Accept", "application/xml, text/xml, */*");
                   req.setRequestHeader("Content-Type", "text/xml; charset=utf-8");
                   req.setRequestHeader("SOAPAction", "http://schemas.microsoft.com/xrm/2011/Contracts/Services/IOrganizationService/Execute");
                   var successCallback = null;
                   var errorCallback = null;
                   req.onreadystatechange = function () { SDK.SAMPLES.BookResponse(req, successCallback, errorCallback); };
                   req.send(requestMain);
               },
           BookResponse: 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) {
                   if (req.status == 200) {
                   if (successCallback != null)
                   { successCallback(); }
                   }
                   else {
                       errorCallback(SDK.SAMPLES._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);
         },
     __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.BookRequest function from your form jscript handler.


    Thats all there is to it!
    -

    1 comment: