Developer Resources

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

Details

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

XML Examples

ENS_API_NotificationSendAdditionErrors

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.
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 ValidConsmProd does not match ConsumerProd in the Body
2700	The business correlation ID is required.
3103	This field is required and cannot be null.
3114	The alert send information record is required.
3116	Format is invalid.
3117	The send alert array is required.
3118	At a minimum, you must have at least one entry in the SndAlrtArray.
3119	Specifying a Consumer Recipient Account ID requires specifying a Consumer Recipient Id.
3120	The Coordinated Universal Time (UTC) Date Time is invalid.
3121	The specified alert name is not valid for the applicable publisher library for the institution.
3122	The AlrtInfoRec requires an initialized SndEvrySub element or at least one valid record in the SndAlrtArray Array.
3123	You must provide either ConsmRecipId or DistGroupId in the SndAlrtRec.
3124	PubVer not valid for this institution/publisher combination.
3125	You cannot provide both ConsmRecipId and DistGroupId in a single SndAlrtRec.
3126	The specified institution has no deployed publisher libraries for the specified publisher.
3127	When specifying to send to every subscriber, you may not include recipients in the SndAlrtArray.
3128	Out of Range (limited to 512 characters).

NotSndAddXML

<?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-11T20:51:13Z</wsu:Created>
            </wsse:UsernameToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <NotSndAdd 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/>
            <InstRtId>003003003</InstRtId>
            <ConsumerProd>PersistentStorage</ConsumerProd>
            <AlrtName SrchType="">CustomSubject_v1</AlrtName>
            <AlrtSndInfoRec>
                <SndEvrySub>false</SndEvrySub>
                <SndAlrtArray>
                    <SndAlrtRec>
                        <ConsmRecipId>Rex</ConsmRecipId>
                        <ConsmRecipAcctId SrchType=""/>
                        <DistGroupId/>
                        <Custom/>
                        <Ver_1/>
                        <RecipConId/>
                        <Ver_2/>
                    </SndAlrtRec>
                </SndAlrtArray>
                <AlrtDataInfoArray>
                    <AlrtDataInfoRec>
                        <Name>EmailBody</Name>
                        <Val>Just a stroll in the park.</Val>
                        <Custom/>
                        <Ver_1/>
                    </AlrtDataInfoRec>
                    <AlrtDataInfoRec>
                        <Name>EmailSubject</Name>
                        <Val>Just saying hi.</Val>
                        <Custom/>
                        <Ver_1/>
                    </AlrtDataInfoRec>
                </AlrtDataInfoArray>
                <Custom/>
                <Ver_1/>
            </AlrtSndInfoRec>
            <PubVer/>
            <AlrtTestType/>
            <Custom/>
            <Ver_1/>
        </NotSndAdd>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Flow Chart

ENS_API_SendAlerts1_Flowchart

ENS_API_SendAlerts2_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