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

Customer Relationship Management Event Search

Enterprise SOAP API > API by Reference > Customer Relationship Management > Customer Relationship Management Event Search

Customer Relationship Management Event Search

Customer Relationship Management Event Search is a jXchange service designed to provide a listing of events as related to a CRM customer.

Message Flow

In jXchange, the Customer Relationship Management Event Search service uses a typical exchange of MType messages to search for and provide a listing of events related to a CRM customer.

Primary Request

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

  • CRMEventType
  • CustId
  • EndDt
  • StartDt
  • TaxId

Primary Response

The service provider returns the CRMEventSrchRs_MType message to the third-party consumer. The message contains:

  • CRMEventType
  • CustId
  • EndDt
  • StartDt
  • TaxId

Customer Relationship Management Event Search Behavior

The Customer Relationship Management (CRM) Event Search request message, CRMEventSrchRq_MType, contains a documented choice statement where the elements are optional, but at least one of the elements is required. The AccountId_CType, CustId element, and TaxId element are available in the request. The CRMEventType element is required.

The CRMEventType element's canonical values are:

  • Svc - Service Events
  • Sale - Sale Events
  • CustCon - Customer Contact Events
  • Incen - Incentive Event
  • All - All Events

The request contains a documented filter statement that contains the optional elements StartDt and EndDt.

The Customer Relationship Management (CRM) Event date search filters compare the element CRMEventDt in the response.

A consumer request with a StartDt and without an EndDt returns all the qualified Customer Relationship Management (CRM) Event records with a date equal to and greater than the StartDt.

A consumer request with an EndDt and without a StartDt returns all the qualified Customer Relationship Management (CRM) Event records with a date equal to and less than the EndDt.

A consumer request with a StartDt and an EndDt returns all the qualified Customer Relationship Management (CRM) Event records with a date equal to and greater than the StartDt and a date equal to and less than the EndDt.

The Customer Relationship Management (CRM) Event Search response message, CRMEventSrchRs_MType, echoes the requested elements.

The service provider cannot apply user accessibility policies when the consumer does not include the end-user credentials.

The CRMEventSrchArray_AType array returns all the items related to the CRM events' requested documented choices. The response should be returned in last in, first out (LIFO) order.

CRMEventSrchRq_MType

CRMEventSrchRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • IncXtendElemArray_AType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

CRMEventType
The type of CRM event. It includes the JHANull and Rstr attributes. Canonical values are:
  • All
  • CustCon
  • Incen
  • Sale
  • Svc
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EndDt
The date that designates the ending point for date selections.
EventOffCode
The code assigned to the CRM officer.
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.

StartDt
The date that designates the starting point for date selections.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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

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.

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
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 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.

CRMEventSrchRs_MType

CRMEventSrchRs_MType is a message MType element.

Contains:

  • AccountId_CType
  • CRMEventSrchArray_AType
  • Custom_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

CRMEventType
The type of CRM event. It includes the JHANull and Rstr attributes. Canonical values are:
  • All
  • CustCon
  • Incen
  • Sale
  • Svc
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EndDt
The date that designates the ending point for date selections.
EventOffCode
The code assigned to the CRM officer.
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.

StartDt
The date that designates the starting point for date selections.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.

AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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

CRMEventSrchArray_AType

CRMEventSrchArray_AType is an array AType element. This is an array of responses for the Customer Relationship Management service events search.

Contains:

  • CRMEventSrchRec_CType

CRMEventSrchRec_CType

CRMEventSrchRec_CType is a complex CType element.

Contains:

  • AccountId_CType
  • CRMSvcEventSrchCustom references Custom_CType
  • PersonName_CType
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.
CRMEventId
The identification assigned to a CRM event. It includes the JHANull and Rstr attributes.
CRMEventRecv
Answers the question: Was the CRM event received by the CRM assigned officer? Canonical values are:
  • false
  • true
CRMEventType
The type of CRM event. It includes the JHANull and Rstr attributes. Canonical values are:
  • All
  • CustCon
  • Incen
  • Sale
  • Svc
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EscltDt
The CRM Date Escalated Date.
EventCmnt
A free format of comments as related to CRM activities and events.
EventCrtOffCode
The code assigned to the CRM officer.
EventCrtOffDesc
The description of the code assigned to the CRM officer.
EventDueDt
The due date of the event.
EventOffCode
The code assigned to the CRM officer.
EventOffDesc
The description of 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.

EventStatDesc
The description of the code related to the status of an event.
TaxId
The tax identifier. It includes the OvrrdInstRtId, MaskVal, Rstr, and SrchType attributes.
AccountId_CType

AccountId_CType is a complex CType element. This element contains the incoming account identification information and any restrictions.

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
CRMSvcEventSrchCustom

Custom_CType is a complex CType element.

CRMSvcEventSrchCustom references Custom_CType.

This element is optional.

PersonName_CType

PersonName_CType is a complex CType element. It contains name information. This complex is optional.

Contains:

  • X_PersonName
Simple Elements

The following simple elements are contained within this complex.

ComName
The common name. This is the full text line name like John Doe.
FirstName
The first name.
LastName
The last name.
MiddleName
The middle name.
X_PersonName_CType

x_PersonName_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

AbbName
An abbreviated individual's or entity's name.
LegalName
Used by entities like trusts, or businesses in the case where an individual is doing business as a company, or when the legal name is different than the ComName.
NameSuffix
The name suffix. For examples, Jr. or MD.
SalName
A full text line name which is used in mailings. For example, Mr. and Mrs. John Doe.
TitlePrefix
The title prefix. Examples: Mr. or Mrs.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

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
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 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 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.
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