Difference between revisions of "Return format"

From EN Ikoula wiki
⧼vector-jumptonavigation⧽ ⧼vector-jumptosearch⧽
Line 1: Line 1:
<span data-link_translate_de_title="Rückgabeformat"  data-link_translate_de_url="R%C3%BCckgabeformat"></span>[[:de:Rückgabeformat]][[de:Rückgabeformat]]
 
<span data-link_translate_nl_title="Terugkeer formaat"  data-link_translate_nl_url="Terugkeer+formaat"></span>[[:nl:Terugkeer formaat]][[nl:Terugkeer formaat]]
 
<span data-link_translate_it_title="Formato di ritorno"  data-link_translate_it_url="Formato+di+ritorno"></span>[[:it:Formato di ritorno]][[it:Formato di ritorno]]
 
<span data-link_translate_pt_title="Formato de retorno"  data-link_translate_pt_url="Formato+de+retorno"></span>[[:pt:Formato de retorno]][[pt:Formato de retorno]]
 
<span data-link_translate_es_title="Formato de devolución"  data-link_translate_es_url="Formato+de+devoluci%C3%B3n"></span>[[:es:Formato de devolución]][[es:Formato de devolución]]
 
<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>
 +
 +
<span data-link_translate_de_title="Rückgabeformat"  data-link_translate_de_url="R%C3%BCckgabeformat"></span>[[:fr::de:Rückgabeformat]][[:fr:de:Rückgabeformat]]
 +
 +
 +
  
  
 
<!-- 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 ==
+
==Introduction==
IKoula API offers two format s back for answers : XML & JSON  
+
IKoula API offers two formats back for answers : XML & JSON
  
==Explanations ==
+
==Explanation==
Each method available in the API returns a response.<br />
+
Each method available in the API returns a response. <br />
By default, the return of the API is XML.<br />
+
By default, the return of the API is XML. <br />
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]])
+
It is possible to change this format of return by passing an extra parameter '''format''', set to be '''JSO''' eit '''XM'''. 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 ==
+
==Example==
Here are some examples of calls GET :<br />
+
Here are some examples of calls GET :<br />
 
;Default XML  
 
;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>
 
;XML desired  
 
;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>
;JSON souhaité
+
;JSON desired
 
: <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 ==
+
==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 [[:fr:Génération_de_la_signature| The signature generation]])
+
If you specify the return format, you add an additional parameter to the API call. He should not forget to Add  '''FRON''' 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 />
This article seemed you to be useful ? <vote />
+
This article seemed you to be u ? <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:Contribute]]
 
[[Category:Linux]] -->
 
[[Category:Linux]] -->
  
  
 
<!-- Gestion SEO. Indiquez les informations manquantes -->
 
<!-- Gestion SEO. Indiquez les informations manquantes -->
 +
<br />
 
<comments />
 
<comments />

Revision as of 15:11, 6 October 2015


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

fr::de:Rückgabeformatfr:de:Rückgabeformat




Introduction

IKoula API offers two formats back for answers : XML & JSON

Explanation

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 JSO eit XM. If you add this parameter, do not forget to add it before the generation of your signature (see Attention)

Example

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 desired
https://api.ikoula.com/index.php?r=wsflex/vmlist&login=mail@example.com&crypted_password=password_encrypted&format=json&signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Attention

If you specify the return format, you add an additional parameter to the API call. He should not forget to Add FRON generate your signature (see WIKI de The signature generation)



This article seemed you to be u ?

0




You are not allowed to post comments.