Contact

Les contacts peuvent être manipulés à travers l'objet ncContact dans l'API.

L'objet ncContact

Le contact récupéré ou à insérer via l'API est un objet comprenant les méthodes suivantes :
Guid : L'identifiant du compte
Label : Le nom et le prénom du contact
Name : Le nom de famille
FirstName : Le prénom
Extcode : Code externe (celui d'une application externe par exemple)
Function : La fonction dans l'entreprise
Gender : L'appelation (Monsieur, Madame...)
Phone : Le téléphone fixe
Cell : Le téléphone mobile
Fax : Le fax
EMail : L'EMail
AssignedTo : A quelle personne est-il affecté (de la forme {FullName:'', Guid:'', Extcode:''})
Origin : L'origine du contact. A renseigner comme suit : { Code : 'XXXX' }. Le code doit être défini dans la liste Origine au niveau de l'application Koban
Third : Un objet ncThird représentant le compte associé au contact
Chaque objet dispose également d'une propriété Updated spécifiant la dernière date de modification.

Méthodes disponibles

Exemples

Création ou modification de plusieurs contacts

Cet exemple lance la création ou la modification de 3 contacts dans Koban à partir d'une application tierce :

Les comptes auront préalablement été créés ou mis à jour grâce à la méthode d'API ncThird/PostMany.

Paramétrage préalable de Koban dans ce cas :

L'appel se fera sur la clé EMail pour dédoublonner les contacts avant insertion ou mise à jour sur l'email. Le compte associé sera repéré grâce à la propriété Code Externe Extcode

POST /api/v1/ncContact/PostMany?uniqueproperty=Email&thirduniqueproperty=Extcode HTTP/1.1
Host: app-koban.com X-ncApi: XXXXXXXXXXXX X-ncUser: XXXXXXXXXXXX Accept: application/json Content-Type: application/json Cache-Control: no-cache
[{ "Name":"DURAND", "FirstName":"Marie", "EMail":"marie9855@gmail.com", "Phone":"04 11 22 55 11", "Mobile":"06 44 86 48 55", "Third":{ "Code": "10001" }, "Tags":[{ "TagCategoryCode":"INTERET","Label":"Cuisine" }] }, { "Name":"DUPOND", "FirstName":"Hervé", "EMail":"herve.dupont@outlook.com", "MoreFields":[ { "FieldId": "nl_5704ffda0dc3640c748f843a", "Value": "true" } ], "Third":{ "Code": "10001" }, "Tags":[{ "TagCategoryCode":"INTERET", "Label":"Bricolage" }, { "TagCategoryCode":"INTERET", "Label":"Poterie" }] }, { "Name": "OVAGNA", "FirstName": "Jean", "EMail": "jean.ovagna@polimat.fr", "Function": "Directeur", "Phone":"04 88 55 11 44", "Third":{ "Code": "10002" } } ]

Résultat
201 Created { "Result": [ "XXXXXXXXXXXX", "XXXXXXXXXXXX", "XXXXXXXXXXXX" ], "Success": true, "Message": null, "Errors": null }

Revenir à la liste des méthodes