Developer Resources

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

Details

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

XML Examples

ENS_API_NotificationRecipientModificationErrors

Error Code	Message
2001	The message request header is required.
2002	The audit workstation ID is required.
2003	The consumer product is required.
2005	Value does not match defined list of enumerations.
2016	The institution routing identifier is required.
2017	Invalid value based on data type.
2021	The audit user ID 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 AlrtRecipId Empty Invalid ConsmRecipId Invalid ConsumerProd ConsmReciId not found in the database Invalid RecipConId RecipConId not found in the database
2700	The business correlation ID is required.
3101	Proposed modification failed because no match was found.
3102	Specified recipient exists for other publisher.
3103	This field is required and cannot be null.
3104	Newer information is available.
3105	No key specified.
3107	ConsumerProduct does not exist for this recipient.
3108	Request contains multiple contact points with the same recipient contact.
3129	At a minimum, you must have at least one entry in the RecipOptInInfoRec.
3130	The ConsumerProd specified in the RecipOptInInfoRec is invalid.
3132	Warning: Contact information already exists.

NotRecipModXML

<?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:58:26Z</wsu:Created>
            </wsse:UsernameToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <NotRecipMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
            <MsgRqHdr>
                <jXchangeHdr>
                    <JxVer/>
                    <AuditUsrId></AuditUsrId>
                    <AuditWsId></AuditWsId>
                    <AuthenUsrId/>
                    <ConsumerName/>
                    <ConsumerProd/>
                    <Ver_1/>
                    <jXLogTrackingId>122222222</jXLogTrackingId>
                    <Ver_2/>
                    <InstRtId>003003003</InstRtId>
                    <InstEnv>PROD</InstEnv>
                    <Ver_3/>
                    <BusCorrelId>6b54f933-1215-48d8-9856-fba0c6790bb6</BusCorrelId>
                    <Ver_4/>
                    <WorkflowCorrelId/>
                    <Ver_5/>
                    <ValidConsmName>{Insert}</ValidConsmName>
                    <ValidConsmProd>{Insert}</ValidConsmProd>
                    <Ver_6/>
                </jXchangeHdr>
                <Ver_1/>
                <Ver_2/>
                <Ver_3/>
            </MsgRqHdr>
            <ErrOvrRdInfoArray>
                <ErrOvrRd>
                    <ErrCode/>
                    <Ver_1/>
                </ErrOvrRd>
            </ErrOvrRdInfoArray>
            <InstRtId>003003003</InstRtId>
            <AlrtRecipId>59274dff-c722-4a6b-b77c-0d29d013708c</AlrtRecipId>
            <ConsumerProd>PersistentStorage</ConsumerProd>
            <ConsmRecipId>RemyWillis</ConsmRecipId>
            <AlrtRecipInfoRec>
                <ConsmRecipStatType JHANull="" Rstr=""/>
                <ConsmRecipName>
                    <ComName/>
                    <FirstName/>
                    <MiddleName>Andrew</MiddleName>
                    <LastName/>
                    <SvcPrvdInfo/>
                    <Ver_1/>
                </ConsmRecipName>
                <Custom/>
                <Ver_1/>
            </AlrtRecipInfoRec>
            <Dlt/>
            <ActIntentKey>AAAAAAAVJKI=</ActIntentKey>
            <Custom/>
            <Ver_1/>
        </NotRecipMod>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

NotRecipModXmlRecipCon

<?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:58:26Z</wsu:Created>
            </wsse:UsernameToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <NotRecipMod xmlns="http://jackhenry.com/jxchange/TPG/2008">
            <MsgRqHdr>
                <jXchangeHdr>
                    <JxVer/>
                    <AuditUsrId></AuditUsrId>
                    <AuditWsId></AuditWsId>
                    <AuthenUsrId/>
                    <ConsumerName/>
                    <ConsumerProd/>
                    <Ver_1/>
                    <jXLogTrackingId>122222222</jXLogTrackingId>
                    <Ver_2/>
                    <InstRtId>003003003</InstRtId>
                    <InstEnv>PROD</InstEnv>
                    <Ver_3/>
                    <BusCorrelId>6b54f933-1215-48d8-9856-fba0c6790bb6</BusCorrelId>
                    <Ver_4/>
                    <WorkflowCorrelId/>
                    <Ver_5/>
                    <ValidConsmName>{Insert}</ValidConsmName>
                    <ValidConsmProd>{Insert}</ValidConsmProd>
                    <Ver_6/>
                </jXchangeHdr>
                <Ver_1/>
                <Ver_2/>
                <Ver_3/>
            </MsgRqHdr>
            <ErrOvrRdInfoArray/>
            <InstRtId>003003003</InstRtId>
            <AlrtRecipId>08b8c836-c8fb-4030-bb44-49d04af48688</AlrtRecipId>
            <ConsumerProd>PersistentStorage</ConsumerProd>
            <ConsmRecipId>Rick</ConsmRecipId>
            <AlrtRecipInfoRec>
                <ConsmRecipStatType/>
                <ConsmRecipName>
                    <ComName/>
                    <FirstName/>
                    <MiddleName></MiddleName>
                    <LastName/>
                    <SvcPrvdInfo/>
                    <Ver_1/>
                </ConsmRecipName>
                <RecipConArray>
                    <RecipConInfoRec>
                        <RecipConId/>
                        <RecipConType>SMSNative</RecipConType>
                        <RecipConName>Rick's Cell Phone</RecipConName>
                        <RecipCon>4792533266</RecipCon>
                        <MobPrvdCode/>
                        <RecipOptInArray>
                            <RecipOptInInfoRec>
                                <ConsumerProd>PersistentStorage</ConsumerProd>
                                <RecipConOptInType>All</RecipConOptInType>
                                <Custom/>
                                <Ver_1/>
                            </RecipOptInInfoRec>
                        </RecipOptInArray>
                        <Custom/>
                        <Ver_1/>
                    </RecipConInfoRec>
                </RecipConArray>
                <Custom/>
                <Ver_1/>
            </AlrtRecipInfoRec>
            <Dlt/>
            <ActIntentKey>AAAAAAAVewU=</ActIntentKey>
            <Custom/>
            <Ver_1/>
        </NotRecipMod>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Flow Chart

ENS_API_NotRecipMod_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 Thu Jun 30 2022