Sertifi API Web Service
Method/testsite/Services/Gateway.asmx/SendNotificationMessage
Description
Send out notification emails.
Request (SendNotificationMessageSoapIn)

The request body is of type SendNotificationMessage.

Request Body Parameters

NameDescriptionData Type
p_APICodeThe API code of the site.  This can be found through your Sertifi web interface under Administration -> Account Settings.xml:string
messageThe info needed to send the notification.NotificationMessage
Value Element Name Element Sequence NameValuePair Element Sequence CustomTokens Element DocumentId Element PaymentId Element FileId Element NotificationType Element Name Element Email Element Sequence EmailAddress Element Sequence CC Element Name Element Email Element Sequence EmailAddress Element Sequence To Element Sequence message Element p_APICode Element Sequence SendNotificationMessage Element
Response (SendNotificationMessageSoapOut)

The response body is of type SendNotificationMessageResponse.

Response Body Parameters

NameDescriptionData Type
SendNotificationMessageResult NotificationResult
IsSuccessful Element ErrorMessage Element Sequence SendNotificationMessageResult Element Sequence SendNotificationMessageResponse Element
Example
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:ser="http://apps.sertifi.net/services/">
   <soap:Header/>
   <soap:Body>
      <ser:SendNotificationMessage>
         <ser:APICode>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</ser:APICode>
         <ser:Message>
            <ser:To>
               <!--Zero or more repetitions:-->
               <ser:EmailAddress>
                  <ser:Email>[email protected]</ser:Email>
                  <!--Optional:-->
                  <ser:Name>Default Name</ser:Name>
               </ser:EmailAddress>
            </ser:To>
            <!--Optional:-->
            <ser:CC>
               <!--Zero or more repetitions:-->
               <ser:EmailAddress>
                  <ser:Email>[email protected]</ser:Email>
                  <!--Optional:-->
                  <ser:Name>Default NameCC</ser:Name>
               </ser:EmailAddress>
            </ser:CC>
            <ser:NotificationType>PaymentCancellation</ser:NotificationType>
            <ser:FileId>.AQBolSYkhQDE5VZAU4YQK_Nk0</ser:FileId>
            <!--Optional:-->
            <ser:PaymentId>.AQCRvWg0NmOHV7iGglau0H760</ser:PaymentId>
            <!--Optional:-->
            <ser:DocumentId/>
            <!--Optional:-->
            <ser:CustomTokens>
               <!--Zero or more repetitions:-->
               <ser:NameValuePair>
                  <!--Optional:-->
                  <ser:Name>{Token}</ser:Name>
                  <!--Optional:-->
                  <ser:Value>Replacement</ser:Value>
               </ser:NameValuePair>
            </ser:CustomTokens>
         </ser:Message>
      </ser:SendNotificationMessage>
   </soap:Body>
</soap:Envelope>
See Also
All Operations Resource GroupSertifi API Web Service

 

 


© Sertifi, Inc., 2019 All Rights Reserved.

Send comments on this topic.