Skip to navigation

GetConnectFailures

View as Markdown

GetConnectFailures retrieves a list of Connect post failures for the account and date range specified.

Schema

Sample request XML
SOAPAction: "http://www.docusign.net/API/3.0/GetConnectFailures"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<GetConnectFailures xmlns="http://www.docusign.net/API/3.0">
<ConnectFailuresFilter>
<AccountId>string</AccountId>
<DateFrom>dateTime</DateFrom>
<DateTo>dateTime</DateTo>
</ConnectFailuresFilter>
</GetConnectFailures>
</soap:Body>
</soap:Envelope>
NameSchema TypeDescription
AccountIdStringThe account ID for the requested Connect post failures.
DateFromdateTimeThe start date and time for the Connect post failures search.
DateTodateTimeThe end date and time for the Connect post failures search.

This method returns GetConnectFailureResults with an array of ConnectFailures. Each ConnectFailure instance has the elements shown below.

NameSchema TypeDescription
EnvelopeIdStringThe envelope ID of the envelope status that failed to post.
AccountIdStringThe account ID associated with the envelope.
FaileddateTimeThe date and time the original Connect post failed.
RetrieddateTimeThe date and time the last attempt to post.
RetryCountIntegerThe number of times the Connect post has been retried.
EnvelopeStatusThe new envelope status for the failed Connect post. The possible values are: Any, Voided, Created, Deleted, Sent, Delivered, Signed, Completed, Declined, TimedOut, Template, or Processing
SenderStringThe name of the envelope sender.
EmailStringThe email that sent the envelope.
SubjectStringThe envelope subject.
ErrorStringThe error that caused the Connect post to fail.
ConfigIdStringThe identifier for the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to to look up the Connect configuration for the failed post.
ConfigUrlStringThe web address of the listener or Retrieving Service end point for Connect.