Customfields API

Les champs personnalisés sont créés via l'interface d'administration (Onglet "Persos" dans l'administration ClicRDV).

Le nom de l'attribut dépend du type de champ personnalisé :

• Champ booléen (cases à cocher), boolX, X=0..9
• Champ date dtX, X=0..1
• Champ nombre numX, X=0..3
• Champ texte (<255) strX, X=0..14
• Champ texte long txtX, X=0..2

Si vous n'arrivez pas à reconnaitre la correspondance de nom avec vos champs personnalisés, vous pouvez executer les requêtes suivantes.

Exemple pour les fiches

GET /api/v1/groups/:id/customfields.json?apikey=xxxxxx&\
      conditions%5B0%5D%5Bfield%5D=model&\
      conditions%5B0%5D%5Bop%5D=%3D&\
      conditions%5B0%5D%5Bvalue%5D=Fiche

Exemple pour les RDV

GET /api/v1/groups/:id/customfields.json?apikey=xxxxxx&\
      conditions%5B0%5D%5Bfield%5D=model&\
      conditions%5B0%5D%5Bop%5D=%3D&\
      conditions%5B0%5D%5Bvalue%5D=Vevent

Exemple de retour d'API (pas de rapport avec l'appel)

{
  "recordsReturned":4,"totalRecords":4,"startIndex":0,"sort":null,"dir":null,"pageSize":4,
  "records":[
    {
      "created_at":"2016-07-29 10:19:54",
      "deleted":false,
      "group_id":117908,
      "id":867810,
      "model":"Fiche",
      "name":"birthdate",
      "pro_inputex":"{"type":"datesplit","label":"Né(e) le","name":"birthdate","dateFormat":"d/m/Y"}",
      "pro_label":"Né(e) le",
      "pro_position":2,
      "pro_required":false,
      "updated_at":"2017-01-03 14:28:47",
      "user_inputex":"",
      "user_label":"",
      "user_position":null,
      "user_required":false,
      "user_visible":false
    },
    ...
  ]
}

L'attribut name retournera pour chaque champ son nom dans l'API. Vous pourrez faire le rapprochement avec l'attribut pro_label.

Il y aura 2 configurations possibles :

• "pro" : concerne la configuration du champ dans l'Agenda
• "user" : concerne la configuration du champ dans la prise de RDV sur internet