Participant Availability

[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/plcm-participant-availability

Summary

Resources	Methods
https://localhost:8443/api/rest/plcm-participant-availability	GET Retrieves all time slots of scheduled conferences for passed participant between start-time and end-time parameter values.

Resources

https://localhost:8443/api/rest/plcm-participant-availability

Methods

GET

Retrieves all time slots of scheduled conferences for passed participant between start-time and end-time parameter values.
If no time slots are present then it will return empty list.
[tags: RPRM]

Request

Query Parameters

Name	Type	Description
username	xs:string	User name of the participant , who's availability you are interested in.
domain	xs:string	Domain name of the participant , who's availability you are interested in.
start-time	xs:string	Get scheduled conference time slots after start-time. start-time string must be in a text format that complies with ISO 8601 date and time formats (see http://www.w3.org/TR/xmlschema-2/#isoformats). Example: 2012-05-01T13:00:00.000-06:00
end-time	xs:string	Get scheduled conference time slots before end-time. end-time string must be in a text format that complies with ISO 8601 date and time formats (see http://www.w3.org/TR/xmlschema-2/#isoformats). Example: 2012-05-03T13:00:00.000-06:00

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-participant-availability+xml application/vnd.plcm.plcm-participant-availability+json	Participant's available time-slots is retrieved successfully
304		Participant Availability information has not changed since the last search. Note: The API client must provide the "plcm-participant-availability" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-participant-availability" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to users on the server.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference start time cannot be in the past.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference start time should be less than end time.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant's info is incomplete. Participant's domain and username must be filled in.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Start Time and End Time are both required and need to comply with ISO 8601 Date and Time Formats (see http://www.w3.org/TR/xmlschema-2/#isoformats).
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User does not exist in domain.