Notification Recipient Subscription Inquiry
Notification Recipient Subscription Inquiry is a jXchange service designed to provide ENS publishers with the ability to inquire on the individual recipients for those who should receive alerts deployed for their institutions.
Message Flow
In jXchange, the Notification Recipient Subscription Inquiry service uses a typical
exchange of MType
messages to allow ENS publishers to inquire on the
individual recipients of those who should receive alerts from their institution.
Primary Request
The consumer forwards the NotRecipSubInqRq_MType
message to the service
provider. The message contains the following simple elements:
- ActIntent
- ConsmRecipAcctId
- ConsmRecipId
- ConsumerProd
- InstRtId
Primary Response
The service provider returns the NotRecipSubInq_MType
message to the
consumer. The message contains the following simple elements:
- ActIntent
- ActIntentKey
- ConsmRecipAcctId
- ConsmRecipId
- InstRtId
Notification Recipient Subscription Inquiry Behavior
The following is the behavior for the Notification Recipient Subscription Inquiry service.
The Notification Recipient Subscription Inquiry request message
(NotRecipSubInqRq_MType
) requires the Institution Routing Identification
(InstRtId), Consumer Product (ConsumerProd),
and Consumer Recipient Identification (ConsmRecipId) simple elements.
The Consumer Recipient Account Identification (ConsmRecipAcctId)
element as related to the Consumer Recipient Identification
(ConsmRecipId) can be optionally included in the request.
The root request includes optionally the Include Extended Element Array
(IncXtendElemArray_AType
).
The Activity Intent (ActIntent) simple element's default canonical value is ~ReadOnly~. The canonical values ~Upd~ or ~Dlt~ require the service provider to return the Activity Intention Key (ActIntentKey) simple element used for subsequent modification service with the adopted concurrency model.
The Notification Recipient Subscription Inquiry root response message
(NotRecipSubInqRs_MType
) returns consumer recipient subscription
information as related to the data values in the request. The Institution Routing
Identification (InstRtId), Consumer Product
(ConsumerProd), Consumer Recipient Identification
(ConsmRecipId), and Consumer Recipient Account Identification
(ConsmRecipAcctId) simple elements are echoed back values from the
request.
The standard Inquiry message tenets are applicable.
Adhere to the tenets for fault reporting.
Adhere to the tenets related to the correlation identifications.
NotRecipSubInqRq_MType
NotRecipSubInqRq_MType
is a
message MType
element.
Contains:
Custom_CType
IncXtendElem_AType
MsgRqHdr_CType
Simple Elements
The following simple elements are 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.
- 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.
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.
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 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
.
NotRecipSubInqRs_MType
NotRecipSubInqRq_MType
is a
message MType
element.
Contains:
Custom_CType
MsgRsHdr_CType
NotRecipSubInqRec_CType
Simple Elements
The following simple elements are 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.
- ConsmRecipAcctId
- The number or character that identifies an account record.
- ConsmRecipId
- The identifier assigned to a publisher's alert recipient.
- 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.
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 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
.
NotRecipSubInqRec_CType
NotRecipSubInqRec_CType
is a
complex CType
element.
Contains:
AlrtRecipSubInfoRec_CType
ConsmRecipName
referencesPersonName_CType
Custom_CType
Simple Elements
The following simple elements are contained within this complex.
- AlrtRecipId
- An identifier assigned to an alert recipient.
- SMSubId
- The SMS subject identification.
AlrtRecipSubInfoRec_CType
AlrtRecipSubInfoRec_CType
is a
complex CType
element.
Contains:
Custom_CType
AlrtArray_AType
Simple Elements
The following simple elements are contained within this complex.
- RecipSubStatType
- The status as related to an alert recipient subscription. Canonical values are:
- Act
- InAct
- Test
The default value is Act.
- RecipSubUTCOffset
- The UTC offset as related to the alert recipient's subscription. For example, -6 = CST and -5 = EST. Review http://en.wikipedia.org/wiki/List_of_UTC_time_offsets for all UTC offsets.
Custom_CType
Custom_CType
is a complex CType
element.
This element is optional.
AlrtArray_AType
AlrtArray_AType
is an array
AType
element. This is an array of alerts.
Contains:
AlrtInfoRec_CType
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.