RESTRequest()

Details

RESTRequest object is used to REST requests

RESTRequest.addToQueryString($key, $value)

Details

Adds a query parameter to the request URL

$request = new RESTRequest();
$request.addToQueryString("Place", "Bangalore");

Single argument can also be passed to this api. This can be a string which is queryString or Parameter object. Parameter object is explained below.

1. As query string

   $request = new RESTRequest();
   $request.addToQueryString("Place=Bangalore");

2. As Parameter object

   $request = new RESTRequest();
   var $p = new Parameter();
   $p.add("Name", "Jane");
   $p.add("Age", "25");
   $request.addToQueryString($p);

RESTRequest.addToBody($key, $value)

Details

Adds a query parameter to the request Body

$request = new RESTRequest();
$request.addToBody("Place", "Bangalore");

Single argument can also be passed to this api. This can be a string which is queryString or Parameter object. Parameter object is explained below.

1. As query string

   $request = new RESTRequest();
   $request.addToBody("Place=Bangalore");

2. As Parameter object

   $request = new RESTRequest();
   var $p = new Parameter();
   $p.add("Name", "Jane");
   $p.add("Age", "25");
   $request.addToBody($p);

RESTRequest.setHeader($key, $value)

Details

Sets request header

$request = new RESTRequest();
$request.setHeader("Accept-Encoding", "deflate,sdch");

RESTRequest.setURL($url)

Details

Sets url to be navigated

$request = new RESTRequest();
$request.setURL("http://sahi.co.in");

RESTRequest.setBody($body)

Details

Sets body of the request. Pass a JSON string.

var $json = {
    "firstName": "John",
    "lastName": "Smith",
    "age": 25,
    "address": {
        "streetAddress": "21 2nd Street",
        "city": "Mumbai"
    }
};
var $jsonString = JSON.stringify($json);

$request = new RESTRequest();
$request.setBody($jsonString);

RESTRequest.setCredentials($username, $password)

Details

Sets authentication parameters when trying to access an authorized page. Uses the credentials provided for 401 Authentication.

$request = new RESTRequest();
$request.setCredentials("testuser", "password");

RESTRequest.setAuthCredentials($oauthtype, $oauthvalue)

Details

Sets authentication parameters when trying to access an authorized page. Uses the credentials provided for Basic/oAuth1.0 Authentication.

// For Basic auth
$request = new RESTRequest();
$request.setAuthCredentials("authType", "Basic Auth");
$request.setAuthCredentials("userName", "testuser");
$request.setAuthCredentials("passWord", "password");
// For oAuth1.0
$request = new RESTRequest();
$request.setAuthCredentials("authType", "OAuth 1.0");
$request.setAuthCredentials("oauth_consumer_key", "consumer key");
$request.setAuthCredentials("oauth_consumer_secret", "consumer secret");
$request.setAuthCredentials("oauth_token", "token");
$request.setAuthCredentials("oauth_token_secret", "token secret");
$request.setAuthCredentials("oauth_signature_method", "HMAC-SHA1");
$request.setAuthCredentials("oauth_version", "1.0");

RESTRequest.submit($method)

Details

Submits the request, reads response and returns a RESTResponse object

$request = new RESTRequest();
$request.setURL("http://sahi.co.in");
$response = $request.submit("get");

If this api is called before setURL it will return a null object

RESTResponse()

Details

RESTResponse object is used to read REST responses

RESTResponse.getResponseCode()

Details

var $s = $response.getResponseCode(); //returns response code e.g. 200, 404 etc.

RESTResponse.getHeader($key)

Details

var $s = $response.getHeader("Content-Length"); //returns value of content-length header

RESTResponse.getBodyAsString([$charSet])

Details

infoNOTE: $charSet was added Since Sahi Pro: 6.2.1. For old document Refer here

var $s = $response.getBodyAsString(); //returns the content of the body using UTF-8 encoding
var $s = $response.getBodyAsString("ISO-8859-1"); //returns the content of the body using ISO-8859-1 encoding

RESTResponse.getBody()

Details

var $s = $response.getBody(); //returns the content of the body

Parameter()

Details

Parameter object is used to add parameters to query string and body

Parameter.add($key, $value)

Details

Adds a key-value pair to Parameter object

var $p = new Parameter();
$p.add("Name", "Jane");

Parameter.remove($key)

Details

Removes a key-value pair(if exists) from Parameter object, specified by the key

var $p = new Parameter();
$p.add("Name", "Jane");
$p.add("Age", "25");
$p.remove("Name");

Parameter.getQueryString()

Details

Creates a query string using all the key-value pairs in the Parameter object

var $p = new Parameter();
$p.add("Name", "Jane");
$p.add("Age", "25");
var $qs = $p.getQueryString();