UF DIRECTORY APIs
Information presented in this section represents work in progress which is subject to modification as needed. The project team’s intention is to offer University application developers an early opportunity to gain familiarity with the structure and design of the UF Directory. As development progresses, contents of these references will be updated accordingly.
A number of DB2 stored procedures (APIs) are located in the test region. Others, designated as being “In Development,” will be placed in the test region for evaluation as soon as they are ready. Campus developers are invited to begin working with the APIs.
Accessing the University of Florida’s Directory using internally developed software involves two important prerequisites. Individuals must have authority to access a particular API and the application must be pre–registered. Security Access values are involved in granting access to these resources.
Comments and suggestions regarding this documentation may be sent to the myUFL Suggestion Box, located in the portal by clicking on the “Suggestions” link in the top right–hand corner.
Documentation
API Table of Contents: Stored Procedure specification details
Field locations by API (PDF; last updated 04-01-2005).
API Security Access settings.
UF Directory Category and Type Codes (PDF; last updated 01–13–2002).
API Return Codes.
API Javadoc: Comprehensive documentation of UF Directory Java classes, objects and methods. Last update: 01–11–2003.
Obtaining Authority to call an API by Registering Applications.
Transaction Type Code values TRANSACTION TYPE CODE flags are used to prepare the Directory for work you, or your application, intend to perform.
JAVA Jar files
These JAR files need to be placed on the appropriate classpath.
The test JAR file (remoteClient_test.jar) refers to NERDC’s test Websphere server. When this file is used to call the Directory’s JAVA API’s, it only affects test region DB2 tables. This JAR is only intended for testing activities.
The production JAR file (remoteClient_production.jar) uses NERDC–s production Websphere server. Use of this file with the Directory–s JAVA APIs will update Directory data in production region DB2 tables. As with all programmatic access of the UF Directory, pre–authorization and activity logging will be performed.
Be very careful to download and use the appropriate file in the appropriate situation.
Production == remoteClient_production.jar file (07–08–2005; 47.2KB).
Test == remoteClient_test.jar file (06–29–2005; 47.2KB).
Programming Information
Four different methods for translating identifiers are described on Identifier Translation options: SSN/UFID/UUID.
Passing WHERE Clauses to the DBMS using SAS.
Calling an API using COBOL: An example.
Calling an API using ASP/VBScript/Visual Basic: An example.
Calling an API using JAVA: An Introduction and example.
Using JAVA to Call the Identifier Translate API (BAUDD250) using the remoteClient_test.jar file (06–29–2005; 47.2KB).
