Page tree
Skip to end of metadata
Go to start of metadata

API Overview

The pjs.sendRequest() API is used to send requests to web services.

This API is non-blocking.

Parameters

  • Object options/String requestType
    If you pass a string, you can pass the request type (get, post). If you pass an object, it will be passed into the request module API (see module API options). If an object is passed, you do not need to pass any other parameters.
  • String URL
    The endpoint to your web service.
  • String|Object Body (optional)
    The body of the request. If you pass in an object, it will send the request in JSON and it will also return JSON. Otherwise, it will pass as text and return a String.

Return Value

Object / String



Exception Handling

This API will crash if any HTTP code is returned.

Examples

Example of General Use
//Simple
var result = pjs.sendRequest("post", "http://website.com/myJSONAPI", {key: 'value'});
 
//Advanced, using request API options
result = pjs.sendRequest({
      method: "POST",
      uri: "http://website.com/myJSONAPI",
      body: {key: 'value'},
      json: true,
	  timeout: 5000,
      time: true
});