<< Up | < Previous Page | Next Page >

API Tips

Vocabulary Differences Between the API and the UI

During the development of @task a few data types have gradually changed from first conception. This includes the way they were named in the API and how they appear in the UI. To alleviate any future confusion while working with the API the following data types are known as one thing in the UI and as a another in the APIs, respectively:

    1. A Library Task in the UI is a MasterTask in the API.

    2. An Issue in the UI is an OpTask in the API.

Login, Access Levels and the JNDI

The first call made in an application should be the login call. The reason is that a login will return the sessionID which will be crucial to making other calls in the application.

Be sensitive to the access level of the logged in user because it will be enforced through out the session. As described before, the access level of the user determines what data objects they can view, edit, add and delete. Thus, when designing the application consider how the access level could affect functionality.

Lastly, when you connect to the server using SOAP or EJB, there is no need to reconnect before each call. Instead, cache the API handle and use it until logout. For EJB, this is handled inside of APISupport (lines 48 through 54). For SOAP, an example of how to do this is done in the SDK SOAPExample (lines 55 and 56).