Carbonio SOAP API Reference 24.9.5_ZEXTRAS

Service: zimbraAccount

Command: SearchCalendarResources
Namespace: urn:zimbraAccount
Description: Search Global Address List (GAL) for calendar resources
"attrs" attribute - comma-separated list of attrs to return ("displayName", "zimbraId", "zimbraCalResType")

Properties:

Authorization token required	true
Admin Authorization token required	false

SearchCalendarResourcesRequest

    <SearchCalendarResourcesRequest [quick="(0|1)"] [sortBy="{sort-by}"] [limit="(Integer)"] [offset="(Integer)"]
                                       [galAcctId="{gal-account-id}"] [attrs="{request-attrs}"]> ## SearchCalendarResourcesRequest
        <locale>{locale} (String)</locale>
        <cursor [id="{cursor-prev-id}"] [sortVal="{cursor-sort-value}"] [endSortVal="{cursor-end-sort-value}"]
                    [includeOffset="{cursor-include-offset} (0|1)"] /> ## CursorInfo
        <name>{name} (String)</name>
        <searchFilter> ## EntrySearchFilterInfo
            Choose one of: {
                <conds [not="{not} (0|1)"] [or="{or} (0|1)"]> ## EntrySearchFilterMultiCond
                    List of any of: {
                        <conds> ... </conds> ## See /searchFilter/conds [ ## EntrySearchFilterMultiCond] # [inside itself]
                        <cond [not="{not} (0|1)"] attr="{single-cond-attr}" op="{single-cond-op}" value="..." /> ## EntrySearchFilterSingleCond
                    }
                 </conds>
                <cond ... /> ## See /searchFilter/conds/cond [ ## EntrySearchFilterSingleCond]
            }
         </searchFilter>
    </SearchCalendarResourcesRequest>

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

XPath Required / Optional Description

@quick Optional (0 or 1) Type: 0|1
"Quick" flag.
For performance reasons, the index system accumulates messages with not-indexed-yet state until a certain threshold and indexes them as a batch. To return up-to-date search results, the index system also indexes those pending messages right before a search. To lower latencies, this option gives a hint to the index system not to trigger this catch-up index prior to the search by giving up the freshness of the search results, i.e. recent messages may not be included in the search results.

@sortBy Optional (0 or 1) Type: String
Name of attribute to sort on. default is the calendar resource name.

@limit Optional (0 or 1) Type: Integer
An integer specifying the 0-based offset into the results list to return as the first result for this search operation

@offset Optional (0 or 1) Type: Integer
The 0-based offset into the results list to return as the first result for this search operation.

@galAcctId Optional (0 or 1) Type: String
GAL Account ID

@attrs Optional (0 or 1) Type: String
Comma separated list of attributes

/locale Optional (0 or 1) Type: {locale} (String)
Client locale identification.
Value is of the form LL-CC[-V+] where:
LL is two character language code
CC is two character country code
V+ is optional variant identifier string

See:
ISO Language Codes: http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
ISO Country Codes: http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

/cursor Optional (0 or 1) Cursor specification

/cursor@id Optional (0 or 1) Type: String
Previous ID. cursor-prev-id and cursor-sort-value and correspond to the last hit on the current page (assuming you're going forward, if you're backing up then they should be the first hit on the current page) or the selected item before changing the sort order. cursor-sort-value should be set to the value of the 'sf' (SortField) attribute. If you are changing the sort field, don't specify sortVal because 'sf' is sort field dependent. (In this case, the server supplements sortVal using the specified item ID. If the item no longer exist, the cursor gets cleared.) The server uses those attributes to find the spot in the new results that corresponds to your old position: even if some entries have been removed or added to the search results (e.g. if you are searching is:unread and you read some).

/cursor@sortVal Optional (0 or 1) Type: String
Should be set to the value of the 'sf' (SortField) attribute. See description for cursor-prev-id for more information.

/cursor@endSortVal Optional (0 or 1) Type: String
Used for ranges to tell the cursor where to stop (non-inclusive) returning values

/cursor@includeOffset Optional (0 or 1) Type: 0|1
If true, the response will include the cursor position (starting from 0) in the entire hits. This can't be used with text queries. Don't abuse this option because this operation is relatively expensive

/name Optional (0 or 1) Type: {name} (String)
If specified, passed through to the GAL search as the search key

/searchFilter Optional (0 or 1) Search filter specification

/searchFilter/conds Optional (0 or 1)

/searchFilter/conds@not Optional (0 or 1) Type: 0|1
Negation flag
If set to 1 (true) then negate the compound condition

/searchFilter/conds@or

Optional (0 or 1)

Type: 0|1
OR flag

1 (true)	child conditions are OR'ed together
0 (false) [default]	child conditions are AND'ed together

/searchFilter/conds/conds Optional (0 or 1) See /searchFilter/conds for more details.

/searchFilter/conds/cond Optional (0 or 1)

/searchFilter/conds/cond@not Optional (0 or 1) Type: 0|1
Negation flag
If set to 1 (true) then negate the compound condition

/searchFilter/conds/cond@attr Required (only 1) Type: String
Attribute name

/searchFilter/conds/cond@op

Required (only 1)

Type: String
Operator. Valid operators are:

eq	attr equals value (integer or string)
has	attr has value (substring search)
ge	attr greater than or equal to integer value
le	attr less than or equal to integer value
gt	attr greater than (but not equal to) equal to integer value
lt	attr less than (but not equal to) to integer value
startswith	attr starts with value (string)
endswith	attr ends with value (string)

/searchFilter/conds/cond@value Required (only 1) Type: String
value

/searchFilter/cond Optional (0 or 1) See /searchFilter/conds/cond for more details.

SearchCalendarResourcesResponse

    <SearchCalendarResourcesResponse [sortBy="{sort-by}"] [offset="(Integer)"] [more="(0|1)"]
                                        [paginationSupported="{pagination-supported} (0|1)"]> ## SearchCalendarResourcesResponse
        (<calresource name="{calendar-resource-name}" id="{calendar-resource-id}"> ## CalendarResourceInfo
            (<a n="{key}">{value}</a> ## KeyValuePair)*
          </calresource>)*
    </SearchCalendarResourcesResponse>

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

XPath	Required / Optional	Description
@sortBy	Optional (0 or 1)	Type: String Name of attribute sorted on. If not present then sorted by the calendar resource name.
@offset	Optional (0 or 1)	Type: Integer The 0-based offset into the results list to return as the first result for this search operation.
@more	Optional (0 or 1)	Type: 0\|1 Flags whether there are more results
@paginationSupported	Optional (0 or 1)	Type: 0\|1 Flag whether the underlying search supported pagination. 1 (true) - limit and offset in the request was honored 0 (false) - the underlying search does not support pagination. limit and offset in the request was not honored
/calresource	Optional (0 or more)	Matching calendar resources
/calresource@name	Required (only 1)	Type: String Name of calendar resource
/calresource@id	Required (only 1)	Type: String Name of calendar resource
/calresource/a	Optional (0 or more)	Type: {value} Attributes specified as key value pairs Description for element text content:Value
/calresource/a@n	Required (only 1)	Type: String Key