API Merci Facteur /listAdress : Lister les adresses du carnet d'adresses d'un utilisateur.

Base URL API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service

Endpoint API Merci Facteur https://www.merci-facteur.com/api/1.2/prod/service/listAdress

← Retour à la liste des endpoints de l'API Merci Facteur

← Voir ce endpoint dans la doc Swagger

GET /listAdressLister les adresses du carnet d'adresses d'un utilisateur.
 
Voir dans Swagger →

Limité à 500 adresses. Pour plus de précision dans la recherche utilisez le paramètre "search".

Paramètres

NomInTypeDescription
ww-service-idheaderstringVotre service Id
ww-access-tokenheaderstringUn access token valide
idUserqueryintegerUser Id de l'utilisateur propriétaire de cette adresse.
typequerystringType d'adresse : Expéditeur (exp) ou destinataire (dest)
searchquerystringRecherche d'une adresse précise (de la forme {"nom":"","societe":"","cp":"","ville":""}).

Request body

Aucun body.

Réponses

HTTP 200 — Objet contenant les adresses du carnet d'adresses en question

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorstringle code d'erreur en cas d'erreur
adressarray<object>
Items:
PropriétéTypeDescription
idintegerId de l'adresse
civilitestringCivilité du contact
nomstringNom du contact
prenomstringPrénom du contact
societestringSociété du contact
adresse1stringAdresse ligne 1 du contact
adresse2stringAdresse ligne 2 du contact
adresse3stringAdresse ligne 3 du contact
cpstringCode postal du contact
villestringVille du contact
paysstringPays du contact
HTTP 400 — Erreur (code d'erreur dans l'entête)

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle message d'erreur correspondant
HTTP 401 — Erreur authentification (code d'erreur dans l'entête : token invalide ou expiré, service-id incorrecte, IP non autorisée)

application/json

PropriétéTypeDescription
successbooleantrue si HTTP 200, sinon false
errorobjectObjet contenant les infos de l'erreur.
PropriétéTypeDescription
codestringle code d'erreur en cas d'erreur
textstringle message d'erreur correspondant


imprimé en france depuis 2004