Editer

MISE À JOUR D'UN CONTACT

Cette méthode permet de modifier un contact si l'utilisateur connecté en a le droit.

URLS DISPONIBLES

MÉTHODE	URL
PUT	/contact/: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
idcontact	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.
nom_prenom	Nom et prénom du contact créé automatiquement.
droits	Droits.

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	    :	'Le contact a bien été mis à 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
CONTACT_UPDATE_CANTADD_NOMCONTACT	Impossible de mettre à jour, vous devez remplir le champs nom_contact.
CONTACT_UPDATE_CANTADD_IDCONTACT	L' idcontact est obligatoire pour mettre à jour un contact.
CONTACT_UPDATE_SUCCESS	Le contact a bien été mis à jour.
CONTACT_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/contact/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 contact = { nom_contact: 'nom du contact'};

    var deferred =$q.defer();
		$http.put('linkapi/contact/yourtoken',{contact }) 
		.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};
				}
			);