how to retrieve list of campaings the suiteCRM API

👨‍💻 Development Help
1

How to retrieve list of campaings the suiteCRM API, can´t I find the module name campaings my source code retrieve that error

////////////////////////////////////////////////

<?php

$url = "URL/service/v4_1/rest.php";
$username = "user";
$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);

$session_id = $login_result->id;

$get_entry_list_parameters = array(

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

//The name of the module from which to retrieve records -      <<<<<<<<<<<<<<<<<<<<<<<<<<<<< !!!
    'module_name' => 'Campaing_lead',

    //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',
    ),

    /*
    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(
        array(
            'name' => 'teams',
            'value' => array(
                'id',
                'name'
            ),
        ),
    ),


    //The maximum number of results to return.
    'max_results' => '100',

    //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>';

?>

//////////////////////////////////////////////////////////////

2

this mistake:
stdClass Object
(
[name] => Module Does Not Exist
[number] => 20
[description] => This module is not available on this server
)

3

Maybe you have one or mre spelling mistakes.

I found in your code:

Campaing_lead

instead of:

Campaign_lead

(note the position of the letter “n”)

Additionally I am not sure if that is the name of a module but you could start from this correction.

1 Like
4

yes you are right, the error was in “n” and the module name “campaigns”.