Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2023-06-23
Formats de message de demande et de réponse

Formats de message de demande et de réponse

Formats de message de demande et de réponse

La demande

Chaque méthode API du
Adaptive Planning
 L'API s'attend à ce que le document XML dans son corps ait une structure semblable à celle 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 concernées :
  1. Cette ligne indique que les données suivantes sont encodées en XML au format UTF-8.
  2. Le marqueur <call> indique quelle méthode API est appelée avec son attribut de méthode. Dans cet exemple, la méthode API est exportData. De plus, CallerName est un attribut obligatoire dans le marqueur <call>. Il identifie votre application client au système et sert à 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 cela, vous devez indiquer un nom de connexion et un mot de passe. D'autres attributs peuvent être indiqués ici. Consultez la documentation de chaque fonction API pour plus d'informations sur les identifiants.
  4. Certaines méthodes d'API nécessitent des données supplémentaires dans la demande. Par exemple, la méthode exportData requiert des critères décrivant les périodes, comptes, périmètres, etc. utilisés lors de l'extraction de ses données. Cette partie de la demande varie d'une méthode à l'autre.
  5. Il s'agit du marqueur de fermeture du marqueur d'appel de la ligne 2.

La réponse

Chaque réponse 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 concernées :
  1. Comme pour la demande, cette ligne indique que les données suivantes sont formatées au format XML et encodées au format UTF-8.
  2. Chaque réponse est associée au marqueur <réponse>. Si la demande a abouti, l'attribut de réussite du marqueur de réponse est défini sur vrai. Si la demande a échoué, l'attribut de réussite est défini sur false (faux).
  3. De nombreux appels d'API renvoient 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'a reçu aucun message à renvoyer en réponse à l'appel. Les messages d'erreur apparaîtront toujours dans le bloc de messages.
  4. Chaque message du bloc de messages a un attribut clé qui identifie 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 concernant 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 clôture.
  6. La sortie réelle de l'appel de méthode API, le cas échéant, est incluse dans un marqueur <sortie>.
  7. La sortie réelle de l'appel de méthode API apparaîtra ici. Ce résultat varie en fonction de la méthode qui a été appelée.
  8. Le marqueur de sortie de clôture.
  9. Le marqueur de la réponse de clôture.