Customer Relationship Management Event Inquiry
Customer Relationship Management Event Inquiry
Customer Relationship Management Event Inquiry is a jXchange service designed to inquire on CRM service events.
Message Flow
In jXchange, the Customer Relationship Management Event Inquiry service uses a typical
exchange of MType messages to inquire on CRM service events.
Primary Request
The third-party consumer forwards the CRMEventInqRq_MType message to the
service provider. The message contains:
- ActIntent
- CRMEventId
- CRMEventType
Primary Response
The service provider returns the CRMEventInqRs_MType message to the
third-party consumer. The message contains:
- ActIntent
- ActIntentKey
Customer Relationship Management Event Inquiry Behavior
The CRMEventInqRq_MType request message
requires valid CRMEventId and CRMEventType
elements. The requested elements can be obtained from the
CRMEventSrchRq_MType service.
The ActIntent default canonical value is ~ReadOnly~. The canonical values ~Upd~ and ~Dlt~ require the service provider to return the ActIntentKey element used for the subsequent modification service with the adopted concurrency model.
The CRMEventInqRs_MType response message returns the elements related to the
CRMEventId and CRMEventType elements. The CRM
event-related elements along with customer-related elements are part of the response.
The standard inquiry message tenets are applicable. Adhere to the tenets for fault reporting. Adhere to the tenets related to the correlation identifications.
CRMEventInqRq_MType
CRMEventInqRq_MType is a message
MType element.
Contains:
Custom_CTypeMsgRqHdr_CTypeIncXtendElemArray_AType
Simple Elements
The following are the simple elements contained within this message.
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- CRMEventId
The identification assigned to a CRM event. It includes the JHANull and Rstr attributes.
Note:Use this element and
CRMEventTypefor the following complex elements:CRMActInqRs_MTypeCRMActInqRec_CTypeCRMActInfoRec_CTypeCRMRelEventInfo_CType
This element deprecates as of 2026-01-01.
- CRMEventType
- The type of CRM event. It includes the
JHANull and Rstr attributes.
Canonical values are:
- All
- CustCon
- Incen
- Sale
- Svc
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
IncXtendElemArray_AType
IncXtendElemArray_AType is an array
AType element.
Contains:
IncXtendElemInfo_CType
IncXtendElemInfo_CType
IncXtendElemInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- XtendElem
- Included extended elements. The consumer would ask by name for x_ prefix elements to be included in the response.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_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.
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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.
CRMEventInqRs_MType
CRMEventInqRs_MType is a message
MType element.
Contains:
CRMEventInqRec_CTypeCustom_CTypeMsgRsHdr_CType
Simple Elements
The following are the simple elements contained within this message.
- ActIntent
Conveys the consumer intention for a subsequent operation for the data set included in the response. Canonical values are:
- Dlt
- ReadOnly
- Upd
The default value is ReadOnly.
- ActIntentKey
- The service provider key that is delivered to the consumer, to be submitted in a subsequent modification operation.
CRMEventInqRec_CType
CRMEventInqRec_CType is a complex
CType element.
Contains:
CRMEventInfoRec_CTypeCustom_CTypex_CRMRelActArray_ATypex_CRMRelReferArray_ATypex_MktCmpgnInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- CRMEventId
The identification assigned to a CRM event. It includes the JHANull and Rstr attributes.
Note:Use this element and
CRMEventTypefor the following complex elements:CRMActInqRs_MTypeCRMActInqRec_CTypeCRMActInfoRec_CTypeCRMRelEventInfo_CType
This element deprecates as of 2026-01-01.
- CRMEventType
- The type of CRM event. It includes the
JHANull and Rstr attributes.
Canonical values are:
- All
- CustCon
- Incen
- Sale
- Svc
- CRMOffCode
- The code assigned to the CRM officer. This element is Open
Enumerated to allow for display of a listing of all officer values. It includes
the OvrrdInstRtId attribute. There is one canonical value
used to identify the current user without having to find the current user's name
in the officer list. If
CRMOffCodeis populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:- CurUsr
- CRMOffDesc
- The description of the code assigned to the CRM officer.
- CRMRelCode
- The code that describes the relationship a customer is to an account.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- EventCatDesc
- The description of the code that conveys the category for an event.
- EventCrtOffDesc
- The description of the code assigned to the CRM officer.
- EventOffDesc
- The description of the code assigned to the CRM officer.
- EventStatDesc
- The description of the code related to the status of an event.
- ModTimeDt
- The date/time stamp a record was modified.
- PotSaleId
- The identification assigned to a CRM potential sales opportunity.
- TaxId
- The tax identifier. It includes the
OvrrdInstRtId,MaskVal,Rstr, andSrchTypeattributes.
CRMEventInfoRec_CType
CRMEventInfoRec_CType is a complex
CType element.
Contains:
CRMAcctArray_ATypeCRMOffArray_ATypeCustom_CTypeUserDefInfoArray_AType
Simple Elements
The following simple elements are contained within this complex.
- CRMEventDesc
- A brief description of the CRM event.
- CRMEventDt
- The date the event was created.
- CRMEventRecv
- Answers the question: Was the CRM event received by the CRM
assigned officer? Canonical values are:
- false
- true
- CRMTerRsnDesc
- Application or user remarks free-form text.
- EscltDt
- The CRM Date Escalated Date.
- EventCatCode
- The code that conveys the category for an event.
- EventCmnt
- A free format of comments as related to CRM activities and events.
- EventCrtOffCode
- The code assigned to the CRM officer.
- EventDueDt
- The due date of the event.
- EventOffCode
- The code assigned to the CRM officer.
- EventPrivType
- Answers the question: Is the CRM entry private with a limited number
of recipients? Canonical values are:
- false
- true
- EventStatCode
The code related to the status of an event. Service Event statuses returned in Service Dictionary Search represent a one-to-one relationship. Use of one of the listed canonical values represents a one-to-many relationship. Canonical values are:
- Act, Return All Events not in a terminating area
- Esclt, Return All Escalated Events (Date Escalated is populated and status is not considered)
- AltEsclt, Return All Active/Escalated Events (Date Escalated is populated and Events are in an Active status
- Ter, Return Events that are in a terminating status
The default if you do not input a value is All, Return All Events.
- LobbyQueId
- An identifier given to entries for lobby queues.
- PotSaleId
- The identification assigned to a CRM potential sales opportunity.
- RmndSchedEnable
- Whether the reminder schedule tied to the CRM Event Category Code
is enabled. Canonical values are:
- false
- true
- 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
- WorkflowProcStat
- The element indicating whether a record is under the control of a
workflow process. Canonical values are:
- false
- true
The default value is false.
CRMAcctArray_AType
CRMAcctArray_AType is an array
AType element. This is an array of accounts associated to a CRM
customer.
Contains:
CRMAcctInfoRec_CType
CRMAcctInfoRec_CType
CRMAcctInfoRec_CType is a complex
CType element.
Contains:
Custom_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.
- CRAMeetType
- Is the CRM activity related to a Community Reinvestment Act (CRA)
meeting? Canonical values are:
- true
- false
- Dlt
The delete element. Canonical values are:
- false
- true
- MeetEndTimeDt
- The date and time that designates the ending point for date/time selections.
- MeetStartTimeDt
- The date and time that designates the starting point for date/time selections.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
CRMOffArray_AType
CRMOffArray_AType is an array AType
element. This is an array of officers for the Customer Relationship Management
service.
Contains:
CRMOffRec_CType
CRMOffRec_CType
CRMOffRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- CRMOffCode
- The code assigned to the CRM officer. This element is Open
Enumerated to allow for display of a listing of all officer values. It includes
the OvrrdInstRtId attribute. There is one canonical value
used to identify the current user without having to find the current user's name
in the officer list. If
CRMOffCodeis populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:- CurUsr
- CRMOffDesc
- The description of the code assigned to the CRM officer.
- CRMOffCodeText
- The text that describes the proceeding elements for the CRM officer array.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
UserDefInfoArray_AType
UserDefInfoArray_AType is an array
AType element. This is an array of UserDefInfo simple
elements used to describe user-defined information.
Contains:
UserDefInfo_CType
UserDefInfo_CType
UserDefInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OvrrdInstRtId
- Describes the institution routing number or bank number/location used to override the InstRtId found in a message header.
- UserDefCode
- The code that represents the answer to the
UserDefTxt. - UserDefDesc
- The description of what the
UserDefCoderepresents. - UserDefDt
- A date field that has a relationship with the
UserDefTxtorUserDefCode. - UserDefInfo1
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo2
- Additional information that may accompany any of the user supplied codes.
- UserDefInfo3
- Additional information that may accompany any of the user supplied codes.
- UserDefTxt
- User Defined Text is part of a matched pair array that describes the proceeding elements.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
x_CRMRelActArray_AType
x_CRMRelActArray_AType is an array
AType element. This is an array of CRM-related activities.
Contains:
CRMRelActInfo_CType
CRMRelActInfoRec_CType
CRMRelActInfoRec_CType is a
complex CType element.
Simple Elements
The following simple elements are contained within this complex.
- ActCrtOffDesc
- The description of the code assigned to the CRM officer.
- ActCrtTimeDt
- The time and date assigned to the creation of an activity.
- CRMActDt
- The date the activity was created.
- CRMActId
- The identification assigned to a CRM activity.
- CRMActRmk
- Application or user remarks free-form text.
- CRMActStatDesc
- The description of the code assigned to the status of a CRM activity.
- CRMActTime
The time an activity was created.
Note: This element deprecates as of 2026-01-01.- CRMActType
- The type of CRM activity. Canonical values are:
- All
- Cmpgn
- Mailing
- Meet
- The Meet canonical value is scheduled for deprecation. Effective date: 2018-01-01.
- Msg
- Note
- Phone
x_CRMRelReferArray_AType
x_CRMRelReferArray_AType is an array
AType. This element is an array of CRM-related referral
information.
Contains:
CRMRelReferInfoRec_CType
CRMRelReferInfoRec_CType
CRMRelReferInfoRec_CType is a complex
CType element.
Simple Dictionary
- ReferCrtOffDesc
- The description of the code assigned to the CRM officer.
- ReferDt
- The date a referral was created.
- ReferId
- The identification assigned to a CRM referral.
- ReferRmk
- Application or user remarks free-form text.
- ReferStatDesc
- The description of the code assigned to the status of a CRM referral.
- ReferTime
- The time a referral was received.
x_MktCmpgnInfoArray_AType
x_MktCmpgnInfoArray_AType is an array
AType element. This element is an array of marketing campaign
information.
Contains:
- MktCmpgnInfoRec_CType
MktCmpgnInfoRec_CType
MktCmpgnInfoRec_CType is a complex
CType element.
Contains:
CRMProdArray_ATypeCustom_CType
Simple Dictionary
- MktCmpgnDesc
- The description of the marketing campaign.
- MktCmpgnEndDt
- The date that designates the ending point for date selections.
- MktCmpgnExpDt
- The expiration date.
- MktCmpgnId
- The identification assigned to a CRM marketing campaign.
- MktCmpgnName
- The name given to a marketing campaign.
- MktCmpgnStartDt
- The date that designates the starting point for date selections.
- MktCmpgnType
The status of an activity specific to the payment hub. Canonical values are:
- PSO
- Cmpgn
- DynamicCmpgn
CRMProdArray_AType
CRMProdArray_AType
is an array AType element. This element is an array of CRM
products.
Contains:
CRMProdInfoRec_CType
CRMProdInfoRec_CType
CRMProdInfoRec_CType
is a complex CType element.
Contains:
Custom_CType
Simple Dictionary
- AcctTypeDesc
- A description of the account type. It includes the
Rstrattribute. - AcctType
- The number or character that categorizes the AcctId.
- CRMProdCode
- The code that identifies a product type of account within an application.
- CRMProdDesc
- A description of the type of account. It includes the
Rstrattribute.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MsgRsHdr_CType
MsgRsHdr_CType is a complex
CType element. This is the default message response
header.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage 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.