Package gp_person_identity

Description

The PersonIdentity Service API is provided to allow external systems to determine the unique identifier (ID number) for a person in the SCT Banner system.  The service allows an external system to query the SCT administrative system with known details about a person in order to obtain the unique identifier and corresponding person details for one or multiple matching records.

This Service can identify a person in Banner in two ways:

It can accept an inactive Banner ID number or another recognized identifier and return the current Banner ID number.  Other accepted identifiers include the GOBSRID_SOURCED_ID used for eLearning integrations (the IMSID), and the Luminis log-on identifier (LogonID).

It can accept a set of criteria describing a person, and apply a set of Common Matching rules to identify persons in the SCT Banner database who match the submitted criteria.

Operations

The GetPersonIdentity message is intended to be used by an external system to pass identifying information about a person to the SCT administrative system.  This information can either be an accepted identifier, or elements established in a set of Common Matching rules.  The information will be used to identity one or more persons who match the criteria.  This message also allows the requestor to specify a limit to the number of possible matches that are returned.  If no MaximumRecords value is specified, no more than 20 possible matches will be returned.

The ShowPersonIdentity response message will return one PersonIdentity element if a unique match is found, multiple PersonIdentity elements if several persons are found to match the criteria, or an empty PersonIdentity element if no person is found to match the criteria.  Each match or potential match will contain a matchType attribute specifying if it is a Match or a Possible Match.  If the Service can determine the actual address and phone number that resulted in a match or potential for a person, then that information will be returned as well.

Common Matching Source Code (CMSC Code)

In order to perform the Common Matching process, this API must identify which CMSC code will be used. The CMSC code defines the rules used to match the input data with existing Banner data.
The API first looks for a CMSC code by checking the Common Matching User Setup Table (GOBCMUS) for a row for the current user. This will allow separate integrations to have separate CMSC codes if they are configured to use proxy logins.
If there is no GOBCMSC record, then the API checks for a GTVSDAX row where internal_code  = 'CONNECTION' and internal_group = 'CM_SOURCE_CODE'.
If no GTVSDAX record is found, or the CMSC code defined there is invalid, the Common Matching process will raise an exception.