Creating Custom Buttons

The create-custombutton operation is used to create custom buttons.

In this chapter:

Request Packet Structure

Response Packet Structure

Samples

 

Request Packet Structure

A request XML packet creating a custom button includes the create-custombutton operation node:

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

 

The create-custombutton node graphical representation is as follows:

To create a custom button for web applications, set values for the following nodes:

Important: When creating request packets, put nodes and elements in the order they follow in the packet structure.

 

Response Packet Structure

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

 

 

Samples

The following packet creates a custom button and adds it to the custom buttons list of the customer with ID 12.

<packet version="1.6.3.0">
<ui>
   <create-custombutton>
         <owner>
            <customer-id>12</customer-id>
         </owner>
      <properties>
         <place>client</place>
         <url>http://example.com</url>
         <text>Example site</text>
      </properties>
   </create-custombutton>
</ui>
</packet>

Response:

<packet version="1.6.3.0">
<ui>
   <create-custombutton>
         <result>
            <status>ok</status>
            <id>4</id>
         </result>
   </create-custombutton>
</ui>
</packet>