AssureSign: LookupSession

The LookupSession operation is called to pull down the result of an asynchronous submit or envelope close operation.

The LookupSession operation requires knowledge of the following:

• the AssureSign account ContextIdentifier (this is exposed in the AssureSign administrative application account settings and serves to provide some security to the transaction)
• the SessionID returned from an AsyncSubmit, AsyncSubmitWithFile, or AsyncSubmitWithFileRetrieval, or AsyncCloseEnvelope operation

Sample XML

<?xml version="1.0" encoding="utf-8"?> 
<LookupSession xmlns="https://www.assuresign.net/Services/DocumentNOW/LookupSession">
    <SessionLookups> 
        <SessionLookup ContextIdentifier="06C4A84A-693C-46CB-8DF2-40A8215AA056" SessionId="96059412-2f90-48d5-ba66-8f798f3cbd8d" /> 
    </SessionLookups> 
</LookupSession>

The SOAP Action header is

https://www.assuresign.net/Services/DocumentNOW/LookupSession/ILookupSessionService/LookupSession

AsyncSubmit*

In the case of looking up a session for an asynchronous submission, information will be returned that should be stored to allow future operations on the newly created document. 

In particular, the Document ID and AuthToken will be required to request any further operations on an active document. Sample XML returned by the LookupSession operation for an asynchronous submission is presented here:

<?xml version="1.0" encoding="utf-8"?> 
<LookupSessionResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/LookupSession"> 
    <SessionLookupResults> 
        <SessionLookupResult SessionId="96059412-2f90-48d5-ba66-8f798f3cbd8d"> 
            <DocumentResults> 
                <DocumentResult Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" AuthToken="8CC9A84B-693C-46CC-4342-40A8215AD76A"> 
                    <Metadata UserName="georgeuser@company.com" DocumentName="John Doe Contract 2-15-2007" OrderNumber="7xe-123478" ExpirationDate="2007-04-13" /> 
                </DocumentResult> 
            </DocumentResults> 
        </SessionLookupResult> 
    </SessionLookupResults> 
</LookupSessionResponse>

AsyncCloseEnvelope

In the case of looking up a session for an AsyncCloseEnvelope operation, the EnvelopeId will be echoed back if the operation was successful.  However, the Exceptions element - if present - should be checked to see if the operation resulted in any exceptions.

Sample XML returned by the LookupSession operation for an AsyncCloseEnvelope session is presented here:

<?xml version="1.0" encoding="utf-8"?> 
<LookupSessionResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/LookupSession"> 
    <SessionLookupResults> 
        <SessionLookupResult SessionId="96059412-2f90-48d5-ba66-8f798f3cbd8d"> 
            <CloseEnvelopeResult EnvelopeId="2CE11EF1-8938-DD11-8735-00065B8CE99B" />
        </SessionLookupResult> 
    </SessionLookupResults> 
</LookupSessionResponse>

The SessionLookupResult should be checked for the presence of an Exceptions element, which may contain multiple SessionLookupException items. Also, the DocumentResult should be checked for the presence of an Exceptions element, which may contain multiple DocumentException items.