ConnectEvents: listFailures

Retrieves the Connect failure log information. You can use this log to determine which envelopes failed to post, in order to create a republish request.

Request

HTTP request

GET /v2.1/accounts/{accountId}/connect/failures

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Optional Query Parameters
from_datestring

The start date for a date range in UTC DateTime format.

Note: If this property is null, no date filtering is applied.

to_datestring

The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned.

Note: If this property is null, the value defaults to the current date.

Responses

CodeDescriptionReference
200

Successful response.

ConnectEvents
400

Error encountered.

errorDetails

SDK Method

Connect::listEventFailureLogs

Definitions

connectDebugLog

connectConfigstring

The name of the Connect configuration.

errorDetailserrorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

eventDateTimestring

The UTC date and time of the event.

eventDescriptionstring

A description of the event.

payloadstring

Log output.

connectLog

Contains information about a Connect log entry.

accountIdstring

The external account number (int) or account ID GUID.

configUrlstring

The web address of the listener or retrieving service endpoint for Connect.

connectDebugLog[connectDebugLog]

A complex element containing information about the Connect configuration, error details, date/time, description and payload. This information is included in the response only when the additional_info query is set to true. This additional information is only available when retrieving general logs with ConnectEvents:get, but not when retrieving failure logs with ConnectEvents:listFailures.

connectIdstring

The id of the Connect configuration that failed. If an account has multiple Connect configurations, this value is used to look up the Connect configuration for the failed post.

createdstring

The UTC DateTime when the Connect post was created.

emailstring

The email address of the envelope sender.

envelopeIdstring

The id of the envelope that failed to post.

errorstring

The server error associated with the Connect post failure.

failureIdstring

The id of the Connect post failure.

failureUristring

The URI for the Connect post failure.

lastTrystring

The UTC DateTime of the last attempt to post.

logIdstring

The id of the Connect log entry.

logUristring

The URI for the Connect log entry.

retryCountstring

The number of times the Connect post has been retried.

retryUristring

A URI that you can use to retry to publish the Connect post.

statusstring

The envelope status for the Connect post. Possible values are:

  • Any
  • Voided
  • Created
  • Deleted
  • Sent
  • Delivered
  • Signed
  • Completed
  • Declined
  • TimedOut
  • Template
  • Processing

For details about these statuses, see Envelope Status Code Descriptions.

subjectstring

The subject of the envelope.

userNamestring

The name of the sender of the envelope.

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

ConnectEvents

Connect event logging information. This object contains sections for regular Connect logs and for Connect failures.

failures[connectLog]

A list of Connect failure logs.

logs[connectLog]

A list of Connect general logs.

totalRecordsstring

The count of records in the log list.

typestring

Examples

Generic JSON Response

Response
{
  "type": "sample string 1",
  "logs": [
    {
      "accountId": "sample string 1",
      "envelopeId": "sample string 2",
      "subject": "sample string 3",
      "created": "sample string 4",
      "userName": "sample string 5",
      "email": "sample string 6",
      "status": "sample string 7",
      "lastTry": "sample string 8",
      "retryCount": "sample string 9",
      "error": "sample string 10",
      "connectId": "sample string 11",
      "configUrl": "sample string 12",
      "logUri": "sample string 13",
      "logId": "sample string 14",
      "failureUri": "sample string 15",
      "failureId": "sample string 16",
      "retryUri": "sample string 17",
      "connectDebugLog": [
        {
          "eventDateTime": "sample string 1",
          "connectConfig": "sample string 2",
          "eventDescription": "sample string 3",
          "payload": "sample string 4",
          "errorDetails": {
            "errorCode": "sample string 1",
            "message": "sample string 2"
          }
        }
      ]
    }
  ],
  "failures": [
    {}
  ],
  "totalRecords": "sample string 2"
}
Generic XML Response

Response
<connectLogs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <failures>
    <connectLog />
  </failures>
  <logs>
    <connectLog>
      <accountId>sample string 1</accountId>
      <configUrl>sample string 12</configUrl>
      <connectDebugLog>
        <connectDebugLog>
          <connectConfig>sample string 2</connectConfig>
          <errorDetails>
            <errorCode>sample string 1</errorCode>
            <message>sample string 2</message>
          </errorDetails>
          <eventDateTime>sample string 1</eventDateTime>
          <eventDescription>sample string 3</eventDescription>
          <payload>sample string 4</payload>
        </connectDebugLog>
      </connectDebugLog>
      <connectId>sample string 11</connectId>
      <created>sample string 4</created>
      <email>sample string 6</email>
      <envelopeId>sample string 2</envelopeId>
      <error>sample string 10</error>
      <failureId>sample string 16</failureId>
      <failureUri>sample string 15</failureUri>
      <lastTry>sample string 8</lastTry>
      <logId>sample string 14</logId>
      <logUri>sample string 13</logUri>
      <retryCount>sample string 9</retryCount>
      <retryUri>sample string 17</retryUri>
      <status>sample string 7</status>
      <subject>sample string 3</subject>
      <userName>sample string 5</userName>
    </connectLog>
  </logs>
  <totalRecords>sample string 2</totalRecords>
  <type>sample string 1</type>
</connectLogs> 
}} />