Service: zimbraMail
Namespace: "urn:zimbraMail"
GetWorkingHours SOAP Command

User's working hours within the given time range are expressed in a similar format to the format used for GetFreeBusy.
Working hours are indicated as free, non-working hours as unavailable/out of office. The entire time range is marked as unknown if there was an error determining the working hours, e.g. unknown user.

Authorization token required false - Working hours information considered public if available
Admin Authorization token required false

GetWorkingHoursRequest

    <GetWorkingHoursRequest s="{range-start-millis} (long)" e="{range-end-millis} (long)" [id="{comma-sep-zimbra-ids}"]
                               [name="{comma-sep-emails}"] /> ## GetWorkingHoursRequest

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

XPath Required / Optional Description
@s Required (only 1) Type:long
Range start in milliseconds since the epoch
@e Required (only 1) Type:long
Range end in milliseconds since the epoch
@id Optional (0 or 1) Type:String
Comma-separated list of Zimbra IDs
@name Optional (0 or 1) Type:String
Comma-separated list of email addresses

GetWorkingHoursResponse

    <GetWorkingHoursResponse> ## GetWorkingHoursResponse
        (<usr id="{account-email}"> ## FreeBusyUserInfo
            List of any of: {
                <f s="{start-millis-gmt} (long)" e="{end-millis-gmt} (long)" /> ## FreeBusyFREEslot
                <b s="{start-millis-gmt} (long)" e="{end-millis-gmt} (long)" /> ## FreeBusyBUSYslot
                <t s="{start-millis-gmt} (long)" e="{end-millis-gmt} (long)" /> ## FreeBusyBUSYTENTATIVEslot
                <u s="{start-millis-gmt} (long)" e="{end-millis-gmt} (long)" /> ## FreeBusyBUSYUNAVAILABLEslot
                <n s="{start-millis-gmt} (long)" e="{end-millis-gmt} (long)" /> ## FreeBusyNODATAslot
            }
          </usr>)*
    </GetWorkingHoursResponse>

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

XPath Required / Optional Description
/usr Optional (0 or more) Working hours information by user
/usr@id Required (only 1) Type:String
"id" is always account email; it is not zimbraId as the attribute name may suggest
/usr/f Optional (0 or 1)
/usr/f@s Required (only 1) Type:long
GMT Start time for slot in milliseconds
/usr/f@e Required (only 1) Type:long
GMT End time for slot in milliseconds
/usr/b Optional (0 or 1)
/usr/b@s Required (only 1) Type:long
GMT Start time for slot in milliseconds
/usr/b@e Required (only 1) Type:long
GMT End time for slot in milliseconds
/usr/t Optional (0 or 1)
/usr/t@s Required (only 1) Type:long
GMT Start time for slot in milliseconds
/usr/t@e Required (only 1) Type:long
GMT End time for slot in milliseconds
/usr/u Optional (0 or 1)
/usr/u@s Required (only 1) Type:long
GMT Start time for slot in milliseconds
/usr/u@e Required (only 1) Type:long
GMT End time for slot in milliseconds
/usr/n Optional (0 or 1)
/usr/n@s Required (only 1) Type:long
GMT Start time for slot in milliseconds
/usr/n@e Required (only 1) Type:long
GMT End time for slot in milliseconds