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

CRM Reminder Modification

Enterprise SOAP API > API by Reference > Customer Relationship Management > CRM Reminder Modification

CRM Reminder Modification

CRM Reminder Modification is a jXchange service designed to allow consumers to modify reminder records.

Message Flow

In jXchange, the CRM Reminder Modification service uses a typical exchange of MType messages to allow consumers to modify reminder records.

Primary Request

The consumer forwards the CRMRmndModRq_MType message to the service provider.

The message contains the following simple elements:

  • ActIntentKey
  • CRMItemId
  • CRMItemType
  • Dlt

The message contains the following complex elements:

  • Custom_CType
  • MsgRqHdr_CType

The message contains the following arrays:

  • CRMRmndModInfoArray_AType
  • ErrOvrRdInfoArray_AType

Primary Response

The service provider returns the CRMRmndModRs_MType message to the consumer.

The message contains the following simple elements:

  • RsStat

The message contains the following complex elements:

  • Custom_CType
  • MsgRsHdr_CType

CRM Reminder Modification Behavior

CRM Reminder Modification is a jXchange service designed to allow consumers to modify reminder records.

The CRM Reminder Modification service behavior is as follows.

  • The standard modification message tenets are applicable.
  • Adhere to the tenets related to the JHANull attribute.
  • Adhere to the tenets for fault reporting.
  • Adhere to the tenets related to the correlation identifications.
  • Adhere to the concurrency model tenets.

CRMRmndModRq_MType

CRMRmndModRq_MType is a message MType element.

Contains:

  • CRMRmndModInfoArray_AType
  • Custom_CType
  • ErrOvrRdInfoArray_AType
  • MsgRqHdr_CType

Simple Elements

This message contains the following simple elements.

ActIntentKey
The service provider key that is delivered to the consumer to be submitted in a subsequent modification operation.
CRMItemID
The element used to identify an event or activity when working with CRM reminders. It includes the Rstr attribute.
CRMItemType

Identifies which reminder is associated with an event, activity, or reminder. It includes the ClosedEnum extension and the JHANull attribute. Canonical values are:

  • CustCon
  • Svc
  • Sale
  • Incen
  • Msg
  • Phone
  • Note
  • Cmpgn
  • Rmnd
Dlt
The delete element. Canonical values are:
  • false
  • true

CRMRmndModInfoArray_AType

CRMRmndModInfoArray_AType is an array AType element. This is an array of reminders to be modified.

Contains:

  • CRMRmndInfoRec_CType

CRMRmndInfoRec_CType

CRMRmndInfoRec_CType is a complex CType element.

Contains:

  • RecurInfoRec_CType
  • Custom_CType
  • RmndDetlArray references Rmk_AType
Simple Elements

The following simple elements are contained within this complex.

AssignOffCode
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
CRMItemID
The element used to identify an event or activity when working with CRM reminders. It includes the Rstr attribute.
CRMItemType

Identifies which reminder is associated with an event, activity, or reminder. It includes the ClosedEnum extension and the JHANull attribute. Canonical values are:

  • CustCon
  • Svc
  • Sale
  • Incen
  • Msg
  • Phone
  • Note
  • Cmpgn
  • Rmnd
CrtOffCode
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
RmndCrtTimeDt
The time and date assigned to the creation of a reminder.
RmndDt
The date the reminder is to occur.
RmndSubj
The subject of the reminder.
RmndType

Identifies the type of reminder. Canonical values are:

  • Indv
  • Recur
  • Onboard
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

RecurInfoRec_CType

RecurInfoRec_CType is a complex CType element.

Contains:

  • DlyRecurInfoRec_CType
  • MthlyRecurInfoRec_CType
  • WeeklyRecurInfoRec_CType
DlyRecurInfoRec_CType

DlyRecurInfoRec_CType is a complex CType element.

Contains:

  • RecurRng_CType
  • DlyRecurPatn_CType
DlyRecurPatn_CType

DlyRecurPatn_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DayCnt
The integer length of the term.
EvryWeekDayType

Daily reminder recurs every week day. Canonical values are:

  • true
  • false
RecurRng_CType

RecurRng_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

EndDt
The date that designates the ending point for date selections.
OccurCnt
The integer length of the term.
StartDt
The date that designates the starting point for date selections.
MthlyRecurInfoRec_CType

MthlyRecurInfoRec_CType is a complex CType element.

Contains:

  • RecurRng_CType
  • MthlyRecurPatn_CType
MthlyRecurPatn_CType

MthlyRecurPatn_CType is a complex CType element.

Contains:

  • DayOfMonthRecurRec_CType
  • DayOfWeekRecur_CType
DayofMonthRecurRec_CType

DayofMonthRecurRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DayCnt
The integer length of the term.
MonthCnt
The integer length of the term.
DayofWeekRecurRec_CType

DayofWeekRecurRec_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

DayOfWeekOccur
The day of week occurrence. Canonical values are:
  • First
  • Secd
  • Third
  • Fourth
  • Last
DayOfWeek
The day of the week. Canonical values are:
  • Mon
  • Tues
  • Wed
  • Thur
  • Fri
  • Sat
  • Sun
MonthNum
The integer length of the term.
RecurRng_CType

RecurRng_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

EndDt
The date that designates the ending point for date selections.
OccurCnt
The integer length of the term.
StartDt
The date that designates the starting point for date selections.
WeeklyRecurInfoRec_CType

WeeklyRecurInfoRec_CType is a complex CType element.

Contains:

  • RecurRng_CType
  • WeeklyRecurPatn_CType
RecurRng_CType

RecurRng_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

EndDt
The date that designates the ending point for date selections.
OccurCnt
The integer length of the term.
StartDt
The date that designates the starting point for date selections.
WeeklyRecurInfoRec_CType

WeeklyRecurInfoRec_CType is a complex CType element.

Contains:

  • RecurRng_CType
  • WeeklyRecurPatn_CType
RecurDayArray_AType

RecurDayArray_AType is an array AType element. This is an array of days for weekly recurrence.

Contains:

  • RecurDayInfoRec_CType
RecurDayInfoRec_CType

RecurDayInfoRec_CType is a complex CType element.

Simple Elements

The following simple element is contained within this complex.

DayOfWeek
The day of the week. Canonical values are:
  • Mon
  • Tues
  • Wed
  • Thur
  • Fri
  • Sat
  • Sun
RmndDetlArray

Rmk_AType is an array AType element. This is an array of application or user remarks in free form text.

RmndDetlArray references Rmk_AType.

Contains:

  • RmkInfo_CType
RmkInfo_CType

RmkInfo_CType is a complex CType element.

Simple Elements

The following simple elements are contained within this complex.

Rmk
Application or user remarks free-form text.

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

ErrOvrRdInfoArray_AType

ErrOvrRdInfoArray_AType is an array AType element. This is an array of overrides for faults.

Contains:

  • ErrOvrRd_CType

ErrOvrRd_CType

ErrOvrRd_CType is a complex CType element. This element is used to override errors created in a previous request. This element is optional.

Simple Elements

The following simple elements are contained within this complex.

BusSvcType
The business service type used to convey certain Add and Mod message handling. The canonical value is NoValidate.
ErrCode
The error code.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request 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.

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.

CRMRmndModRs_MType

CRMRmndModRs_MType is a message MType element.

Contains:

  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

RsStat
The status of the response. Canonical values are:
  • Fail
  • Success

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

MsgRqHdr_CType

MsgRqHdr_CType is a complex CType element. This is the default message request 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.

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.

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 Tue Jan 24 2023