The delete-custombutton operation is used to remove custom buttons.
A request XML packet removing a custom button includes the delete-custombutton operation node:
<packet version="1.5.1.0">
<ui>
<delete-custombutton>
...
</delete-custombutton>
</ui>
</packet>
The delete-custombutton graphical representation is as follows:
ui_input.xsd
).The delete-custombutton node of the output XML packet is structured as follows:
common.xsd
).
The following packet removes custom button with ID 1.
<packet version="1.5.1.0">
<ui>
<delete-custombutton>
<filter>
<custombutton-id>1</custombutton-id>
</filter>
</delete-custombutton>
</ui>
</packet>
Response:
<packet version="1.5.1.0">
<ui>
<delete-custombutton>
<result>
<status>ok</status>
<id>1</id>
</result>
</delete-custombutton>
</ui>
</packet>
The following packet removes custom buttons of the customer with ID 2.
<packet version="1.6.3.0">
<ui>
<delete-custombutton>
<filter>
<owner>
<customer-id>2</customer-id>
</owner>
</filter>
</delete-custombutton>
</ui>
</packet>
Response:
<packet version="1.6.3.0">
<ui>
<delete-custombutton>
<result>
<status>ok</status>
<id>1</id>
</result>
<result>
<status>ok</status>
<id>2</id>
</result>
<result>
<status>ok</status>
<id>3</id>
</result>
</delete-custombutton>
</ui>
</packet>