Aller au contenu

Galaxie Artibox

Formulaires d'orientation · Référence de l'API

Les formulaires qui orientent un invité vers le bon type ou la bonne personne.

Lister les formulaires d'orientation

GET/orientation-forms

Portée : types:lire Lire les types de rendez-vous, leurs créneaux et leurs messages

Jeton : portée `types:lire`. Sans `page` ni `limit`, une liste simple ; avec, `{items, pagination}`.

Liste entière par défaut ; avec page ou limit, paginée (25 par défaut, 500 au plus).

Paramètres

NomOùTypeObligatoireDescription
pagerequêteintegernon
limitrequêteintegernon
pagerequêteintegernonNuméro de page, à partir de 1
limitrequêteintegernonÉléments par page (500 au plus)
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/orientation-forms' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Créer un formulaire d'orientation

POST/orientation-forms

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Création : l'en-tête Idempotency-Key évite un doublon pendant 24 heures.

Paramètres

NomOùTypeObligatoireDescription
Idempotency-Keyen-têtestringnonUne clé de votre choix (255 caractères au plus) : rejouée dans les 24 heures, la même requête rend la première réponse sans rien recréer ; en cours, 409 ; sur une autre route, 422.

Corps de la requête

Exemple de requête
curl -X POST 'https://www.artibox-calendar.com/api/v1/orientation-forms' \
  -H "x-api-key: $RDV_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"

Réponses

  • 201 Créé
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 409 Conflit : créneau pris ou requête en cours
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Lister les réponses à un formulaire d'orientation

GET/orientation-forms/{id}/submissions

Portée : types:lire Lire les types de rendez-vous, leurs créneaux et leurs messages

De la plus récente à la plus ancienne. Superviseur ou propriétaire (`orientation.manage`). Jeton : portée `types:lire`. Les adresses s'effacent avec la durée de conservation de l'organisation.

Liste paginée : page et limit (25 par défaut, 500 au plus).

Paramètres

NomOùTypeObligatoireDescription
idcheminstring (uuid)ouiLe formulaire
pagerequêteintegernon
limitrequêteintegernon
pagerequêteintegernonNuméro de page, à partir de 1
limitrequêteintegernonÉléments par page (500 au plus)
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/orientation-forms/{id}/submissions' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Lire une réponse à un formulaire d'orientation

GET/orientation-submissions/{id}

Portée : types:lire Lire les types de rendez-vous, leurs créneaux et leurs messages

Superviseur ou propriétaire. Jeton : portée `types:lire`.

Paramètres

NomOùTypeObligatoireDescription
idcheminstring (uuid)oui
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/orientation-submissions/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Lire un formulaire d'orientation

GET/orientation-forms/{id}

Portée : types:lire Lire les types de rendez-vous, leurs créneaux et leurs messages

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui
Exemple de requête
curl -X GET 'https://www.artibox-calendar.com/api/v1/orientation-forms/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Modifier un formulaire d'orientation

PUT/orientation-forms/{id}

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui

Corps de la requête

Exemple de requête
curl -X PUT 'https://www.artibox-calendar.com/api/v1/orientation-forms/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 200 Réussi
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 422 Données refusées : le détail est donné champ par champ
  • 429 Trop d'appels : attendez Retry-After

Supprimer un formulaire d'orientation

DELETE/orientation-forms/{id}

Portée : organisation:administrer Modifier l'organisation, ses réglages, ses membres et ses formulaires d'orientation

Paramètres

NomOùTypeObligatoireDescription
idcheminstringoui
Exemple de requête
curl -X DELETE 'https://www.artibox-calendar.com/api/v1/orientation-forms/{id}' \
  -H "x-api-key: $RDV_TOKEN"

Réponses

  • 204 Fait, sans contenu
  • 401 Jeton absent, inconnu ou expiré
  • 403 Portée manquante ou droit refusé
  • 404 Introuvable (ou d'une autre organisation)
  • 429 Trop d'appels : attendez Retry-After