Skip to main content

JQuery JavaScript Client for CoreService

Image
By
In my previous post, I presented a JavaScript CoreService client that was using the out-of-the-box Visual Studio project and a WCF generated JS proxies using the Microsoft AJAX framework.

In this blog post, I write about a JQuery client for CoreService that is lighter and only depends on JQuery. I took my inspiration from Yoav's blog post Creating a Webservice Proxy with jQuery

The server part remains untouched. This means I can only focus on the JavaScript client.

CoreService is secured with Basic or Federated authentication. I am focusing on Basic auth in this post, mainly because it is so simple to use from JS.

The main entry point in the code is the ServiceProxy class. This is where we define the constructor and where we set the endpoint to use for CoreService and the username, password combination to use.

The ServiceProxy makes use of the JQuery's $.ajax function, where it performs a POST to the CoreService endpoint, sets the payload to send, Authorization header and the success, failed callback functions.

ServiceProxy = function (adminUser, adminPassword, endpoint) {
    this._basicAuth = "Basic " + btoa(adminUser + ":" + adminPassword);
    this._baseURL = endpoint;
};

ServiceProxy.prototype =
{
    _defaultErrorHandler: function (xhr, status, error) {
        alert(xhr.status + " " + xhr.statusText + "\r\n" + xhr.responseText);
    },

    _doAjax: function (method, data, fnSuccess, fnError, isAsync) {
        if (!data) data = {};
        if (isAsync == undefined) isAsync = true;
        if (!fnError) fnError = this._defaultErrorHandler;

        $.ajax({
            type: "POST",
            url: this._baseURL + method,
            data: data,
            contentType: "application/json; charset=utf-8",
            headers: { "Authorization": this._basicAuth },
            success: fnSuccess,
            error: fnError,
            async: isAsync
        });
    },

    getCurrentUser: function (success, error) {
        this._doAjax("GetCurrentUser", null, success, error);
    }
};

The code above also declares method getCurrentUser, which calls the CoreService GetCurrentUser method without posting any payload.

The HTML

The sample code below connects to the CoreService endpoint defined earlier and performs a sample call to retrieve the current user.

Notice that the JS code only requires the JQuery library and the ServiceProxy we defined earlier.

Since we are declaring contentType as application/json, JQuery will parse and decode the JSON response from the web-service into a JavaScript object.

<!DOCTYPE html>
<html>
<head>
    <script src="jquery-1.10.2.js"></script>
    <script src="ServiceProxy.js"></script>
</head>
<body>
    <script type="text/javascript">
        var proxy = new ServiceProxy("mihai@adfs", "p@assword",
            "https://web85.playground/webservices/CoreService201603.svc/rest/");

        function userSuccess(result) {
            if (!result) {
                alert("no result");
                return;
            }

            if (result.hasOwnProperty("d")) {
                result = result.d;
            }

            alert("Retrieved user: " + result.Id + " | " + result.Description);
        }

        $(document).ready(function () {
            proxy.getCurrentUser(userSuccess);
        });
    </script>
</body>
</html>




Labels:

Comments

Post a Comment

Popular posts from this blog

Running sp_updatestats on AWS RDS database

By
Part of the maintenance tasks that I perform on a MSSQL Content Manager database is to run stored procedure sp_updatestats . exec sp_updatestats However, that is not supported on an AWS RDS instance. The error message below indicates that only the sa  account can perform this: Msg 15247 , Level 16 , State 1 , Procedure sp_updatestats, Line 15 [Batch Start Line 0 ] User does not have permission to perform this action. Instead there are several posts that suggest using UPDATE STATISTICS instead: https://dba.stackexchange.com/questions/145982/sp-updatestats-vs-update-statistics I stumbled upon the following post from 2008 (!!!), https://social.msdn.microsoft.com/Forums/sqlserver/en-US/186e3db0-fe37-4c31-b017-8e7c24d19697/spupdatestats-fails-to-run-with-permission-error-under-dbopriveleged-user , which describes a way to wrap the call to sp_updatestats and execute it under a different user: create procedure dbo.sp_updstats with execute as 'dbo' as...
1 comment
Read more

I Have Gone Dark

By Unknown
Maybe it's the Holidays, but my mood has gone pretty dark. That is, regarding the look and feel of my computer and Tridion CME, of course. What I did was to dim the lights on the operating system, so I installed Placebo themes for Windows 7 . I went for the Ashtray look -- great name :) My VM looks now like this: But, once you change the theme on Windows, you should 'match' the theme of your applications. Some skin easily, some not. The Office suite has an in-built scheme, which can be set to Black , but it doesn't actually dim the ribbon tool bars -- it looks quite weird. Yahoo Messenger is skinnable, but you can't change the big white panels where you actually 'chat'. Skype is not skinnable at all. For Chrome, there are plenty of grey themes. Now i'm using Pro Grey . But then I got into changing the theme of websites. While very few offer skinnable interfaces (as GMail does), I had to find a way to darken the websites... Enter Stylish -- a pl...
4 comments
Read more

REL Standard Tag Library

By
The RSTL is a library of REL tags providing standard functionality such as iterating collections, conditionals, imports, assignments, XML XSLT transformations, formatting dates, etc. RSTL distributable is available on my Google Code page under  REL Standard Tag Library . Always use the latest JAR . This post describes each RSTL tag in the library explaining its functionality, attributes and providing examples. For understanding the way expressions are evaluated, please read my post about the  Expression Language used by REL Standard Tag Library . <c:choose> / <c:when> / <c:otherwise> Syntax:     <c:choose>         <c:when test="expr1">             Do something         </c:when>         <c:when test="expr2">             Do something else         </c:when...
2 comments
Read more