Developer Resources

Enterprise SOAP API > API by Reference > Notification Services > Notification Recipient Inquiry > Developer Resources

Details

SoapAction	http://jackhenry.com/ws/NotRecipInq
Input Name	NotRecipInq
Output Name	NotRecipInqResponse
Input Namespace	http://jackhenry.com/jxchange/TPG/2008
Group Name	ENS
Container	TPG_ENSMaster.xsd

XML Examples

ENS_API_NotificationRecipientInquiryErrors

Error Code	Message
2001	The message request header is required.
2002	The audit workstation ID is required.
2003	The consumer product is required.
2016	The institution routing identifier is required.
2021	The audit user ID is required.
2205	The unique identifier is required.
2401	The valid consumer name is required.
2505	Access was denied. This error can be triggered by multiple events: Invalid ValidConsmName Invalid ValidConsmProd Invalid InstRtId for ENS Invalid AlrtRecipId Invalid ConsmProd ValidConsmProd does not match ConsumerProd in the Body
2700	The business correlation ID is required.
3104	Newer information is available.
3129	At a minimum, you must have at least one entry in the RecipOptInInfoRec.

NotRecipInqAlrtXml


<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <SOAP-ENV:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" 
            xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
                <wsse:Username>{Insert}</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
                <wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2019-12-04T20:30:44Z</wsu:Created>
            </wsse:UsernameToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <NotRecipInq xmlns="http://jackhenry.com/jxchange/TPG/2008">
            <MsgRqHdr>
                <jXchangeHdr>
                    <JxVer/>
                    <AuditUsrId>{Insert}</AuditUsrId>
                    <AuditWsId>{Insert}</AuditWsId>
                    <AuthenUsrId/>
                    <ConsumerName/>
                    <ConsumerProd/>
                    <Ver_1/>
                    <jXLogTrackingId>122222222</jXLogTrackingId>
                    <Ver_2/>
                    <InstRtId JHANull="" Rstr="">003003003</InstRtId>
                    <InstEnv>PROD</InstEnv>
                    <Ver_3/>
                    <BusCorrelId/>
                    <Ver_4/>
                    <WorkflowCorrelId/>
                    <Ver_5/>
                    <ValidConsmName>{Insert}</ValidConsmName>
                    <ValidConsmProd>{Insert}</ValidConsmProd>
                    <Ver_6/>
                </jXchangeHdr>
                <Ver_1/>
                <Ver_2/>
                <Ver_3/>
            </MsgRqHdr>
            <InstRtId>003003003</InstRtId>
            <AlrtRecipId>003decaa-35c2-4bcf-a10c-cbb4c5dbc011</AlrtRecipId>
            <ConsumerProd></ConsumerProd>
            <ConsmRecipId></ConsmRecipId>
            <ActIntent/>
            <IncXtendElemArray>
                <IncXtendElemInfo>
                    <XtendElem/>
                    <Ver_1/>
                </IncXtendElemInfo>
            </IncXtendElemArray>
            <Custom/>
            <Ver_1/>
        </NotRecipInq>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

NotRecipInqConsmXml


<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" 
    xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <SOAP-ENV:Header>
        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" 
            xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:UsernameToken xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
                <wsse:Username>{Insert}</wsse:Username>
                <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">{Insert}</wsse:Password>
                <wsu:Created xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">2019-12-04T20:30:44Z</wsu:Created>
            </wsse:UsernameToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <NotRecipInq xmlns="http://jackhenry.com/jxchange/TPG/2008">
            <MsgRqHdr>
                <jXchangeHdr>
                    <JxVer/>
                    <AuditUsrId>{Insert}</AuditUsrId>
                    <AuditWsId>{Insert}</AuditWsId>
                    <AuthenUsrId/>
                    <ConsumerName/>
                    <ConsumerProd/>
                    <Ver_1/>
                    <jXLogTrackingId>122222222</jXLogTrackingId>
                    <Ver_2/>
                    <InstRtId>003003003</InstRtId>
                    <InstEnv>PROD</InstEnv>
                    <Ver_3/>
                    <BusCorrelId/>
                    <Ver_4/>
                    <WorkflowCorrelId/>
                    <Ver_5/>
                    <ValidConsmName>{Insert}</ValidConsmName>
                    <ValidConsmProd>{Insert}</ValidConsmProd>
                    <Ver_6/>
                </jXchangeHdr>
                <Ver_1/>
                <Ver_2/>
                <Ver_3/>
            </MsgRqHdr>
            <InstRtId>003003003</InstRtId>
            <AlrtRecipId></AlrtRecipId>
            <ConsumerProd>PersistentStorage</ConsumerProd>
            <ConsmRecipId>GRoney</ConsmRecipId>
            <ActIntent/>
            <IncXtendElemArray>
                <IncXtendElemInfo>
                    <XtendElem/>
                    <Ver_1/>
                </IncXtendElemInfo>
            </IncXtendElemArray>
            <Custom/>
            <Ver_1/>
        </NotRecipInq>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Flow Chart

ENS_API_NotRecipInq_Flowchart

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 Nov 15 2022