AssureSign: ResendNotification

  • 11 January 2022
  • 0 replies
  • 48 views

Userlevel 5
Badge +19

The ResendNotification operation can be used to re-send an email notification, a web notification or a document transmission that has already been attempted or completed for a document or envelope.

The ResendNotification operation requires knowledge of the following:

  • the Document ID of the document to which the notification belongs (this is returned as an element in the returned XML from a document submit operation)
  • the AssureSign account ContextIdentifier (this is exposed in the AssureSign administrative application account settings and serves to provide some security to the transaction)
  • the AuthToken of the document (this is returned as an element in the returned XML from a document submit operation)
  • the Notification ID which can be obtained via a ListNotifications call

OR

  • the Envelope ID of the envelope to which the notification belongs (this is returned as an element in the returned XML from an envelope creation operation)
  • the AssureSign account ContextIdentifier (this is exposed in the AssureSign administrative application account settings and serves to provide some security to the transaction)
  • the AuthToken of the envelope (this is returned as an element in the returned XML froman envelope creation operation)
  • the Notification ID which can be obtained via a ListNotifications call

 

Sample XML

<?xml version="1.0" encoding="utf-8"?> 
<ResendNotification xmlns="https://www.assuresign.net/Services/DocumentNOW/ResendNotification">
<ResendRequests>
<ResendNotificationRequest ContextIdentifier="06C4A84A-693C-46CB-8DF2-40A8215AA056" Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" AuthToken="8CC9A84B-693C-46CC-4342-40A8215AD76A">
<EmailNotification NotificationId="53f0942c-8167-4204-9437-095be7e1d263">
<Recipients>
<EmailNotificationRecipient EmailAddress="john.doe@assuresign.com"/>
</Recipients>
</EmailNotification>
</ResendNotificationRequest>
<ResendNotificationRequest ContextIdentifier="06C4A84A-693C-46CB-8DF2-40A8215AA056" Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" AuthToken="8CC9A84B-693C-46CC-4342-40A8215AD76A">
<SmsNotification NotificationId="
eff1c659-6af5-49c7-9160-a7210130e5d8"> <Recipients> <SmsNotificationRecipient MobilePhone="3215556789"/> </Recipients> </SmsNotification> </ResendNotificationRequest> <ResendNotificationRequest ContextIdentifier="06C4A84A-693C-46CB-8DF2-40A8215AA056" Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" AuthToken="8CC9A84B-693C-46CC-4342-40A8215AD76A">
<WebNotification NotificationId="3180c5a5-a6d9-440d-8073-08bd301ee2d0"/>
</ResendNotificationRequest>
<ResendNotificationRequest ContextIdentifier="06C4A84A-693C-46CB-8DF2-40A8215AA056" Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" AuthToken="8CC9A84B-693C-46CC-4342-40A8215AD76A">
<DocumentTransmission NotificationId="19d4e5f9-8e31-40fe-9067-4a8dd4d7645e" />
</ResendNotificationRequest>
</ResendRequests>
</ResendNotification>

The SOAP Action header is

https://www.assuresign.net/Services/DocumentNOW/ResendNotification/IResendNotificationService/ResendNotification

The result returned will contain a status for the resend operation for each notification:

<?xml version="1.0" encoding="utf-8"?> 
<ResendNotificationResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/LookupSession">
<ResendResults>
<ResendNotificationResult Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" NotificationId="53f0942c-8167-4204-9437-095be7e1d263" Success="true"/>
<ResendNotificationResult Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" NotificationId="eff1c659-6af5-49c7-9160-a7210130e5d8" Success="true"/>
<ResendNotificationResult Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" NotificationId="3180c5a5-a6d9-440d-8073-08bd301ee2d0" Success="true"/>
<ResendNotificationResult Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" NotificationId="19d4e5f9-8e31-40fe-9067-4a8dd4d7645e" Success="true"/>
</ResendResults>
</ResendNotificationResponse>

The ResendNotificationResult should be checked for the presence of an Exceptions element, which may contain multiple ResendNotificationException items.


0 replies

Be the first to reply!

Reply