REST API Exportation des réservations de produits dans les aménagements V1

Cette ressource est utilisée pour exporter les réservations de produits dans les aménagements dans Quant. Le format d'entrée et de sortie est JSON.

Utilisez la section Tâches automatiques pour créer et configurer une exportation. Une fois créée, la liste des tâches aura l'ID que vous devrez transmettre dans l'URL de la requête.

Tâche automatique
ID de la tâche automatique. 
  • Paramètres

Avant d'utiliser l'API, vous devez modifier les attributs suivants dans l'onglet Paramètres :

  • Cochez l'attribut Activé pour autoriser la tâche.
  • Dans Utilisateurs avec autorisation API, sélectionnez un ou plusieurs utilisateurs ayant le rôle Robot et pouvant exécuter la tâche.
  • Dans les lignes Mappage des attributs de réservation, Mappage des attributs de produit, Mappage des attributs des magasins et Mappage des attributs des types d'aménagement, sélectionnez les attributs à exporter et modifiez leurs clés JSON si nécessaire.
  • Nous recommandons également de renseigner les e-mails pour les notifications, où vous pouvez saisir une ou plusieurs adresses e-mail auxquelles seront envoyés des e-mails relatifs aux statuts d’erreur.
  • Attributs
Attribut
Description
Type
Activé
Spécifie si la tâche automatique est active et peut recevoir des données.
oui/non
Titre
Nom personnalisé de la tâche automatique.
texte
Description
Description personnalisée du rôle de la tâche automatique.
texte formaté
Remarques
Notes.
texte long
Emails pour notifications

Une ou plusieurs adresses e-mail pour recevoir les erreurs éventuelles.

liste de chaînes
Utilisateurs avec autorisation API 
Utilisateurs avec le rôle Robot autorisés à exécuter la tâche.
liste des utilisateurs
Délai en secondes avant nouvelle tentative
En cas de code d'état 503, le client doit réessayer l'envoi de la requête après quelques secondes.
numéro
Mappage des attributs de réservation
Mappage contenant une entrée pour chaque attribut de réservation d'aménagement à exporter.
type complexe
Mappage des attributs de produit
Mappage contenant une entrée pour chaque attribut du produit placé à exporter.
type complexe

Mappage des attributs des magasins

Mappage contenant une entrée pour chaque attribut de magasin à exporter.
type complexe

Mappage des attributs des types d'aménagement

Mappage contenant une entrée pour chaque attribut de type d'aménagement à exporter.
type complexe
Unité de mesure 
Unité comme cm, mm, etc.
sélection
Format de date
Format de date, par ex. 31.12.19
sélection
Format date et heure
Format de date et heure, par ex. 19.12.31 23:59:59
sélection
Séparateur des éléments de liste
Symbole utilisé pour séparer les éléments dans une liste de valeurs.
symbole


Paramètres
  • Requête

/v1/export/fixture-product-reservations/{id_ulohy}

Paramètre
Valeur
URL
Ajoutez ?debug à l'URL pour afficher aussi les avertissements. Sinon, seules les messages d'erreurs sont affichés.
Header
Accept: application/json
Header
Content-type: application/json
Header

Authorization: Bearer  <TOKEN>

Le TOKEN s'obtient via /authenticate (voir la section Connexion).

Method
POST

Le contenu de la requête peut être vide (texte vide) ou un objet JSON vide.

Le contenu de la requête est un objet JSON contenant les clés suivantes :

Clé
Valeur
ReservedBy
Chaîne ou tableau de chaînes distinct(e)s précisant les utilisateurs dont les réservations doivent être exportées. Si  vide, toutes les réservations seront exportées.
Examples:
{ "ReservedBy": [] }
{ "ReservedBy": ["test.rehorova.cz.extech.sk"] }
  • Réponse
Clé
Valeur
Status
Une chaîne indiquant l'état final de l'exportation.
  • SUCCESS = processus d'exportation sans erreur
  • PARTIAL_SUCCESS = exportation terminée mais un ou plusieurs avertissements ont été générés
  • FAILURE = une ou plusieurs erreurs se sont produites lors de l'exportation
Warnings
Il est facultatif, c'est-à-dire qu'il n'est inclus que si le paramètre ?debug est présent dans l'URL et que l'exportation a généré au moins un avertissement.

Liste des chaînes d'avertissement.  

Errors
Facultatif - inclus uniquement si l'exportation a généré au moins une erreur.

Liste des chaînes d'avertissement.
Records

Optionnel - inclus si l'exportation ne s'est pas terminée avec le statut « FAILURE ».

Liste d'objets exportés avec la clé de correspondance définie dans les paramètres de la tâche.

  • Codes de statut
Statut
Valeur
200 OK
Exportation réussie avec le statut « SUCCESS » ou « PARTIAL_SUCCESS ». La réponse peut contenir des avertissements ou des erreurs mineures.
400 Bad Request
Paramètres de tâche ou requête incorrects.
401 Unauthorized
Le jeton d'autorisation invalide ou l'utilisateur connecté avec ce jeton n'est pas autorisé à exécuter cette tâche.
404 Not Found
Aucune tâche trouvée avec l'ID spécifié dans l'URL.
403 Reservations Not Enabled
Réservations ne sont pas disponibles pour cet établissement.
500 Internal Server Error

Une erreur serveur critique s'est produite lors de l'exportation.

  • Journal d'exécution

Dans Quant, en plus des paramètres des tâches, vous pouvez également consulter l'historique des exportations individuelles, avec les statistiques, erreurs et avertissements.

Si vous sélectionnez un enregistrement spécifique, vous pouvez afficher ses détails en cliquant sur le bouton Afficher les éléments.

Afficher les éléments


  • Requête

curl -X POST --location "http://[VASE_SPOLECNOST].iquant.eu/v1/export/fixture-product-reservations/246?debug" \
    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
    -H "Accept: application/json" \
    -H "Content-Type: application/json" \
    -H "Cache-Control: no-cache" \
   -d "{ \"ReservedBy\": [\"test.rehorova.cz.extech.sk\",\"quant.customer\"] }"

  • Réponse

{
"Status": "SUCCESS", 
"FixtureTypes": {
 "357888": {
     "Name": "Freezer",
     "Monthly fee": "500" },
 "568836": { 
     "Name": "Fixture 6 shelves", 
     "Monthly fee": "200" }
 }, 
"Products": {
 "718234": { 
       "Primary Id": "971070800", 
       "Product name": "", 
       "Name of supplier": "",
       "ISupplier ID": "" }, 
"720552": { 
       "Primary Id": "970518320", 
       "Product name": "",
       "Name of supplier": "", 
       "Supplier ID": "" },
 }, 
"Stores": {
 "169": { 
       "Store name": "Čáslav", 
       "Store ID": "198", 
  },
 "Records": [ { 
    "Status": "Waiting for Approval", 
    "Reserved by user": "test.rehorova.cz.extech.sk",
    "Year": "2023", 
    "Month": "10",
    "Note": "PAVLA test2", 
    "Products": [ "721884", "720552" ], 
    "Store QID": "663097", 
    "Fixture Type QID": "701386",
    "Equipment fee": "1000" }
  ...]
}