CancelSession

    Cancels a current signing session.

    URI PUT rest/v1/sessions/{sessionId}/cancel?returnURL={returnURL}

    Returns – A RequestResponse containing a string (“True” or “False”) representation of a Boolean indicating whether or not the call was a success or failure in the ReturnValue.  (See RequestResponse 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.
    sessionID string Required. The ID of the session being cancelled
    returnURL string Required. Your Host URL.

     

    Example – C#

    [gdlr_notification icon=”none” type=”color-border” border=”#31BEF9″ color=”#000000″]
    string uri = “rest/v1/sessions/{0}/cancel?returnURL={1}”;
    string responseString = string.Empty;
    JavaScriptSerializer jss = new JavaScriptSerializer();
    RequestResponse requestResponse;

    uri = string.Format(uri, signingsessionId, returnURL);
    HttpWebRequest request = (HttpWebRequest)WebRequest.Create(host + uri);
    request.Headers.Add(“Authorization” , encryptedToken);
    request.ContentLength = 0;
    request.Method = “PUT”;
    request.ContentType = “application/json”;

    HttpWebResponse response = (HttpWebResponse)request.GetResponse();
    responseString = new StreamReader(response.GetResponseStream()).ReadToEnd();
    requestResponse = jss.Deserialize<RequestResponse>(responseString);

    [/gdlr_notification]