Notification Recipient Subscription Search
Notification Recipient Subscription Search is a jXchange service designed to provide ENS publishers with the ability to search recipient subscriptions of alerts that could be an alert to the recipient directly or an alert triggered by an event rule.
Message Flow
In jXchange, the Notification Recipient Subscription Search service uses a typical exchange
of MType
messages to allow ENS publishers to search those recipient
subscriptions of alerts.
Primary Request
The consumer forwards the NotRecipSubSrchRq_MType
message to the service
provider. The message contains the following simple elements:
- ConsmRecipAcctId
- ConsmRecipId
- ConsumerProd
- InstRtId
- RecipConId
Primary Response
The service provider returns the NotRecipSubSrchRs_MType
message to the
consumer. The message contains the following simple elements:
- ConsmRecipAcctId
- ConsumerProd
- InstRtId
- RecipConId
Notification Recipient Subscription Search Behavior
The Notification Recipient Subscription
Modification (NotRecipSubSrch
) operation behavior is as follows.
The Notification Recipient Subscription Search root request message
(NotRecipSubSrchRq_MType
) requires an Institution Routing Identification
(InstRtId) simple element. It includes optionally the Consumer
Product (ConsumerProd), Consumer Recipient Identification
(ConsmRecipId), First Name (FirstName), Last
Name (LastName), Common Name (ComName), and
Recipient Contact Identifier (RecipConId) simple elements. All
elements at the request have a ~and~ relationship and not a ~or~ relationship.
The root request includes optionally the Include Extended Element Array
(IncXtendElemArray_AType
).
The First Name (FirstName), Last Name (LastName), and Common Name (ComName) simple elements search type attribute is supported.
The Notification Recipient Subscription Search root response message
(NotRecipSubSrchRs_MType
) echoes back the request elements. The
Notification Recipient Subscription Search Record Array
(NotRecipSubSrchRecArray_AType
) returns the Consumer Product
(ConsumerProd), Consumer Recipient Identification
(ConsmRecipId), Consumer Recipient Account Identification
(ConsmRecipAcctId), and Recipient Subscription Status Type
(RecipSubStatType) simple elements and the Consumer Recipient Name
complex (ConsmRecipName_CType
).
NotRecipSubSrchRq_MType
NotRecipSubSrchRq_MType
is a
message MType
element.
Contains:
ConsmRecipName
referencesPersonName_CType
Custom_CType
IncXtendElem_AType
SrchMsgRqHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ConsmRecipAcctId
- The number or character that identifies an account record.
- ConsmRecipId
- The identifier assigned to a publisher's alert recipient.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- 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.
- RecipConId
- An identifier assigned to a recipient's alert contacts.
ConsmRecipName
PersonName_CType
is a complex CType
element. It contains name information. This complex is optional.
ConsmRecipName
references PersonName_CType
.
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.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
IncXtendElem_AType
IncXtendElem_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.
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
.
NotRecipSubSrchRs_MType
NotRecipSubSrchRs_MType
is a
message MType
element.
Contains:
ConsmRecipName
referencesPersonName_CType
Custom_CType
NotRecipSubSrchRecArray_AType
SrchMsgRsHdr_CType
Simple Elements
The following simple elements are contained within this message.
- ConsmRecipAcctId
- The number or character that identifies an account record.
- ConsmRecipId
- The identifier assigned to a publisher's alert recipient.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- 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.
- RecipConId
- An identifier assigned to a recipient's alert contacts.
ConsmRecipName
PersonName_CType
is a complex CType
element. It contains name information. This complex is optional.
ConsmRecipName
references PersonName_CType
.
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.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
NotRecipSubSrchRecArray_AType
NotRecipSubSrchRecArray_AType
is
an array AType
element. This is an array of responses for alert recipient
subscriptions search.
Contains:
NotRecipSubSrchRec_CType
NotRecipSubSrchRec_CType
NotRecipSubSrchRec_CType
is a
complex CType
element.
Contains:
ConsmRecipName
referencesPersonName_CType
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- ConsmRecipAcctId
- The number or character that identifies an account record.
- ConsmRecipId
- The identifier assigned to a publisher's alert recipient.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- RecipSubStatType
- The status as related to an alert recipient subscription. Canonical values are:
- Act
- InAct
- Test
The default value is Act.
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 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
.