This page describes how to call a TotalAgility web service from jquery using JSON.

The JSON data passed to each TotalAgility SDK API is the same structure as specified in the SDK documentation, the only difference is the data is specified in JSON format. The examples given below should provide guidance on how to formulate the JSON data for any TotalAgility SDK API by referencing the input class definitions in the SDK documentation.

Calling UserService

Method: LogOnWithPassword2()

Create a html file using the below code
Host the file in web server using the path where the HTML file resides
Browse the html file and it will invoke LogOnWithPassword2 method in UserService

 <html>
 <body>
     <header>
         <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
     </header>
     <div id="Request"></div>
     <div id="Result"></div>
     <script>
         var LogonWithPasswordStruct = function () {
             var struct = {
                 "userIdentityWithPassword": {
                     "LogOnProtocol": "",
                     "UnconditionalLogOn": false,
                     "UserId": "",
                     "Password": ""
                 }
             };
             return struct;
         };
 
 
         var logonJSON = new LogonWithPasswordStruct();
         logonJSON.userIdentityWithPassword.LogOnProtocol = "7";
         logonJSON.userIdentityWithPassword.UnconditionalLogOn = true;
         logonJSON.userIdentityWithPassword.UserId = "User1";
         logonJSON.userIdentityWithPassword.Password = "xxxxxxxxxx";
 
         $("#Request").html("<BR/><B>Request:</B><BR/>" + JSON.stringify(logonJSON));
 
         // Calling method LogOnWithPassword2
         $.ajax({
             type: "POST",
             async: "false",
             url: "http://localhost/TotalAgility/Services/Sdk/UserService.svc/json/LogOnWithPassword2",
             data: JSON.stringify(logonJSON),
             contentType: "application/json; charset=utf-8",
             crossDomain: true,
             dataType: "json",
             success: function (result) {
                 $("#Result").html("<BR/><B>Response: </B><BR/>" + JSON.stringify(result.d));
             },
             error: function (jqXHR, textStatus, errorThrown) {
                 alert("***Error***\n");
             }
         });
 
     </script>
 </body>
 </html>

Method: Logoff()

Create a html file using the below code
Host the file in web server using the path where the HTML file resides
Browse the html file and it will invoke Logoff method in UserService

 <html>
 <body>
     <header>
         <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
     </header>
     <div id="Request"></div>
     <div id="Result"></div>
     <script>
         var LogOffStruct = function () {
             var struct = {
                 "sessionId": null
             };
             return struct;
         };
 
 
         var logOffJSON = new LogOffStruct();
         logOffJSON.sessionId = "B1B44E3109E6447BB4EEBA578937402B";
 
         $("#Request").html("<BR/><B>Request:</B><BR/>" + JSON.stringify(logOffJSON));
 
         // Calling method Logoff
         $.ajax({
             type: "POST",
             async: "false",
             url: "http://localhost/TotalAgility/Services/Sdk/UserService.svc/json/LogOff",
             data: JSON.stringify(logOffJSON),
             contentType: "application/json; charset=utf-8",
             crossDomain: true,
             dataType: "json",
             success: function (result) {
                 $("#Result").html("<BR/><B>Response: </B><BR/>" + JSON.stringify(result.d));
             },
             error: function (jqXHR, textStatus, errorThrown) {
                 alert("***Error***\n");
             }
         });
 
     </script>
 </body>
 </html>

Calling JobService

Method: CreateJob()

Create a html file using the below code
Host the file in web server using the path where the HTML file resides
Browse the html file and it will invoke CreateJob method in JobService

 <html>
 <body>
     <header>
         <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
     </header>
     <div id="Request"></div>
     <div id="Result"></div>
     <script>
         var InputVariableStruct = function () {
             var struct = {
                 "DisplayName": "",
                 "Id": "",
                 "Value": "",
                 "VariableType": {
                     "FormattedAsText": null,
                     "Value": ""
                 }
             };
 
             return struct;
         };
 
         var CreateJobStruct = function () {
             var struct = {
                 "jobInitialization": {
                     "InputVariables": [],
                     "StartDate": null,
                 },
                 "processIdentity": {
                     "Id": "",
                     "Name": "",
                     "Version": 0
                 },
                 "sessionId": ""
             };
 
             return struct;
         };
 
 
         var createJobJSON = new CreateJobStruct();
 
         var varFirstName = new InputVariableStruct();
         varFirstName.DisplayName = "FirstName";
         varFirstName.Id = "FIRSTNAME";
         varFirstName.Value = "Naresh"; // string
         createJobJSON.jobInitialization.InputVariables.push(varFirstName);
 
         var varLastName = new InputVariableStruct();
         varLastName.DisplayName = "LastName";
         varLastName.Id = "LASTNAME";
         varLastName.Value = "Kokkula"; // String
         createJobJSON.jobInitialization.InputVariables.push(varLastName);
 
         var varLoanApplied = new InputVariableStruct();
         varLoanApplied.DisplayName = "LoanApplied";
         varLoanApplied.Id = "LOANAPPLIED";
         varLoanApplied.Value = "2016-01-05T10:19:00.000Z"; //Date
         createJobJSON.jobInitialization.InputVariables.push(varLoanApplied);
 
         var varAmountRequired = new InputVariableStruct();
         varAmountRequired.DisplayName = "AmountRequired";
         varAmountRequired.Id = "AMOUNTREQUIRED";
         varAmountRequired.Value = 25000.00; // Decimal
 
         createJobJSON.jobInitialization.InputVariables.push(varAmountRequired);
         createJobJSON.processIdentity.Id = "F296FF6FC8794410BAA627093A8A74D3";
         createJobJSON.processIdentity.Name = "BP";
         createJobJSON.processIdentity.Version = 0;
         createJobJSON.sessionId = "3F05A05532EA469D8F9FC150A61D5CBB";
 
         $("#Request").html("<BR/><B>Request:</B><BR/>" + JSON.stringify(createJobJSON));
 
         // Calling method CreateJob
         $.ajax({
             type: "POST",
             async: "false",
             url: "http://localhost/TotalAgility/Services/Sdk/JobService.svc/json/CreateJob",
             data: JSON.stringify(createJobJSON),
             contentType: "application/json; charset=utf-8",
             crossDomain: true,
             dataType: "json",
             success: function (result) {
                 $("#Result").html("<BR/><B>Response: </B><BR/>" + JSON.stringify(result.d));
             },
             error: function (jqXHR, textStatus, errorThrown) {
                 alert("***Error***\n");
             }
         });
 
     </script>
 </body>
 </html>

Method: CreateJobWithDocumentsAndProgress2()

Create a html file using the below code
Host the file in web server using the path where the HTML file resides
Browse the html file and it will invoke CreateJobWithDocumentsAndProgress2 method in JobService

 <html>
 <body>
     <header>
         <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
     </header>
     <div id="Request"></div>
     <div id="Result"></div>
 
     <script>
 
         var CreateJobWithDocumentsAndProgress2Struct = function () {
             var struct = {
                 "jobWithDocsInitialization": {
                     "InputVariables": null,
                     "RuntimeDocumentCollection": [],
                     "StartDate": null 
                 },
                 "processIdentity": {
                     "Id": "", // required
                     "Name": "", // required
                     "Version": 0.0 // required
                 },
                 "variablesToReturn": [],
                 "sessionId": "" // required
             };
             return struct
         };
 
         var RuntimeDocument = function () {
             var rtd = {
                 "Base64Data": null, //alternate to passing 'Data'
                 "Data": null, //required byte array, JS Array i.e. [73,73,14 ...] (not Unit8)
                 "DeleteDocument": false,
                 "DocumentGroup": null,
                 "DocumentTypeId": null,
                 "DocumentTypeName": null,
                 "FieldsToReturn": [], //RunTimefieldIdentityCollection
                 "FilePath": null,   //alternate to passing 'Data' (serverSide Path)
                 "FolderId": null,
                 "FolderTypeId": null,
                 "MimeType": null, //required
                 "PageDataList": [], // PageDataCollection
                 "PageImages": [],   // PageImageDataCollection
                 "ReturnAllFields": true,
                 "RuntimeFields": [] // RuntimeFieldcollection
             };
             return rtd
         };
 
         var VariableIdentity = function () {
             var vId = {
                 "Id": null, //required
                 "Name": null
             };
             return vId;
         }
 
         var jobJSON = new CreateJobWithDocumentsAndProgress2Struct();
         jobJSON.sessionId = "3F05A05532EA469D8F9FC150A61D5CBB";
         jobJSON.processIdentity.Id = "DB65BE80231045779AED6D802C2CAD6C";
         jobJSON.processIdentity.Name = "Bank - Standard Capture";
 
         var rVar = new VariableIdentity();
         rVar.Id = "LOT_NUMERISATION";
         jobJSON.variablesToReturn.push(rVar);
 
         var rtd1 = new RuntimeDocument();
 
         rtd1.Base64Data = "<<base64 data would go here>>";
         rtd1.MimeType = "image/tiff";
         rtd1.ReturnAllFields = true;
         jobJSON.jobWithDocsInitialization.RuntimeDocumentCollection.push(rtd1);
 
         var rtd2 = new RuntimeDocument();
         rtd2.Base64Data = "<<base64 data would go here>>";
         rtd2.MimeType = "image/tiff";
         rtd2.ReturnAllFields = true;
         jobJSON.jobWithDocsInitialization.RuntimeDocumentCollection.push(rtd2);
 
         $("#Request").html("<BR/><B>Request:</B><BR/>" + JSON.stringify(jobJSON));
 
         // Call CreateJobWithDocumentsAndProgress2 method
         $.ajax({
             type: "POST",
             async: "false",
             url: "http://localhost/TotalAgility/Services/Sdk/JobService.svc/json/CreateJobWithDocumentsAndProgress2",
             data: JSON.stringify(jobJSON),
             contentType: "application/json; charset=utf-8",
             crossDomain: true,
             dataType: "json",
             success: function (result) {
                 $("#Result").html("<BR/><B>Response: </B><BR/>" + JSON.stringify(result.d));
             },
             error: function (jqXHR, textStatus, errorThrown) {
                 alert("***Error***\n");
             }
         });
 
     </script>
 </body>
 </html>

Calling ActivityService

Method: GetWorkqueue2()

Create a html file using the below code
Host the file in web server using the path where the HTML file resides
Browse the html file and it will invoke GetWorkqueue2 method in ActivityService

 <html>
 <body>
     <header>
         <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
     </header>
     <div id="Request"></div>
     <div id="Result"></div>
     <script>
 
         var GetWorkQueueStruct = function () {
             var struct = {
                 "jobActivityFilter": {
                     "NodeId": 0,
                     "LoanResource": {
                         "Id": null,
                         "Name": null,
                         "ResourceType": 0
                     },
                     "EndDueDateTime": null,
                     "StatusFilter": 0,
                     "JobIdsFilter": null,
                     "MaxActivitiesCount": 100,
                     "StartDueDateTime": null,
                     "StartPendingTime": null,
                     "ActivityTypeFilters": 0,
                     "WorkQueueDefinition": {
                         "Id": "",
                         "Name": ""
                     },
 
                     "MetaDataFilter": {
                         "Filter": "",
                         "FilterOperator": 0
                     },
                     "ReturnJobIds": false,
                     "UsePrioritySetting": 0,
                     "Priority": -1,
                     "ActivityName":"",
                     "Resource": {
                         "Id": null,
                         "Name": null,
                         "ResourceType": 0
                     },
 
                     "UseCombinedWorkQueue": false,
                     "UseJobSlaStatus": false,
                     "JobSlaStatus": 0,
                     "JobState": null,
                     "PageDirection":0,
                     "UseActivitySlaStatus": false,
                     "ActivitySlaStatus": 0,
                     "CaseActivitiesOnly": false,
                     "Process": {
                         "Id": "",
                         "Name": "",
                         "Version": 0
                     },
                     "Case": {
                         "CaseId": "",
                         "CaseReference": "",
                         "Name": null
                     },
 
                     "Category": {
                         "Id": null,
                         "Name": null,
                     },
                     "ScoreFilter": {
                         "Filter": "",
                         "ScoreOperator": 0
                     },
                     "PriorityType": 0,
                     "DueDateType": 0,
                 },
                 "sessionId": ""
             };
             return struct;
         };
 
 
         var getWorkQueueJSON = new GetWorkQueueStruct();
         getWorkQueueJSON.sessionId = "FA4CAE506A5F49FF90C832BCA311C439";
         getWorkQueueJSON.jobActivityFilter.MaxActivitiesCount = 100;
         getWorkQueueJSON.jobActivityFilter.UseCombinedWorkQueue = true;
 
         $("#Request").html("<BR/><B>Request:</B><BR/>" + JSON.stringify(getWorkQueueJSON));
 
         // Call GetWorkQueue2 method
         $.ajax({
             type: "POST",
             async: "false",
             url: "http://localhost/TotalAgility/Services/Sdk/ActivityService.svc/json/GetWorkQueue2",
             data: JSON.stringify(getWorkQueueJSON),
             contentType: "application/json; charset=utf-8",
             crossDomain: true,
             dataType: "json",
             success: function (result) {
                 $("#Result").html("<BR/><B>Response: </B><BR/>" + JSON.stringify(result.d));
             },
             error: function (jqXHR, textStatus, errorThrown) {
                 alert("***Error***\n");
             }
         });
 
     </script>
 </body>
 </html>

Method: TakeActivity()

Create a html file using the below code
Host the file in web server using the path where the HTML file resides
Browse the html file and it will invoke TakeActivity method in ActivityService

 <html>
 <body>
     <header>
         <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
     </header>
     <div id="Request"></div>
     <div id="Result"></div>
     <script>
 
         var TakeActivityStruct = function () {
             var struct = {
                 "sessionId": "",
                 "jobActivityIdentity":
                     {
                         "NodeId": 0,
                         "EmbeddedProcessCount": 0,
                         "JobId": "",
                         "SubNodeId": 0,
                         "Automatic": false,
                         "ActivityName": null
                     }
             };
             return struct;
         };
 
 
         var takeActivityJSON = new TakeActivityStruct();
         takeActivityJSON.sessionId = "FA4CAE506A5F49FF90C832BCA311C439";
         takeActivityJSON.jobActivityIdentity.NodeId = 1;
         takeActivityJSON.jobActivityIdentity.EmbeddedProcessCount = 0;
         takeActivityJSON.jobActivityIdentity.JobId = "FD871D79AA544328B7EB99A8E42727B9";
 
         $("#Request").html("<BR/><B>Request:</B><BR/>" + JSON.stringify(takeActivityJSON));
 
         // Call TakeActivity method
         $.ajax({
             type: "POST",
             async: "false",
             url: "http://localhost/TotalAgility/Services/Sdk/ActivityService.svc/json/TakeActivity",
             data: JSON.stringify(takeActivityJSON),
             contentType: "application/json; charset=utf-8",
             crossDomain: true,
             dataType: "json",
             success: function (result) {
                 $("#Result").html("<BR/><B>Response: </B><BR/>" + JSON.stringify(result.d));
             },
             error: function (jqXHR, textStatus, errorThrown) {
                 alert("***Error***\n");
             }
         });
 
     </script>
 </body>
 </html>

Method: CompleteActivity()

Create a html file using the below code
Host the file in web server using the path where the HTML file resides
Browse the html file and it will invoke CompleteActivity method in ActivityService

 <html>
 <body>
     <header>
         <script src="http://code.jquery.com/jquery-1.7.1.min.js"></script>
     </header>
     <div id="Request"></div>
     <div id="Result"></div>
     <script>
 
         var CompleteActivityStruct = function () {
             var struct = {
                 "jobActivityIdentity":
                     {
                         "NodeId": 0,
                         "EmbeddedProcessCount": 0,
                         "JobId": "",
                         "SubNodeId": 0,
                         "Automatic": false,
                         "ActivityName": null
                     },
                 "jobActivityOutput": {
                     "OutputVariables": [],
                     "SetTime": null,
                     "Cost": null
                 }
             };
             return struct;
         };
 
 
         var completeActivityJSON = new CompleteActivityStruct();
         completeActivityJSON.sessionId = "FA4CAE506A5F49FF90C832BCA311C439";
         completeActivityJSON.jobActivityIdentity.NodeId = 1;
         completeActivityJSON.jobActivityIdentity.EmbeddedProcessCount = 0;
         completeActivityJSON.jobActivityIdentity.JobId = "FD871D79AA544328B7EB99A8E42727B9";
 
         $("#Request").html("<BR/><B>Request:</B><BR/>" + JSON.stringify(completeActivityJSON));
 
         // Call TakeActivity method
         $.ajax({
             type: "POST",
             async: "false",
             url: "http://localhost/TotalAgility/Services/Sdk/ActivityService.svc/json/CompleteActivity",
             data: JSON.stringify(completeActivityJSON),
             contentType: "application/json; charset=utf-8",
             crossDomain: true,
             dataType: "json",
             success: function (result) {
                 $("#Result").html("<BR/><B>Response: </B><BR/>" + JSON.stringify(result.d));
             },
             error: function (jqXHR, textStatus, errorThrown) {
                 alert("***Error***\n");
             }
         });
 
     </script>
 </body>
 </html>