HTTP Method Helpers

HTTP Method Helpers are the newest addition to the PHP Client. They allow a generalized calling of the four services we allow in the Spark API. It is currently available for a get, post, put, and delete. Each event is documented within Core.php file on what $options can hold and use.

#Example // Get Saved Searches $resultgettest = $api->get("savedsearches", $options = array()); /** @param $options An array with the following potential attributes: * 'cache_time' => The time, either in seconds or in the format * specified by parse_cache_time, to cache the response. * 'params' => The array of request parameters to send along with * the request. */ if ($resultgettest === false) { echo "API Error Code: {$api->last_error_code}\n"; echo "API Error Message: {$api->last_error_mess}\n"; exit; } else { print_r($resultgettest); }

// Post New Saved Search
$resultposttest = $api->post("savedsearches", $options = array("data" => array("Name" => "PostTestSavedSearch", "Filter" => "City Eq 'Fargo'")));
 /*	 * @param  $options  An array with the following potential attributes:
 *                     'cache_time' => The time, either in seconds or in the format
 *                                     specified by parse_cache_time, to cache the response.
 *                     'params'     => The array of request parameters to send along with
 *                                     the request.
 *                     'data'       => The PUT data, as an array that will be later translated
 *                                     to JSON.  Ignore the "D" attribute -- we will wrap the data
 *                                     with the "D" attribute for you.
     */
if ($resultposttest === false) {
	echo "API Error Code: {$api->last_error_code}\n";
	echo "API Error Message: {$api->last_error_mess}\n";
	exit;
} else {
	print_r($resultposttest);
}

 	// Put Saved Search Update
$resultputtest = $api->put("savedsearches/20110314222417421851000000", $options = array("data" => array("Name" => "PostTestSavedSearch2", "Filter" => "City Eq 'West Fargo'")));
 /* * @param  $options  An array with the following potential attributes:
 *                     'cache_time' => The time, either in seconds or in the format
 *                                     specified by parse_cache_time, to cache the response.
 *                     'params'     => The array of request parameters to send along with
 *                                     the request.
 *                     'data'       => The POST data, as an array that will be later translated
 *                                     to JSON.  Ignore the "D" attribute -- we will wrap the data
 *                                     with the "D" attribute for you.
     */
if ($resultputtest === false) {
	echo "API Error Code: {$api->last_error_code}\n";
	echo "API Error Message: {$api->last_error_mess}\n";
	exit;
} else {
	print_r($resultputtest);
}

// Delete Saved Search 
$resultdeletetest = $api->delete("savedsearches/20110314221916966126000000", $options = array());
 /*	 * @param  $options  An array with the following potential attributes:
 *                     'cache_time' => The time, either in seconds or in the format
 *                                     specified by parse_cache_time, to cache the response.
 *                     'params'     => The array of request parameters to send along with
 *                                     the request.
     */
if ($resultdeletetest === false) {
	echo "API Error Code: {$api->last_error_code}\n";
	echo "API Error Message: {$api->last_error_mess}\n";
	exit;
} else {
	print_r($resultdeletetest);
}

#Spark Platform Documentation Saved Searches Documentation for Spark API