Response Samples

A positive response with a single button displayed for the specified domain (ID 1324) looks as follows:

<packet version="1.4.1.2">

<domain>

<cform_buttons_list>

   <result>

      <status>ok</status>

      <id>1324</id>

      <button>

          <code>EDIT_BUTTON</code>

          <type>link_button</type>

          <name>Edit</name>

          <name_id>edit</name_id>

          <group_name>Tools</group_name>

          <group_name_id>__tools</group_name_id>

          <href>/domains/d_ed.php3</href>

          <enabled>true</enabled>

          <new_window>false</new_window>

      </button>

   </result>

</cform_buttons_list>

</domain>

</packet>

<packet version="1.4.2.0">

<domain>

<cform_buttons_list>

   <result>

      <status>ok</status>

      <filter-id>1324</filter-id>

      <id>1324</id>

      <button>

          <code>EDIT_BUTTON</code>

          <type>link_button</type>

          <name>Edit</name>

          <name_id>edit</name_id>

          <group_name>Tools</group_name>

          <group_name_id>__tools</group_name_id>

          <href>/domains/d_ed.php3</href>

          <enabled>true</enabled>

          <new_window>false</new_window>

      </button>

   </result>

</cform_buttons_list>

</domain>

</packet>

Notice the difference in these identical packets sent using different versions of API RPC:

• versions 1.4.1.2 and earlier return the domain identifier in its id node;
• versions 1.4.2.0 and later return the filtering parameter (the filter-id node) and the domain identifier (the id node). These two nodes can coincide if the domain was filtered by domain_id.

If the operation fails, a negative response can look as follows:

<packet version="1.4.1.2">

<domain>

<cform_buttons_list>

   <result>

      <status>error</status>

      <errcode>1023</errcode>

      <errtext>Operation failed.</errtext>

      <id>1324</id>

   </result>

</cform_buttons_list>

</domain>

</packet>

<packet version="1.4.2.0">

<domain>

<cform_buttons_list>

   <result>

      <status>error</status>

      <errcode>1023</errcode>

      <errtext>Operation failed.</errtext>

      <filter-id>1324</filter-id>

      <id>1324</id>

   </result>

</cform_buttons_list>

</domain>

</packet>