PHP Example using cURL with the v4 REST API to retrieve leads related to a specific target list with get_relationships

REST_PHP_get_relationships_example.php

<?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;

//retrieve related list -------------------------------------------------------------------------------

$get_relationships_parameters = array(

     'session'=>$session_id,

     //The name of the module from which to retrieve records.
     'module_name' => 'ProspectLists',

     //The ID of the specified module bean.
     'module_id' => '76d0e694-ef66-ddd5-9bdf-4febd3af44d5',

     //The relationship name of the linked field from which to return records.
     'link_field_name' => 'leads',

     //The portion of the WHERE clause from the SQL statement used to find the related items.
     'related_module_query' => '',

     //The related fields to be returned.
     'related_fields' => array(
        'id',
        'first_name',
        'last_name',
     ),

     //For every related bean returned, specify link field names to field information.
     'related_module_link_name_to_fields_array' => array(
     ),

     //To exclude deleted records
     'deleted'=> '0',

     //order by
     'order_by' => '',

     //offset
     'offset' => 0,

     //limit
     'limit' => 5,
);

$get_relationships_result = call("get_relationships", $get_relationships_parameters, $url);

echo "<pre>";
print_r($get_relationships_result);
echo "</pre>";

?>

result.txt

stdClass Object
(
    [entry_list] => Array
        (
            [0] => stdClass Object
                (
                    [id] => 117c26c0-11d4-7b8b-cb8f-4f7cb6823dd8
                    [module_name] => Leads
                    [name_value_list] => stdClass Object
                        (
                            [id] => stdClass Object
                                (
                                    [name] => id
                                    [value] => 117c26c0-11d4-7b8b-cb8f-4f7cb6823dd8
                                )

                            [first_name] => stdClass Object
                                (
                                    [name] => first_name
                                    [value] => Diane
                                )

                            [last_name] => stdClass Object
                                (
                                    [name] => last_name
                                    [value] => Mckamey
                                )

                        )

                )

            [1] => stdClass Object
                (
                    [id] => 142faeef-1a19-b53a-b780-4f7cb600c553
                    [module_name] => Leads
                    [name_value_list] => stdClass Object
                        (
                            [id] => stdClass Object
                                (
                                    [name] => id
                                    [value] => 142faeef-1a19-b53a-b780-4f7cb600c553
                                )

                            [first_name] => stdClass Object
                                (
                                    [name] => first_name
                                    [value] => Leonor
                                )

                            [last_name] => stdClass Object
                                (
                                    [name] => last_name
                                    [value] => Reser
                                )

                        )

                )

        )

    [relationship_list] => Array
        (
        )

)