Customer Relationship Management Prospect Search
Customer Relationship Management Prospect Search is a jXchange service designed to provide a listing of CRM prospects.
Message Flow
In jXchange, the Customer Relationship Management Prospect Search service uses a typical
exchange of MType
messages to search for and provide a listing of CRM
prospects.
Primary Request
The third-party consumer forwards the CRMProspSrchRq_MType
message to the
service provider. The message contains
- CustType
- PhoneNum
- PostalCode
- SrchAddr
- SrchCity
- State
- TaxId
Primary Response
The service provider returns the CRMProspSrchRs_MType
message to the
third-party consumer. The message contains:
- CustType
- PhoneNum
- PostalCode
- SrchAddr
- SrchCity
- State
- TaxId
Customer Relationship Management Prospect Search Behavior
The Customer Relationship Management (CRM)
Prospect Search request message, CRMProspSrchRq_MType
, contains a documented
choice statement where the elements in the request are optional, but at least one of the
elements is required. The PersonName_CType
complex,
TaxId, SrchAddr,
SrchCity, State, and
PostalCode elements are available in the request message.
The CRMProspSrchRq_MType
request message includes the
CustType element to filter for business and personal.
The TaxId, FirstName, LastName, PhoneNum, SrchAddr, and SrchCity elements support a limited set of wild-card searches.
The TaxId element's Search attribute supports ~Exact~, ~StartsWith~, and ~EndsWith~. The default is ~Exact~.
The FirstName, LastName, SrchAddr, and SrchCity elements' Search attribute supports ~Exact~, ~StartsWith~, ~EndsWith~, and ~Contains~. The default is ~Exact~.
The PhoneNum element's Search attribute supports ~Exact~, ~EndsWith~, and ~Contains~. The default is ~Exact~.
The Customer Relationship Management (CRM) Prospect Search response message,
CRMProspectSrchRs_MType
, echoes the requested elements.
The CRMProspSrchArray_AType
array returns all the items related to the CRM
search requested documented choices.
The service provider cannot apply user accessibility policies when the consumer does not include the end-user credentials.
The CRMProspId element can be cached to be used for CRM Prospect Inquiry service to obtain the details as related to the prospect.
CRMProspSrchRq_MType
CRMProspSrchRq_MType
is a message
MType
element.
Contains:
Custom_CType
PersonName_CType
SrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CRMOffCode
- The code assigned to the CRM officer. This element is Open
Enumerated to allow for display of a listing of all officer values. 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
- CustType
- The customer type.
- PhoneNum
- The phone number.
- PostalCode
- The postal code or ZIP code.
- SrchAddr
- The street address for a search.
- SrchCity
- The city for a search.
- State
- Corresponding abbreviation for the state.
- TaxId
- The tax identifier. It includes the
MaskVal
,Rstr
, andSrchType
attributes.
Custom_CType
Custom_CType
is a complex CType
element.
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.
- 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.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 credentialsAuthenUsrCred_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 byWS-Security
.
CRMProspSrchRs_MType
CRMProspSrchRs_MType
is a message
MType
element.
Contains:
CRMProspSrchArray_AType
Custom_CType
PersonName_CType
SrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- CRMOffCode
- The code assigned to the CRM officer. This element is Open
Enumerated to allow for display of a listing of all officer values. 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
- CustType
- The customer type.
- PhoneNum
- The phone number.
- PostalCode
- The postal code or ZIP code.
- SrchAddr
- The street address for a search.
- SrchCity
- The city for a search.
- State
- Corresponding abbreviation for the state.
- TaxId
- The tax identifier. It includes the
MaskVal
,Rstr
, andSrchType
attributes.
CRMProspSrchArray_AType
CRMProspSrchArray_AType
is an array AType
element. This is an array of responses for the
Customer Relationship Management prospects search.
Contains:
CRMProspSrchRec_CType
CRMProspSrchRec_CType
CRMProspSrchRec_CType
is a complex
CType
element.
Contains:
Addr_CType
CRMProspSrchCustom
referencesCustom_CType
PersonName_CType
PhoneArray_AType
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. 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
- CRMProspId
- The identification assigned to a CRM prospect.
- CustType
- The customer type.
- TaxId
- The tax identifier. It includes the
MaskVal
,Rstr
, andSrchType
attributes.
Addr_CType
Addr_CType
is a complex
CType
element containing address information. This element
is optional.
Contains:
FreeFormAddr_AType
Simple Elements
The following simple elements are contained within this complex.
- BusAddr
- Answers the question: Is this a business address? Y states it is a business address.
- City
- The city name.
- Cntry
- The country name.
- CntryType
- The country abbreviation from ISO 3166.
- County
- The county name.
- DlvryPt
- The delivery point added to the zip.
- FornAddr
- Is this a foreign address? Where Y states it is a foreign address.
- InvAddr
- Is this address invalid? Y states mail has been returned from this address.
- PostalCode
- The postal code or ZIP code.
- StateCode
- The 2 alpha long code which represents a state. For example, MO.
- StateProv
- The state or province or region.
- StreetAddr1
- The street address.
- StreetAddr2
- The second line of street address.
- StreetAddr3
- The third line of street address.
FreeFormAddr_AType
FreeFormAddr_AType
is an array AType
element. This is
an array of free form address lines 1–11 in a printable/usable form.
Contains:
AddrLineInfo_CType
AddrLineInfo_CType
AddrLineInfo_CType
is a complex
CType
element.
Simple Elements
The following simple elements are contained within this complex.
- AddrLine
- Free form element of address lines 1 - 11 in a printable/usable form, generally not separated.
CRMProspSrchCustom
Custom_CType
is a complex CType
element.
CRMProspSrchCustom
references
Customer_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.
- 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.
PhoneArray_AType
PhoneArray_AType
is an array AType
element. This array contains one or more PhoneInfo_CType
complexes to define phone contact information. This array is
optional.
Contains:
PhoneInfo_CType
PhoneInfo_CType
PhoneInfo_CType
is a complex CType
element. It contains basic phone contact information. This complex is optional.
MobPhoneInfo_CType
Simple Elements
The following simple elements are contained within this complex.
- ConEndTime
- The Greenwich Mean time when contact availability ends.
- ConStartTime
- The Greenwich Mean time when contact availability starts.
- PhoneExt
- The phone extension.
- PhoneNum
- The phone number.
- PhoneTime
- Best phone usage time, day, or evening.
- PhoneType
- Phone type examples are: home, work, fax, cell.
Custom_CType
Custom_CType
is a complex CType
element.
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.
- 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.
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 HeaderMsgRqHdr_CType
. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_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 credentialsAuthenUsrCred_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 byWS-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.