Retrieving Custom Button Settings

The get-custombutton operation is used to retrieve custom button settings.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet retrieving a custom button settings includes the get-custombutton operation node:

<packet>
<ui>
   <get-custombutton>
...
   </get-custombutton>
</ui>
</packet>

 

The get-custombutton graphical representation is as follows:

 

Response Packet Structure

The get-custombutton node of the output XML packet is structured as follows:

Note: When you retrieve details on the custom button that links to a Web application, and you have not specified values for all required properties nodes, the validation error occurs.

 

 

Samples

The following packet retrieves settings of custom buttons of the customer with ID 1.

<packet version="1.6.3.0">
<ui>
   <get-custombutton>
   <filter>

      <owner>
            <customer-id>1</customer-id>
      </owner>

   </filter>

   </get-custombutton>
</ui>
</packet>

 

The following packet retrieves settings of custom button with ID 1.

<packet version="1.5.1.0">
<ui>
   <get-custombutton>
   <filter>

      <custombutton-id>1</custombutton-id>

   </filter>

   </get-custombutton>
</ui>
</packet>