View Source DocuSign.Api.EnvelopeDocumentHtmlDefinitions (DocuSign v1.2.0)

API calls for all endpoints tagged EnvelopeDocumentHtmlDefinitions.

Summary

Functions

Retrieves the HTML definition used to generate a dynamically sized responsive document. Retrieves the HTML definition used to generate a dynamically sized responsive document. If the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body. Note: The documentId query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body. ### Related topics - Responsive signing

Functions

Link to this function

responsive_html_get_envelope_document_html_definitions(connection, account_id, document_id, envelope_id, opts \\ [])

View Source
@spec responsive_html_get_envelope_document_html_definitions(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.DocumentHtmlDefinitionOriginals.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Retrieves the HTML definition used to generate a dynamically sized responsive document. Retrieves the HTML definition used to generate a dynamically sized responsive document. If the document was not created as a signable HTML document, this endpoint will return a 200-OK response and an empty JSON body. Note: The documentId query parameter is a GUID value, not an integer document ID. If an invalid document ID is provided, this endpoint will return a 200-OK response and an empty JSON body. ### Related topics - Responsive signing

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • document_id (String.t): The GUID of the document. Example: c671747c-xxxx-xxxx-xxxx-4a4a48e23744
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.DocumentHtmlDefinitionOriginals.t} on success
  • {:error, Tesla.Env.t} on failure