getFreeBusyRequest

Returns free/busy information for GroupWise users. This method is called with startFreeBusySessionRequest and closeFreeBusySessionRequest and can be called more than once to retrieve the free/busy information for all users defined in startFreeBusySessionRequest.

Request

<getFreeBusyRequest>
   <freeBusySessionId>
   <view type="string"/>
</getFreeBusyRequest>

Response

<getFreeBusyResponse>
   <freeBusyStats type="types:FreeBusyStats"/>
   <freeBusyInfo type="types:FreeBusyInfoList"/>
   <status type="types:Status"/>
</getFreeBusyResponse>

Elements

freeBusySessionId: Specifies the session ID, as returned in the startFreeBusySessionResponse. startFreeBusySessionRequest must be called before getFreeBusyRequest.
view: Can pass “from” or “place”.
freeBusyStats: Returns the current state of the free/busy search on the GroupWise POA.
responded: Specifies the number of users in the free/busy request that have responded with free/busy information.
outstanding: Specifies the number of users in the free/busy request that have not yet responded with free/busy information.
total: Specifies the total number of users in the free/busy request.
freeBusyInfo: Specifies the free/busy blocks for users.
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

<getFreeBusyRequest>
   <freeBusySessionId>354</freeBusySessionId>
</getFreeBusyRequest>

<getFreeBusyResponse>
   <freeBusyInfo>
      <freeBusyStats> 
         <responded>2</responded> 
         <outstanding>0</outstanding> 
         <total>2</total>
      </freeBusyStats> 
      <user> 
         <email>user1@dmz4.provo.novell.com</email>
         <blocks>
            <block> 
               <startDate>2012-03-19T16:00:00Z</startDate> 
               <endDate>2012-03-19T16:30:00Z</endDate>
               <acceptLevel>Busy</acceptLevel>
               <subject>A tea party at MadHatter's place</subject> 
            </block> 
            <block>
               <startDate>2004-03-19T20:00:00Z</startDate> 
               <endDate>2004-03-19T20:30:00Z</endDate> 
               <acceptLevel>Busy</acceptLevel> 
               <subject>Watch the match (stadium)</subject>
            </block>
            <block> 
               <startDate>2004-03-19T20:00:00Z</startDate> 
               <endDate>2004-03-19T20:30:00Z</endDate> 
               <acceptLevel>Busy</acceptLevel> 
               <subject>watch the match </subject>
            </block>
            <block> 
               <startDate>2004-03-19T07:00:00Z</startDate> 
               <endDate>2004-03-19T15:00:00Z</endDate> 
               <acceptLevel>OutOfOffice</acceptLevel>
            </block>
            <block> 
               <startDate>2004-03-20T00:00:00Z</startDate> 
               <endDate>2004-03-22T15:00:00Z</endDate> 
               <acceptLevel>OutOfOffice</acceptLevel>
            </block>
            <block> 
               <startDate>2004-03-23T00:00:00Z</startDate> 
               <endDate>2004-03-23T15:00:00Z</endDate> 
               <acceptLevel>OutOfOffice</acceptLevel>
            </block>
         </blocks> 
      </user> 
      <user>
         <email>user2@dmz4.provo.novell.com</email> 
         <blocks>
            <block> 
               <startDate>2004-03-19T07:00:00Z</startDate> 
               <endDate>2004-03-19T15:00:00Z</endDate> 
               <acceptLevel>OutOfOffice</acceptLevel>
            </block>
            <block> 
               <startDate>2004-04-08T23:00:00Z</startDate> 
               <endDate>2004-04-09T14:00:00Z</endDate> 
               <acceptLevel>OutOfOffice</acceptLevel>
            </block> 
         </blocks>
      </user>
   </freeBusyInfo>
   <status>
      <code>0</code>
   </status>
</getFreeBusyResponse>