webservicesdetailsxperience
Différences
Ci-dessous, les différences entre deux révisions de la page.
Les deux révisions précédentesRévision précédenteProchaine révision | Révision précédenteProchaine révisionLes deux révisions suivantes | ||
webservicesdetailsxperience [2019/11/22 16:05] – [WebServicesDetailsXperience] sylvain | webservicesdetailsxperience [2019/11/22 16:23] – [1. addrecord] sylvain | ||
---|---|---|---|
Ligne 1: | Ligne 1: | ||
====== Xperience WebServices Details ====== | ====== 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:// | 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:// | ||
- | + | < | |
1. / | 1. / | ||
2. / | 2. / | ||
Ligne 11: | Ligne 11: | ||
5. / | 5. / | ||
6. / | 6. / | ||
+ | </ | ||
- | For instance, the URL to call the first function is: http:// | + | For instance, the URL to call the first function is: http:// |
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, | + | * String sddVersion,// |
- | * String sessionid, | + | * String sessionid,// |
- | * String jsonItemsSelectedmkeyid, | + | * String jsonItemsSelectedmkeyid,// |
- | * String urlImageUser | + | * String urlImageUser// |
- | **returns** : | + | **returns** : |
- | { ' | + | < |
- | + | ||
- | **en cas d' | + | |
- | { ' | + | |
- | ' | + | |
+ | **error example :** | ||
+ | < | ||
- | ===== 2. getrecord ===== | + | =====2. getrecord ===== |
get a history entry | get a history entry | ||
Ligne 40: | Ligne 39: | ||
**parameter** : | **parameter** : | ||
- | * String sessionid < | ||
+ | * String sessionid,// | ||
**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 |
- | { " | + | <code>{ " |
- | **ou en cas d' | + | **error example :** |
- | { " | + | <code>{ " |
Ligne 57: | Ligne 56: | ||
**parameter** : | **parameter** : | ||
- | * String sessionid | + | * String sessionid// |
**returns** : | **returns** : | ||
- | { " | + | < |
- | **ou en cas d' | + | **error example :** |
- | { " | + | <code>{ " |
Ligne 73: | Ligne 71: | ||
**parameter** : | **parameter** : | ||
- | * String baseid | + | * String baseid//id of the base (ex : 1916916151212) |
**returns** : | **returns** : | ||
- | { ' | + | < |
- | **ou en cas d' | + | **error example :** |
- | { " | + | <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 | + | * DescriptorsNames (metadata) : Liste des identifiants des descripteurs avec leurs noms |
- | *StatesNames (metadata) : Liste des identifiants des états avec leurs noms | + | * StatesNames (metadata) : Liste des identifiants des états avec leurs noms |
- | *TaxaConfusion : Une seule matrice de confusion des taxons | + | * TaxaConfusion : Une seule matrice de confusion des taxons |
- | *TaxaDescriptor : Une seule matrice avec en rangé les items et en colonne les descripteurs. Pour chaque descritpeurs, | + | * TaxaDescriptor : Une seule matrice avec en rangé les items et en colonne les descripteurs. Pour chaque descritpeurs, |
- | *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. 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; | + | * StatesConfusionByDescriptor : Un matrice confusion entre les états par descripteur et par items. Avant chaque matrice un ligne avec “TaxonIDTAXON; |
Ligne 98: | Ligne 95: | ||
**parameter** : | **parameter** : | ||
- | * String item < | + | * String item // uniqueid of the item that will be used for the validation ((ex : 32) |
- | * String sessionid | + | * String sessionid // sessionid with the form : BASEID-WHATEVER (ex : 1916916151212-123SDAD32132) |
**returns** : | **returns** : | ||
- | { " | + | < |
**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” :** | ||
- | { " | + | < |
- | **Ou en cas d' | + | **error example |
- | { " | + | < |
===== 6. updatesddurl ===== | ===== 6. updatesddurl ===== | ||
Ligne 117: | Ligne 114: | ||
**parameter** : | **parameter** : | ||
- | * String baseid | + | * String baseid // baseid : id of the base (ex : 1916916151212) |
- | * String sddurl | + | * String sddurl // the news sdd url. See the sddmanger (ex: http:// |
**returns** : | **returns** : | ||
- | { ' | + | < |
**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” :** | ||
- | { ' | + | < |
- | **Ou en cas d' | + | **error example |
- | { " | + | < |
webservicesdetailsxperience.txt · Dernière modification : 2019/11/22 16:31 de sylvain