Reservation

[tags: RPRM]

Resource Root

https://localhost:8443/api/rest/reservations

Summary

Resources	Methods
https://localhost:8443/api/rest/reservations	POST Creates a reservation for a conference using passed parameters. GET Returns list of reservations which are between start time and end time [tags: RPRM] .
https://localhost:8443/api/rest/reservations/{reservation-identifier}	DELETE Deletes reservation of a conference for passed reservation id [tags: RPRM] . GET Returns Reservation information of conference for the requested reservation id [tags: RPRM] . PUT Updates values for the reservation [tags: RPRM] .

Resources

https://localhost:8443/api/rest/reservations

Methods

POST

Creates a reservation for a conference using passed parameters. To create reservation at least two
participants should be there. The start time and end time should be future time. End time should be after start
time. Minimum conference time should be 5 minutes. Conference password should be in digits.
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-reservation+xml

application/vnd.plcm.plcm-reservation+json

Response

Status	Representation	Description
201	application/vnd.plcm.plcm-reservation+xml application/vnd.plcm.plcm-reservationjsonxml	Returns created Reservation
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation Identifier must be empty, since this is a new reservation.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference name is blank
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference starttime is in the past
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference endtime is in the past
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference starttime is more than endtime
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference duration is less than 5 minutes
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Template name cannot be blank.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Specified conference template does not exist. Please make sure your system is configured with a DMA that contains the specified conference template.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference password is invalid
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Supported language cannot be empty since sendEmail is set to TRUE.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference must have at least two users.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participants info is incomplete. Participant domain and username must be filled in.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Join Mode is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Connection Type is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Dial Direction is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Dial Direction is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Dial Number cannot be empty if participant mode is anything other than IN_PERSON.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference owner must be specified, and cannot be a guest. Reservation can only have one owner.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation must contain a chairperson since the chairperson passcode is set.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Chairperson passcode, if not empty, must contain 15 digits.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Chairperson passcode can only contain digits.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A chairperson was specified, but the chairperson passcode is empty.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference passcode, if not empty, must contain 15 digits.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference passcode can only contain digits.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to retrieve information from database.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to find an MCU with enough capacity to host the reservation.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to persist conference in database.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Error while sending email.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to persist email in database.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to persist email in database.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The chosen MCU is not found.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant contains unsupported connection type.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No MCU available.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Not enough bandwidth.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	No media path between MCU and participants.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The conference alias had been used.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	When creating or updating reservation, only API_DMA_CONF and API_CMA_CONF are permitted. If not filled, API_DMA_CONF is set.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The reservation-identifier must be empty, since this is a new reservation.The reservation-identifier must be empty, since this is a new reservation.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation recurrence-id must be empty, since this is a new reservation.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The recurrence-id should be number.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-sched-recurrence does not exist.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The sched-recurrence-type-enum does not exist or format is error.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The end-time-type-enum does not exist or format is error.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The conference duration must be 5 minutes or more and be less than 24 hours.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The occurences should not be empty and not be less than 2 and not be more than 365.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The recur-start-time does not exist or format is error.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The recur-end-time does not exist or format is error.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The recur-start-time cannot be in the past.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The recur-end-time can not be in the past.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The recur-start-time should be less than recur-end-time.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-daily does not exist.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-daily interval is need to fill if daily-type-enum is EVERY_N_DAY.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The interval must be equal or greater than 1.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-weekly does not exist.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-weekly's day-of-week-mask does not exist.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-weekly's day-of-week-mask format is error, it shall be 7 chars length and consist of 0 and 1.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-weekly's day-of-week-mask format is error, it shall be 7 chars length and consist of 0 and 1.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-monthly does not exist.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The day must be between 1 and 28.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-monthly-nth does not exist.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-monthly-nth's prefix-type-enum does not exist or format is error.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The plcm-recur-monthly-nth's day-type-enum does not exist or format is error.
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).
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	Conference name cannot contain '?' or ':'.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Supported language cannot be empty since sendEmail is set to TRUE.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The bridge-selection-type-enum is not supported when schedule-uitype-enum is API_DMA_CONF.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The bridge-selection-type-enum cann't be empty when schedule-uitype-enum is API_CMA_CONF.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only bridge-selection-type-enum AUTOBRIDGE and SINGLEBRIDGE are supported when schedule-uitype-enum is API_CMA_CONF.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant's Connection Type is invalid, it is only supported by guest or guestboook.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant's Connection Type is invalid, it is only supported by get operation.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User does not exist in domain.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Room does not exist in domain.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Guest does not exist in guestbook.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The participant's dial-direction-enum can not be DIAL_OUT when mode-enum is IN_PERSON.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant's Connection Type is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation can only have one chairperson.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference must contain at least one known user.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid billing-code.

GET

Returns list of reservations which are between start time and end time
[tags: RPRM]

Request

Query Parameters

Name	Type	Description
start-time	xs:string	Get Reservations 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 Reservations before the 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
recurrence-id	xs:int	Get Reservations associated with the recurrence-id. recurrence-id string must be in a int format.

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-reservation-list+xml application/vnd.plcm.plcm-reservation-list+json	Returns list of reservations.
304		Reservation list information has not changed since the last search. Note: The API client must provide the "plcm-reservation-list" 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-reservation-list" 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 the reservations on the server.
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).
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Start time should be less than end time.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The requested search result limit of is too large.

https://localhost:8443/api/rest/reservations/{reservation-identifier}

Template Parameters

Name	Type	Description
reservation-identifier	xs:string

Methods

DELETE

Deletes reservation of a conference for passed reservation id
[tags: RPRM]

Response

Status	Representation	Description
204	application/octet-stream	Reservation is deleted successfully
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Bad Request
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation does not exist.

GET

Returns Reservation information of conference for the requested reservation id
[tags: RPRM]

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-reservation+xml application/vnd.plcm.plcm-reservation+json	Returns reservation information
304		Reservation information has not changed since the last search. Note: The API client must provide the "plcm-reservation" 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-reservation" 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 the reservation on the server.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation does not exist
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation exists, but was not scheduled through the API. Permission Denied

PUT

Updates values for the reservation
[tags: RPRM]

Request

Representations

application/vnd.plcm.plcm-reservation+xml

application/vnd.plcm.plcm-reservation+json

Response

Status	Representation	Description
204	application/vnd.plcm.plcm-reservation+xml application/vnd.plcm.plcm-reservation+json	Reservation information successfully updated. Note: The response will only contain both an ETag value and link to the updated reservation resource in the HTTP header.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation Id in object does not match the URI.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation does not exist.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation exists, but was not scheduled through the API. Permission denied.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference name is blank
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference starttime is in the past
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference endtime is in the past
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference starttime is more than endtime
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference duration is less than 5 minutes
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Template name cannot be blank.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Specified conference template does not exist. Please make sure your system is configured with a DMA that contains the specified conference template.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference password is invalid
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Supported language cannot be empty since sendEmail is set to TRUE.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference must have at least two users.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participants info is incomplete. Participant domain and username must be filled in.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Join Mode is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Connection Type is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Dial Direction is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Dial Direction is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant Dial Number cannot be empty if participant mode is anything other than IN_PERSON.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference owner must be specified, and cannot be a guest. Reservation can only have one owner.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation must contain a chairperson since the chairperson passcode is set.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Chairperson passcode, if not empty, must contain 15 digits.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Chairperson passcode can only contain digits.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	A chairperson was specified, but the chairperson passcode is empty.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference passcode, if not empty, must contain 15 digits.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference passcode can only contain digits.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	When creating or updating reservation, only API_DMA_CONF and API_CMA_CONF are permitted. If not filled, API_DMA_CONF is set.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The reservation-identifier must be empty, since this is a new reservation.The reservation-identifier must be empty, since this is a new reservation.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation recurrence-id must be empty, since this is a new reservation.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The recurrence-id should be number.
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).
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	Conference name cannot contain '?' or ':'.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Supported language cannot be empty since sendEmail is set to TRUE.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The bridge-selection-type-enum is not supported when schedule-uitype-enum is API_DMA_CONF.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The bridge-selection-type-enum cann't be empty when schedule-uitype-enum is API_CMA_CONF.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Only bridge-selection-type-enum AUTOBRIDGE and SINGLEBRIDGE are supported when schedule-uitype-enum is API_CMA_CONF.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant's Connection Type is invalid, it is only supported by guest or guestboook.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant's Connection Type is invalid, it is only supported by get operation.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	User does not exist in domain.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Room does not exist in domain.
404	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Guest does not exist in guestbook.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The participant's dial-direction-enum can not be DIAL_OUT when mode-enum is IN_PERSON.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Participant's Connection Type is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Reservation can only have one chairperson.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Conference must contain at least one known user.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid billing-code.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The reservation resource has changed on the server. Note: The response will contain the ETag value and link that reflects the server's reservation resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-reservation.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-reservation.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.