Outils pour utilisateurs

Outils du site


webservicesdetailsxperience

Différences

Ci-dessous, les différences entre deux révisions de la page.

Lien vers cette vue comparative

Prochaine révision
Révision précédente
webservicesdetailsxperience [2019/11/21 17:00]
sni créée
webservicesdetailsxperience [2019/11/22 15:31] (Version actuelle)
sylvain [4. getfeedbackscsv]
Ligne 1: Ligne 1:
-====== ​WebServicesDetailsXperience ​======+====== ​Xperience WebServices Details ​======
  
-====== Xperience Webservice function : ======+===== Xperience Webservice function : =====
 The Xperience webservice provides 6 functions. These functions can be queried using HTTP requests. They can be reached using URLs created with the webservice address (http://​mkey.services.identificationkey.fr) and a path to a webservice function. The seven functions are: The Xperience webservice provides 6 functions. These functions can be queried using HTTP requests. They can be reached using URLs created with the webservice address (http://​mkey.services.identificationkey.fr) and a path to a webservice function. The seven functions are:
  
- +<​code> ​
  1. /​xperience/​addrecord  1. /​xperience/​addrecord
  2. /​xperience/​getrecord  2. /​xperience/​getrecord
Ligne 11: Ligne 11:
  5. /​xperience/​validate  5. /​xperience/​validate
  6. /​xperience/​updatesddurl  6. /​xperience/​updatesddurl
 +</​code>​
  
-For instance, the URL to call the first function is: http://​mkey.services.identificationkey.fr/​xperience/​addrecord+For instance, the URL to call the first function is: http://​mkey.services.identificationkey.fr/​xperience/​addrecord.
 These functions return Json objects, and each element returned has a specific name (see Development API).  These functions return Json objects, and each element returned has a specific name (see Development API). 
  
-===== 1. addrecord =====+=====1. addrecord =====
 Send a new record of an identification process with xperience mod Send a new record of an identification process with xperience mod
  
Ligne 21: Ligne 22:
  
 **parameter** : **parameter** :
-  * String sddVersion, <​nowiki>//</​nowiki>​ name of the sdd file used for this identification (ex : 20150113-135241.sdd.xml ) 
-  * String sessionid, <​nowiki>//</​nowiki>​ sessionid with the form : BASEID-WHATEVER (ex : 1916916151212-123SDAD32132 ) 
-  * String jsonItemsSelectedmkeyid,​ <​nowiki>//</​nowiki>​ json with the items given by the user (ex : [[123,43]] ) 
-  * String urlImageUser <​nowiki>//</​nowiki>​ (facultatif) 
  
-**returns** ​+  ​String sddVersion => name of the sdd file used for this identification (ex 20150113-135241.sdd.xml ) 
-{ '​status' ​'​ok'​ , '​message' ​// , '​spipollsessionid'​ : 'XXXX-YYYYY' }<br />+  * String sessionid => sessionid with the form BASEID-WHATEVER (ex 1916916151212-123SDAD32132 ) 
 +  * String jsonItemsSelectedmkeyid => json with the items given by the user (ex : [123,43] ) 
 +  * String urlImageUser =(facultatif)
  
-**en cas d'​erreur,​ exemple :** +**returns**  
-{ '​status'​ : 'Error' , '​message'​ : '​Xperiense Data Base not found' ​, +<​code>​{ '​status'​ : 'ok' , '​message'​ : // , '​spipollsessionid'​ : '​XXXX-YYYYY'​ }</​code>​
-'​spipollsessionid'​ : '​XXXX-YYYYY'​ }+
  
 +**error example :** 
 +<​code>​{ '​status'​ : '​Error'​ , '​message'​ : '​Xperiense Data Base not found' ,'​spipollsessionid'​ : '​XXXX-YYYYY'​ }</​code>​
  
-===== 2. getrecord =====+=====2. getrecord =====
 get a history entry get a history entry
  
Ligne 40: Ligne 40:
  
 **parameter** : **parameter** :
-  * String sessionid <​nowiki>//</​nowiki>​ sessionid with the form : BASEID-WHATEVER (ex : 1916916151212-123SDAD32132) 
  
 +  * String sessionid => sessionid with the form : BASEID-WHATEVER (ex : 1916916151212-123SDAD32132)
  
 **returns** : **returns** :
-feed the json return with the list of taxa given by the user <br /> +feed the json return with the list of taxa given by the user 
-{ "​status"​ : "​ok"​ , "​value"​ : {"​urlimage":"​none","​items":​[["​979","​1077"​]],"​sessionid":"​0123456789-id666"​} }<br />+<code>{ "​status"​ : "​ok"​ , "​value"​ : {"​urlimage":"​none","​items":​["​979","​1077"​],"​sessionid":"​0123456789-id666"​} }</code>
  
-**ou en cas d'​erreur,​ exemple** :<br /> +**error example :** 
-{ "​status"​ : "​error"​ , "​value"​ : {"​message":"​Record not found","​sessionid":"​0123456789-id66"​} }+<code>{ "​status"​ : "​error"​ , "​value"​ : {"​message":"​Record not found","​sessionid":"​0123456789-id66"​} }</​code>​
  
  
Ligne 57: Ligne 57:
  
 **parameter** : **parameter** :
-  * String sessionid ​<​nowiki>//</​nowiki> sessionid with the form : BASEID-WHATEVER (ex : 1916916151212-123SDAD32132) +  * String sessionid ​=> sessionid with the form : BASEID-WHATEVER (ex : 1916916151212-123SDAD32132)
  
 **returns** : **returns** :
-{ "​status"​ : "​ok"​ , "​value"​ : {"​items":​{"​Les Sphinx du Pin et mauresque (<​i>​Sphinx maurorum<​\/​i>,​ <​i>​Sphinx pinastri<​\/​i>​)":"​1031","​Les Clairons brillants (<​i>​Korynetes<​\/​i>​ et autres)":"​812","​L'​Ecaille marbrée (<​i>​Callimorpha dominula<​\/​i>​)":"​402"​},"​sessionid":"​0123456789-id666"​} }<br />+<​code>​{ "​status"​ : "​ok"​ , "​value"​ : {"​items":​{"​Les Sphinx du Pin et mauresque (<​i>​Sphinx maurorum<​\/​i>,​ <​i>​Sphinx pinastri<​\/​i>​)":"​1031","​Les Clairons brillants (<​i>​Korynetes<​\/​i>​ et autres)":"​812","​L'​Ecaille marbrée (<​i>​Callimorpha dominula<​\/​i>​)":"​402"​},"​sessionid":"​0123456789-id666"​} }</code>
  
-**ou en cas d'​erreur,​ exemple** :<br /> +**error example :**  
-{ "​status"​ : "​error"​ , "​value"​ : {"​message":"​Record not found","​sessionid":"​0123456789-id66"​} }+<code>{ "​status"​ : "​error"​ , "​value"​ : {"​message":"​Record not found","​sessionid":"​0123456789-id66"​} }</​code>​
  
  
Ligne 73: Ligne 72:
  
 **parameter** : **parameter** :
-  * String baseid ​<​nowiki>//</​nowiki> id of the base (ex : 1916916151212) +  * String baseid ​=> id of the base (ex : 1916916151212)
  
 **returns** : **returns** :
-{ '​status'​ : '​ok'​ , '​value'​ : 'LES MATRICES'​ }<br />+<​code>​{ '​status'​ : '​ok'​ , '​value'​ : 'LES MATRICES'​ }</code>
  
-**ou en cas d'​erreur,​ exemple** :<br /> +**error example :**  
-{ "​status":"​error"​ ,"​value":​{"​message":"​Xperience Base not found",​ "​baseid":"​0123456789"​} }+<code>{ "​status":"​error"​ ,"​value":​{"​message":"​Xperience Base not found",​ "​baseid":"​0123456789"​} }</​code>​
  
 **LES MATRICES :** **LES MATRICES :**
-*TaxaNames (metadata) : Liste des identifiants des items avec leurs noms + 
-*DescriptorsNames (metadata) : Liste des identifiants des descripteurs avec leurs noms +  ​* TaxaNames (metadata) : Liste des identifiants des items avec leurs noms 
-*StatesNames (metadata) : Liste des identifiants des états avec leurs noms +  * DescriptorsNames (metadata) : Liste des identifiants des descripteurs avec leurs noms 
-*TaxaConfusion : Une seule matrice de confusion des taxons +  * StatesNames (metadata) : Liste des identifiants des états avec leurs noms 
-*TaxaDescriptor : Une seule matrice avec en rangé les items et en colonne les descripteurs. Pour chaque descritpeurs,​ quatres colonnes : nombre d'​utilisation,​ nombre d'​erreurs,​ nombre de doute, nombre d'​erreur apres un doute +  * TaxaConfusion : Une seule matrice de confusion des taxons 
-*StatesConfusionByDescriptor : Un matrice confusion entre les états par descripteur. Avant chaque matrice un ligne avec “DescIDDESCRIPTEUR” (ex : Desc12) +  * TaxaDescriptor : Une seule matrice avec en rangé les items et en colonne les descripteurs. Pour chaque descritpeurs,​ quatres colonnes : nombre d'​utilisation,​ nombre d'​erreurs,​ nombre de doute, nombre d'​erreur apres un doute 
-*StatesConfusionByDescriptor : Un matrice confusion entre les états par descripteur et par items. Avant chaque matrice un ligne avec “TaxonIDTAXON;​DescIDDESCRIPTEUR” (ex : Taxon43;​Desc12)+  * StatesConfusionByDescriptor : Un matrice confusion entre les états par descripteur. Avant chaque matrice un ligne avec “DescIDDESCRIPTEUR” (ex : Desc12) 
 +  * StatesConfusionByDescriptor : Un matrice confusion entre les états par descripteur et par items. Avant chaque matrice un ligne avec “TaxonIDTAXON;​DescIDDESCRIPTEUR” (ex : Taxon43;​Desc12)
  
  
Ligne 98: Ligne 97:
  
 **parameter** : **parameter** :
-  * String item <​nowiki>//</​nowiki> uniqueid of the item that will be used for the validation ((ex : 32) +  * String item => uniqueid of the item that will be used for the validation ((ex : 32) 
-  * String sessionid ​<​nowiki>//</​nowiki> sessionid with the form : BASEID-WHATEVER (ex : 1916916151212-123SDAD32132)+  * String sessionid ​=> sessionid with the form : BASEID-WHATEVER (ex : 1916916151212-123SDAD32132)
  
  
 **returns** : **returns** :
-{ "​status"​ : "​ok"​ , "​value"​ : {"​message":"​record validated","​sessionid":"​0123456789-id666","​taxon":"​371"​} }+<​code>​{ "​status"​ : "​ok"​ , "​value"​ : {"​message":"​record validated","​sessionid":"​0123456789-id666","​taxon":"​371"​} }</​code>​
  
 **En cas de taxon non trouvé, on renvoie la liste des taxons possibles, dans “items” :** **En cas de taxon non trouvé, on renvoie la liste des taxons possibles, dans “items” :**
-{ "​status"​ : "​notfound"​ , "​value"​ : {"​items":​{"​Les Sphinx du Pin et mauresque (<​i>​Sphinx maurorum<​\/​i>,​ <​i>​Sphinx pinastri<​\/​i>​)":"​1031"​},"​sessionid":"​0123456789-id666","​taxon":"​1213"​} }+<​code>​{ "​status"​ : "​notfound"​ , "​value"​ : {"​items":​{"​Les Sphinx du Pin et mauresque (<​i>​Sphinx maurorum<​\/​i>,​ <​i>​Sphinx pinastri<​\/​i>​)":"​1031"​},"​sessionid":"​0123456789-id666","​taxon":"​1213"​} }</​code>​
  
-**Ou en cas d'​erreur,​ exemple ​:** +**error example ​:**  
-{ "​status"​ : "​error"​ , "​value"​ : {"​message":"​Record not found","​sessionid":"​0123456789-id1","​taxon":"​1213"​} }+<​code>​{ "​status"​ : "​error"​ , "​value"​ : {"​message":"​Record not found","​sessionid":"​0123456789-id1","​taxon":"​1213"​} }</​code>​
  
 ===== 6. updatesddurl ===== ===== 6. updatesddurl =====
Ligne 117: Ligne 116:
  
 **parameter** : **parameter** :
-  * String baseid ​<​nowiki>//</​nowiki> baseid : id of the base (ex : 1916916151212) +  * String baseid ​=> baseid : id of the base (ex : 1916916151212) 
-  * String sddurl ​<​nowiki>//</​nowiki> the news sdd url. See the sddmanger (ex: http://​nomdomain.com/​messdd/​ +  * String sddurl ​=> the news sdd url. See the sddmanger (ex: http://​nomdomain.com/​messdd/​
  
 **returns** : **returns** :
-{ '​status'​ : '​ok'​ , '​message'​ : // }+<​code>​{ '​status'​ : '​ok'​ , '​message'​ : // }</​code>​
  
 **En cas de taxon non trouvé, on renvoie la liste des taxons possibles, dans “items” :** **En cas de taxon non trouvé, on renvoie la liste des taxons possibles, dans “items” :**
-{ '​status'​ : '​error'​ , '​message'​ : '​Xperience Base not found' }+<​code>​{ '​status'​ : '​error'​ , '​message'​ : '​Xperience Base not found' }</​code>​
  
-**Ou en cas d'​erreur,​ exemple ​:** +**error example ​:**  
-{ "​status"​ : "​error"​ , "​value"​ : {"​message":"​Record not found","​sessionid":"​0123456789-id1","​taxon":"​1213"​} }+<​code>​{ "​status"​ : "​error"​ , "​value"​ : {"​message":"​Record not found","​sessionid":"​0123456789-id1","​taxon":"​1213"​} }</​code>​
webservicesdetailsxperience.1574355604.txt.gz · Dernière modification: 2019/11/21 17:00 par sni