Developer Resources

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

Details

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

XML Examples

ENS_API_NotificationRecipientAdditionErrors

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.
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 ValidConsmProd does not match ConsumerProd in the Body
2700	The business correlation ID is required.
3100	The proposed addition failed because index combination already exists.
3103	This field is required and cannot be null.
3129	At a minimum, you must have at least one entry in the RecipOptInInfoRec.
3130	The ConsumerProd specified in the RecipOptInInfoRec is invalid.
3131	Warning: Contact Information was duplicated, only one contact was added.

NotRecipAddXML


<?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-04T16:18:13Z</wsu:Created>
            </wsse:UsernameToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <NotRecipAdd 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/>
                    <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>
            <ConsumerProd>PersistentStorage</ConsumerProd>
            <ConsmRecipId>RemyWillis</ConsmRecipId>
            <AlrtRecipInfoRec>
                <ConsmRecipStatType>Act</ConsmRecipStatType>
                <ConsmRecipName>
                    <ComName>Remy Willis</ComName>
                    <x_PersonName>
                        <TitlePrefix/>
                        <NameSuffix/>
                        <LegalName/>
                        <SalName/>
                        <Ver_1/>
                        <AbbName/>
                        <Ver_2/>
                    </x_PersonName>
                    <SvcPrvdInfo/>
                    <Ver_1/>
                </ConsmRecipName>
                <RecipConArray>
                    <RecipConInfoRec>
                        <RecipConId/>
                        <RecipConType>EmailHTML</RecipConType>
                        <RecipConName>WorkEmail</RecipConName>
                        <RecipCon>remy.willis@jerico.com</RecipCon>
                        <MobPrvdCode/>
                        <RecipOptInArray>
                            <RecipOptInInfoRec>
                                <ConsumerProd>PersistentStorage</ConsumerProd>
                                <RecipConOptInType>All</RecipConOptInType>
                                <Custom/>
                                <Ver_1/>
                            </RecipOptInInfoRec>
                        </RecipOptInArray>
                        <Custom/>
                        <Ver_1/>
                    </RecipConInfoRec>
                </RecipConArray>
                <Custom/>
                <Ver_1/>
            </AlrtRecipInfoRec>
            <Custom/>
            <Ver_1/>
        </NotRecipAdd>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

FAQ

NotRecipAddFAQ

Flow Chart

ENS_API_NotRecipAdd_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 Wed Sep 7 2022