Created
June 28, 2012 19:42
-
-
Save sugarknowledge/3013417 to your computer and use it in GitHub Desktop.
PHP Example using cURL with the v4 SOAP API to retrieve a list of records with get_entry_list
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
$url = "http://{site_url}/service/v4/rest.php"; | |
$username = "admin"; | |
$password = "password"; | |
//function to make cURL request | |
function call($method, $parameters, $url) | |
{ | |
ob_start(); | |
$curl_request = curl_init(); | |
curl_setopt($curl_request, CURLOPT_URL, $url); | |
curl_setopt($curl_request, CURLOPT_POST, 1); | |
curl_setopt($curl_request, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0); | |
curl_setopt($curl_request, CURLOPT_HEADER, 1); | |
curl_setopt($curl_request, CURLOPT_SSL_VERIFYPEER, 0); | |
curl_setopt($curl_request, CURLOPT_RETURNTRANSFER, 1); | |
curl_setopt($curl_request, CURLOPT_FOLLOWLOCATION, 0); | |
$jsonEncodedData = json_encode($parameters); | |
$post = array( | |
"method" => $method, | |
"input_type" => "JSON", | |
"response_type" => "JSON", | |
"rest_data" => $jsonEncodedData | |
); | |
curl_setopt($curl_request, CURLOPT_POSTFIELDS, $post); | |
$result = curl_exec($curl_request); | |
curl_close($curl_request); | |
$result = explode("\r\n\r\n", $result, 2); | |
$response = json_decode($result[1]); | |
ob_end_flush(); | |
return $response; | |
} | |
//login ------------------------------------------------------------------------------------------- | |
$login_parameters = array( | |
"user_auth"=>array( | |
"user_name"=>$username, | |
"password"=>md5($password), | |
"version"=>"1" | |
), | |
"application_name"=>"RestTest", | |
"name_value_list"=>array(), | |
); | |
$login_result = call("login", $login_parameters, $url); | |
/* | |
echo "<pre>"; | |
print_r($login_result); | |
echo "</pre>"; | |
*/ | |
//get session id | |
$session_id = $login_result->id; | |
//get list of records ------------------------------------------------------------------------------ | |
$get_entry_list_parameters = array( | |
//session id | |
'session' => $session_id, | |
//The name of the module from which to retrieve records | |
'module_name' => 'Leads', | |
//The SQL WHERE clause without the word "where". | |
'query' => "", | |
//The SQL ORDER BY clause without the phrase "order by". | |
'order_by' => "", | |
//The record offset from which to start. | |
'offset' => '0', | |
//Optional. A list of fields to include in the results. | |
'select_fields' => array( | |
'id', | |
'name', | |
'title', | |
), | |
/* | |
A list of link names and the fields to be returned for each link name. | |
Example: 'link_name_to_fields_array' => array(array('name' => 'email_addresses', 'value' => array('id', 'email_address', 'opt_out', 'primary_address'))) | |
*/ | |
'link_name_to_fields_array' => array( | |
), | |
//The maximum number of results to return. | |
'max_results' => '2', | |
//To exclude deleted records | |
'deleted' => '0', | |
//If only records marked as favorites should be returned. | |
'Favorites' => false, | |
); | |
$get_entry_list_result = call('get_entry_list', $get_entry_list_parameters, $url); | |
echo '<pre>'; | |
print_r($get_entry_list_result); | |
echo '</pre>'; | |
?> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stdClass Object | |
( | |
[result_count] => 2 | |
[total_count] => 200 | |
[next_offset] => 2 | |
[entry_list] => Array | |
( | |
[0] => stdClass Object | |
( | |
[id] => 18124607-69d1-b158-47ff-4f7cb69344f7 | |
[module_name] => Leads | |
[name_value_list] => stdClass Object | |
( | |
[id] => stdClass Object | |
( | |
[name] => id | |
[value] => 18124607-69d1-b158-47ff-4f7cb69344f7 | |
) | |
[name] => stdClass Object | |
( | |
[name] => name | |
[value] => Bernie Worthey | |
) | |
[title] => stdClass Object | |
( | |
[name] => title | |
[value] => Senior Product Manager | |
) | |
) | |
) | |
[1] => stdClass Object | |
( | |
[id] => 1cdfddc1-2759-b007-8713-4f7cb64c2e9c | |
[module_name] => Leads | |
[name_value_list] => stdClass Object | |
( | |
[id] => stdClass Object | |
( | |
[name] => id | |
[value] => 1cdfddc1-2759-b007-8713-4f7cb64c2e9c | |
) | |
[name] => stdClass Object | |
( | |
[name] => name | |
[value] => Bobbie Kohlmeier | |
) | |
[title] => stdClass Object | |
( | |
[name] => title | |
[value] => Director Operations | |
) | |
) | |
) | |
) | |
[relationship_list] => Array | |
( | |
) | |
) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment