Enterprise Solutions

CRM Client Related Data Inquiry

Enterprise SOAP API > API by Reference > Customer Relationship Management > CRM Client Related Data Inquiry
CRM Client Related Data Inquiry

CRM Client Related Data Inquiry

CRM Client Related Data Inquiry is a jXchange service designed to expose CRM extended client information, client interests, and client demographics to consumers.

Message Flow

In jXchange, the CRM Client Related Data Inquiry service uses a typical exchange of MType messages to expose CRM extended client information, client interests, and client demographics to consumers.

Primary Request

The consumer forwards the CRMClientRelDataInqRq_MType message to the service provider.

The message contains the following simple element:

  • ActIntent

The message contains the following complex elements:

  • CRMClientId_CType
  • Custom_CType
  • MsgRqHdr_CType

The message contains the following array:

  • IncXtendElemArray_AType

Primary Response

The service provider returns the CRMClientRelDataInqRs_MType message to the consumer.

The message contains the following simple elements:

  • ActIntent
  • ActIntentKey

The message contains the following complex elements:

  • ClientRelDataInqRec_CType
  • CRMClientId_CType
  • Custom_CType
  • MsgRsHdr_CType

CRM Client Related Data Inquiry Behavior

CRM Client Related Data Inquiry is a jXchange service designed to expose CRM extended client information, client interests, and client demographics to consumers.

The CRM Client Related Data Inquiry service behavior is as follows.

The CRMClientId_CType required in the CRM Client Related Data Inquiry root request is returned in the following response messages:

  • CRM Prospect Search Response (CRMProspSrchRs_MType)
  • CRM Customer Search Response (CRMCustSrchRs_MType)

CRMClientRelDataInqRq_MType

CRMClientRelDataInqRq_MType is a message MType element.

Contains:

  • CRMClientId_CType
  • Custom_CType
  • IncXtendElemArray_AType
  • MsgRqHdr_CType

Simple Elements

The following simple element is 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.

CRMClientId_CType

CRMClientId_CType is a complex CType element.

Contains:

  • Custom_CType

Simple Elements

The following simple elements are contained within this message.

CRMClientId
The identifier attached to a CRM client.
CRMClientIdType
Identifies the type of CRM client. Canonical values are:
  • Exst
  • Pot

The default value is Exst.

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.

IncXtendElemArray_AType

IncXtendElemArray_AType is an array AType element. This is an array that lists x_ elements by name, which are to be included in the response.

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

CRMClientRelDataInqRs_MType

CRMClientRelDataInqRs_MType is a message MType element.

Contains:

  • ClientRelDataInqRec_CType
  • CRMClientId_CType
  • Custom_CType
  • MsgRsHdr_CType

Simple Elements

The following simple element is 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.

ClientRelDataInqRec_CType

ClientRelDataInqRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • x_ClientDemogrArray references ClientDemogrArray_AType
  • x_ClientIntArray references ClientIntArray_AType
  • x_XtendInfoArray references XtendInfoArray_AType

Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_ClientDemogrArray

ClientDemogrArray_AType is an array AType element. Client demographics. This array is inquire-only, never editable.

x_ClientDemogrArray references ClientDemogrArray_AType.

Contains:

  • ClientDemogrInfo_CType
ClientDemogrInfo_CType

ClientDemogrInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this complex.

ClientDemogrDesc
The name of a name value pair.
ClientDemogrName
Application or user remarks free-form text.
ClientDemogrVal
The value of a name value pair.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_ClientIntArray

ClientIntArray_AType is an array AType element. This array contains client interests to follow up on.

x_ClientIntArray references ClientIntArray_AType.

Contains:

  • ClientIntInfo_CType
ClientIntInfo_CType

ClientIntInfo_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this message.

ClientIntCode
The code that relates information about the client interests within the array (the element identifier).
ClientIntModTimeDt
The date/time stamp a record was modified.
ClientIntName
Application or user remarks free-form text.
ClientIntType

Client interests. Canonical values are:

  • Int - Interested
  • Decline - Declined
  • N/A - Not Applicable
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 values are:
  • CurUsr
  • OvrrdInstRtId
CRMOffDesc
The description of the code assigned to the CRM officer.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

x_XtendInfoArray

XtendInfoArray_AType is an array AType element. This array contains additional informations pecific to each client by category.

x_XtendInfoArray references XtendInfoArray_AType.

Contains:

  • XtendInfoRec_CType
XtendInfoRec_CType

XtendInfoRec_CType is a complex CType element.

Contains:

  • Custom_CType
  • XtendInfoDetailArray_AType
Simple Elements

The following simple element is contained within this complex.

XtendInfoCatDesc
The Description of the Extended Information Category Code.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

XtendInfoDetailArray_AType

XtendInfoDetailArray_AType is an array AType element. This array contains client information related to an extended information category.

Contains:

  • XtendInfoDetailRec_CType
XtendInfoDetailRec_CType

XtendInfoDetailRec_CType is a complex CType element.

Contains:

  • Custom_CType
Simple Elements

The following simple elements are contained within this message.

ClientInfoReqCode
The client information request code (the element identifier).
ClientInfoReqDeclineType
Was the client information request denied? Canonical values are:
  • true
  • false
ClientInfoReqDesc
The name of a name value pair.
ClientInfoReqModTimeDt
The date/time stamp a record was modified.
ClientInfoReqName
Application or user remarks free-form text.
ClientInfoReqVal
The value of a name value pair.
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 values are:
  • CurUsr
  • OvrrdInstRtId
CRMOffDesc
The description of the code assigned to the CRM officer.
Custom_CType

Custom_CType is a complex CType element.

This element is optional.

CRMClientId_CType

CRMClientId_CType is a complex CType element.

Contains:

  • Custom_CType

Simple Elements

The following simple elements are contained within this message.

CRMClientId
The identifier attached to a CRM client.
CRMClientIdType
Identifies the type of CRM client. Canonical values are:
  • Exst
  • Pot

The default value is Exst.

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_CType
  • MsgRecInfoArray_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_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 Mon Jan 24 2022