Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
GetCalendarResource SOAP Command

Get a calendar resource Access: domain admin sufficient

Authorization token required true
Admin Authorization token required true

GetCalendarResourceRequest

    <GetCalendarResourceRequest [applyCos="{apply-cos} (0|1)"] [attrs="{request-attrs}"]> ## GetCalendarResourceRequest
        <calresource [by="{cal-resource-selector-by} (id|foreignPrincipal|name)"]>{key}</calresource> ## CalendarResourceSelector
    </GetCalendarResourceRequest>

The following table describes elements and attributes you can define within a <GetCalendarResourceRequest> element:

XPath Required / Optional Description
@applyCos Optional (0 or 1) Type:0|1
Flag whether to apply Class of Service (COS)
1 (true) [default] COS rules apply and unset attrs on the calendar resource will get their value from the COS.
0 (false) only attributes directly set on the calendar resource will be returned *
@attrs Optional (0 or 1) Type:String
Comma separated list of attributes
/calresource Optional (0 or 1) Type:{key}
Specify calendar resource
Description for element text content:The key used to identify the account. Meaning determined by {cal-resource-selector-by}
/calresource@by Optional (0 or 1) Type:id|foreignPrincipal|name
Select the meaning of {cal-resource-selector-key}

GetCalendarResourceResponse

    <GetCalendarResourceResponse> ## GetCalendarResourceResponse
        <calresource name="{name}" id="{id}"> ## CalendarResourceInfo
            (<a n="{key}" /> ## Attr)*
        </calresource>
    </GetCalendarResourceResponse>

The following table describes elements and attributes you can define within a <GetCalendarResourceResponse> element:

XPath Required / Optional Description
/calresource Required (only 1) Information on calendar resource
/calresource@name Required (only 1) Type:String
Name
/calresource@id Required (only 1) Type:String
ID
/calresource/a Optional (0 or more) Attributes
/calresource/a@n Required (only 1) Type:String
Key