Implemented retrieve by alternate key

Author: DigitalFlow

src/js/WebApiClient.js

@@ -195,6 +195,22 @@
         if (params.entityId) {
             url += "(" + RemoveIdBrackets(params.entityId) + ")";
         }
+        else if (params.alternateKey) {
+            url += "(";
+            
+            for (var i = 0; i < params.alternateKey.length; i++) {
+                var key = params.alternateKey[i];
+                
+                url += key.property + "='" + key.value + "'";
+                
+                if (i + 1 === params.alternateKey.length) {
+                    url += ")";
+                }
+                else {
+                    url += ",";
+                }
+            }
+        }
 
         if (params.queryParams) {
             url += params.queryParams;

src/spec/WebApiClientSpec.js

@@ -1,6 +1,7 @@
 describe("WebApiClient", function() {
     var fakeUrl = "http://unit-test.local";
     var account;
+    var contact;
     var xhr;
 
     Xrm = {};
@@ -18,6 +19,10 @@ describe("WebApiClient", function() {
         account = { 
             Name: "Adventure Works"
         };
+        
+        contact = {
+            FirstName: "Joe"
+        };
 
         xhr = sinon.fakeServer.create();
 
@@ -39,6 +44,12 @@ describe("WebApiClient", function() {
             [200, { "Content-Type": "application/json" }, JSON.stringify([account])]
         );
 
+        // Respond to Retrieve Request for contact with alternate key 
+        var retrieveByAlternateKeyUrl = RegExp.escape(fakeUrl + "/api/data/v8.0/contacts(firstname='Joe',emailaddress1='[email protected]')");
+        xhr.respondWith("GET", new RegExp(retrieveByAlternateKeyUrl, "g"),
+            [200, { "Content-Type": "application/json" }, JSON.stringify(contact)]
+        );
+        
         // Respond to update Request for account 
         var updateAccountUrl = RegExp.escape(fakeUrl + "/api/data/v8.0/accounts(00000000-0000-0000-0000-000000000001)");
         xhr.respondWith("PATCH", new RegExp(updateAccountUrl, "g"),
@@ -171,6 +182,28 @@ describe("WebApiClient", function() {
 
             xhr.respond();
         });
+        
+        it("should retrieve by alternative key", function(done){
+            WebApiClient.Retrieve(
+            {
+                entityName: "contact", 
+                alternateKey: 
+                    [
+                        { property: "firstname", value: "Joe" },
+                        { property: "emailaddress1", value: "[email protected]"}
+                    ]
+            })
+            .then(function(response){
+                expect(response).toEqual(contact);
+            })
+            .catch(function(error) {
+                expect(error).toBeUndefined();
+            })
+            // Wait for promise
+            .finally(done);
+            
+            xhr.respond();
+        });
     });
 
     describe("Update", function() {