MultiSession

  • Method

    SlimCD.Sessions.MultiSession

    Purpose

    Creates a unique session from a master-session and displays it. Used instead of ShowSession when the form is a template form.

    Description

    MultiSession is used to display a previously-created session similarly to ShowSession. It is designed to accept limited input and display HTML output so that the SessionID value can be included in the URL that is provided as a command-line when launching in a browser. This also works well when redirecting from one web server to another. Unlike ShowSession, MultiSession is designed to be used by multiple recipients such as for charitable donations. MultiSession creates a unique session from the original template each time it is called.

    Business Rules

    Link to something

    Argument List

    Name Required Usage
    MultiSessionRequest 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

    MultiSession Request Fields

    Field Name Type Length Required Description
    SessionID string 40 require HEX string uniquely representing the session
    Amount string 20 optional Amount of the transaction, which can override the amount specified by CreateSession.

    Reply Fields

    MultiSession is used to display HTML in a browser or browser control.

    • For browser-based references: HTML is displayed.
    • For class libraries: It returns a formatted URL.

    Reply Hierarchy

    It returns either a URL or HTML, not intended to be a structured document to parse.

    Remarks

    • MultiSession requires a single input field, the SessionID. A form is displayed based on the configuration settings for the form on the SLIM CD server.
    • The MultiSession service returns an HTML web page for display in a browser. The displayed form and the actions of that form can be managed using the SLIM CD HOSTED PAYMENT PAGES functionality in the SLIM CD website.
    • When using libraries, the libraries will return a formatted url with the specified sessionid
      (ex: https://stats.slimcd.com/soft/multisession.asp?sessionid=….&amount=…)
    • When using JavaScript/PHP (web-based languages), MultiSession will set the browser’s location so that the HTML is displayed (it will redirect the browser to the created url)
    • It is possible to configure HOSTED PAYMENT PAGES to perform a PostBack and/or Redirection at the end of the payment. Alternatively, the CheckSession and CancelSession functions can be used to monitor the outcome of the activity in a HOSTED PAYMENT PAGE.
  • Include

    Method

    Request

    Reply

    Sample Code

    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.


  • 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 DestroySESSION

    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