Support array for json_data posted in rest/json service

[Ousret]

When using x-www-form-urlencoded we could leverage the possibility to send array instead of raw json as PHP support it out of the box.

This change/bugfix is not BC-Break.

I do not know if this is a bug or not, when reading current documentation, it is not clearly stated that json_data should be a string.

auth_user=my_user&auth_pwd=my_password&json_data%5Boperation%5D=core%2Fget&json_data%5Bclass%5D=ServiceChange&json_data%5Bkey%5D=SELECT+ServiceChange+WHERE+id%3D1&json_data%5Boutput_fields%5D=request_state

instead of

auth_user=my_user&auth_pwd=my_password&json_data=%7B%22operation%22%3A+%22core%2Fget%22%2C+%22class%22%3A+%22ServiceChange%22%2C+%22key%22%3A+%22SELECT+ServiceChange+WHERE+id%3D1%22%2C+%22output_fields%22%3A+%22request_state%22%7D

It is more convenient to post json_data[operation]=core/get instead of json_data={"operation": "core/get"..

[Hipska]

Actually, JSON is a string by definition, but I like your suggestion.

[Ousret]

@Hipska absolutely JSON is a string. But sending raw JSON through HTTP x-www-form-urlencoded is not a good idea for maintenance/readability. Or we could support application/json instead of x-www-form-urlencoded. That could work too.

[piRGoif]

Just a note for when this PR will be reviewed : there is a corresponding Combodo support UR, referenced R-023452

[Ousret]

Doc has been updated. https://www.itophub.io/wiki/page?id=latest%3Aadvancedtopics%3Arest_json

[piRGoif]

J'ai peut-être un projet interessant à partager avec la communauté iTop.

Please use english :)
And also, you should better communicate on this in the appropriate forum section : https://sourceforge.net/p/itop/discussion/third-party-extensions/

[piRGoif]

This was submitted in Combodo ticket DB as N°2767, candidate for iTop 2.8.

@Ousret sorry it took us so much time to accept this PR... We were (and still are in a way) quite busy with the 2.7.0... We are aiming to integrate this in 2.8.0.

[Hipska]

If this would be implemented, can I suggest that the params would then be like this?

auth_user=my_user&auth_pwd=my_password&operation=core%2Fget&class=ServiceChange&key=SELECT+ServiceChange+WHERE+id%3D1&output_fields=request_state

[piRGoif]

Hello,
I just did a review, the code seems ok but I would prefer to test it with real world examples...

Here is below a PHP caller using current json_data as string. Can you send back a script that would generate the new parameter format ?

<?php

$curl = curl_init();


$aStdOptions = array('auth_user' => 'admin','auth_pwd' => 'admin');

// JSON form
$aJsonData = array('json_data' => '{
   "operation": "core/get",
   "class": "Person",
   "key": "SELECT Person", "limit": "10", "page": "1"
}');

	curl_setopt_array($curl, array(
	CURLOPT_URL => 'http://localhost/itop-dev/webservices/rest.php?version=1.4',
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 0,
	CURLOPT_FOLLOWLOCATION => true,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "POST",
	CURLOPT_POSTFIELDS => array_merge($aStdOptions, $aJsonData),
	CURLOPT_HTTPHEADER => array(
		'Cookie: XDEBUG_SESSION=netbeans-ide',
	),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

[Hipska]

When implementing my suggestion, it would be:

$aJsonData = array(
   "operation" => "core/get",
   "class" => "Person",
   "key" => "SELECT Person",
   "limit" => 10,
   "page" => 1
);

When the initial suggestion is implemented, it would be:

$aJsonData = array(
    "json_data[operation]" => "core/get",
    "json_data[class]" => "Person",
    "json_data[key]" => "SELECT Person",
    "json_data[limit]" => 10,
    "json_data[page]" => 1
 );

[piRGoif]

Many thanks Thomas, I was able to test then :)

I like your solution... Should be doable with little modification... I'm merging this for now :)

[piRGoif]

When implementing my suggestion, it would be:

$aJsonData = array(
   "operation" => "core/get",
   "class" => "Person",
   "key" => "SELECT Person",
   "limit" => 10,
   "page" => 1
);

I implemented something to handle this, see #130. @Hipska and @Ousret I'd like to have your feedback in this new PR !

[piRGoif]

@Ousret I will add you to the contributors list in our README.md. How would you prefer to be seen ? With your real name, your github name ?

[Ousret]

With my Github name, or both. 👍

[piRGoif]

This was also merged to support/2.7 branch, and will be available in the future 2.7.1 version.

[Hipska]

Doc has been updated. https://www.itophub.io/wiki/page?id=latest%3Aadvancedtopics%3Arest_json

@Ousret I don't see this reflected in the docs (Also not for 2.7)

[piRGoif]

Ousret comment was made in nov 2019...
What did you expect to see in the wiki page @Hipska ?

[Hipska]

Okay, now you make me wonder what he meant. What exactly was updated in the doc? Since I would expect a line somewhere you could also use the array syntax as introduced by this PR..

[piRGoif]

Woops I forgot to answer about the documentation sorry !

I've just published this little extra paragraph : https://www.itophub.io/wiki/page?id=latest%3Aadvancedtopics%3Arest_json#parameters_in_a_php_array_form

[Hipska]

Great, maybe also mention this on the 2.7 wiki pages for people staying on the LTS release?

[piRGoif]

Done : https://www.itophub.io/wiki/page?id=2_7_0%3Aadvancedtopics%3Arest_json#parameters_in_a_php_array_form