Developer Programs
Vendor Integration Program (VIP)
Direct access to Jack Henry's technical integration resources.
Technical Account Manager (TAM)
Get technical integration help from a single point of contact.
Learn
Shared Responsibility
Learn about shared roles and responsibilities of customers and Jack Henry in open banking.
Developer Use Cases
Find a use case that fits your development needs.
Developer Video Gallery
Watch the latest demos, webinars, and more.
Developer Conference
Connect with industry leaders, gain insights from expert speakers, and explore our latest innovations.
Docs
Admin API
Create solutions for an institution's back office support tools.
Authentication Framework
Map customer identities to your existing system IDs.
Consumer API
Access financial data for user accounts, transactions, and more.
Data Broker
Get deeper access to financial institution data.
Enterprise Event System
Respond to events in real-time using this powerful pub/sub-based solution.
jXchange - REST API
Translate business information between Jack Henry and third-party applications using a REST-based API.
jXchange - SOAP API
Translate business information between Jack Henry and third-party applications using a SOAP-based API.
Operational Data Integration (ODI)
Get customized queries for bulk data needs.
Payments
Embed check deposits, ACH, bill pay, cards, and real-time payments.
Plugin Framework
Embed the best of the fintech world directly into your user's dashboard.
SymXchange
Query Symitar core member accounts, post transactions, run PowerOn scripts, and more.
Xperience
Modern UI that provides consistent visual integration across Jack Henry products.
Important notification about upcoming changes to the DMZ environment. Please read.
More info

Document Image Search

Enterprise SOAP API > API by Reference > Document Image > Document Image Search

Document Image Search

Document Image Search is a jXchange service designed to allow a customer to search document images along with their associated indexes.

Message Flow

In jXchange, the Document Image Search service uses a typical exchange of MType messages to search document images along with their associated indexes to a service provider.

Primary Request

The third-party consumer forwards the DocImgSrchRq_MType message to the service provider. The message contains:

  • Custom_CType
  • DocImgIdxArray_AType
  • IdxOnly
  • SrchMsgRqHdr_CType

Primary Response

The service provider returns the DocImgSrchRs_MType message to the service provider. The message contains:

  • Custom_CType
  • DocImgSrchArray_AType
  • IdxOnly
  • RsStat
  • SrchMsgRsHdr_CType

Document Image Search Behavior

The DocImgSrchRq_MType message allows for an infinite number of document images to be requested in a single request. However, the service provider may limit this number based on their established limitations for array response. The service provider should accept the indexes that it permits, process the request, and convey to the third-party consumer that all the requested indexes could not be delivered.

The third-party consumer may request indexes only in the request. They might submit a high-level index and only want the service provider to return a list of indexes related to the higher-level index. This allows the third-party consumer to convey a list of the available images for a high-level entity to the end consumer when the service could be submitted with an exact index to return the actual image object. The response would not include the DocImgDetArray when requesting indexes only. The default value is False for the IdxOnly element.

The service provider may limit the number of indexes returned if the consumer's request is at such a high level in the index hierarchy that the number of indexes in the response would be unmanageable.

The DocImgFilterType element is an optional element in the request. It is open enumerated with a set of contract canonical named queries. This design permits a consumer to submit a mutually agreed upon data value to the service provider. The DocImgFilterType element is annotated with Synergy's standard acceptable index names for each pre-defined named query. The service provider returns a fault when the DocImgFilterType element contains a data value not configured by the service provider. The DocImgFilterType element always requires respective data values, specific to the pre-defined query, to be provided in the DocImgIdxArray_AType array. The required indexes are annotated for each DocImgFilterType element canonical value. The service provider does not return a fault when the DocImgFilterType element contains a data value configured by the service provider. However, due to index data values, the service provider returns a ~zero~ row response set.

The DocImgSrchRs_MType message can return multiple images per request. The response should attempt to return the images using the first in, first out (FIFO) method. The document image needs to be converted to base 64 binary by the service provider. The DocImgFilterType element in the response message is an echo from the request.

DocImgSrchRq_MType

DocImgSrchRq_MType is a message MType element.

Contains:

  • Custom_CType
  • DocImgIdxArray_AType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

DocImgFilterType
The type of predefined filters that convey image filters understood by the image provider. Canonical values are:
  • qry_account_payable
  • qry_cd
  • qry_club
  • qry_commercial_loan
  • qry_consumer_loan
  • qry_customer
  • qry_customer_tin
  • qry_demand_deposit
  • qry_demand_loan
  • qry_gl
  • qry_loan
  • qry_mortgage_loan
  • qry_overdraft
  • qry_photo_id
  • qry_safe_deposit
  • qry_savings
  • qry_sig_id

Synergy accepts any combination of the indexes referenced for each annotated predefined query name. The more specific index reduces the response set of document images.

The following document image indexes can be captured with the qry_demand_deposit:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_savings:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_club:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_cd:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_consumer_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_demand_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_commercial_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_mortgage_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_safe_deposit:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • BranchNumber

The following document image indexes can be captured with the qry_customer:

  • MemberNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName

The following document image indexes can be captured with the qry_customer_tin:

  • MemberNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName

The following document image index can be captured with the qry_gl:

  • AccountNumber

The following document image index can be captured with the qry_account_payable:

  • VendorNumber

The following document image indexes can be captured with the qry_sig_id:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_photo_id:

  • CIFNumber
  • TaxID

The following document image index can be captured with the qry_overdraft:

  • AccountNumber
DocImgFormat
Identifies the type of file that contains the document image. Canonical values are:
  • GIF
  • IOCA
  • JPG
  • PDF
  • PNG
  • TIFF
IdxOnly
Selection to get in the response a listing of indexes. Canonical values are:
  • false
  • true

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocImgIdxArray_AType

DocImgIdxArray_AType is an array AType element. This array contains document indexes used for a document image.

Contains:

  • DocImgIdx_CType

DocImgIdx_CType

DocImgIdx_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

DocImgAlgSymb
The algebraic symbol for the document index ranges. Canonical values are:
  • EQ
  • GT
  • GE
  • LT
  • LE
  • NE
DocImgIdxName
The name that describes the naming convention for the DocImIdxType element used for indexing a document.
DocImgIdxOrder
The document image order for image ranges.
DocImgIdxType
The type or classification of the index that could be used in the DocImgAdd service. Canonical values are:
  • AcctId
  • AcctType
  • Cabinet
  • CustId
  • FileName
  • Folder
  • Index
  • IndexLookup
  • Name
  • ShortName
  • TaxId
  • UniqueIndex
DocImgIdxValue
The value that correlates to the DocImgIdxName used for indexing a document image.

SrchMsgRqHdr_CType

SrchMsgRqHdr_CType is a complex CType element. This is a standard request message header.

Contains:

  • AuthenUsrCred_CType
  • jXchangeHdr_CType

Simple Elements

The following simple elements are contained within this complex.

AuthenProdCred
Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MaxRec
The maximum number of records when multiple records are returned.

AuthenUsrCred_CType

AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.

Simple Elements

The following simple elements are contained within this complex.

Security
Defines the wsse:Security SOAP header element per section 4.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

DocImgSrchRs_MType

DocImgSrchRsMType is a message MType element.

Contains:

  • Custom_CType
  • DocImgSrchArray_AType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

DocImgFilterType
The type of predefined filters that convey image filters understood by the image provider. Canonical values are:
  • qry_account_payable
  • qry_cd
  • qry_club
  • qry_commercial_loan
  • qry_consumer_loan
  • qry_customer
  • qry_customer_tin
  • qry_demand_deposit
  • qry_demand_loan
  • qry_gl
  • qry_loan
  • qry_mortgage_loan
  • qry_overdraft
  • qry_photo_id
  • qry_safe_deposit
  • qry_savings
  • qry_sig_id

Synergy accepts any combination of the indexes referenced for each annotated predefined query name. The more specific index reduces the response set of document images.

The following document image indexes can be captured with the qry_demand_deposit:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_savings:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_club:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_cd:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_consumer_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_demand_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_commercial_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_mortgage_loan:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer
  • Coborrower1Name
  • Coborrower1SSN
  • Coborrower2Name
  • CollateralCode
  • LoanClassCode
  • LoanCreditRating
  • LoanDateEntered
  • LoanDealerNumber
  • LoanDepartmentCode
  • LoanOriginationDate
  • LoanPurposeCode
  • LoanStatusCode
  • LoanTypeCode
  • PropertyDescription

The following document image indexes can be captured with the qry_safe_deposit:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • BranchNumber

The following document image indexes can be captured with the qry_customer:

  • MemberNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName

The following document image indexes can be captured with the qry_customer_tin:

  • MemberNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName

The following document image index can be captured with the qry_gl:

  • AccountNumber

The following document image index can be captured with the qry_account_payable:

  • VendorNumber

The following document image indexes can be captured with the qry_sig_id:

  • AccountNumber
  • CIFNumber
  • TaxID
  • Name
  • ShortName
  • DateOpened
  • BranchNumber
  • Officer

The following document image indexes can be captured with the qry_photo_id:

  • CIFNumber
  • TaxID

The following document image index can be captured with the qry_overdraft:

  • AccountNumber
IdxOnly
Selection to get in the response a listing of indexes. Canonical values are:
  • false
  • true

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

DocImgSrchArray_AType

DocImgSrchArray_AType is an array AType element. This is an array response for the document image search request.

Contains:

  • DocImgSrchInfo_CType

DocImgSrchInfo_CType

DocImgSrchInfo_CType is a complex CType element.

Simple Elements
Contains:
  • DocImgDetArray_AType
  • DocImgIdxArray_AType

The following simple elements are contained within this complex.

DocName
The name given to a document that describes the document image captured.
DocImgDetArray_AType

DocImgDetArray_AType is an array AType element. This is an array of document images.

Contains:

  • DocImgDetInfo_CType
DocImgDetInfo_CType

DocImgDetInfo_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

DocImgFormat
Identifies the type of file that contains the document image. Canonical values are:
  • GIF
  • IOCA
  • JPG
  • PDF
  • PNG
  • TIFF
DocImgProcSeq
A sequence number assigned to each document image that assists the service provider for processing.
DocImgSize
The size of the document image in bytes. The size is prior to compression if the image has been compressed.
DocImg
The document image.
DocImgIdxArray_AType

DocImgIdxArray_AType is an array AType element. This array contains document indexes used for a document image.

Contains:

  • DocImgIdx_CType
DocImgIdx_CType

DocImgIdx_CType is a complex CType element. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

DocImgAlgSymb
The algebraic symbol for the document index ranges. Canonical values are:
  • EQ
  • GT
  • GE
  • LT
  • LE
  • NE
DocImgIdxName
The name that describes the naming convention for the DocImIdxType element used for indexing a document.
DocImgIdxOrder
The document image order for image ranges.
DocImgIdxType
The type or classification of the index that could be used in the DocImgAdd service. Canonical values are:
  • AcctId
  • AcctType
  • Cabinet
  • CustId
  • FileName
  • Folder
  • Index
  • IndexLookup
  • Name
  • ShortName
  • TaxId
  • UniqueIndex
DocImgIdxValue
The value that correlates to the DocImgIdxName used for indexing a document image.

SrchMsgRsHdr_CType

SrchMsgRsHdr_CType is a complex CType element. It searches specific message response headers.

Contains:

  • jXchangeHdr_CType
  • MsgRecInfoArray_AType

Simple Elements

The following simple elements are contained within this complex.

Cursor
The state information that allows the next call to understand where it left off when returning multiple records and allowing a subsequent call to retrieve more records.
MoreRec
Indicates if there are more records that could be returned. Canonical values are:
  • false
  • true
SentRec
The number of records sent in the response.
TotRec
Indicates the total records the request selected, which could be larger than MaxRec.

jXchangeHdr_CType

jXchangeHdr_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AuditUsrId
The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
AuditWsId
The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

BusCorrelId
The correlation identification as related to business functions and activities.
ConsumerName
The name of the service consumer (business name) for the Soap Header Fault.
ConsumerProd
The name of the product which is consuming the service (business product name) for the Soap Header Fault.
InstEnv
An identification provided by the consumer that defines the environment in which the institution is operating. Canonical values are:
  • Prod
InstRtId
The identification of the entity of the submitted message. A financial institution entity uses the routing transit or nine-digit number assigned to financial institutions for routing as assigned by the American Bankers Association. Any leading zeros must be provided for a complete routing and transit number. A non-financial institution entity should use a mutually agreed upon identification that must contain at least one non-integer character. The canonical value is JHA.

The element is required in all message requests.

jXLogTrackingId
An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
JxVer
Contains the version jXchange is running for the Soap Header Fault.
ValidConsmName
The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
ValidConsmProd
The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
WorkflowCorrelId
The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.

This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header SrchMsgRqHdr_CType and the Message Request Header MsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentials AuthenUsrCred_CType package is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.

MsgRecInfoArray_AType

MsgRecInfoArray_AType is an array AType element. This is an array of messages that can be returned in a response.

Contains:

  • MsgRec_CType
MsgRec_CType

MsgRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

ErrCat
The Soap Header Fault error category.
ErrCode
The error code.
ErrDesc
The Soap Header Fault error description.
ErrElem
The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
ErrElemVal
The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
ErrLoc
The Soap Header Fault error location. This is typically the program that generated the error condition.

©1999-2020 Jack Henry & Associates, Inc.

Dates are provided as estimates only and can be changed at any time at the sole discretion of JHA.

Have a Question?
Have a how-to question? Seeing a weird error? Get help on StackOverflow.
Register for the Digital Toolkit Meetup where we answer technical Q&A from the audience.
Last updated Mon Jan 24 2022