Code de programme pour Requêtes REST
Le code de programme C# contenant des tâches pour RaptorXML+XBRL Server est défini dans le fichier C# dénommé Program.cs. Le code utilise les classes définies dans le Wrapper C# pour API REST pour créer les requêtes REST qui sont envoyées à RaptorXML+XBRL Server.
Dans le code de programme, il existe trois cases d’utilisation pour démontrer comment utiliser l’API REST de RaptorXML+XBRL Server :
•Validation d’un fichier XML référencé avec la commande valany de RaptorXML+XBRL Server. Le fichier de schéma est référencé depuis l’intérieur du fichier XML et n'a pas besoin d’être fourni comme argument de la commande.
•Deux fichiers XML sont validés utilisant la commande valany de RaptorXML+XBRL Server. Les deux fichiers XML, tout comme le fichier schéma utilisé pour la validation, sont chargés avec la commande en tant que string en pièces jointes. Le résultat des validations est retourné ensemble une fois que les deux validations ont été terminées.
•Un fichier XML est téléchargé et transformé par un fichier XSLT. Les deux fichiers sont téléchargés par le biais de REST. La commande utilisée est xslt de RaptorXML+XBRL Server. Le document résultant de la transformation est extrait par le programme.
Le code pour ces trois cas d’utilisation est discuté plus en détail ci-dessous.
Gestion d'erreur
Si une erreur est retournée, une fonction de gestion d’erreur (dénommée HandleError) en bas du code extrait le message d’erreur depuis la réponse du serveur.
Cas 1 : Valider un fichier XML référencé (commande simple)
Le code de programme pour ce cas utilise les classes et fonctions depuis le wrapper API REST pour définir et exécuter la communication HTTP avec RaptorXML+XBRL Server. La logique du code est comme suit :
RaptorXMLRESTAPI.Command | Spécifie la commande de RaptorXML+XBRL Server à appeler, qui est valany, et le fichier à soumettre comme l’argument de la commande valany. |
RaptorXMLRESTAPI.CommandResponse | Met la réponse du serveur de la requête de validation dans la variable jsonResponse. Veuillez noter que les tâches de validation sont rapportées comme «OK» ou «Échec». |
RaptorXMLRESTAPI.ResultDocument | Récupère le document de résultat retourné par le serveur et, s’il n’y a pas d’erreurs, affiche les résultats de validation. |
Cas 2 : Valider deux fichiers XML téléchargés par rapport à un XSD téléchargé (commande multipartie)
Le code de programme pour ce cas utilise la classe MultiPartCommand du wrapper API REST pour définir et exécuter la communication HTTP avec RaptorXML+XBRL Server. Puisque nous voulons charger des fichiers au sein de la requête de POST, l’en-tête de message doit avoir son set de type de contenu défini comme multipart/form-data. La classe de wrapper MultiPartCommand est utilisée pour définir la communication HTTP REST en conséquence. Le code pour ce cas d’utilisation est organisé comme suit :
RaptorXMLRESTAPI.MultiPartCommand | Spécifie la commande RaptorXML+XBRL Server à appeler, qui est valany, et utilise ensuite la fonction AppendAttachment de la classe pour télécharger les deux fichiers XML et le fichier de schéma. Les fichiers sont soumis en tant que strings. La réponse du serveur retourne le résultat de validation des deux fichiers et sa réponse est stockée dans la variable jsonResponse |
RaptorXMLRESTAPI.fetchCommandResult | Récupère le document de résultat retourné par le serveur et, s’il n’y a pas d’erreurs, affiche les résultats de validation. |
RaptorXMLRESTAPI.cleanupResults | Cette fonction de wrapper utilise la méthode DELETE de l’HTTP pour supprimer le fichier de document du résultat, les fichiers temporaires et les fichiers de document de sortie et d’erreur liés à la tâche. |
Cas 3 : Transformation XSLT pour XML et XSLT téléchargés (commande multipartie)
Le code de programme pour ce cas est similaire à celui du cas 2 ci-dessus. Il utilise la classe MultiPartCommand pour définir la transformation XSLT et afficher le document de résultat dans une zone de message. Les fichiers XML et XSLT pour la transformation sont téléchargés avec la requête. De plus, la commande XSLT de RaptorXML+XBRL Server prend également des options, donc ce cas vous montre comment vous pourriez ajouter des options par le biais de l’interface REST (dans l’exemple, ceci est fait avec la fonction RaptorXMLRESTAPI.AppendOption. Les points importants en ce qui concerne le code sont données ci-dessous.
RaptorXMLRESTAPI.MultiPartCommand | Spécifie la commande de RaptorXML+XBRL Server à appeler, qui est XSLT, et utilise ensuite (i) la fonction AppendAttachment de la classe pour télécharger les fichiers XML et XSLT, et (ii) la fonction AppendOption pour fournir des options pour la ligne de commande RaptorXML+XBRL Server. Les fichiers téléchargés sont soumis en tant que strings. La réponse du serveur retourne le résultat de validation des deux fichiers et sa réponse est stockée dans la variable jsonResponse |
RaptorXMLRESTAPI.fetchCommandResult | Récupère le document de résultat retourné par le serveur et, s’il n’y a pas d’erreurs, affiche les résultats de validation. |
RaptorXMLRESTAPI.cleanupResults | Cette fonction de wrapper utilise la méthode DELETE de l’HTTP pour nettoyer le fichier du document de résultat, les fichiers temporaires et les fichiers de document de sortie et d’erreur liés à la tâche. |