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 Activity Search

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

Customer Relationship Management Activity Search

Customer Relationship Management Activity Search is a jXchange service designed to provide a list of CRM activities related to a specific CRM customer.

Message Flow

In jXchange, the Customer Relationship Management Activity Search service uses a typical exchange of MType messages to retrieve a list of CRM activities related to a specific CRM customer.

Primary Request

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

  • CRMActType
  • CustId
  • EndDt
  • StartDt
  • TaxId

Primary Response

The service provider returns the CRMActSrchRs_MType message to the third-party consumer. The message contains an echo of the requested elements.

Customer Relationship Management Activity Search Behavior

The CRMActSrchRq_MType request message contains a documented choice statement where the elements at the root are optional, but at least one of the elements is required.

The AccountId_CType complex, CustId element, and TaxId element are available at the root request. The CRMActType element is required.

The CRMActType canonical values are:

  • Note - Notes
  • Meet - Meetings
  • Phone - Phone Activity
  • Mailing - Mailing
  • Cmpgn - Campaign Activity
  • All - All Activities

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

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

A consumer request with a StartDt and without an EndDt returns all the qualified Customer Relationship Management (CRM) Activity 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) Activity 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) Activity records with a date equal to and greater than the StartDt and a date equal to and less than the EndDt.

The CRMActSrchRs_MType response message echoes the requested elements.

The CRMActSrchArray_AType array returns all the items related to the CRM activities' requested documented choices. The response is returned in last in, first out (LIFO) order.

The CRMActSrchRec_CType complex contains the ActOffArray_AType array to return multiple officers per activity. The array is a matched pair array with the CRMOffCodeText element, which behaves as a key for the matched pair array. The CRMActSrchRec_CType complex contains the Rstr attribute.

The service provider must adhere to the established tenets for the user accessibility policy. The service provider cannot apply user accessibility policies when the consumer does not include the end-user credentials.

CRMActSrchRq_MType

CRMActSrchRq_MType is a message MType element.

Contains:

  • AccountId_CType
  • Custom_CType
  • SrchMsgRqHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActOffCode
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 CRMOffCode is populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:
  • CurUsr
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
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EndDt
The date that designates the ending point for date selections.
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.

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.

CRMActSrchRs_MType

CRMActSrchRs_MType is a message MType element.

Contains:

  • AccountId_CType
  • CRMActSrchArray_AType
  • Custom_CType
  • SrchMsgRsHdr_CType

Simple Elements

The following simple elements are contained within this message.

ActOffCode
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 CRMOffCode is populated with CurUsr, the provider looks to the subject name in the IMS token to identify the officer. The canonical value is:
  • CurUsr
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
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
EndDt
The date that designates the ending point for date selections.
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

CRMActSrchArray_AType

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

Contains:

  • CRMActSrchRec_CType

CRMActSrchRec_CType

CRMActSrchRec_CType is a complex CType element.

Contains:

  • AccountId_CType
  • ActOffArray references CRMOffArray_AType
  • CRMSvcActSrchCustom references Custom_CType
Simple Elements

The following simple elements are contained within this complex.

CRMActTime is not supported as of 01-01-2023.

Note: ActOffCode and ActOffDesc is provided in individual elements in the CRMOffArray_AType response. This information deprecates on effective date 2026-01-01.
ActCmnt
A free format of comments as related to CRM activities and events.
ActCrtOffCode
The code assigned to the CRM officer.
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.
CRMActRecv
Answers the question: Was the CRM activity received by the CRM assigned officer? Canonical values are:
  • false
  • true
CRMActRmk
Application or user remarks free-form text.
CRMActStatCode
The code assigned to the status of a CRM activity.
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
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 CRMOffCode is 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.
CustId
The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
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
ActOffArray

CRMOffArray_AType is an array AType element. This is an array of officers for the Customer Relationship Management service.

ActOffArray references CRMOffArray_AType.

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 CRMOffCode is 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.
CRMSvcActSrchCustom

Custom_CType is a complex CType element.

CRMSvcActSrchCustom references Custom_CType.

This element is optional.

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
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.
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 Wed Nov 8 2023