MISE À JOUR D'UNE INTERACTION
Cette méthode permet de modifier une interaction si l'utilisateur connecté en a le droit.
URLS DISPONIBLES
MÉTHODE |
URL
|
PUT |
/interaction/:token |
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.
|
CHAMPS REQUIS
NOM |
DESCRIPTION |
idaction
|
L' identifiant unique autoincrémenté.
|
CHAMPS NON AUTORISÉS
NOM |
DESCRIPTION |
idutilisateur
|
L' id est rempli par l'API en fonction de l'utilisateur identifé par l'API Key.
|
date_mod
|
Date de dernière modification calculée automatiquement.
|
date_stat
|
Date calculée automatiquement avec le champ date_action.
|
date_action
|
Date de l'interaction calculée automatiquement.
|
date_fin
|
Date calculée automatiquement avec date_action + duree_heures + duree_minutes.
|
duree_heures
|
Créé automatiquement par l'API.
|
duree_minutes
|
Créé automatiquement par l'API.
|
droits
|
Les droits sont créés automatiquement.
|
CHAMPS OPTIONNELS
La liste des champs optionnels est disponible dans l'onglet Champs
|
RÉSULTAT
Exemple de résultat lors d'un retour positif
|
{
result : 1,
message : 'L' interaction a bien été mise à jour'
}
Exemple de résultat lors d'une erreur liée à la méthode ou un champ non autorisé. Les autres erreurs sont listées dans la section 'Erreurs'
|
{
result : 0,
err_code : 'CODE ERREUR',
err_message : 'Message error'
}
CODE D'ERREUR
Liste des erreurs possibles
|
CODE |
MESSAGE |
INTERACTION_UPDATE_CANTADD_SUJET
|
Impossible de mettre à jour, vous devez remplir le champs sujet.
|
INTERACTION_UPDATE_CANTADD_IDACTION
|
L' idaction est obligatoire pour mettre à jour une interaction.
|
INTERACTION_UPDATE_SUCCESS
|
L' interaction a bien été mise à jour.
|
INTERACTION_UPDATE_UNAUTHORIZED
|
Vous tentez de rentrer un paramètre non autorisé.
|
EXEMPLE D'UTILISATION
JQuery
Exemple d'un code réalisé avec jQuery
$.ajax({
type:'PUT',
url:'linkapi/interaction/yourtoken',
data:$('identifiant du form').serialize(),
dataType:'json',
beforeSend:function(){
//Action à exécuter si besoin
},
success: function(data){
// traitement du retour
},
error:function(xhr,ajaxOptions,thrownError){
//traitement des erreurs
}
});
AngularJS
Exemple d'un code réalisé avec angularJS
var interaction = { sujet: 'sujet de l'interaction};
var deferred =$q.defer();
$http.put('linkapi/interaction/yourtoken',{interaction })
.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
let headers = new Headers({ 'content-type':'application/json;
charset=utf-8'});
let options = new RequestOptions({headers:headers});
return this.http.put('linkapi/contact/yourtoken',data,options)
.toPromise().then(
response => {
let data = response.json();
return data;
},
err => {
return {result:false,message:err};
}
);
|