Authorization token required | true |
Admin Authorization token required | true |
<SearchCalendarResourcesRequest [limit="{max-cal-resources} (Integer)"] [offset="(Integer)"]
[domain="{domain-name}"] [applyCos="{apply-cos} (0|1)"] [sortBy="{sort-by}"]
[sortAscending="{sort-ascending} (0|1)"] [attrs="{request-attrs}"]> ## SearchCalendarResourcesRequest
<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 | ||||||||||||||||
@limit | Optional (0 or 1) | Type: Integer The maximum number of calendar resources to return (0 is default and means all) |
||||||||||||||||
@offset | Optional (0 or 1) | Type: Integer The starting offset (0, 25, etc) |
||||||||||||||||
@domain | Optional (0 or 1) | Type: String The domain name to limit the search to |
||||||||||||||||
@applyCos | Optional (0 or 1) | Type: 0|1 applyCos - Flag whether or not to apply the COS policy to calendar resource. Specify 0 (false) if only requesting attrs that aren't inherited from COS |
||||||||||||||||
@sortBy | Optional (0 or 1) | Type: String Name of attribute to sort on. default is the calendar resource name. |
||||||||||||||||
@sortAscending | Optional (0 or 1) | Type: 0|1 Whether to sort in ascending order. Default is 1 (true) |
||||||||||||||||
@attrs | Optional (0 or 1) | Type: String Comma separated list of attributes |
||||||||||||||||
/searchFilter | Optional (0 or 1) | Search Filter | ||||||||||||||||
/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
|
||||||||||||||||
/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:
|
||||||||||||||||
/searchFilter/conds/cond@value | Required (only 1) | Type: String value |
||||||||||||||||
/searchFilter/cond | Optional (0 or 1) | See /searchFilter/conds/cond for more details. |
<SearchCalendarResourcesResponse more="{more-flag} (0|1)" searchTotal="{search-total} (long)"> ## SearchCalendarResourcesResponse
(<calresource name="{name}" id="{id}"> ## CalendarResourceInfo
(<a n="{key}" /> ## Attr)*
</calresource>)*
</SearchCalendarResourcesResponse>
elements and attributes you can define within a
<SearchCalendarResourcesResponse>
element:
XPath | Required / Optional | Description |
@more | Required (only 1) | Type: 0|1 1 (true) if more calendar resources to return |
@searchTotal | Required (only 1) | Type: long Total number of calendar resources that matched search (not affected by limit/offset) |
/calresource | Optional (0 or more) | Information about calendar resources |
/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 |