Action

Les actions commerciales peuvent être manipulés à travers l'objet ncAction dans l'API.

L'objet ncAction

L'action récupérée ou à insérer via l'API est un objet comprenant les méthodes suivantes :
Guid : L'identifiant de l'action
ExternalCode : Le code externe
RecCode : Le code de regroupement pour les actions récurrentes
Label : Le sujet de l'action
Status : Le code du statut (COU : En cours, NDEM : Non démarrée)
Place : Localisation de l'action
Comments : Commentaires
Priority : La priorité (objet ListValue)
AssignedTo : L'utilisateur affecté (objet ncUser, ne renseigner que le Guid pour une création ou une mise à jour)
Deal : L'opportunité associée (objet ncDeal, ne renseigner que le Guid pour une création ou une mise à jour)
Third : Le compte associé (objet ncThird, ne renseigner que le Guid pour une création ou une mise à jour)
Contact : Le contact associé (objet ncContact, ne renseigner que le Guid pour une création ou une mise à jour)
Lead : La piste associée (objet ncLead, ne renseigner que le Guid pour une création ou une mise à jour)
Project : Le projet associé (objet ncProject, ne renseigner que le Guid pour une création ou une mise à jour)
ActionType : Le type d'action (objet ncActionType, ne renseigner que le code du type d'action. Si cette valeur n'est pas renseignée, alors l'action sera associée au type d'action par défaut.)
DStart : La date de démarrage de l'action (Timestamp UNIX)
DEnd : La date de fin de l'action (Timestamp UNIX)
DTerm : L'échéance de l'action (Timestamp UNIX)
IsPeriod : Définit si l'action est périodique
IsGuest : Définit si l'utilisateur concerné est un invité Chaque objet dispose également d'une propriété Updated spécifiant la dernière date de modification.

Méthodes disponibles

• GET https://app-koban.com/api/v1/ncAction/GetPending Tester
  

  Renvoie la liste des actions d'un utilisateur en cours entre deux dates créées ou modifiées à partir d'une date de référence

  Paramètres :
  • updated : date au format texte (dd/MM/YYYY). date de référence
  • from : date de début au format texte (dd/MM/YYYY)
  • to : date de fin au format texte (dd/MM/YYYY)
  • userid : Identifiant de l'utilisateur (Guid). Récupération possible à partir de la méthode ncAuthenticate/GetId
  • st : Entier: Index de démarrage de la liste renvoyée (pagination). La méthode renvoie 20 éléments par défaut
  • s : Tri (Nom de la propriété de tri). Chaine vide possible
  
  
• GET https://app-koban.com/api/v1/ncAction/Get Tester
  

  Renvoie une action à partir de son identifiant

  Paramètres :
  • id : Identifiant (Guid) de l'action
• GET https://app-koban.com/api/v1/ncAction/GetForGuest Tester
  

  Renvoie la liste des actions pour lesquels l'utilisateur en cours est invité entre deux dates

  Paramètres :
  • from : date de début au format texte (dd/MM/YYYY)
  • to : date de fin au format texte (dd/MM/YYYY)
  • userid : Identifiant de l'utilisateur (Guid). Récupération possible à partir de la méthode ncAuthenticate/GetId
• POST https://app-koban.com/api/v1/ncAction
  

  Ajoute une action.

  Paramètres :
  • Corps de la requête : Action en objet ncAction JSON
• POST https://app-koban.com/api/v1/ncAction/PostUpdate
  

  Met à jour une action.

  Paramètres :
  • uniqueproperty : Propriété sélectionnée pour vérifier quelle action être modifiée. Peut prendre la valeur : Guid (Identifiant), ExternalCode (Code externe)
  • Corps de la requête : Action en objet ncAction JSON
• PUT https://app-koban.com/api/v1/ncAction
  

  Met à jour une action.

  Paramètres :
  • Corps de la requête : Action en objet ncAction JSON

Revenir à la liste des méthodes