Difference between revisions of "Return format"

From EN Ikoula wiki
⧼vector-jumptonavigation⧽ ⧼vector-jumptosearch⧽
Line 1: Line 1:
−
<span data-link_translate_fr_title="Format de retour"  data-link_translate_fr_url="Format_de_retour"></span>[[:fr:Format de retour]][[fr:Format de retour]]
 
 
<br />
 
<br />
  
 
This article has been created by an automatic translation software. You can view the article source [[:fr:Format de retour|here]].<br /><span data-translate="fr"></span>
 
This article has been created by an automatic translation software. You can view the article source [[:fr:Format de retour|here]].<br /><span data-translate="fr"></span>
 +
  
 
<!-- Début de l'article. Placez votre texte ci-après et n'hésitez pas à personnaliser les chapitres selon votre besoin -->
 
<!-- Début de l'article. Placez votre texte ci-après et n'hésitez pas à personnaliser les chapitres selon votre besoin -->
  
−
====
+
==Introduction ==
−
: &  
+
IKoula API offers two format s back for answers : XML & JSON
  
−
====
+
==Explanations ==
−
<br />
+
Each method available in the API returns a response.<br />
−
<br />
+
By default, the return of the API is XML.<br />
−
'''''''''''' ''''''([[:fr:Format_de_retour#Attention| Attention]])
+
It is possible to change this format  of return by passing an extra parameter '''format ''', set to be '''JSON ''' either '''XML '''. If you add this parameter, do not forget to add it before the generation of your signature (see [[:fr:Format_de_retour#Attention| Attention]])
  
−
====
+
==Examples ==
−
:<br />
+
Here are some examples of calls GET :<br />
−
;par défaut
+
;Default XML
 
: <pre>https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pre>
 
: <pre>https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pre>
−
;souhaité
+
;XML desired
 
: <pre>https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=xml&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pre>
 
: <pre>https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=xml&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pre>
−
; souhaité
+
;JSON  souhaité
 
: <pre>https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=json&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pre>
 
: <pre>https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=json&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx</pre>
  
−
====
+
==Attention ==
−
Si vous précisez le  de retour, vous ajoutez un paramètre supplémentaire à l'appel API. Il ne faut donc pas oublier de l'ajouter '''''' (WIKI de [[:fr:Génération_de_la_signature| The signature generation]])
+
Si vous précisez le format de retour, vous ajoutez un paramètre supplémentaire à l'appel API. Il ne faut donc pas oublier de l'ajouter '''FRONT ''' generate your signature (see WIKI de [[:fr:Génération_de_la_signature| The signature generation]])
  
 
<!-- Fin de l'article -->
 
<!-- Fin de l'article -->
 
<br /><br />
 
<br /><br />
−
? <vote />
+
This article seemed you to be useful ? <vote />
 
<!-- Placez ici la ou les catégories auxquelles se rapporte votre article. Une ligne par catégorie. Ex:  
 
<!-- Placez ici la ou les catégories auxquelles se rapporte votre article. Une ligne par catégorie. Ex:  
 
[[Category:Help]]
 
[[Category:Help]]
Line 35: Line 35:
  
 
<!-- Gestion SEO. Indiquez les informations manquantes -->
 
<!-- Gestion SEO. Indiquez les informations manquantes -->
−
 
 
<comments />
 
<comments />

Revision as of 08:08, 24 September 2015


This article has been created by an automatic translation software. You can view the article source here.


Introduction

IKoula API offers two format s back for answers : XML & JSON

Explanations

Each method available in the API returns a response.
By default, the return of the API is XML.
It is possible to change this format of return by passing an extra parameter format , set to be JSON either XML . If you add this parameter, do not forget to add it before the generation of your signature (see Attention)

Examples

Here are some examples of calls GET :

Default XML
https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
XML desired
https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=xml&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx
JSON souhaité
https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=json&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Attention

Si vous précisez le format de retour, vous ajoutez un paramètre supplémentaire à l'appel API. Il ne faut donc pas oublier de l'ajouter FRONT generate your signature (see WIKI de The signature generation)



This article seemed you to be useful ?

0



You are not allowed to post comments.

Retrieved from "https://en-wiki.ikoula.com/index.php?title=Return_format&oldid=886"