DETAIL D'UNE ENTITE
Cette méthode retourne les détails de l'entite demandé si l'utilisateur, authentifié via le token, a accès.
URLS DISPONIBLES
MÉTHODE |
URL |
GET |
/lkentity/:token/:id |
Url de base. |
PARAMÈTRES D'URL
NOM |
REQUIS |
DESCRIPTION |
Token
|
requis
|
Le token est requis et est fourni par l'api, voir la documentation sur le token pour plus de renseignements.
|
id
|
requis
|
L' id doit être fourni pour récuperer l'entite.
|
Vous pouvez également ajouter les paramètres pour la pagination, veuillez vous referer à la section pagination pour de plus amples informations. |
RÉSULTAT
Exemple de résultat lors d'un retour positif
|
{
result : 1,
identity : 1,
entity_name : 'entity name',
entity_name_db : 'entity name db'
}
EXEMPLE D'UTILISATION
JQuery
Exemple d'un code réalisé avec jQuery
$.ajax({
type:'GET',
url:'linkapi/lkentity/yourtoken/identity',
dataType:'json',
beforeSend:function(){
//Action à exécuter si besoin
},
success: function(data){
// traitement du retour, vérifier d'abord si il y a un résultat
if(data.result){
console.log('L id :'+data.identity)
}else{
//Traitement de l'erreur
}
},
error:function(xhr,ajaxOptions,thrownError){
//traitement des erreurs
}
});
AngularJS
Exemple d'un code réalisé avec angularJS
var deferred =$q.defer();
$http.get('linkapi/lkentity/yourtoken/identity')
.success(function(data){
deferred.resolve(data);
}).error(function(data,status){
deferred.reject('Message personalisé');
})
return deferred.promise;
Angular2
Exemple d'un code réalisé avec angular2 en typescript
return this.http.get('linkapi/lkentity/yourtoken/identity')
.toPromise().then(
response => {
let data = response.json();
if(data.result){
console.log(data.identity);
}
return data;
},
err => {
return {result:false,message:err};
}
);
|