PHP Example using cURL with the v4 REST API to retrieve fields under a module with get_module_fields

REST_PHP_get_module_fields_example.php

<?php

$url = "http://{site_url}/service/v4/rest.php";
$username = "admin";
$password = "password";

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 fields -----------------------------------------------------------------------------------

$get_module_fields_parameters = array(

     //session id
     'session' => $session_id,

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

     //Optional. Returns vardefs for the specified fields. An empty array will return all fields.
     'fields' => array(
         'id',
         'name',
     ),
);

$get_module_fields_result = call("get_module_fields", $get_module_fields_parameters, $url);

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

?>

result.txt

stdClass Object
(
    [module_name] => Accounts
    [table_name] => accounts
    [module_fields] => stdClass Object
        (
            [id] => stdClass Object
                (
                    [name] => id
                    [type] => id
                    [group] => 
                    [id_name] => 
                    [label] => ID
                    [required] => 1
                    [options] => Array
                        (
                        )

                    [related_module] => 
                    [calculated] => 
                    [len] => 
                )

            [name] => stdClass Object
                (
                    [name] => name
                    [type] => name
                    [group] => 
                    [id_name] => 
                    [label] => Name:
                    [required] => 1
                    [options] => Array
                        (
                        )

                    [related_module] => 
                    [calculated] => 
                    [len] => 150
                )

        )

    [link_fields] => Array
        (
        )

)