Carbonio SOAP API Reference 23.11.0_ZEXTRAS

Command

Service: zimbraAdmin

Command: GetZimletStatus
Namespace: urn:zimbraAdmin
Description: Get status for Zimlets
priority is listed in the global list <zimlets> ... </zimlets> only. This is because the priority value is relative to other Zimlets in the list. The same Zimlet may show different priority number depending on what other Zimlets priorities are. the same Zimlet will show priority 0 if all by itself, or priority 3 if there are three other Zimlets with higher priority.

Properties:

Authorization token required	true
Admin Authorization token required	true

GetZimletStatusRequest

<GetZimletStatusRequest /> ## GetZimletStatusRequest

GetZimletStatusResponse

    <GetZimletStatusResponse> ## GetZimletStatusResponse
        <zimlets> ## ZimletStatusParent
            (<zimlet name="{zimlet-name}" status="{status} (enabled | disabled)" extension="{extension} (0|1)"
                         [priority="{priority} (Integer)"] /> ## ZimletStatus)*
        </zimlets>
        (<cos name="{cos-name}"> ## ZimletStatusCos
            (<zimlet ... /> ## See /zimlets/zimlet [ ## ZimletStatus])*
          </cos>)*
    </GetZimletStatusResponse>

elements and attributes you can define within a <GetZimletStatusResponse> element:

XPath	Required / Optional	Description
/zimlets	Required (only 1)	Information about status of zimlets
/zimlets/zimlet	Optional (0 or more)	Status information
/zimlets/zimlet@name	Required (only 1)	Type: String Zimlet name
/zimlets/zimlet@status	Required (only 1)	Type: enabled \| disabled
/zimlets/zimlet@extension	Required (only 1)	Type: 0\|1 Extension
/zimlets/zimlet@priority	Optional (0 or 1)	Type: Integer Priority
/cos	Optional (0 or more)	Class Of Service (COS) Information
/cos@name	Required (only 1)	Type: String Class Of Service (COS) name
/cos/zimlet	Optional (0 or more)	Information on zimlet status See /zimlets/zimlet for more details.