Service Dictionary Search
Overview
SvcDictSrch
This operation allows you to convey a service provider's element XSD paths, requirements, default values, open enumerated canonical values, help/knowledge content, and fault codes per operation.
Behavior
The SvcDictName and SvcDictType elements are
required in the response.
The SvcDictName canonical values represent operations that
can be queried. The canonical values are separated by the Third-Party Consumer operations
and Jack Henry Consumer operations. The canonical values are phased in as service providers
adopt them.
The SvcDictType element canonical values are Rq and
Rs. The request includes the optional element
ElemName so that a consumer can query for the values as related to a
specific child node. When the ElemName element is populated, it can also
carry the Override Institution Routing Identifier attribute
OvrrdInstRtId to indicate to the service provider the consumer's intent
to gather information about a bank-specific client's information. When the
ElemName element is left blank, the consumer is requesting information
about the entire service.
The request includes the optional array SvcDictFilterArray_AType, which
includes the SvcDictFilterInfo_CType. The
SvcDictFilterInfo_CType complex contains the
SvcDictFilterCode and SvcDictFilterVal elements. These
two elements present a matched pair that provides canonical values that allow a consumer to
restrict a query for specific values that have a correlation to an operation. For example, a
submission for Account Addition (SvcDictName = AcctAdd)
could include the dictionary values related to a specific product code
(SvcDictFilterCode = ProdCode and
SvcDictFilterVal = product code data value). However, a consumer must
query for the valid product codes with the Service Dictionary to make a subsequent call that
includes the product code as a filter on the request.
The SvcDictName is returned back in response.
XPath Elements
XPath Elements
For this business service, certain template fields, or XPath elements, are sent in on the request and corresponding elements are returned in the response.
The following tables list the elements that you send on the request and what is sent back in the response. Each table also includes any pertinent notes, such as element values or whether it is required for input.
| XPath Element | File/Field | Description |
|---|---|---|
MaxRec | N/A | Maximum Records |
Cursor | N/A | Beginning Record |
SvcDictName | N/A | Requested Operation |
SvcDictType | N/A | Request Response |
SvcDictFilterCode | N/A | Filter One Code |
SvcDictFilterCode | N/A | Filter Two Code |
SvcDictFilterCode | N/A | Filter Three Code |
SvcDictFilterVal | N/A | Filter One Value |
SvcDictFilterVal | N/A | Filter Two Value |
SvcDictFilterVal | N/A | Filter Three Value |
XtendElem | N/A | IncXtendElemArray1 |
XtendElem | N/A | IncXtendElemArray 2 |
ElemName | N/A | Element Name |
SvcDictFilterCode | N/A | Filter Four Code |
SvcDictFilterCode | N/A | Filter Five Code |
SvcDictFilterVal | N/A | Filter Four Value |
SvcDictFilterVal | N/A | Filter Five Value |
| XPath Element | File/Field | Description |
|---|---|---|
SentREc | N/A | Number Sent Records |
MoreRec | N/A | More Records? |
Cursor | N/A | Next Record |
TotRec | N/A | Total Number Records Exist |
SvcDictName | N/A | Requested Operation |
SvcDictType | N/A | Request Response |
SvcDictFilterCode | N/A | Filter One Code |
SvcDictFilterCode | N/A | Filter Two Code |
SvcDictFilterCode | N/A | Filter Three Code |
SvcDictFilterVal | N/A | Filter One Value |
SvcDictFilterVal | N/A | Filter Two Value |
SvcDictFilterVal | N/A | Filter Three Value |
ElemName | JXTAGS.XENMTAG | Enumeration Tag |
ElemPath | JXTAGS.XPATH | Path Hierarchy |
ElemDft | N/A | Provider Dft Value |
SvcPrvdFldName | JXTAGS.PRVFIELD | Mapped Provider Field |
ElemReq | JXFREF.PRVREQ | Provider Required |
SvcPrvdTblName | JXFREF.PRVFILE | Mapped Provider File |
SvcPrvdFldDesc | JXTAGS.DESC | Record Description |
SvcPrvdFldType | JXTAGS.XVALTYP | Value Type |
SvcPrvdFldLen | JXTAGS.LENGTH | Length |
UIDecPlaces | JXTAGS.DECPOS | Decimal Positions |
Validations
Validations
Within the response, specific validations can appear in the response if incorrect or different information than what is required is sent in the request.
The following table lists the errors that can be returned and includes what prompts the validation to occur.
| Code | Element | System Message | Validation Trigger |
|---|---|---|---|
| 9920048 | Cursor | Value cannot be less than zero | Presents when the value in this element is less than zero. |
| 9920048 | MaxRec | Value cannot be less than zero | Presents when the value in this element is less than zero. |
| 9930001 | N/A | Requested institution Id not found | Presents when the search for an institution record is not found within the iAdapter Institution Parameter File (JXINST). |
| 9930005 | N/A | An error occurred allocating a record of an opened Service File | Presents when the system cannot allocate the record the operation is searching for. |
| 9930011 | N/A | An unknown error occurred loading Response Data | Presents when errors occur building the XML response. |
| 9930013 | N/A | An unknown error occurred validating input data | Presents when the MaxRec and Cursor
elements are validated for numeric values and the data does not meet the criteria for
the numeric value. |
| 9930014 | N/A | An unknown error occurred setting default values | Presents when the values entered cannot be put to the default values. |
| 9930022 | SvcDictType | A Non-Blank value is required for the associated field(s) | Presents when a blank value in entered as a value is required. |
| 9930022 | SvcDictName | A Non-Blank value is required for the associated field(s) | Presents when a blank value in entered as a value is required. |
| 9930045 | N/A | An error occurred opening a Service File | Presents when the system is unable to allocate field definitions. |
| 9930049 | N/A | No Records Match Selection Criteria | Presents when no records match the information entered. |
| 9930201 | SvcDictName | An error occurred building field list for requested operation | Presents when the response is unable to build for the operation that has been requested. |