startFreeBusySessionRequest

Starts a free/busy search on the specified users. On a successful startFreeBusySessionResponse, a freeBusySessionId is returned. The freeBusySessionId is used with the other free/busy methods: getFreeBusyRequest and closeFreeBusySessionRequest.

Request

<startFreeBusySessionRequest>
   <users type="types:FreeBusyUserList"/>
   <startDate type="dateTime"/>
   <endDate type="dateTime"/>
</startFreeBusySessionRequest>

Response

<startFreeBusySessionResponse>
   <freeBusySessionId> type="int"/>
   <status> type="types:Status"/>
</startFreeBusySessionResponse>

Elements

user

Specifies the list of users that you want free/busy information for.

startDate

Specifies the start of the range of time to search.

endDate

Specifies the end of the range of time to search.

code

Returns the error number related to the event. 0 indicates that the request was successful.

status

Returns the success or failure of the method.

Example

<startFreeBusySessionRequest> 
   <users> 
      <user> 
         <displayName>u2</displayName> 
         <email>u2@phantom.com</email> 
         <uuid>42F9A600-175B-0000-890F-6E00D5004E00</uuid> 
      </user> 
   </users> 
   <startDate>20120920T060000Z</startDate> 
   <endDate>20121011T060000Z</endDate> 
</startFreeBusySessionRequest>

<startFreeBusySessionResponse> 
   <freeBusySessionId>4163</freeBusySessionId> 
   <status> 
      <code>0</code> 
   </status> 
</startFreeBusySessionResponse>