File Maintenance Search
File Maintenance Search is a jXchange service designed to provide the consumer with the ability to retrieve a listing of file maintenance audit changes.
Message Flow
In jXchange, the File Maintenance Search service uses a typical exchange of
MType
messages to retrieve a listing of file maintenance audit
changes.
Primary Request
The Third Party Consumer forwards the FileMainSrchRq_MType
message to the
Service Provider. The message contains:
- ACHId
- BrCode
- CustId
- EndDt
- StartDt
Primary Response
The Service Provider returns the FileMainSrchRs_MType
message to the Third
Party Consumer. The message contains an echo of the elements contained in the request.
File Maintenance Search Behavior
The FileMainSrchRq_MType
request message requires the submission of the AcctId,
CustId, or ACHId even though contractually
they all are optional. The AcctId takes precedence over the other
request elements when it is present and either the CustId or
ACHId is included in the request.
The response set is returned in last in, first out order.
A consumer request with a StartDt and without an EndDt, returns all of the qualified file maintenance audit items with a date equal to and greater than the start date. All of the other filters must be considered for the response.
A consumer request with an EndDt and without a start date StartDt, returns all of the qualified file maintenance audit items with a date equal to and less than the end date. All of the other filters must be considered for the response.
A consumer request without a StartDt or an EndDt returns all of the qualified file maintenance audit items for the key(s) requested.
The service providers date value being used for the FileMainDt is used for the date range comparisons.
The BrCode is provided as an optional request filter. The standard search message header tenets are applicable. The FileMainDt, FileMainTime, and FieldDesc are required elements in the response array.
FileMainSrchRq_MType
FileMainSrchRq_MType
is a message
MType
element.
Contains:
Custom_CType
InAcctId
referencesAccountId_CType
SrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ACHId
- The number or character that identifies an account record.
- BrCode
- The branch code.
- CustId
- The identifier attached to a customer.
- EndDt
- The date that designates the ending point for date selections.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- StartDt
- The date that designates the starting point for date selections.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
InAcctId
AccountId_CType
is a complex
CType
element. This element contains the incoming account
identification information and any restrictions.
InAcctId
references
AccountId_CType
.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-Security
.
FileMainSrchRs_MType
FileMainSrchRs_MType
is a message
MType
element.
Contains:
FileMainSrchRecArray_AType
InAcctId
referencesAccountId_CType
SrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ACHId
- The number or character that identifies an account record.
- BrCode
- The branch code.
- CustId
- The identifier attached to a customer.
- EndDt
- The date that designates the ending point for date selections.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- GLProdCode
- The GL product code provided for bank use in reporting the account to a specific GL product code.
- StartDt
- The date that designates the starting point for date selections.
FileMainSrchRecArray_AType
FileMainSrchRecArray_AType
is an array AType
element. This is an array of responses for the
File Maintenance Search service.
Contains:
FileMainSrchRec_CType
FileMainSrchRec_CType
FileMainSrchRec_CType
is a complex
CType
element.
Contains:
CustomFileMainSrchRec
referencesCustom_CType
Simple Elements
The following simple elements are contained within this complex.
- BrCode
- The branch code.
- BrDesc
- A description of the branch name. It includes the
Rstr
attribute. - FieldDesc
- The description of the field that has been maintained.
- FieldNewVal
- The new value of the field that has been maintained as a result of this change occurrence.
- FieldOrigVal
- The original value of the field that has been maintained.
- FileMainDt
- The date of the file maintenance change.
- FileMainTime
- The time of the file maintenance change.
- FileMainUsrId
- The identification of the user who made the file maintenance change.
- FileMainWsId
- The identification of the workstation where the file maintenance occurred.
- GLCostCtr
- The GL cost center provided for bank use in reporting the account to a specific GL cost center.
- ProdCode
- The code that identifies a product type of account within an application.
CustomFileMainSrchRec
Custom_CType
is a complex CType
element.
CustomFileMainSrchRec
references Custom_CType
.
This element is optional.
InAcctId
AccountId_CType
is a complex
CType
element. This element contains the incoming account
identification information and any restrictions.
InAcctId
references
AccountId_CType
.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child node. Canonical
values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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
- AuthenUserId
- This element deprecates in three years in accordance with XSD contract tenets.
Effective date: 2012–01–01. The new complex element for user authentication credentials
was added to 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 credentialsAuthenUsrCred_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 byWS-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 Soap Header Fault 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.