JobTracker API

In this article

Background (non-technical)

The JobTracker application programming interface (API) allows programmers to write custom software to interact with your JobTracker data. 

The API allows add/change/delete access to accounts, jobs, job activities, job forms, material allocations, purchase orders and files.

Technical Details

The JobTrackerAPI .NET object model is a wrapper around the XML interface, greatly reducing the amount of code needed to interact with JobTracker. To use the JobTracker API in a .NET language, call methods on the JobTrackerAPI .NET object model.

To use the SDK on your machine, simply download the latest .zip file and extract the contents to your local file system.

To use the object model from your .NET project, you first need to create a reference to the .dll in your project properties.

Moraware User Rights

In order to use the API, a user must either be an Admin or have the API right checked on a role: 

Download latest SDK version

http://www.moraware.com/downloads/JTAPISDK4.4.zip

The JobTracker API .NET software development kit (SDK) consists of:

  1. .NET object model (JobTrackerAPI4.dll)
  2. API User Guide, a help file which provides a reference to the properties and methods on the object model

In addition, here are basic samples:

There are more detailed code snippets and samples on GitHub.


Connecting to the JobTracker API

To connect to a JobTracker instance, use the URL of the JobTracker server along with a username and password.

The URL for the API ends with "api.aspx", while the regular JobTracker application web page ends in "d.asp" for the desktop web page or "m.asp" for the mobile web page.

Example #1: for Moraware hosted, use the URL, for example:  https://demo.moraware.net/api.aspx (NOTE: it used to be necessary to repeat the DB name like this: demo.moraware.net/demo/api.aspx - that's no longer necessary, but it will still work).

Example #2: for a self-hosted JobTracker server (not hosted by Moraware):  http://[myServerName]/JobTracker/api.aspx

The UserName and Password can be any JobTracker user who has security permissions to execute API requests. (i.e. The user must be an Administrator or be associated with a Role that has the Execute API Requests permission set.)

.NET Object Model

For the .NET object model, you interact with the server through the Connection object. The first step is to create a Connection object and connect to the server using the URL/UserName/Password. Then you can call methods on the Connection object to interact with the server.

To log out of the session you can call the Disconnect method. If you don't call this method, the session will eventually time out based on the "Session Timeout" setting on the System Settings page in JobTracker.

VB.NET Example:

C# Example:

Still need help? Contact Us Contact Us