Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Formats de messages pour les demandes et les réponses

Formats de messages pour les demandes et les réponses

Formats de messages pour les demandes et les réponses

La demande

Chaque méthode API dans
Adaptive Planning
 L’API s’attend à ce que le document XML dans son corps ait une structure semblable à la suivante :

    <?xml version='1.0' encoding='UTF-8'?>
    <call method="exportData" callerName="a string that identifies your client application">
       <credentials login="sample@company.com" password="my_pwd"/>              
       method specific data goes here
    </call>
Voici une description de chacune des lignes pertinentes :
  1. Cette ligne indique que les données subséquentes sont encodées XML en UTF-8.
  2. Le marqueur <call> indique la méthode API qui est appelée à l'aide de son attribut de méthode. Dans cet exemple, la méthode de l’API est exportData. De plus, CallerName est un attribut obligatoire dans le marqueur <call>. Il identifie votre application cliente sur le système et est utilisé à des fins d’identification lors du dépannage et de la journalisation.
  3. Chaque méthode API doit authentifier l’utilisateur qui effectue l’appel. Pour ce faire, il faut généralement fournir un nom d’utilisateur et un mot de passe. D'autres attributs peuvent être indiqués ici. Consultez la documentation de chaque fonction API pour obtenir plus de détails sur les données d’identification.
  4. Certaines méthodes de l’API nécessitent des données supplémentaires dans la demande. Par exemple, la méthode exportData nécessite certains critères décrivant les périodes, les comptes, les niveaux, etc. qui doivent être utilisés lors de la récupération de ses données. Cette partie de la demande variera d'une méthode à l'autre.
  5. Il s’agit du marqueur de fermeture du marqueur d’appel sur la ligne 2.

La réponse

Chaque réponse provenant d’une méthode API aura la structure suivante :

     <?xml version='1.0' encoding='UTF-8'?>
     <response success="true">
       <messages>
          <message key="modeled-import-success">Personnel import successful. Rows imported: 100</message>
       </messages>
       <output>
         ... method output ...
       </output>
     </response>
Voici une description des lignes pertinentes :
  1. Comme pour la demande, cette ligne indique que les données suivantes sont au format XML et encodées en UTF-8.
  2. Chaque réponse est incluse dans un marqueur <response>. Si la demande aboutit, l’attribut de réussite du marqueur de réponse est défini à Vrai. Si la demande a échoué, l’attribut success est défini à Faux.
  3. De nombreux appels d'API retourneront ce bloc facultatif <messages> contenant une liste de messages générés par le serveur. Ce bloc peut ne pas s'afficher si le serveur n'avait aucun message à renvoyer en réponse à l'appel. Les messages d'erreur seront toujours affichés dans le bloc de messages.
  4. Chaque message du bloc de messages comporte un attribut clé qui détermine le type de message transmis. Le marqueur de message contient également le texte du message du serveur, y compris les valeurs de retour, les valeurs de statut ou d’autres métadonnées autonomes liées à la réussite ou à l’échec de la demande. Une réponse peut contenir un nombre illimité de marqueurs de message.
  5. Le marqueur des messages de fermeture.
  6. La sortie réelle de l’appel de méthode API, le cas échéant, est incluse dans un marqueur <output>.
  7. La sortie réelle de l'appel de méthode API s'affichera ici. Cette sortie varie selon la méthode appelée.
  8. Le marqueur de sortie de fermeture.
  9. Le marqueur de réponse de fermeture.