Authorization token required | true |
Admin Authorization token required | false |
<GetMiniCalRequest s="{range-start-time-millis} (long)" e="{range-end-time-millis} (long)"> ## GetMiniCalRequest
(<folder [id="..."] /> ## Id)*
<tz id="{timezone-id}" stdoff="{timezone-std-offset} (Integer)" dayoff="{timezone-daylight-offset} (Integer)"
[stdname="..."] [dayname="..."]> ## CalTZInfo
<standard [week="{tzonset-week} (Integer)"] [wkday="{tzonset-day-of-week} (Integer)"]
mon="{tzonset-month} (Integer)" [mday="{tzonset-day-of-month} (Integer)"]
hour="{tzonset-hour} (Integer)" min="{tzonset-minute} (Integer)" sec="{tzonset-second} (Integer)" /> ## TzOnsetInfo
<daylight ... /> ## See /tz/standard [ ## TzOnsetInfo]
</tz>
</GetMiniCalRequest>
elements and attributes you can define within a
<GetMiniCalRequest>
element:
XPath | Required / Optional | Description |
@s | Required (only 1) | Type: long Range start time in milliseconds |
@e | Required (only 1) | Type: long Range end time in milliseconds |
/folder | Optional (0 or more) | Local and/or remote calendar folders |
/folder@id | Optional (0 or 1) | Type: String ID |
/tz | Optional (0 or 1) | Optional timezone specifier. References an existing server-known timezone by ID or the full specification of a custom timezone |
/tz@id | Required (only 1) | Type: String Timezone ID. If this is the only detail present then this should be an existing server-known timezone's ID Otherwise, it must be present, although it will be ignored by the server |
/tz@stdoff | Required (only 1) | Type: Integer Standard Time's offset in minutes from UTC; local = UTC + offset |
/tz@dayoff | Required (only 1) | Type: Integer Daylight Saving Time's offset in minutes from UTC; present only if DST is used |
/tz@stdname | Optional (0 or 1) | Type: String Standard Time component's timezone name |
/tz@dayname | Optional (0 or 1) | Type: String Daylight Saving Time component's timezone name |
/tz/standard | Optional (0 or 1) | Time/rule for transitioning from daylight time to standard time. Either specify week/wkday combo, or mday. |
/tz/standard@week | Optional (0 or 1) | Type: Integer Week number; 1=first, 2=second, 3=third, 4=fourth, -1=last |
/tz/standard@wkday | Optional (0 or 1) | Type: Integer Day of week; 1=Sunday, 2=Monday, etc. |
/tz/standard@mon | Required (only 1) | Type: Integer Month; 1=January, 2=February, etc. |
/tz/standard@mday | Optional (0 or 1) | Type: Integer Day of month (1..31) |
/tz/standard@hour | Required (only 1) | Type: Integer Transition hour (0..23) |
/tz/standard@min | Required (only 1) | Type: Integer Transition minute (0..59) |
/tz/standard@sec | Required (only 1) | Type: Integer Transition second; 0..59, usually 0 |
/tz/daylight | Optional (0 or 1) | Time/rule for transitioning from standard time to daylight time
See /tz/standard for more details. |
<GetMiniCalResponse> ## GetMiniCalResponse
(<date>{busyDates} (String)</date>)*
(<error id="{calendar-folder-id}" code="{ServiceException-error-code}">{errorMessage}</error> ## MiniCalError)*
</GetMiniCalResponse>
elements and attributes you can define within a
<GetMiniCalResponse>
element:
XPath | Required / Optional | Description |
/date | Optional (0 or more) | Type: {busyDates} (String) Matching busy dates in format : yyyymmdd |
/error | Optional (0 or more) | Type: {errorMessage} Error for each calendar folder that couldn't be accessed Description for element text content:Error message from the exception (but no stack trace) |
/error@id | Required (only 1) | Type: String ID for calendar folder that couldn't be accessed |
/error@code | Required (only 1) | Type: String ServiceException error code - service.PERM_DENIED, mail.NO_SUCH_FOLDER, account.NO_SUCH_ACCOUNT, etc. |