UpdateSession

    Updates an existing signing session that is not in one of these statuses (Completed, Cancelled, Deleted, Purged, Expired, Archived) by sending a list of documents and signers to be added to the signing session.  See Appendix B for a list of predefined signer roles available.

    Returns – A SessionResponse containing the updated Signing Session.  (See SessionResponse in Appendix B)

    Parameters

    Name Type Description
    encryptedToken string Required. Encrypted Token returned from client authentication.
    Returns null if token has expired or is invalid.
    username string Required. Username (email address) of the user who’s starting the signing session.
    session Session Required. See Session class in Appendix B

    Example – C#

    ServiceAPIClient ws = new ServiceAPIClient();

    string signsessionId = “GUID of existing session”;
    string url = string.Empty;
    string autologinUrl = landingURL + “token={0}&user={1}&ssid={2}&page={3}”;
    List<Document> documents = new List<Document>();
    SessionResponse sessionResponse;

    Session sessionConfig = new Session();

    sessionConfig.Id = signsessionId;
    sessionConfig.SessionInfo = new SessionInfo();

    sessionConfig.SessionInfo.RemoveUnassignedSignerRoles = true; // Or false.

     

    Document documentConfig = new Document();
    documentConfig.FileName = “Test.docx”;
    documentConfig.FormId = “TemplateId”;
    documentConfig.FormTag = “Tag2”;

    documentConfig.HasAnchorTags= true;  // New property telling eSign to process this document for Anchor Tags. Refer to Anchor Tags section.

    documentConfig.FileBytes = File.ReadAllBytes(@”D:\doc\Test.docx”);

    documents.Add(documentConfig);
    sessionConfig.Documents = documents.ToArray();

    Signer signer;
    List<Signer> signers = new List<Signer>();

    signer = new Signer();
    signer.EmailAddress = “email1@docs.constellation1.com”;
    signer.FirstName = “FirstName”;
    signer.LastName = “LastName”;
    signer.SignerRole = “Seller 1”; //(see signer roles Appendix B)
    signer.AuthMethod = Authentication.KBAPlusPassword;
    signer.AuthenticationSettings = new eSignAPI.AuthenticationSettings();
    signer.AuthenticateSigner.Password = “password”;

    // Here we’re assuming the template used has two merge fields one called “CompanyName” and the other “Job Title”. So, you supply their values this way.

    signer.MergeFieldMapping = new Dictionary<string, string>() { { “CompanyName”, “RED” }, { “Job Title”, “Manager” } };

    signers.Add(signer);

    signer = new Signer();
    signer.EmailAddress = “email2@docs.constellation1.com”;
    signer.FirstName = “FirstName”;
    signer.LastName = “LastName”;
    signer.SignerRole = “Buyer 1”; //(see signer roles Appendix B)
    signer.AuthMethod = Authentication.KBA;

    signers.Add(signer);

    sessionConfig.Signers = signers.ToArray();

    sessionResponse = ws.CreateSession(encryptedToken, “username”, sessionConfig);

    signsessionId = sessionResponse.SigningSessionId.ToString();
    url = string.Format(autologinUrl, encryptedToken, user, signsessionId, “continue”);

    System.Diagnostics.Process.Start(url);