Institution Defined Fields
API’s available for use with Institution Defined Fields
There are three API’s that handle the search/modification/inquiry of the Institution Defined Fields.
InstDefFldInq Inquire on the value of a single institution defined field that has been defined.
InstDefFldMod Modify the value of a single institution defined field.
InstDefFldSrch Search for institution defined fields
Implementation of the Institution Defined Field API’s
There are currently six types of Institution Defined Fields available. As this list is likely to expand, a SvcDictSrch passing in InstDefFldSrch will list the Canonical Values that would be available under the <AppCode> Element path. A sample of this SvcDictSrch request may be found here.
The current six <AppCode>’s are listed below.
| AppCode | AppCode Description | Element/s used in Search |
|---|---|---|
| CF | Customer | CustId |
| CI | Collateral Tracking Items | InstDefKey |
| CO | Collateral Tracking Owners | InstDefKey |
| CT | Collateral Tracking Documents | InstDefKey |
| LN | Loans | AcctId/AcctType |
| LE | Loan Escrow Endpoint | InstDefKey |
| SD | Safe Deposit Box | AcctId/AcctType |
The InstDefFld API’s return information base on the AppCode used.
Example: If the **InstDefFldSrch** is used with an <AppCode>CF</AppCode> it would expect the <CustId> element to be populated. If there are other elements populated, such as AcctID/AcctType, these will be ignored and only <CustId> will be used.
Keeping the requests clear of unneeded search criteria will make usage and research more concise when required.
The <InstDefKey> is the key value that is assigned to each Collateral Item/Owner/Document. This can be found using the CollatTrackSrch and CollatTrackItemInq API’s.
- To use
<AppCode>CI</AppCode>the<InstDefKey>needed for search is returned in a CollatTrackSrch in the<CollatItemKey>element. - To use
<AppCode>CT</AppCode>the<InstDefKey>needed for search is returned in a CollatTrackSrch or CollatTrackItemInq in the<CollatDocInstDefKey>element. - To use
<AppCode>CO</AppCode>the<InstDefKey>needed for search is returned in a CollatTrackItemInq in the<CollatDocInstDefKey>element within the<CustIdCollatRecArray>. - To use
<AppCode>LE</AppCode>the<InstDefKey>needed for search is returned in a EscrowInq in the<InstDefKey>element within the<x_EscrwPayeeArray>
InstDefFldSrch
The search for institution defined fields will return the fields tied to the current search criteria and the values associated. If there is no value in the <FldVal> element there is not currently a value assigned.
When using the InstDefFldSrch an <AppCode> will always need to be passed. This is what drives the search and using the <AppCode> table listed above will define what fields are required for the search to take place.
Example: When searching for an <AppCode>CF</AppCode> the <CustId> element will be required for the search to complete.
Example: When searching for an <AppCode>CI</AppCode> the <InstDefKey> element will be required for the search to complete.
InstDefFldInq
The inquiry on an institution defined field will return the value of only the field that is passed. This will also need to be used before a modification to get an <ActIntentKey> which is used to check against the current data to make sure it has not changed between the inquiry and the modification.
Example: The person requesting the change went to modify the field and did not send in the changes before leaving for lunch. Upon return the request is submitted, but a change was made by another person in the interim.
When using the InstDefFldInq the <AppCode> and <FldId> are required along with the elements used in the search. This would be the <CustId> if this was used with a CF <AppCode> in the search. The <FldId> is returned in the InstDefFldSrch and identifies the correct field.
If the intent is to get an <ActIntentKey> for use with a modification request, then the <ActIntent> element will need to be passed. If the <ActIntentKey> is not passed a warning, will we issued in the response but will not stop processing of the request. It will be treated as a ReadOnly and no <ActIntentKey> will be returned in the response.
| ActIntent Value | Meaning |
|---|---|
| ReadOnly | No Modification |
| Dlt | Modification with Intent to Delete |
| Upd | Modification Intent to Update |
InstDefFldMod
The modification of an institution defined field will change the value of only the field it is passed. This request will need to be preceded by a InstDefFldInq to get an <ActIntentKey>.
When using the InstDefFldMod the combination of fields used on the inquiry will need to be included here along with the <ActIntentKey>. This will identify the correct institution defined field for modification.
The value to be placed in the field will need to be in <FldVal> in the request.
If the field is to be removed, no value, then the element <Dlt> will need to be passed with a Y. The exclusion of this element or no value is the assumption that the field is not to be deleted.
Errors for each Operation
InstDefFldSrch Error Listing
| Service | Code | Template Field | Category | Description |
|---|---|---|---|---|
| InstDefFldSrch | 1 | ACCTNO | Error | Account Not Found |
| InstDefFldSrch | 1 | ACTYPE | Error | Account Not Found |
| InstDefFldSrch | 5004 | ACTYPE | Error | Invalid Account Type |
| InstDefFldSrch | 800001 | APPL | Error | Invalid Application |
| InstDefFldSrch | 202010 | APPL | Error | Cannot be blank |
| InstDefFldSrch | 11 | BEGREC | Error | Beginning Record cannot be negative |
| InstDefFldSrch | MAXREC | Error | Maximum records must be greater than zero of less than 4000 | |
| InstDefFldSrch | 49 | Warning | No Records Match Selection Criteria | |
| InstDefFldSrch | 45 | Error | Numeric data is not valid | |
| InstDefFldSrch | 235 | Error | Field required for input |
InstDefFldInq Error Listing
| Service | Code | Template Field | Category | Description |
|---|---|---|---|---|
| InstDefFldInq | 45 | ACCTNO | Error | Numeric data is not valid |
| InstDefFldInq | 235 | ACCTNO/ACTYPE | Error | Field required for input |
| InstDefFldInq | 5004 | ACTYPE | Error | Invalid Account Type. |
| InstDefFldInq | 235 | APPL | Error | Field required for input |
| InstDefFldInq | 800001 | APPL | Error | Invalid application |
| InstDefFldInq | 235 | FLDNAME | Error | Field required for input |
| InstDefFldInq | 49 | Warning | No Records Match Selection Criteria |
InstDefFldMod Error Listing
| Service | Code | Template Field | Category | Description |
|---|---|---|---|---|
| InstDefFldMod | 235 | ACCTNO | Error | Field required for input |
| InstDefFldMod | 235 | ACTYPE | Error | Field required for input |
| InstDefFldMod | 5004 | ACTYPE | Error | Invalid Account Type. |
| InstDefFldMod | 235 | APPL | Error | Field required for input |
| InstDefFldMod | 800001 | APPL | Error | Invalid Application |
| InstDefFldMod | 235 | CIFNO | Error | Field required for input |
| InstDefFldMod | 235 | FLDNAME | Error | Field required for input |
| InstDefFldMod | 100409 | FLDNAME | Error | Field name is not found |
| InstDefFldMod | 235 | FLDVALUE | Error | Field required for input |
| InstDefFldMod | 9001 | FLDVALUE | Error | Invalid field value |
| InstDefFldMod | 100400 | FLDVALUE | Error | Value not allowed with data type |
| InstDefFldMod | 103 | FLDVALUE | Error | The value entered is longer than the field length |
| InstDefFldMod | 101002 | FLDVALUE | Error | Invalid date |
| InstDefFldMod | 235 | IFSPATH | Error | Field required for input |
| InstDefFldMod | 16 | Error | Cannot open files | |
| InstDefFldMod | 45 | Error | Numeric data is not valid | |
| InstDefFldMod | 49 | Error | No Records Match Selection Criteria | |
| InstDefFldMod | 1002 | Error | Error occurred while attempting to add, mod or delete a field value | |
| InstDefFldMod | 2000 | Error | Maintenance denied due to data not being current |