CancelSession

  • Method

    SlimCD.Sessions.CancelSession

    Purpose

    Prevents the session from being used.

    Description

    CancelSession is used to cancel a session. Cancelling a session will prevent the clerk from performing payment processing. Cancelling a session may not be possible if the payment has already been completed (in which case a VOID transaction must be performed on the gateway), or if the payment is currently in-process for payment processing with the credit card companies.

    Business Rules

    Link to something

    Argument List

    Name Required Usage
    CancelSessionRequest Required Object containing properties for the request
    timeout Optional Integer wait time, in seconds, before timeout response is generated
    callback* Optional Function to call upon completion of asynchronous request

    *for JavaScript only

    CancelSession Request Fields

    Field Name Type Length Required Description
    UserName string 20 require Username or API Access Credential that accesses web service.
    Password string 20 require Plaintext password for the client account.
    SessionID string 40 require HEX string uniquely representing the session

    1. Passwords are required except when the username is set to an API Access Credential, in which case it should be passed in as an empty string..

    Reply Fields

    reply outer tag for the reply data block
    response Success, FAIL, Error
    response code 0, 1, 2 (respective) matching the above
    description If successful, this will contain the single word, OK. Otherwise it will contain a description of failure or error which occurred
    reponseurl The Slimcd.com url which was called for this operation
    datablock The confirmation text returned from the server.

    Reply Hierarchy

    • reply
      • response
      • responsecode
      • description
      • responseurl
      • datablock

    Remarks

    • CancelSession Input Values identify the session and authenticate access to the session information.

    Examples

    Sample HTTP GET:

    Sample HTTP POST:

    URL: https://stats.slimcd.com/soft/cancelsession.asp POSTDATA:clientid=1032&password=289075&sessionid=22ADCBF1F23F19D125DF76B00B6DC75B201CB6CF

    Sample HTML Form with POST:

  • Include

    Method

    Request

    Reply

    Sample Code

    Downloads

    Download full sample source.

     

  • Include

    Method

    Request

    JSON Reply

    Sample Code

    Downloads Download full sample source.


  • Include

    Method

    Request

    Reply

    Cross Reference:Client

    Sample Code

    Downloads Download full sample source.


  • Include

    Method

    Request

    Reply

    Cross Reference: Client

    Sample Code

    Downloads Download full sample source.


  • Include

    Method

    Request

    Reply

    Sample Code


  • Method

    Request

    Reply

    Sample Code

    Downloads Download full sample source.


  • URL

    Protocols

        • SOAP/XML
        • HTTP POST
        • HTTP GET

    Request

    The sample above shows the name/value pairs that would be send with HTTP POST

    Status Codes

    Status Code Status Description Explanation
    200 200 OK Approved or declined attempts will return a response with an XML reply block
    500 500 Internal Server Error The response will not contain XML, as a server error has occurred.

    Reply Output is in XML format if a status code of 200 is returned.

    If the block’s tag does not indicate “Success”, the tag will contain an error description which can be displayed to the end-user

    Sample Code

    The sample above shows the use of an API Access Credential with a blank password, and specifies a long timeout for CloseBatch

    The sample above shows the clientid, siteid and password. BatchNumber is always blank.

    SIMPLE HTML FORM TO SHOW CANCELSESSION

    Remarks

    • Remarks Go here
  • URL

    Protocols

    • HTTP POST
    • HTTP GET

    This function accepts either name/value pairs or JSON

    Request

    Reply

    Sample Code

    The sample above shows the use of an API Access Credential with a blank password, and specifies a long timeout for CloseBatch

    The sample above shows the clientid, siteid and password. BatchNumber is always blank.

    The sample above shows the use jQuery cross-domain POST with jsonp, sends an API Access Credential with a blank password, and specifies a long timeout for CloseBatch. Note that the service can be specified on the URL or inside the request object as another json data item

    The sample above shows the use jQuery cross-domain POST with name/value pairs, sends an API Access Credential with a blank password, and specifies a long timeout for CloseBatch. Note that the service can be specified on the URL or inside the request object as another name/value pair

    Remarks

    1. None