Transaction Type Code Values
December 6, 2002
TRANSACTION TYPE CODE flags are used to prepare the Identity Registry for work you, or your application, intend to perform. Principle functions using this flag include APIs designed to maintain records, retrieve (i.e., obtain) records or browse through available records. This design increases the flexibility of the UF Identity Registry with the intention of maximizing it’s value to units supporting the University’s diverse assortment of needs.
Different sets of input codes are valid for the TRANSACTION TYPE CODE field in different APIs. The current classification includes: (1) all MAINTAIN APIs and the ASSOCIATE PHONE API; (2) OBTAIN APIs for record types with a Primary Flag; (3) OBTAIN APIs for record types without a Primary Flag; (4) BROWSE APIs for record types with a PrimaryFlag; and, (5) BROWSE APIs for record types without a Primary Flag;
MAINTAIN APIs
Maintaining an Identity Registry record consists of adding a new record (‘A’), modifying data already contained in a record (‘M’), or erasing (‘E’) the record.
- TRANSACTION TYPE CODE (MAINTAIN APIs) (input only)Definition: Input value indicating the particular type of action being applied to this record (i.e., for Maintain APIs: A – Add; M – Modify; or, E – Erase).BAUDD060 Maintain Person
BAUDD100 Maintain Organization
BAUDD140 Maintain Address
BAUDD180 Maintain Phone
BAUDD220 Maintain Email
BAUDD260 Maintain Identifier
BAUDD300 Maintain Computer Access Identifier
BAUDD340 Maintain Digital Credential
BAUDD380 Maintain Name
BAUDD500 Maintain Relationship
BAUDD740 Maintain Extension
BAUDD741 Maintain Extension VISA
BAUDD930 Associate Phone
OBTAIN APIs
Specifying an ‘O’ which means to “obtain using occurrence number” allows a record to be retrieved by using the OCCURRENCE NUMBER and primary key represented by this API (e.g., Identifier for BAUDD251 or e-mail address for BAUDD210, etc.). Presumes knowledge of the sequence number for a particular entry which would have to be determined before submitting this transaction.
Using an ‘R’ for “obtain most recent updated active” indicates that a UFID and Identifier Type are being submitted to retrieve the most recently updated active record of this type. If more than one active record of the same type exists for this individual, only the most recently updated one will be returned.
As an example, if the current Social Security number value is needed (remember — pre-authorization is required for SSN access), use BAUDD251 (Obtain Identifier) by submitting the individual’s UFID with a desired Identifier Type value of “00000018” representing their SSN and an ‘R’ Transaction Type Code value.
OBTAIN APIs for Address, Phone, Name and Email, use a PRIMARY FLAG to signify that a particular record is “first among many” when an unlimited number of entries of a given type may exist for an individual. Use the ‘P’ value to retrieve the primary address, phone, name or email entry. These APIs do not support the ‘R’ Transaction Type Code. As an example of the reasoning for this situation, consider the fact that there is little to be gained by asking for the most recently added e-mail address. It would however, be reasonable to seek either the primary address or all active ones.
None of the other OBTAIN APIs, including Computer Access, Digital Credential, Relationship, Extension, and Identifier, support a PRIMARY FLAG because all active entries are equally valued. Although the ‘P’ code cannot be used with these APIs, they do support use of the ‘R’ code which provides access to the most recently updated active record of that type.
TRANSACTION TYPE CODE (OBTAIN APIs with Primary records)
Definition: Input value indicating the particular type of action being applied to this record (i.e., for Obtain APIs: O – obtain using occurrence number; P – obtain using primary).
BAUDD130 Obtain Address
BAUDD170 Obtain Phone
BAUDD210 Obtain Email
BAUDD370 Obtain Name
TRANSACTION TYPE CODE (OBTAIN APIs without Primary records)
Definition: Input value indicating the particular type of action being applied to this record (i.e., for Obtain APIs: O – obtain using occurrence number; R – obtain most recently updated active).
BAUDD251 Obtain Identifier BAUDD290 Obtain Computer Access Identifier BAUDD330 Obtain Digital Credential BAUDD490 Obtain Relationship BAUDD730 Obtain Extension
BROWSE APIs
Specifying an ‘O’ to “obtain all records” will retrieve all records of this API’s subject (e.g., Relationships, Identifier, Phone, etc.) belonging to this individual. No prior knowledge concerning the number or occurrence number is required to use this transaction code.
Use the ‘P’ value to retrieve the primary address, phone, name or emailentry for an individual. Other BROWSE APIs do not support this function. A Browse request for all Primary Address records will return the primary address for their office and another for their home, assuming both exist for that individual.
All active records of the API’s subject area will be retrieved by specifying ‘A’ as the TRANSACTION TYPE CODE value.
TRANSACTION TYPE CODE (BROWSE APIs with Primary Keys)
Definition: Input value indicating the particular type of action being applied to this record (i.e., for Browse APIs: O – obtain all records; P – obtain all primary records; or, A – obtain all active records).
BAUDD160 Browse Address BAUDD200 Browse Phone BAUDD240 Browse Email BAUDD400 Browse Name
TRANSACTION TYPE CODE (BROWSE APIs without Primary Keys)
Definition: Input value indicating the particular type of action being applied to this record (i.e., for Browse APIs: O – obtain all records; A – obtain all active records).
BAUDD280 Browse Identifier
BAUDD320 Browse Computer Access Identifier
BAUDD360 Browse Digital Credential
BAUDD520 Browse Relationships