SLIM CD DEVELOPER » ShowSession

ShowSession

Method

SlimCD.Sessions.ShowSession

Purpose

Displays the session inside the browser.

Description

ShowSession is used to display a previously-created session. 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.

Business Rules

Link to something

Argument List

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

ShowSession Request Fields

Field Name	Type	Length	Required	Description
SessionID	string	40	require	HEX string uniquely representing the session

Reply Fields

ShowSession 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

ShowSession 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 ShowSession 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/showsession.asp?sessionid=….)
When using JavaScript/PHP (web-based languages), ShowSession 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.

Examples

Sample HTTP GET:

https://stats.slimcd.com/soft/showsession.asp?sessionid=22ADCBF1F23F19D125DF76B00B6DC75B201CB6CF

Sample HTTP POST:

URL:https://stats.slimcd.com/soft/showsession.asp
POSTDATA: sessionid=22ADCBF1F23F19D125DF76B00B6DC75B201CB6CF

Sample HTML Form with POST:

https://stats.slimcd.com/session/show.htm

Include

<script type="text/javascript" src="https://trans.slimcd.com/soft/json/slimcd.js"></script>

Method

function ShowSession(sessionid)

function ShowSession(sessionid)

Request

request=
{
"sessionid": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"
}

request=

{

"sessionid": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"

}

Reply

callback (
{
window.location.href = SlimCD.internal.getStatsServer() + "/soft/showsession.asp?sessionid=" +
sessionid
}
);

callback (

{

window.location.href = SlimCD.internal.getStatsServer() + "/soft/showsession.asp?sessionid=" +

sessionid

}

);

Sample Code

<script type="text/javascript" src="https://trans.slimcd.com/soft/json/slimcd.js"></script>
<script type="text/javascript">
SlimCD.Sessions.ShowSession(
{
"sessionid": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"
}
);
</script>

SlimCD.Sessions.ShowSession(

{

"sessionid": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"

}

);

</script>

Downloads

Download full sample source.

Include

include 'slimcd.php';

include 'slimcd.php';

Method

function Sessions_ShowSession(Sessions_ShowSessionRequest $request)

function Sessions_ShowSession(Sessions_ShowSessionRequest $request)

Request

class Sessions_ShowSessionRequest {
// property declaration
public $SessionID="";
}

class Sessions_ShowSessionRequest {

// property declaration

public $SessionID="";

}

JSON Reply

{return( $this->statsURL . "/soft/showsession.asp?sessionid=" . urlencode($request->
SessionID) );}

{return( $this->statsURL . "/soft/showsession.asp?sessionid=" . urlencode($request->

SessionID) );}

Sample Code

include 'slimcd.php';
// Create the Slim CD object
$SlimCD = new SlimCD() ;
// Create a ShowSession Request class
$request = new Sessions_ShowSessionRequest() ;
$request->sessionid = "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439";
$result = $SlimCD->Sessions_ShowSession($request);

include 'slimcd.php';

// Create the Slim CD object

$SlimCD = new SlimCD() ;

// Create a ShowSession Request class

$request = new Sessions_ShowSessionRequest() ;

$request->sessionid = "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439";

$result = $SlimCD->Sessions_ShowSession($request);

Downloads Download full sample source.

Include

using SlimCD;

using SlimCD;

Method

public String ShowSessionURL(String SessionId);

public String ShowSessionURL(String SessionId);

Request

public class ShowSessionRequest
{
public string sessionid { get; set; };
}

public class ShowSessionRequest

{

public string sessionid { get; set; };

}

Reply

Displays the form chosen in the "formname" parameter of CreateSession request.

Displays the form chosen in the "formname" parameter of CreateSession request.

Cross Reference: Client

Sample Code

String sessionid = "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439";
String sessionURL = "https://stats.slimcd.com/soft/showsession.asp?sessionid=" + sessionid;
lblURL.Text = sessionURL;
webbrowser.Url = new Uri(sessionURL);
}

String sessionid = "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439";

String sessionURL = "https://stats.slimcd.com/soft/showsession.asp?sessionid=" + sessionid;

lblURL.Text = sessionURL;

webbrowser.Url = new Uri(sessionURL);

}

Downloads Download full sample source.

Include

using SlimCD;

using SlimCD;

Method

public async Task< String > ShowSessionURL(String SessionId);

public async Task< String > ShowSessionURL(String SessionId);

Request

public class ShowSessionRequest
{
public string sessionid { get; set; };
}

public class ShowSessionRequest

{

public string sessionid { get; set; };

}

Reply

Displays the form chosen in the "formname" parameter of CreateSession request.

Displays the form chosen in the "formname" parameter of CreateSession request.

Cross Reference: Client

Sample Code

String sessionid = "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439";
String sessionURL = "https://stats.slimcd.com/soft/showsession.asp?sessionid=" + sessionid;
lblURL.Text = sessionURL;
webbrowser.Url = new Uri(sessionURL);

String sessionid = "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439";

String sessionURL = "https://stats.slimcd.com/soft/showsession.asp?sessionid=" + sessionid;

lblURL.Text = sessionURL;

webbrowser.Url = new Uri(sessionURL);

Downloads Download full sample source.

Include

#import "SlimCD.h"

#import "SlimCD.h"

Method

- (NSString*) sessionsShowSessionWithSession:(NSString*)sessionID;

- (NSString*) sessionsShowSessionWithSession:(NSString*)sessionID;

Request

Session ID

1	Session ID

Reply

NSString containing URL to launch

1	NSString containing URL to launch

Sample Code

SlimCD *api = [[SlimCD alloc] init];
NSString *sessionID = @"12345";
NSString *urlString = [api sessionsShowSessionWithSession:sessionID];
NSURL *url = [NSURL URLWithString:urlString];
if ([[UIApplication sharedApplication] canOpenURL:url])
{
[[UIApplication sharedApplication] openURL:url];
}
else
{
NSLog(@"Cannot launch URL.");
}

SlimCD *api = [[SlimCD alloc] init];

NSString *sessionID = @"12345";

NSString *urlString = [api sessionsShowSessionWithSession:sessionID];

NSURL *url = [NSURL URLWithString:urlString];

if ([[UIApplication sharedApplication] canOpenURL:url])

{

[[UIApplication sharedApplication] openURL:url];

}

else

{

NSLog(@"Cannot launch URL.");

}

Method

public String  getShowSession(ShowSessionRequest sessionShowRequest)

public String getShowSession(ShowSessionRequest sessionShowRequest)

Request

public class ShowSessionRequest{
// request parameter.
private String sessionid;
public ShowSessionRequest()
{
// set default values.
sessionid="";
}
// setters and getters.
public String getSessionid() {
return sessionid;
}
public void setSessionid(String sessionid) {
this.sessionid = sessionid;
}
}

public class ShowSessionRequest{

// request parameter.

private String sessionid;

public ShowSessionRequest()

{

// set default values.

sessionid="";

}

// setters and getters.

public String getSessionid() {

return sessionid;

}

public void setSessionid(String sessionid) {

this.sessionid = sessionid;

}

Reply

Sample Code

// Set the request parameter.
ShowSessionRequest request =new ShowSessionRequest();
request.setSessionid("4BC8FB1927A2BD499A22E7EDCA1D6CA3F709A5C8");
String result= new SessionShowSession().getShowSession(request);

// Set the request parameter.

ShowSessionRequest request =new ShowSessionRequest();

request.setSessionid("4BC8FB1927A2BD499A22E7EDCA1D6CA3F709A5C8");

String result= new SessionShowSession().getShowSession(request);

Downloads Download full sample source.

URL

https://stats.slimcd.com/soft/showsession.asp

Protocols

SOAP/XML

HTTP POST

HTTP GET

Request

Name/Value Pairs
SOAP/XML

&sessionid=CD3054F53D176471D46F7272CF17634AD94FAC6E

&sessionid=CD3054F53D176471D46F7272CF17634AD94FAC6E

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

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.

Output will be an HTML code

Output will be an HTML code

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

cURL
HTTP GET

curl https://stats.slimcd.com/soft/showsession.asp
--data-urlencode "sessionid=CD3054F53D176471D46F7272CF17634AD94FAC6E"
--max-time 600

curl https://stats.slimcd.com/soft/showsession.asp

--data-urlencode "sessionid=CD3054F53D176471D46F7272CF17634AD94FAC6E"

--max-time 600

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 use of an API Access Credential with a blank password, and specifies a long timeout for CloseBatch

Simple HTML form to show ShowSession

Use our online exerciser tool for showsession

Remarks

Remarks Go here

URL

https://stats.slimcd.com/soft/showsession.asp

https://stats.slimcd.com/soft/showsession.asp

Protocols

HTTP POST
HTTP GET

This function accepts either name/value pairs or JSON

Request

JASON
Name/Value Pairs

{
"SessionID": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"
}

{

"SessionID": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"

}

&sessionid=04AEB1217EE5927FE5AF4ABBB84A4DF42D5DF382

&sessionid=04AEB1217EE5927FE5AF4ABBB84A4DF42D5DF382

Reply

Displays the form chosen in the "formname" parameter of CreateSession request.

Displays the form chosen in the "formname" parameter of CreateSession request.

Sample Code

curl https://stats.slimcd.com/soft/ShowSession.asp
--data-urlencode "SessionID=6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"   
--max-time 600

curl https://stats.slimcd.com/soft/ShowSession.asp

--data-urlencode "SessionID=6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"

--max-time 600

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

https://stats.slimcd.com/soft/showsession.asp?sessionid=B365BFE31680CDBD92B867B34F81FA18F25E3A56

https://stats.slimcd.com/soft/showsession.asp?sessionid=B365BFE31680CDBD92B867B34F81FA18F25E3A56

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

$.ajax({
type: 'POST',
url: 'https://stats.slimcd.com/soft/ShowSession.asp',
crossDomain: true,
timeout: 600000,
contentType: "application/json",
data: {"SessionID": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439" } ,
dataType: 'jsonp',
success: function(responseData, textStatus, jqXHR) {
alert("reply=" + responseData.reply.response + ":" +
responseData.reply.description) ;
},
error: function (responseData, textStatus, errorThrown) {
alert('POST failed:' + textStatus + '=' + errorThrown);
}
});

$.ajax({

type: 'POST',

url: 'https://stats.slimcd.com/soft/ShowSession.asp',

crossDomain: true,

timeout: 600000,

contentType: "application/json",

data: {"SessionID": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439" } ,

dataType: 'jsonp',

success: function(responseData, textStatus, jqXHR) {

alert("reply=" + responseData.reply.response + ":" +

responseData.reply.description) ;

error: function (responseData, textStatus, errorThrown) {

alert('POST failed:' + textStatus + '=' + errorThrown);

}

});

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.

// This turns on cross-domain posts.
$.support.cors=true;
$.ajax({
type: 'POST',
url: 'https://stats.slimcd.com/soft/ShowSession.asp',
crossDomain: true,
timeout: 600000,
contentType: "application/x-www-form-urlencoded", 
data: { "SessionID": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"} ,
success: function(responseData, textStatus, jqXHR) {
alert("reply=" + responseData.reply.response + ":" + 
responseData.reply.description) ;
},
error: function (responseData, textStatus, errorThrown) {
alert('POST failed:' + textStatus + '=' + errorThrown);
}
});

// This turns on cross-domain posts.

$.support.cors=true;

$.ajax({

type: 'POST',

url: 'https://stats.slimcd.com/soft/ShowSession.asp',

crossDomain: true,

timeout: 600000,

contentType: "application/x-www-form-urlencoded",

data: { "SessionID": "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"} ,

success: function(responseData, textStatus, jqXHR) {

alert("reply=" + responseData.reply.response + ":" +

responseData.reply.description) ;

error: function (responseData, textStatus, errorThrown) {

alert('POST failed:' + textStatus + '=' + errorThrown);

}

});

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

<!--?php 
$data = array("SessionID" =--> "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439" );
$data_string = json_encode($data);
$ch = curl_init('https://stats.slimcd.com/soft/ShowSession.asp');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // receive server response ...
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);
curl_setopt($ch, CURLOPT_HTTPHEADER, 
array(
'Content-Type: application/json',
'Content-Length: ' . strlen($data_string)
)
);  
$server_output = curl_exec($ch);
$http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
if ($http_status != 200 || 
($contentType <> 'text/javascript' && $contentType <> 'application/json')) {
$reply = (object) array('response'=>'Error', 'responsecode'=>'2', 
'description' => $server_output , 
'responseurl' => curl_getinfo( $ch,
CURLINFO_EFFECTIVE_URL) ,
'datablock' => '');
$result = (object) array('reply' => $reply) ;
}
else {
$result = json_decode($server_output);
}
echo $result->reply->response . ':' . $result->reply->description;
?>

<!--?php

$data = array("SessionID" =--> "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439" );

$data_string = json_encode($data);

$ch = curl_init('https://stats.slimcd.com/soft/ShowSession.asp');

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // receive server response ...

curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);

curl_setopt($ch, CURLOPT_HTTPHEADER,

array(

'Content-Type: application/json',

'Content-Length: ' . strlen($data_string)

)

);

$server_output = curl_exec($ch);

$http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);

if ($http_status != 200 ||

($contentType <> 'text/javascript' && $contentType <> 'application/json')) {

$reply = (object) array('response'=>'Error', 'responsecode'=>'2',

'description' => $server_output ,

'responseurl' => curl_getinfo( $ch,

CURLINFO_EFFECTIVE_URL) ,

'datablock' => '');

$result = (object) array('reply' => $reply) ;

}

else {

$result = json_decode($server_output);

}

echo $result->reply->response . ':' . $result->reply->description;

<!--?php 
$ch = curl_init("https://stats.slimcd.com/soft/ShowSession.asp");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // receive server response ...
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,
http_build_query(
array(
"SessionID" =--> "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"
)
)
);
$server_output = curl_exec ($ch);
$http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);
if ($http_status != 200 || 
($contentType <> 'text/javascript' && $contentType <> 'application/json')) {
$reply = (object) array('response'=>'Error', 
'responsecode'=>'2', 
'description' => $server_output , 
'responseurl' => curl_getinfo($ch, 
CURLINFO_EFFECTIVE_URL) ,
'datablock' => '');
$result = (object) array('reply' => $reply) ;
}
else {
$result = json_decode($server_output);
}
curl_close ($ch);
echo $result->reply->response . ':' . $result->reply->description;
?>

<!--?php

$ch = curl_init("https://stats.slimcd.com/soft/ShowSession.asp");

curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // receive server response ...

curl_setopt($ch, CURLOPT_POST, 1);

curl_setopt($ch, CURLOPT_POSTFIELDS,

http_build_query(

array(

"SessionID" =--> "6B9AC5C22EF62BB46EDBC2D2C49215D1157E3439"

)

);

$server_output = curl_exec ($ch);

$http_status = curl_getinfo($ch, CURLINFO_HTTP_CODE);

$contentType = curl_getinfo($ch, CURLINFO_CONTENT_TYPE);

if ($http_status != 200 ||

($contentType <> 'text/javascript' && $contentType <> 'application/json')) {

$reply = (object) array('response'=>'Error',

'responsecode'=>'2',

'description' => $server_output ,

'responseurl' => curl_getinfo($ch,

CURLINFO_EFFECTIVE_URL) ,

'datablock' => '');

$result = (object) array('reply' => $reply) ;

}

else {

$result = json_decode($server_output);

}

curl_close ($ch);

echo $result->reply->response . ':' . $result->reply->description;

Remarks

None