Directory

API Home | Table of Contents | Next API | Previous API |
Input Fields | Output Fields | Return Codes | Comments

BAUDD051

Status: In Production. Last Update: 01/24/2003

Obtain Person Loaf
The Obtain Person Loaf API is used to obtain an individual’s information from the directory. The eight (8) character public ID, UFID, is required for these lookups. This API returns data from all available fields.

Input Fields:

UFID    [CHAR 8]
University ID –– an eight–character. unique public value which serves as the primary means for distinguishing a particular individual or organization. A person’s UFID consists of the digits zero through nine. Other kinds of UFIDs include numeric digits and alphabetic characters.

SOURCE ID    [CHAR 12]
Represents the source of the update. Most often will be an item ID which is related to a module ID and then a program name.

UPDATED BY UFID    [CHAR 8]
UFID of the individual who last altered this record.

[back to top]

Output Fields:

RETURN CODE    [CHAR 9]
An indicator used to describe the status of an activity involving APIs. Defined codes include:
All ok (+00000000),
Incomplete input data (–00000100),
Control lib record not found (–00000200),
Person not found (–00000330),
Email dup rec (duplicate record) (–00000461),
Identifier not found (–00000500),
Type not found (–00000630),
Rule not found (–00000830),
Invalid application security registration (–00000997),
User does not have security (–00000998) and
Severe Error (–00000999).

DATABASE RETURN CODE    [CHAR 9]
A value provided by the directory database used to convey status of a request. For example, a value of –00000998 means this individual does not have appropriate authorization according to the system’s security settings.

FILE RETURN CODE    [CHAR 9]
A value provided to convey status of a file creation request.

ERR–PROGRAM    [CHAR 8]
Name of the program responsible for the reported error.

ERR–PARA    [CHAR 30]
Name of the paragraph most closely associated with the reported error.

ERR–TABLE    [CHAR 20]
Name of the table most closely associated with the reported error.

[back to top]

ERR–COMMENT    [CHAR 50]
Additional information intended to be beneficial in efforts to debug and troubleshoot database errors.

ERR–RSRC–DATA–NAME    [CHAR 8]
Name of the structure associated with an error.

ERR–RSRC–DATA–TEXT    [CHAR 254]
Resource Data text contains information pertaining to the content of the structure identified in ERR–RSRC–DATA–NAME.

STATUS    [CHAR 1]
Directory status:
I = Inactive,
A = Active.

PRIMARY AFFILIATION    [CHAR 1]
Primary affiliation is automatically defined as the highest AFFILIATION TYPE value with which an individual is associated. Primary Affiliation codes include:
F=Faculty,
T=Staff,
S=Student,
E=Employee,
M=Member,
A=Alumni,
L=Affiliate, and,
P=Pre–Applicant/Contact.

SSN    [CHAR 12]
Social Security number of the individual represented by this record.

[back to top]

UFID    [CHAR 8]
University ID –– an eight–character. unique public value which serves as the primary means for distinguishing a particular individual or organization. A person’s UFID consists of the digits zero through nine. Other kinds of UFIDs include numeric digits and alphabetic characters.

NAME    [CHAR 44]
The name of an individual or organization contained within the Directory.

TITLE    [CHAR 44]
An individual’s working title. Examples could include: Project Leader, Security Coordinator; Customer Service Representative, etc.

ETHNICITY    [CHAR 1]
An indicator of culture, nationality or race. Available values include:
B = Black Non–Hispanic,
W = White Non–Hispanic,
H = Hispanic,
A = Asian or Pacific Islander,
I = American Indian or Alaskan Native.

GENDER    [CHAR 1]
Female (F),
Male (M),
or Not Specified (N).

BIRTH DATE    [CHAR 10]
Date (yyyy–mm–dd) of this individual’s birth.

[back to top]

DOMESTIC STATUS    [CHAR 1]
This individual is:
M - Married,
S = Single,
D = Divorced,
L = Separated,
W = Widowed, or
N = Not Specified.

COUNTRY OF CITIZENSHIP    [CHAR 2]
A two character country code representing this individual’s primary national citizenship.

BIRTH CITY    [CHAR 30]
Name of the city where this individual was born.

BIRTH STATE    [CHAR 2]
Coded representation of the state (e.g., FL for Florida) where this individual was born in the United States, otherwise this field is blank.

BIRTH COUNTRY    [CHAR 2]
Coded representation of the country (e.g., US for United States) where this individual was born.

VETERAN STATUS    [CHAR 2]
Indicates whether this individual satisfactorily completed service in the United States armed forces. Codes yet to be determined.

[back to top]

HANDICAP FLAG    [CHAR 1]
Indicates this individual has a physical disability but is not permanently disabled:
Y = This person has a Handicap,
N = No Handicap,
Z = Not Specified.

DISABLED    [CHAR 1]
Indicates this individual has a permanent physical disability:
Y = Disabled Vet,
N = Not a Disabled Vet,
Z = Not Specified (values based on current UF Payroll/Personnel system).

HOME PHONE PUBLISH    [CHAR 1]
A code indicating whether this home phone number is to be publicly displayed:
Y = Publish this record in Public Media,
N = see relationship table for restrictions.

HOME PHONE COUNTRY CODE    [CHAR 5]
Country code of the fully qualified phone number of the individual’s residence. Associated with international (i.e., non-US) locations.

HOME PHONE PREFIX    [CHAR 2]
Some countries have a special prefix that must be dialed before the country code, area code and phone number. All others will be blank.

HOME PHONE AREA CODE    [CHAR 5]
Area code of the fully qualified phone number at the individual’s residence.

[back to top]

HOME PHONE NUMBER    [CHAR 10]
Phone number of the individual’s residence.

HOME PHONE INVALID    [CHAR 1]
Y = This Home Phone Number has been marked invalid;
N = Not Invalid.

UF PHONE PUBLISH    [CHAR 1]
A code indicating whether this UF phone number is to be publicly displayed:
Y = Publish this record in Public Media,
N = see relationship table for restrictions.

UF PHONE COUNTRY CODE    [CHAR 5]
Country code of the fully qualified phone number of the individual’s University work location. Associated with international non-US locations.

UF PHONE PREFIX    [CHAR 2]
Some countries have a special prefix that must be dialed before the country code, area code and phone number. All others will be blank.

UF PHONE AREA CODE    [CHAR 5]
Area code of the fully qualified phone number at the individual’s University work location.

[back to top]

UF PHONE NUMBER    [CHAR 10]
The fully qualified phone number of the individual’s University work location.

UF PHONE EXTENSION    [CHAR 6]
If applicable, an extension number of the fully qualified phone number at the individual’s University work location.

UF PHONE INVALID    [CHAR 1]
Indicates whether this UF phone number is incorrect: Y = This UF phone number has been marked invalid,
N = Not Invalid.

HOME ADDRESS PUBLISH    [CHAR 1]
Determines whether this address may be publicly displayed:
Y = Publish in public media,
N = See relationship tables for restrictions.

HOME ADDRESS LINE1    [CHAR 44]
Delivery address of the location where this individual resides - optional line 1, used as necessary.

HOME ADDRESS LINE2    [CHAR 44]
Delivery address of the location where this individual resides - optional line 2, used as necessary.

[back to top]

HOME ADDRESS DELIVERY    [CHAR 44]
Delivery address where this individual resides. Also known as Address Line 3, this is the only required address line.

HOME ADDRESS CITY    [CHAR 30]
Name of the city where this individual resides.

HOME ADDRESS STATE    [CHAR 2]
Coded representation of the state (e.g., FL = Florida) where this individual resides.

HOME ADDRESS ZIP    [CHAR 12]
U.S. Postal Service ZIP+4 code for the location where this individual resides. Format: 5 Digit Zip - 4 Digit Zip Extension or International Code.

HOME ADDRESS COUNTRY    [CHAR 2]
Coded representation of the country (e.g., US for United States) where this individual resides.

HOME ADDRESS INVALID    [CHAR 1]
The address recorded as this individual’s Home Address is incorrect (Y). "N" indicates the address is valid.

[back to top]

UF ADDRESS PUBLISH    [CHAR 1]
Determines whether this address is publicly displayed:
Y = Publish in public media,
N = See relationship tables for restrictions.

UF ADDRESS LINE1    [CHAR 44]
Delivery address of the location where this individual works for the University of Florida - optional line 2, used as necessary.

UF ADDRESS LINE2    [CHAR 44]
Delivery address of the location where this individual works for the University of Florida - optional line 2, used as necessary.

UF ADDRESS DELIVERY    [CHAR 44]
Delivery address where this individual works for the University of Florida. Also known as Address Line 3, this is the only required address line.

UF ADDRESS CITY    [CHAR 30]
Name of the city where this individual works for the University of Florida.

UF ADDRESS STATE    [CHAR 2]
Coded representation of the state (e.g., FL = Florida) where this individual works for the University of Florida.

[back to top]

UF ADDRESS ZIP    [CHAR 12]
U.S. Postal Service ZIP+4 code for the location where this individual works for the University of Florida. Format: 5 Digit Zip - 4 Digit Zip Extension or International Code.

UF ADDRESS COUNTRY    [CHAR 2]
Coded representation of the country (e.g., US for United States) where this individual works for the University of Florida.

UF ADDRESS INVALID    [CHAR 1]
The address recorded for this individual’s UF location is incorrect (Y). "N" indicates the address is valid.

EMAIL PUBLISH    [CHAR 1]
This e-mail address may be publicly displayed if this field contains a "Y" rather than an "N."

EMAIL INVALID    [CHAR 1]
A "Y" in this field indicates the e-mail address does not work. May be caused by a variety of situations. An "N" indicates the address is valid.

PREFERRED LANGUAGE    [CHAR 30]
A part of the eduPerson specification, this value indicates the individual’s preferred language (e.g., Spanish, English, French, etc.)

[back to top]

EMERGENCY SECURED    [CHAR 1]
An indication as to whether this record has been locked in response to an urgent situation:
"Y" = emergency security is required for this individual (extension table contains reasons) or
"N" meaning, no special security settings are in effect.

PROTECTION FLAG    [CHAR 1]
Y = All addresses, phone numbers, e-mail addresses, etc. for this individual are to be protected;
N = Individual protection flags must be examined to determine status.

PUBLISH FLAG    [CHAR 1]
Y = All addresses, phone numbers, e-mail addresses, etc. for this individual may be published in public media;
N = Individual publish flags must be examined to determine status. Relationship table describes restrictions.

DECEASED    [CHAR 1]
This field is coded with a "Y" if the individual is no longer living. "N" indicates they are still alive.

SOURCE ID    [CHAR 12]
Represents the source of the update. Most often will be an item ID which is related to a module ID and then a program name.

UPDATED BY UFID    [CHAR 8]
UFID of the individual who last altered this record.

[back to top]

LAST UPDATE TIMESTAMP    [CHAR 26]
The date and time (yyyy/mm/dd hh:mm:ss:mmmmmm) when this record was last altered.

EMAIL ADDRESS    [CHAR 254]
UF Business e-mail address. An e-mail address identifies an electronic post office box where messages can be received. Usually of the form: name@domain name such as GatorJoe@ufl.edu.

Return Codes:

Return Code
+ 00000000  All ok,
- 00000100   Incomplete input data,
- 00000330   Person not found,
- 00000500   Identifier not found,
- 00000997   Invalid application security registration,
- 00000998   User does not have security,
- 00000999   Severe Error.

Comments:

None.

[back to top]

Accounts Receivable and Billing

Asset Management

Benefits

Directory

Effort Tracking

Enterprise Reporting

GatorLink Password Management

General Ledger and Budgets

Grants

Hiring and Job Actions

Payroll

Portal

Purchasing and Payables

Security

Student

Time and Labor

Travel and Expense

UFID

Vendors

ViewDirect