PlcmReservation

PlcmReservation

CMA Reservation. It's used to reserve a conference in the future on CMA system.


PlcmReservation Fields

NameTypeDescriptionAttributes
plcmSchedRecurrence PlcmSchedRecurrenceSee Definition of PlcmSchedRecurrence
atomLinkList Array of LinkSee Definition of Link
plcmReservedParticipantList PlcmReservedParticipantListSee Definition of PlcmReservedParticipantListMandatory
nameName The reservation name. Mandatory
reservationIdentifierstring Identifier of the reservation. Need to fill this in if this is an edited reservation. Leave it blank if this is a new reservation
confPasscodestring Passcode for participants to enter conference
chairPasscodestring Passcode for chairperson to enter conference
templateNamestring Name of conference template this reservation is using. Mandatory
sendEmailboolean Reservation confirmation will be sent to participants if set to TRUE Mandatory
supportedLanguageEnumSupportedLanguageEnum The language used in the email notification message.
dialInNumberstring The dial in number of this reservation. This is a read-only field. Modification of this field is not allowed. For RMA-reservation, this is the VMR number
entityTagEntityTag The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance.
billingCodestring The area billing code of this reservation.
scheduleConferenceTypeEnumScheduleConferenceTypeEnum Identify where the conference is reserved, when creating or updating reservation, only API_DMA_CONF and API_CMA_CONF are permitted. If not filled, API_DMA_CONF is set.
bridgeSelectionTypeEnumBridgeSelectionTypeEnum Identify the bridge selection type, if not filled, MULTIDMAPOOL is set. CMA conference supports AUTOBRIDGE and SINGLEBRIDGE. DMA conference supports MULTIDMAPOOL. SINGLEDMAPOOL and MULTIDMAPOOL are not supported now.
scheduledMcuIpstring The ScheduledMcu's ip address of this reservation. If bridge-selection-type-enum is SINGLEBRIDGE, then scheduled-mcu-ip must be set.
conferenceReserveTypeEnumConferenceReserveTypeEnum Identify the conference reserve type, if not filled, SINGLE is set. If this is RECURRING, then plcm-sched-recurrence must be set.
conferenceIdstring The conferenceId of reservation.
vmrRoomIdstring The vmr room Id of reservation, Only used for DMA conference.
recurrenceIdstring The recurrenceId of a set of reservations. It can identify the set of recurring reservations. This is a read-only field.
startTimedateTime
endTimedateTime


Nested Types/Restrictions


NameTypeRestrictions
ConferenceReserveTypeEnumstring
Value must be one of:
  • SINGLE
  • RECURRING
BridgeSelectionTypeEnumstring
Value must be one of:
  • AUTOBRIDGE
  • SINGLEBRIDGE
  • MULTIBRIDGE
  • SINGLEDMAPOOL
  • MULTIDMAPOOL
ScheduleConferenceTypeEnumstring
Value must be one of:
  • API_DMA_CONF
  • API_CMA_CONF
  • UI_DMA_CONF
  • UI_CMA_CONF
  • UI_DMA_ANYTIME_CONF
EntityTagstring
Length of value must be >=1
Length of value must be <=64
SupportedLanguageEnumstring
Value must be one of:
  • ENGLISH
  • DEUTSCH
  • SPANISH
  • FRENCH
  • JAPANESE
  • KOREAN
  • PORTUGESE
  • RUSSIAN
  • CHINESE
  • TAIWANESE
Namestring
Length of value must be >=1
Length of value must be <=64