返回DocuSign客户数据字段值

时间:2014-10-06 14:51:54

标签: xml docusignapi

有没有办法将数据值输入到与文档一起返回的DocuSign文档自定义字段中?我们正在使用DocuSign的SOAP API接口,并将发送文档和XML,请求收件人/签名者将数据输入字段(数据输入,复选框,单选按钮等)。

从我们的研究中可以看出,DocuSign将文档和数据作为PDF返回,但我们也希望将数据发送回DocuSign的XML响应中。

似乎还有一个名为“GetEnvelopeCustomField”的DocuSign要求撤消此数据,但我们不确定此调用是如何工作的。似乎无法在通话中找到太多信息。

如果有人这样做或有任何建议,我将不胜感激。

谢谢!

1 个答案:

答案 0 :(得分:0)

是的,在SOAP和REST中都有API调用。在SOAP中,只需进行RequestEnvelope调用,即可返回有关信封的所有信息,包括文档,收件人和标签。例如,回复的部分响应将包含以下内容:

<Tabs>
      <Tab>
        <DocumentID>positiveInteger</DocumentID>
        <RecipientID>positiveInteger</RecipientID>
        <PageNumber>nonNegativeInteger</PageNumber>
        <XPosition>nonNegativeInteger</XPosition>
        <YPosition>nonNegativeInteger</YPosition>
        <ScaleValue>decimal</ScaleValue>
        <AnchorTabItem xsi:nil="true" />
        <Type>InitialHere or SignHere or FullName or FirstName or LastName or EmailAddress or Company or Title or DateSigned or InitialHereOptional or EnvelopeID or Custom or SignerAttachment or SignHereOptional or Approve or Decline or SignerAttachmentOptional</Type>
        <Name>string</Name>
        <TabLabel>string</TabLabel>

        <Value>string</Value>

        <CustomTabType>Text or Checkbox or Radio or List or Date or Number or SSN or ZIP5 or ZIP5DASH4 or Email or Note or Formula</CustomTabType>
        <CustomTabWidth>int</CustomTabWidth>
        <CustomTabHeight>int</CustomTabHeight>
        <CustomTabRequired>boolean</CustomTabRequired>
        <CustomTabLocked>boolean</CustomTabLocked>
        <CustomTabDisableAutoSize>boolean</CustomTabDisableAutoSize>
        <CustomTabListItems>string</CustomTabListItems>
        <CustomTabListValues>string</CustomTabListValues>
        <CustomTabListSelectedValue>string</CustomTabListSelectedValue>
        <CustomTabRadioGroupName>string</CustomTabRadioGroupName>
        <CustomTabValidationPattern>string</CustomTabValidationPattern>
        <CustomTabValidationMessage>string</CustomTabValidationMessage>
        <TemplateLocked>boolean</TemplateLocked>
        <TemplateRequired>boolean</TemplateRequired>
        <ConditionalParentLabel>string</ConditionalParentLabel>
        <ConditionalParentValue>string</ConditionalParentValue>
        <SharedTab>boolean</SharedTab>
        <RequireInitialOnSharedTabChange>boolean</RequireInitialOnSharedTabChange>
        <ConcealValueOnDocument>boolean</ConcealValueOnDocument>
        <Font>Arial or ArialNarrow or Calibri or CourierNew or Garamond or Georgia or Helvetica or LucidaConsole or Tahoma or TimesNewRoman or Trebuchet or Verdana</Font>
        <Bold>boolean</Bold>
        <Italic>boolean</Italic>
        <Underline>boolean</Underline>
        <FontColor>Black or BrightBlue or BrightRed or DarkRed or DarkGreen or Gold or Green or NavyBlue or Purple or White</FontColor>
        <FontSize>Size7 or Size8 or Size9 or Size10 or Size11 or Size12 or Size14 or Size16 or Size18 or Size20 or Size22 or Size24 or Size26 or Size28 or Size36 or Size48 or Size72</FontSize>
        <MergeFieldXml>string</MergeFieldXml>
        <IncludeNoteInEmail>boolean</IncludeNoteInEmail>
        <IsPaymentAmount>boolean</IsPaymentAmount>
        <Formula>string</Formula>
        <RoundDecimalPlaces>int</RoundDecimalPlaces>
        <MaxLength>int</MaxLength>
        <SenderRequired>boolean</SenderRequired>
      </Tab>
  </Tabs>

您只需解析XML并检索您感兴趣的任何值。以下是RequestEnvelope调用的架构:

https://demo.docusign.net/api/3.0/api.asmx?op=RequestEnvelope