Follow

GetDocumentValues

Last updated 2017-04-27 15:13:20 UTC

The GetDocumentValues operation can be used to retrieve the values of all of the Typed JotBlocks and Typed Parameters for a specific document. If this method is called prior to document completion, some of the Typed JotBlock values may return as empty if those JotBlocks have not yet been filled out by the assigned signatory.

The GetDocumentValues operation requires knowledge of the following:

  • the Document ID of the document to cancel (this is returned as an element in the returned XML from a document submission operation)
  • the AssureSign account ContextIdentifier (this is exposed in the AssureSign administrative application account settings and serves to provide some security to the transaction)
  • the AuthToken of the document to cancel (this is returned as an element in the returned XML from a document submission operation)

Sample XML

<?xml version="1.0" encoding="utf-8"?> 
<GetDocumentValues xmlns="https://www.assuresign.net/Services/DocumentNOW/GetDocumentValues"> 
    <DocumentValuesQuery ContextIdentifier="6c17c44a-458d-455b-b240-fc6dbb8cf1da" Id="98413f47-42e8-df11-9b14-0022195a8cb4" AuthToken="78ddafe6-8dd1-4244-bf5b-58eb7fb5b9e7" /> 
</GetDocumentValues>

The SOAP Action header is

https://www.assuresign.net/Services/DocumentNOW/GetDocumentValues/IGetDocumentValuesService/GetDocumentValues

A response will return an object containing a list of all of the parameters and a list of all of the JotBlocks with their corresponding values (if available).

Note: For “MultipleChoiceCheckbox” Jotblocks which allow selection of one or more options, the value returned here will be a comma-delimited list of the selected option values.

<?xml version="1.0" encoding="utf-8"?> 
<GetDocumentValuesResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/GetDocumentValues"> 
    <DocumentValuesQueryResult Id="98413f47-42e8-df11-9b14-0022195a8cb4"> 
        <DocumentValues> 
            <JotBlocks> 
                <JotBlockInfo Name="JotBlock 1" Value="JotBlock 1 Value" /> 
            </JotBlocks> 
            <Parameters> 
                <ParameterInfo Name="Signatory 1 Full Name" Tag="Tag" Value="Signatory 1 Full Name Value" /> 
                <ParameterInfo Name="Signatory 1 Email" Tag="Tag" Value="email@assuresign.com" /> 
            </Parameters> 
        </DocumentValues> 
    </DocumentValuesQueryResult> 
</GetDocumentValuesResponse>
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

0 Comments

Article is closed for comments.