事件通知 XML 结构

Question

我正在按照 docusign rest api v2，第 93 页中的“发送信封或创建草稿信封”发送文档​​以供签名。

文档已发送并签名，但我在使用事件通知功能时遇到了问题。

我对此功能的 xml 结构有点困惑。我尝试了很多不同的组合，但我无法弄清楚。有什么帮助吗？

这是我尝试过的众多方法之一......

<eventNotification>
    <url>xxxxxx</url>
    <includeDocuments>false</includeDocuments>
    <loggingEnabled>true</loggingEnabled>
    <envelopeEvents>
        <envelopeEvent>
            <envelopeEventStatusCode>completed</envelopeEventStatusCode>
        </envelopeEvent>
    </envelopeEvents>
</eventNotification>

Answer 1

Kim 说得对，DocuSign 目前没有很好的 XML 格式请求正文文档。然而，有时由于技术限制、您不想重新编写解析代码或其他原因，JSON 不是一个选项，并且开发人员被 XML 格式卡住了。

话虽如此，以下是 eventNotifications 对象的正确 XML 格式，以及您可以在其上设置的所有可能属性：

<eventNotification>
   <EnvelopeEvents>
      <envelopeEvent>
         <envelopeEventStatusCode>sample string 1</envelopeEventStatusCode>
         <includeDocuments>sample string 2</includeDocuments>
      </envelopeEvent>
      <envelopeEvent>
         <envelopeEventStatusCode>sample string 1</envelopeEventStatusCode>
         <includeDocuments>sample string 2</includeDocuments>
      </envelopeEvent>
   </EnvelopeEvents>
   <includeCertificateWithSoap>sample string 6</includeCertificateWithSoap>
   <includeDocuments>sample string 8</includeDocuments>
   <includeEnvelopeVoidReason>sample string 9</includeEnvelopeVoidReason>
   <includeSenderAccountAsCustomField>sample string 11</includeSenderAccountAsCustomField>
   <includeTimeZone>sample string 10</includeTimeZone>
   <loggingEnabled>sample string 2</loggingEnabled>
   <recipientEvents>
      <recipientEvent>
         <includeDocuments>sample string 2</includeDocuments>
         <recipientEventStatusCode>sample string 1</recipientEventStatusCode>
      </recipientEvent>
      <recipientEvent>
         <includeDocuments>sample string 2</includeDocuments>
         <recipientEventStatusCode>sample string 1</recipientEventStatusCode>
      </recipientEvent>
   </recipientEvents>
   <requireAcknowledgment>sample string 3</requireAcknowledgment>
   <signMessageWithX509Cert>sample string 7</signMessageWithX509Cert>
   <soapNameSpace>sample string 5</soapNameSpace>
   <url>sample string 1</url>
   <useSoapInterface>sample string 4</useSoapInterface>
</eventNotification>

Answer 2

虽然从技术上讲，DocuSign REST API 支持 XML 格式和 JSON 格式，但大多数 DocuSign REST API 文档、代码示例和开发人员资源都是 JSON 格式。不幸的是，这意味着尝试将 XML 格式与 DocuSign REST API 一起使用（执行非常基本的任务之外的任何事情）可能会非常令人沮丧——因为当您的 XML 请求无法按预期工作时，您几乎没有资源来弄清楚什么正确的格式是。

因此，我建议您考虑在 DocuSign REST API 中使用 JSON 而不是 XML。这是一个成功创建信封通知的 JSON 请求。

POST https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes
{
  "templateId": "TEMPLATE_ID",
  "templateRoles": [
   {
      "roleName": "Signer1",
      "name": "John Doe",
      "email": "johnsemail@outlook.com"
    }
  ],
  "eventNotification":       {
    "url": "http://www.google.com",
    "loggingEnabled": "true",
    "requireAcknowledgement": "true",
    "includeDocuments" : "false",
    "envelopeEvents" : [{
      "envelopeEventStatusCode" : "completed"     
    }]
  },
  "status": "sent"
}

更新：使用下面 Ergin 提供的信息，我能够使用 XML 来实现这一点——关键是 中的“信封”和“事件”都使用大写>EnvelopeEvents 元素。下面是一个成功触发 Connect 通知的请求示例：

POST https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes
<envelopeDefinition xmlns="http://www.docusign.com/restapi">
   <accountId>ACCOUNT_ID</accountId>
   <status>sent</status>
   <templateId>TEMPLATE_ID</templateId>
   <templateRoles>
      <templateRole>
         <email>johnsemail@outlook.com</email>
         <name>John Doe</name>
         <roleName>Signer1</roleName>
      </templateRole>
   </templateRoles>
   <eventNotification>
    <EnvelopeEvents>
      <envelopeEvent>
        <envelopeEventStatusCode>completed</envelopeEventStatusCode>
      </envelopeEvent>
    </EnvelopeEvents>
    <includeDocuments>false</includeDocuments>
    <loggingEnabled>true</loggingEnabled>
    <requireAcknowledgement>true</requireAcknowledgement>
    <url>http://www.google.com</url>
   </eventNotification>
</envelopeDefinition>