请求和响应消息格式

请求

中的每个 API 方法

Adaptive Planning

API 要求正文中的 XML 文档具有如下所示的结构：


    <?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>

以下是每个相关行的描述：

此行表示后续数据是以 UTF-8 格式进行 XML 编码的。

<call> 标记使用其方法属性指示正在调用哪个 API 方法。在此示例中，API 方法为 exportData。此外，callerName 是 <call> 标记的必需属性。它向系统标识您的客户端应用程序，并在问题排查和日志记录时用于识别目的。

每个 API 方法都需要对进行调用的用户进行身份验证。通常通过提供登录名和密码来完成此操作。允许在此处指定其他属性。有关凭据的更多详细信息，请参见每个 API 函数的文档。

某些 API 方法需要在请求中提供其他数据。例如，exportData 方法需要一些条件来描述在检索其数据时应使用的时段、账户、层级等。申请的这一部分因方法而异。

这是第 2 行调用标记的结束标记。

API 方法的每个响应都将具有以下结构：


     <?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>

以下是相关行的描述：

与请求类似，此行表示后续数据格式为 XML，并使用 UTF-8 编码。

每条回复都包含在 <response> 标记内。如果请求成功，则响应标记上的 success 属性将设置为 true。如果请求未成功，则 success 属性将设置为 false。

许多 API 调用都会返回此可选的 <messages> 块，其中包含服务器生成的消息列表。如果服务器没有要响应调用而返回的消息，则可能不会显示此块。错误消息将始终显示在消息块内。

消息块中的每条消息都有一个键属性，用于标识要传输的消息类型。消息标记还包含来自服务器的消息文本，包括任何返回值、状态值或有关请求成功或失败的其他独立元数据。回复可以包含不限数量的消息标记。

结束消息标记。

API 方法调用的实际输出（如果有返回）包含在 <output> 标记内。

API 方法调用的实际输出将显示在此处。此输出因调用的方法而异。

结束输出标记。

结束响应标记。