CoCon API Description

Copyright

All information in this document is subject to change without notice. No part of this document may be
reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the
express written permission of Televic.

© 2020 Televic NV. All rights reserved.

Document history

Version Author Date Description

0.01 JV 23/01/2014 Initial version
0.02 DL 12/02/2014 Add commands description
0.03 DL 13/02/2014 Add badge event and delegate event
0.04 DL 07/03/2014 Add user information during microphone state change
1.0 JV 22/05/2014 Finalized the API for CoCon v3.1
1.1 JV 16/06/2014 Added commands for individual voting results
1.2 JV 24/06/2014 Defined the event model and commands
1.3 JV 11/07/2014 Added the “ButtonLED_Event” model
1.4 JV 18/08/2014 Added commands for
- Interactive model: Delegate screen control
- Start meeting from XML file
- Agenda and voting control

1.5 MP 31/10/2014 Added and improved commands in the Meeting_Agenda

model
1.6 GL 25/11/2014 Modify SeatTimerPauseResumed name and parameters
1.7 GL 26/12/2014 Added commands for

CoCon API 24 Dec 2021 1/184

 - ClearAllDelegatesAndGroups
- StartEmptyMeeting
- About Audio application commands

1.8 GL 12/01/2015 Added commands for

- Initialization

1.9 GL/MP 21/04/2015 Added command for

- SetNextButtonLedStatus
- SetPriorButtonLedStatus
- NextButtonPressedEvent
- PriorButtonPressedEvent
- Send message to Operator

2.0 GL/MP 04/05/2015 Agenda item ID replaced with sequence number

ID is not well readable for user.
But Sequence number is string ,It might be “1”, “1.1”, “1.1.2”

Added commands for

- RemoveAgendaItemById
- DeleteAllAgendaItems
- MoveAgendaItem

2.1 GL/MP 21/05/2015 Added commands for Interpretation

4.1 KMA/MP 25/01/2016 Updated with commands for
- Interpreter
- Intercom
- Flexible delegate
- Timer

4.5 KMA 28/08/2016 Updated commands for

- Room (initialization)

5.0 MP/KMA 03/04/2017 Update API for

- Timer setting enabled / disabled
- Video application
- API for microphone activation type
- GetUnitErrorState
- GetMatrixNodeStatus
- GetCUState
- GetNetworkDeviceList

5.1 MP/KMA 12/07/2017 Update API for:

- StartEmptyMeeting (With login method as optional)
- GetCuIpAddress
- SetCuIpAddress
- RestartRoomServer
- GetAmountOfVotes
- NotifyExternalCall
- Intercom Parameter name improved.
(Request/ Accept /End call )
- AddSeat (New API)
- RemoveSeat (New API)
- AddChannel / EditChannel (add new para :
IsRecording)

CoCon API 24 Dec 2021 2/184

 5.1.1 MP 11/07/2017 - Audio preset commands. (Newly added)
- Interpreter Preset API improved with new optional
parameter.
- Remove unit from room.
- SaveAndSendInterpreterPreset
- AddDelegatesToMeeting
- AddDelegatesToSeats
- EditSeat & EditBooth (intercom new field)
- Audio API update events (MatrixNodeUpdated;
ActiveAudioPresetUpdated;
MatrixNodeVolumeUpdated)
- API name correction and keep old API for exiting
customer.(ActivateNextMicrophone;
GetAudioConfigurationDetailById;
GetAudioConfigurationDetailByName)
- SetMicrophoneSensitivity /
MicrophoneSensitivityUpdated
- SetDelegateTimer & SetGroupTimer update event
added with the correct name.

5.2 MP 12/20/2017 - AddSynoptic

- EditSeat (IsChairman)
- GetDefaultMicrophoneModeForRoom
- SetDefaultMicrophoneModeForRoom
- DefaultMicrophoneModeForRoomUpdated
- ClearAllMeetingAndDelegateData
- AddVotingTemplate

5.3.2 MP 09/10/2018 - ResetDelegateTimer

- ResetGlobalDelegateTimer
- ResetGroupTimer
- ResetGlobalGroupTimer
- ChangeDelegateTimer
- ChangeGroupTimer
- ResendMeetingData
- keypad_login_code (notification api)

5.4 MP 05/12/2018 - Updated api

1. Voting template with new para “ IsUnanimous”
2. AddDelegate, EditDelegate, DelegateAdded &
Delegateupdated api calls with new
Para”MiddleName”, “FingerprinterData”,
“KeypadLoginCode”
- Newly added api
1. SetAudioSoftwareConfigurationById (update
notification)
2. CurrentAudioSoftwareConfigurationUpdated(upd
ate notification)
3. GetGeneralVotingResults
4. Recording Module
i. GetRecordingFilesInfo
ii. Startrecording

CoCon API 24 Dec 2021 3/184

 iii. Stoprecording
iv. Getrecordingstate
5. Wireless Coupling Module
i. Getwcapinfo
ii. Getallwcapinfo
iii. SetWcapCoupledMode

5.4.1 MP 04/17/2019 - API updated :

1. ClearAllMeetingAndDelegateData with optional
parameter “IncludeService=True/False”

6.0 JHO 05/20/2019 - API updated: CoCon for Plixus no longer supported

6.1 MP / ISA 12/10/2019 - Added new api :

22/10/2019 1. ServiceRequestEvent
2. GetServiceList
3. GetServiceListbyMeetingId
4. GetServiceState
5. SetServiceRequestState
6. GetVotingAgendaTemplateList
7. GetAgendaDetailById
8. FingerprintEvent
9. RemoveDelegatesFromSeat
10. RemoveAllDelegatesFromSeat
- API updated with additional optional parameters
1. SetDelegateScreen/Discussion:
“VideoStream=1”

Updated & Validated api document for 6.1

6.2 FN 02/01/2020 - Extended SetNextButtonEnabled and
SetPriorButtonEnabled with possibility to apply to all
seats (indicating seat number 9999)
- Added a note that ButtonLED_Event module is
default NOT subscribed.

6.2 FN 22/01/2020 Added a note regarding

GetCurrentAudioSoftwareConfigurationInDetails call which
only returns the current saved configuration info.
6.3 MP 10/03/2020 - Newly added API for Interpretation
1. AssignDeskToBooth
2. Unassigndesk
3. UpdateBooth.

CoCon API 24 Dec 2021 4/184

 6.3.2 MP/FN 18/11/2020 - SetCustomScreenOnSeat/SetCustomScreenOnRoom
api extended with fullscreen parameter
- GetIndividualVotingResults
- Removed the MaxNbRequest parameter as option for
microphone mode (no longer supported)
- Added documentation for GetActivationType call
which was already supported
- SetNextButtonLedStatus and
SetPriorButtonLedStatus are applied on seat level
now

6.3.2 FN 07/01/2021 - Added API call Voting/DeleteVotingTemplate

- Added API call Interactive/DisableDelegateScreen

6.3.2 FN 24/02/2021 - Correct parameter of NextButtonPressed and

6.3.3 PriorButtonPressed towards seat ID
- Added sections which were part of separate
application note (enabling of API and best practices)
- Updated response of StartEmtpyMeeting
- Added notes regarding using API calls to remove
delegate from seat (only working in fixed seating
mode)

6.3.3 FN 31/03/2021 - Added example for SetCustomScreen

- Added API call AddChannels
- Updated description of RemoveDelegateFromMeeting
API call which is not allowed once delegate has
participated in a voting
- Removed MaxNrRequest as return value from API call
“Get”, since not relevant anymore since Core version
- Added API call to change delegate and group timer
state

6.3.3 FN 20/04/2021 - Added API call GetAllMeetings

- Added API call SetSeatPriority
- Added API call EditMeetingTitle

6.3.4 FN 30/09/2021 - Added API call ResetScreen

- Added comment about Timer event intervals
- Updated FingerprintEvent
- Added API call GetAuthorityOverview
- Added module OperatorCustomization (both API calls
as event)

6.3.5 FN 30/09/2021 - Limitations for custom buttons and labels

- Added API call Disconnect (already present since
version 6.3.3)
- Fixed API call documentation for
SetDefaultMicrophoneModeForRoom
- Added API call GetSynoptic

CoCon API 24 Dec 2021 5/184

 Table of contents

Table of Contents
1 Introduction & Scope ...................................................................................................................................... 15
1.1 Introduction ............................................................................................................................................ 15
1.2 Scope ..................................................................................................................................................... 15
1.2.1 In scope ............................................................................................................................................. 15
1.2.2 Out of scope ...................................................................................................................................... 15
1.3 API module compatibility ....................................................................................................................... 15
Server to Client .................................................................................................................................................. 15
Client to server ................................................................................................................................................... 18
2 How to activate the API .................................................................................................................................. 24
2.1 Plixus Core ............................................................................................................................................ 24
2.2 Cocon for Plixus Core ............................................................................................................................ 24
3 General communication structure .................................................................................................................. 25
3.1 Communication format .......................................................................................................................... 25
3.1.1 REST/JSON ....................................................................................................................................... 25
3.1.2 Long polling ....................................................................................................................................... 25
3.2 Communication methods ....................................................................................................................... 25
3.3 Publish/Subscribe .................................................................................................................................. 26
3.4 Setting up and operating the CoCon API connection ............................................................................ 27
3.4.1 General .............................................................................................................................................. 27
3.4.2 REST/JSON Example........................................................................................................................ 28
3.4.3 Server return values .......................................................................................................................... 29
4 Operational commands .................................................................................................................................. 30
4.1 Data models ........................................................................................................................................... 30
4.1.1.1 AuthorityAssigned ...................................................................................................................... 30
4.1.1.2 Meeting ...................................................................................................................................... 30
4.1.1.3 VotingCountWeight .................................................................................................................... 30
4.1.1.4 VotingOption .............................................................................................................................. 30
4.1.1.5 VotingOptionVoteDetail ............................................................................................................. 31
4.1.1.6 VotingResultSummary ............................................................................................................... 31
4.1.1.7 IndividualVote ............................................................................................................................ 31
4.1.1.8 Timer .......................................................................................................................................... 31
4.1.1.9 BaseObjectTimer ....................................................................................................................... 31
4.1.1.10 DelegateTimer : BaseObjectTimer ........................................................................................ 32
4.1.1.11 GroupTimer : BaseObjectTimer ............................................................................................. 32
4.1.1.12 SeatTimer : BaseObjectTimer ............................................................................................... 32
4.1.1.13 Delegate ................................................................................................................................ 32
4.1.1.14 Group ..................................................................................................................................... 33
4.1.1.15 AgendaItem ........................................................................................................................... 33
4.1.1.16 VotingAgendaItem:AgendaItem ............................................................................................. 33
4.1.1.17 LecturerAgendaItem:AgendaItem .......................................................................................... 33
4.1.1.18 AudioGroup ............................................................................................................................ 33
4.1.1.19 AudioMatrixNode ................................................................................................................... 33
4.1.1.20 AudioSoftwareConfiguration .................................................................................................. 34
4.1.1.21 AudioSoftwareConfigurationDetailed ..................................................................................... 34
4.1.1.22 ScreenControlOptions ........................................................................................................... 34

CoCon API 24 Dec 2021 6/184

 4.1.1.23 HomeControl : ScreenControlOptions ................................................................................... 34
4.1.1.24 DiscussionControl : ScreenControlOptions ........................................................................... 34
4.1.1.25 AgendaControl : ScreenControlOptions ................................................................................ 34
4.1.1.26 DelegatesControl : ScreenControlOptions ............................................................................ 35
4.1.1.27 VotingControl : ScreenControlOptions .................................................................................. 35
4.1.1.28 DocumentsControl : ScreenControlOptions .......................................................................... 35
4.1.1.29 MessagesControl : ScreenControlOptions ............................................................................ 35
4.1.1.30 ServicesControl : ScreenControlOptions ............................................................................... 35
4.1.1.31 ConfigurationControl : ScreenControlOptions ....................................................................... 35
4.1.1.32 Unit......................................................................................................................................... 35
4.1.1.33 Channel.................................................................................................................................. 35
4.1.1.34 InterpreterPreset .................................................................................................................... 36
4.1.1.35 DeskUnitInChannel ................................................................................................................ 36
4.1.1.36 ChannelRealtimeData............................................................................................................ 36
4.2 Server to client ....................................................................................................................................... 36
4.2.1 Room ................................................................................................................................................. 37
4.2.1.1 InitializationState........................................................................................................................ 37
4.2.1.2 UnitStateChanged ..................................................................................................................... 37
4.2.1.3 VolumeChangedForRoom ......................................................................................................... 37
4.2.1.4 UnitError .................................................................................................................................... 38
4.2.2 Microphone ........................................................................................................................................ 38
4.2.2.1 MicrophoneState........................................................................................................................ 38
4.2.2.2 MicrophoneMode ....................................................................................................................... 39
4.2.2.3 MicButtonEvent .......................................................................................................................... 40
4.2.2.4 MicrophoneSensitivityUpdated .................................................................................................. 40
4.2.2.5 MicStateChangedInRunningMeeting ......................................................................................... 40
4.2.3 Meeting_Agenda................................................................................................................................ 41
4.2.3.1 MeetingTitleChanged................................................................................................................. 41
4.2.3.2 MeetingStatus ............................................................................................................................ 41
4.2.3.3 MeetingAgendaChanged ........................................................................................................... 42
4.2.3.4 Agenda_ItemChanged ............................................................................................................... 42
4.2.3.5 Keypad_login_code ................................................................................................................... 43
4.2.3.6 FingerprintEvent ........................................................................................................................ 43
4.2.4 Voting ................................................................................................................................................. 44
4.2.4.1 VotingState ................................................................................................................................ 44
4.2.4.2 VotingOutcome .......................................................................................................................... 44
4.2.4.3 GeneralVotingResults ................................................................................................................ 45
4.2.4.4 IndividualVotingResults ............................................................................................................. 45
4.2.4.5 VotingTemplateAdded ............................................................................................................... 45
4.2.5 Timer .................................................................................................................................................. 51
4.2.5.1 MeetingTimerEvent.................................................................................................................... 51
4.2.5.2 MeetingTimerStateChange ........................................................................................................ 51
4.2.5.3 DelegateTimerEvent .................................................................................................................. 52
4.2.5.4 DelegateTimerStateChange ...................................................................................................... 52

CoCon API 24 Dec 2021 7/184

 4.2.5.5 GroupTimerEvent ...................................................................................................................... 52
4.2.5.6 GroupTimerStateChange .......................................................................................................... 53
4.2.5.7 SeatTimerEvent ......................................................................................................................... 53
4.2.5.8 SeatTimerPauseResumed ........................................................................................................ 54
4.2.5.9 ActiveAgendaItemTimerEvent ................................................................................................... 54
4.2.5.10 ActiveAgendaItemTimerPauseResumed ............................................................................... 54
4.2.5.11 VotingTimerEvent .................................................................................................................. 55
4.2.5.12 VotingTimerPauseResumed .................................................................................................. 55
4.2.6 Delegate ............................................................................................................................................ 56
4.2.6.1 BadgeEvent ............................................................................................................................... 56
4.2.6.2 DelegateOnSeat ........................................................................................................................ 56
4.2.6.3 DelegateSeatingUpdated .......................................................................................................... 57
4.2.6.4 MeetingStartsUserInformation ................................................................................................... 57
4.2.6.5 DelegateUpdated ....................................................................................................................... 58
4.2.6.6 DelegateAdded .......................................................................................................................... 58
4.2.6.7 DelegateRemoved ..................................................................................................................... 59
4.2.6.8 DelegateSeatingUpdated .......................................................................................................... 60
4.2.6.9 DelegatesInMeetingUpdated ..................................................................................................... 60
4.2.7 Interactive .......................................................................................................................................... 61
4.2.7.1 ScreenLockRemoved ................................................................................................................ 61
4.2.7.2 DelegateScreenSetChanged ..................................................................................................... 61
4.2.7.3 CustomButtonEvent ................................................................................................................... 62
4.2.7.4 ServiceRequestEvent ................................................................................................................ 62
4.2.8 Audio .................................................................................................................................................. 62
4.2.8.1 SetAudioSoftwareConfigurationById ......................................................................................... 62
4.2.8.2 CurrentAudioSoftwareConfigurationUpdated ............................................................................ 62
4.2.9 Logging .............................................................................................................................................. 63
4.2.9.1 ConnectionLost_CentralUnit ...................................................................................................... 63
4.2.9.2 ConnectionLost_Database ........................................................................................................ 63
4.2.10 ButtonLED_Event .......................................................................................................................... 64
4.2.10.1 ButtonPressed ....................................................................................................................... 64
4.2.10.2 NextButtonPressed ................................................................................................................ 64
4.2.10.3 PriorButtonPressed................................................................................................................ 65
4.2.11 Interpretation .................................................................................................................................. 66
4.2.11.1 IMicrophoneStateUpdated ..................................................................................................... 66
4.2.11.2 IActivatedChannelUpdated .................................................................................................... 66
4.2.11.3 SpeakSlowerRequest ............................................................................................................ 66
4.2.11.4 SpeakSlowerEnded ............................................................................................................... 67
4.2.11.5 ActivePresetStateChanged ................................................................................................... 67
4.2.12 Rocording ( AE-R & Plixus Core only) ........................................................................................... 67
4.2.12.1 RecordingStatusUpdate......................................................................................................... 67
4.2.13 Wireless Coupling .......................................................................................................................... 68
4.2.13.1 WcapInfoUpdated .................................................................................................................. 68
4.2.13.2 WcapCoupledUpdated........................................................................................................... 68
4.2.13.3 AllWcapInfoUpdated .............................................................................................................. 68

CoCon API 24 Dec 2021 8/184

 4.2.14 Operator Customization ................................................................................................................. 69
4.2.14.1 CustomButtonPressed ........................................................................................................... 69
4.3 Client to server....................................................................................................................................... 70
4.3.1 General .............................................................................................................................................. 70
4.3.1.1 Connect ..................................................................................................................................... 70
4.3.1.2 Disconnect ................................................................................................................................. 70
4.3.1.3 Subscribe ................................................................................................................................... 71
4.3.1.4 Unsubscribe ............................................................................................................................... 71
4.3.1.5 Notification ................................................................................................................................. 71
4.3.1.6 RebootSystem ........................................................................................................................... 72
4.3.2 Room ................................................................................................................................................. 73
4.3.2.1 GetRoomServerName ............................................................................................................... 73
4.3.2.2 GetActiveRoomInfo.................................................................................................................... 73
4.3.2.3 GetStatusOfCuAndDbConnection ............................................................................................. 73
4.3.2.4 SetInitializationState .................................................................................................................. 74
4.3.2.5 GetAllUnitsState ........................................................................................................................ 74
4.3.2.6 SetDefaultVolumeForRoom ....................................................................................................... 75
4.3.2.7 GetDefaultMicrophoneModeForRoom....................................................................................... 75
4.3.2.8 SetDefaultMicrophoneModeForRoom ....................................................................................... 76
4.3.2.9 SetVolumeForRoom .................................................................................................................. 77
4.3.2.10 AddSynoptic ........................................................................................................................... 77
4.3.2.11 GetSynoptic ........................................................................................................................... 78
4.3.2.12 GetAllSeats ............................................................................................................................ 78
4.3.2.13 GetBooths .............................................................................................................................. 79
4.3.2.14 EditSeat ................................................................................................................................. 79
4.3.2.15 GetAllUnits ............................................................................................................................. 80
4.3.2.16 SetOperatingMode................................................................................................................. 80
4.3.2.17 GetOperatingMode ................................................................................................................ 81
4.3.2.18 ClearAllMeetingAndDelegateData ......................................................................................... 81
4.3.2.19 SetSeatPriority ....................................................................................................................... 82
4.3.3 Microphone ........................................................................................................................................ 83
4.3.3.1 SetState ..................................................................................................................................... 83
4.3.3.2 SetMicrophoneMode.................................................................................................................. 83
4.3.3.3 SetActivationType ...................................................................................................................... 84
4.3.3.4 SetMicrophoneSensitivity .......................................................................................................... 84
4.3.3.5 Get ............................................................................................................................................. 86
4.3.3.6 GetState ..................................................................................................................................... 86
4.3.3.7 ClearMicrophoneList .................................................................................................................. 86
4.3.3.8 GetMicrophoneMode ................................................................................................................. 87
4.3.3.9 GetActivationType ..................................................................................................................... 87
4.3.3.10 ActivateNextMicrophone ........................................................................................................ 87
4.3.4 Meeting_Agenda................................................................................................................................ 88
4.3.4.1 SetMeetingState ........................................................................................................................ 88
4.3.4.2 StartEmptyMeeting .................................................................................................................... 88

CoCon API 24 Dec 2021 9/184

 4.3.4.3 GetMeetingsForToday ............................................................................................................... 89
4.3.4.4 GetAllMeetingsForDate ............................................................................................................. 89
4.3.4.5 GetMeetingById ......................................................................................................................... 89
4.3.4.6 SetActiveAgendaItemByDirection .............................................................................................. 90
4.3.4.7 SetActiveAgendaItemById ......................................................................................................... 90
4.3.4.8 GetAgendaItemInformationInRunningMeeting .......................................................................... 91
4.3.4.9 GetAgendaItemInformationInMeetingById ................................................................................ 91
4.3.4.10 GetAgendaItemById .............................................................................................................. 92
4.3.4.11 StartMeetingViaMeetingTemplate ......................................................................................... 92
4.3.4.12 StartMeetingViaXMLimport .................................................................................................... 93
4.3.4.13 AddAgendaItem ..................................................................................................................... 94
4.3.4.14 GetLoginMethodForMeeting .................................................................................................. 94
4.3.4.15 RemoveAgendaItemById ....................................................................................................... 95
4.3.4.16 DeleteAllAgendaItems ........................................................................................................... 95
4.3.4.17 MoveAgendaItem ................................................................................................................... 96
4.3.4.18 EditAgendaItem ..................................................................................................................... 96
4.3.4.19 AddDelegateToMeeting ......................................................................................................... 97
4.3.4.20 AddDelegatesToMeeting ....................................................................................................... 97
4.3.4.21 RemoveDelegateFromMeeting .............................................................................................. 98
4.3.4.22 GetDelegateSeating .............................................................................................................. 98
4.3.4.23 AddDelegateToSeat .............................................................................................................. 99
4.3.4.24 AddDelegatesToSeats ........................................................................................................... 99
4.3.4.25 RemoveDelegateFromSeat ................................................................................................. 100
4.3.4.26 RemoveDelegatesFromSeat ............................................................................................... 100
4.3.4.27 RemoveAllDelegatesFromSeat ........................................................................................... 101
4.3.4.28 ApplyDelegatesToSystem ................................................................................................... 101
4.3.4.29 EndActiveMeeting ................................................................................................................ 101
4.3.4.30 ResendMeetingData ............................................................................................................ 102
4.3.4.31 GetVotingAgendaTemplateList ............................................................................................ 102
4.3.4.32 GetAgendaDetailById .......................................................................................................... 102
4.3.4.33 GetAllMeetings .................................................................................................................... 103
4.3.4.34 EditMeetingTitle ................................................................................................................... 104
4.3.5 Voting ............................................................................................................................................... 105
4.3.5.1 SetVotingState ......................................................................................................................... 105
4.3.5.2 AddInstantVote ........................................................................................................................ 106
4.3.5.3 AddVotingTemplate ................................................................................................................. 106
4.3.5.4 GetVotingState ........................................................................................................................ 114
4.3.5.5 GetAmountOfVotes.................................................................................................................. 115
4.3.5.6 GetGeneralVotingResults ........................................................................................................ 115
4.3.5.7 GetIndividualVotingResults ..................................................................................................... 115
4.3.5.8 DeleteVotingTemplate ............................................................................................................. 116
4.3.6 Timer ................................................................................................................................................ 116
4.3.6.1 Get ........................................................................................................................................... 116

CoCon API 24 Dec 2021 10/184

 4.3.6.2 GetDelegateTimers.................................................................................................................. 116
4.3.6.3 GetSeatTimers ......................................................................................................................... 117
4.3.6.4 GetGroupTimers ...................................................................................................................... 117
4.3.6.5 GetActiveTimers ...................................................................................................................... 117
4.3.6.6 SetDelegateTimer .................................................................................................................... 118
4.3.6.7 SetGroupTimer ........................................................................................................................ 118
4.3.6.8 SetGlobalDelegateTimer ......................................................................................................... 119
4.3.6.9 SetGlobalSeatTimer ................................................................................................................ 120
4.3.6.10 SetGlobalGroupTimer .......................................................................................................... 121
4.3.6.11 ResetDelegateTimer ............................................................................................................ 121
4.3.6.12 ResetGlobalDelegateTimer ................................................................................................. 122
4.3.6.13 ResetGroupTimer ................................................................................................................ 122
4.3.6.14 ResetGlobalGroupTimer ...................................................................................................... 123
4.3.6.15 ChangeDelegateTimer......................................................................................................... 124
4.3.6.16 ChangeGroupTimer ............................................................................................................. 124
4.3.6.17 ChangeDelegateTimerState ................................................................................................ 125
4.3.6.18 ChangeGroupTimerState..................................................................................................... 125
4.3.7 Delegate .......................................................................................................................................... 126
4.3.7.1 GetDelegatesInMeeting ........................................................................................................... 126
4.3.7.2 GetDelegatesInCurrentMeeting ............................................................................................... 127
4.3.7.3 ClearAllDelegatesAndGroups .................................................................................................. 127
4.3.7.4 GetAllDelegates ....................................................................................................................... 128
4.3.7.5 AddDelegate ............................................................................................................................ 128
4.3.7.6 RemoveDelegate ..................................................................................................................... 130
4.3.7.7 EditDelegate ............................................................................................................................ 130
4.3.7.8 ImportDelegatesFromFile ........................................................................................................ 131
4.3.7.9 GetAuthorityOverview .............................................................................................................. 132
4.3.8 Interactive ........................................................................................................................................ 133
4.3.8.1 SetDelegateScreen.................................................................................................................. 133
4.3.8.2 RemoveScreenLock ................................................................................................................ 137
4.3.8.3 SetCustomButtonOnSeat ........................................................................................................ 137
4.3.8.4 SetCustomButtonOnRoom ...................................................................................................... 137
4.3.8.5 SetCustomLabelOnSeat .......................................................................................................... 138
4.3.8.6 SetCustomLabelOnRoom ........................................................................................................ 138
4.3.8.7 SetCustomScreenOnSeat ....................................................................................................... 138
4.3.8.8 SetCustomScreenOnRoom ..................................................................................................... 139
4.3.8.9 GetServiceList ......................................................................................................................... 140
4.3.8.10 GetServiceListbyMeetingId .................................................................................................. 140
4.3.8.11 SetServiceRequestState...................................................................................................... 140
4.3.8.12 GetServiceRequestStates ................................................................................................... 140
4.3.8.13 DisableDelegateScreen ....................................................................................................... 141
4.3.8.14 ResetScreen ........................................................................................................................ 141
4.3.9 Audio ................................................................................................................................................ 143

CoCon API 24 Dec 2021 11/184

 4.3.9.1 GetCurrentAudioSoftwareConfiguration .................................................................................. 143
4.3.9.2 GetCurrentAudioSoftwareConfigurationInDetails .................................................................... 143
4.3.9.3 GetAudioSoftwareConfigurations ............................................................................................ 149
4.3.9.4 GetAudioGroupsInCurrentConfiguration ................................................................................. 149
4.3.9.5 SetAudioSoftwareConfigurationById ....................................................................................... 150
4.3.9.6 SetAudioSoftwareConfigurationByName................................................................................. 150
4.3.9.7 ChangeMatrixNodeStatus ....................................................................................................... 151
4.3.9.8 GetMatrixNodeStatus .............................................................................................................. 151
4.3.9.9 SaveAudioSoftwareConfiguration ............................................................................................ 152
4.3.10 Logging ........................................................................................................................................ 153
4.3.10.1 GetCUState ......................................................................................................................... 153
4.3.10.2 GetUnitErrorState ................................................................................................................ 153
4.3.11 ButtonLED_Event ........................................................................................................................ 153
4.3.11.1 SetButtonsEnabled .............................................................................................................. 153
4.3.11.2 SetLED................................................................................................................................. 154
4.3.11.3 SetNextButtonEnabled ........................................................................................................ 155
4.3.11.4 SetPriorButtonEnabled ........................................................................................................ 155
4.3.11.5 SetNextButtonLedStatus ..................................................................................................... 156
4.3.11.6 SetPriorButtonLedStatus ..................................................................................................... 156
4.3.12 External ........................................................................................................................................ 157
4.3.12.1 Send message to Operator ................................................................................................. 157
4.3.12.2 NotifyExternalCall ................................................................................................................ 157
4.3.13 Interpretation ................................................................................................................................ 158
4.3.13.1 GetAllBoothsInRoom ........................................................................................................... 158
4.3.13.2 AddLanguage ...................................................................................................................... 158
4.3.13.3 RemoveLanguage ............................................................................................................... 158
4.3.13.4 ClearLanguages .................................................................................................................. 159
4.3.13.5 AddInterpreterPreset ........................................................................................................... 159
4.3.13.6 DeleteInterpreterPreset ....................................................................................................... 160
4.3.13.7 ApplyInterpreterPreset ......................................................................................................... 161
4.3.13.8 GetActiveInterpreterPreset .................................................................................................. 161
4.3.13.9 GetAllInterpreterPresets ...................................................................................................... 162
4.3.13.10 GetAllLanguages ................................................................................................................. 162
4.3.13.11 GetAllChannels .................................................................................................................... 162
4.3.13.12 AddChannel ......................................................................................................................... 163
4.3.13.13 AddChannels ....................................................................................................................... 164
4.3.13.14 EditChannel ......................................................................................................................... 165
4.3.13.15 DeleteChannel ..................................................................................................................... 166
4.3.13.16 RemoveAllChannels ............................................................................................................ 166
4.3.13.17 SetDisplayText ..................................................................................................................... 167
4.3.13.18 SaveInterpreterPresetAs ..................................................................................................... 167
4.3.13.19 GetAllChannelRealtimeData ................................................................................................ 168
4.3.13.20 GetSpeakSlowerRequestList ............................................................................................... 169

CoCon API 24 Dec 2021 12/184

 4.3.13.21 GetInterpreterPresetById ..................................................................................................... 169
4.3.13.22 AssignDeskToBooth ............................................................................................................ 170
4.3.13.23 UnassignDesk ...................................................................................................................... 170
4.3.13.24 UpdateBooth ........................................................................................................................ 171
4.3.14 API calls for Configurations ......................................................................................................... 171
4.3.14.1 GetCuIpAddress .................................................................................................................. 171
4.3.14.2 SetCuIpAddress ................................................................................................................... 172
4.3.14.3 RestartRoomServer ............................................................................................................. 172
4.3.14.4 GetCoconServerVersion ...................................................................................................... 172
4.3.15 Recording ( AE-R & Plixus Core only) ......................................................................................... 173
4.3.15.1 Getrecordingfilesinfo ............................................................................................................ 173
4.3.15.2 Startrecording ...................................................................................................................... 173
4.3.15.3 Stoprecording ...................................................................................................................... 174
4.3.15.4 Getrecordingstate ................................................................................................................ 174
4.3.16 Wireless coupling ......................................................................................................................... 175
4.3.16.1 Getwcapinfo ......................................................................................................................... 175
4.3.16.2 Getallwcapinfo ..................................................................................................................... 175
4.3.16.3 SetWcapCoupledMode ........................................................................................................ 175
4.3.17 Operator Customization ............................................................................................................... 176
4.3.17.1 GetCustomButtons .............................................................................................................. 176
4.3.17.2 GetCustomLabels ................................................................................................................ 176
4.3.17.3 SetCustomButton ................................................................................................................. 176
4.3.17.4 SetCustomLabel .................................................................................................................. 177
4.3.17.5 SetCustomButtonState ........................................................................................................ 178
4.3.17.6 SetNumberOfCustomButtons .............................................................................................. 178
4.3.17.7 SetNumberOfCustomLabels ................................................................................................ 179
5 Future commands ........................................................................................................................................ 180
5.1 Server to client ..................................................................................................................................... 180
5.2 Client to server..................................................................................................................................... 180
6 Best practice for use of API .......................................................................................................................... 181
6.1 Setting up and operating the CoCon API connection .......................................................................... 181
6.1.1 General ............................................................................................................................................ 181
6.1.2 Wireshark log screenshot of API connection ................................................................................... 181
6.2 Advised way of working ....................................................................................................................... 183
6.3 To be avoided ...................................................................................................................................... 184

CoCon API 24 Dec 2021 13/184

 List of figures

No table of figures entries found.

List of tables

No table of figures entries found.

Terminology

Name Meaning

References

ID Reference Version Name and meaning

CoCon API 24 Dec 2021 14/184

1 Introduction & Scope
1.1 Introduction
This document contains the description of the API (Application Programmers’ Interface) of the CoCon Room
Server. Through this API, CoCon offers two functionalities:
• Publication of events that are happening in the conference room and software;
• External control of the conference room and software.

1.2 Scope
1.2.1 In scope
The current version of the document targets one technology that is used for the API. This is REST
(Representational State Transfer) with JSON format.
The general working of this system is described and the commands are defined and shown with examples.

1.2.2 Out of scope

• Other technologies than REST/JSON.
• Other external points of access to the CoCon software and Televic Conference products in general.

1.3 API module compatibility

This table shows which API modules are available in the different systems.

API Module Cocon for Plixus Core

Plixus Core

Server to Client
4.2.1 Room
4.2.1.1 InitializationState  ☐
4.2.1.2 UnitStateChanged  ☐
4.2.1.3 VolumeChangedForRoom  
4.2.1.4 UnitError  

4.2.2 Microphone
4.2.2.1 MicrophoneState  
4.2.2.2 MicrophoneMode  
4.2.2.3 MicButtonEvent  
4.2.2.4 MicrophoneSensitivityUpdated  ☐
4.2.2.5 MicStateChangedInRunningMeeting  ☐

4.2.3 Meeting_Agenda
4.2.3.1 MeetingTitleChanged  ☐

CoCon API 24 Dec 2021 15/184

API Module Cocon for Plixus Core
Plixus Core

4.2.3.2 MeetingStatus  ☐
4.2.3.3 MeetingAgendaChanged  ☐
4.2.3.4 Agenda_ItemChanged  ☐
4.2.3.5 keypad_login_code  ☐
4.2.3.6 FingerprintEvent  ☐

4.2.4 Voting
4.2.4.1 VotingState  ☐
4.2.4.2 VotingOutcome  ☐
4.2.4.3 GeneralVotingResults  ☐
4.2.4.4 IndividualVotingResults  ☐
4.2.4.5 VotingTemplateAdded  ☐

4.2.5 Timer
4.2.5.1 MeetingTimerEvent  ☐
4.2.5.2 MeetingTimerStateChange  ☐
4.2.5.3 DelegateTimerEvent  ☐
4.2.5.4 DelegateTimerStateChange  ☐
4.2.5.5 GroupTimerEvent  ☐
4.2.5.6 GroupTimerStateChange  ☐
4.2.5.7 SeatTimerEvent  ☐
4.2.5.8 SeatTimerPauseResumed  ☐
4.2.5.9 ActiveAgendaItemTimerEvent  ☐
4.2.5.10 ActiveAgendaItemTimerPauseResumed  ☐
4.2.5.11 VotingTimerEvent  ☐
4.2.5.12 VotingTimerPauseResumed  ☐

4.2.6 Delegate
4.2.6.1 BadgeEvent  ☐
4.2.6.2 DelegateOnSeat  ☐
4.2.6.3 DelegateSeatingUpdated  ☐
4.2.6.4 MeetingStartsUserInformation  ☐
4.2.6.5 DelegateUpdated  ☐
4.2.6.6 DelegateAdded  ☐

CoCon API 24 Dec 2021 16/184

API Module Cocon for Plixus Core
Plixus Core

4.2.6.7 DelegateRemoved  ☐
4.2.6.8 DelegateSeatingUpdated  ☐
4.2.6.9 DelegatesInMeetingUpdated  ☐

4.2.7 Interactive
4.2.7.1 ScreenLockRemoved  ☐
4.2.7.2 DelegateScreenSet  ☐
4.2.7.3 CustomButtonEvent  ☐
4.2.7.4 ServiceRequestEvent  ☐

4.2.8 Audio
4.2.8.1 SetAudioSoftwareConfigurationById  
4.2.8.2 CurrentAudioSoftwareConfigurationUpdated  

4.2.9 Logging
4.2.9.1 ConnectionLost_CentralUnit  ☐
4.2.9.2 ConnectionLost_Database  ☐

4.2.10 ButtonLED_Event
4.2.10.1 ButtonPressed  
4.2.10.2 NextButtonPressed  
4.2.10.3 PriorButtonPressed  

4.2.11 Interpretation
4.2.11.1 IMicrophoneStateUpdated  
4.2.11.2 IActivatedChannelUpdated  
4.2.11.3 SpeakSlowerRequest  
4.2.11.4 SpeakSlowerEnded  
4.2.11.5 ActivePresetStateChanged  

4.2.12 Rocording ( AE-R & Plixus Core only)

4.2.12.1 WcapInfoUpdated  

4.2.13 Wireless Coupling

CoCon API 24 Dec 2021 17/184

API Module Cocon for Plixus Core
Plixus Core

4.2.13.1 WcapInfoUpdated  
4.2.13.2 WcapCoupledUpdated  
4.2.13.3 AllWcapInfoUpdated  

Client to server
4.3.1 General
4.3.1.1 Connect  
4.3.1.2 Subscribe  
4.3.1.3 Unsubcribe  
4.3.1.4 Notification  
4.3.1.5 ReboothSystem  ☐

4.3.2 Room
4.3.2.1 GetRoomServerName  ☐
4.3.2.2 GetActiveRoomInfo  
4.3.2.3 GetStatusOfCuAndDbConnection  ☐
4.3.2.4 SetInitializationState  
4.3.2.5 GetAllUnitsState  
4.3.2.6 SetDefaultVolumeForRoom  
4.3.2.7 GetDefaultMicrophoneModeForRoom  
4.3.2.8 SetDefaultMicrophoneModeForRoom  
4.3.2.9 SetVolumeForRoom  
4.3.2.10 AddSynoptic  ☐
4.3.2.11 GetSynoptic  ☐
4.3.2.12 GetAllSeats  
4.3.2.13 GetBooths  
4.3.2.14 EditSeat  
4.3.2.15 GetAllUnits  
4.3.2.16 SetOperatingMode  
4.3.2.17 GetOperatingMode  
4.3.2.18 ClearAllMeetingAndDelegateData  ☐
4.3.2.19 SetSeatPriority  ☐

4.3.3 Microphone
4.3.3.1 SetState  

CoCon API 24 Dec 2021 18/184

API Module Cocon for Plixus Core
Plixus Core

4.3.3.2 SetMicrophoneMode  
4.3.3.3 SetActivationType  
4.3.3.4 SetMicrophoneSensitivity  
4.3.3.5 Get  
4.3.3.6 GetState  
4.3.3.7 ClearMicrophoneList  
4.3.3.8 GetMicrophoneMode  
4.3.3.9 ActivateNextMicrophone  

4.3.4 Meeting_Agenda
4.3.4.1 SetMeetingState  ☐
4.3.4.2 StartEmptyMeeting  ☐
4.3.4.3 GetMeetingsForToday  ☐
4.3.4.4 GetAllMeetingsForDate  ☐
4.3.4.5 GetMeetingById  ☐
4.3.4.6 SetActiveAgendaItemByDirection  ☐
4.3.4.7 SetActiveAgendaItemById  ☐
4.3.4.8 GetAgendaItemInformationInRunningMeeting  ☐
4.3.4.9 GetAgendaItemInformationInMeetingById  ☐
4.3.4.10 GetAgendaItemById  ☐
4.3.4.11 StartMeetingViaMeetingTemplate  ☐
4.3.4.12 StartMeetingViaXMLimport  ☐
4.3.4.13 AddAgendaItem  ☐
4.3.4.14 GetLoginMethodForMeeting  ☐
4.3.4.15 RemoveAgendaItemById  ☐
4.3.4.16 DeleteAllAgendaItems  ☐
4.3.4.17 MoveAgendaItem  ☐
4.3.4.18 EditAgendaItem  ☐
4.3.4.19 AddDelegateToMeeting  ☐
4.3.4.20 AddDelegatesToMeeting  ☐
4.3.4.21 RemoveDelegateFromMeeting  ☐
4.3.4.22 GetDelegateSeating  ☐
4.3.4.23 AddDelegateToSeat  ☐
4.3.4.24 AddDelegatesToSeats  ☐

CoCon API 24 Dec 2021 19/184

API Module Cocon for Plixus Core
Plixus Core

4.3.4.25 RemoveDelegateFromSeat  ☐
4.3.4.26 RemoveDelegatesFromSeat  ☐
4.3.4.27 RemoveAllDelegatesFromSeat  ☐
4.3.4.28 ApplyDelegatesToSystem  ☐
4.3.4.28 EndActiveMeeting  ☐
4.3.4.30 ResendMeetingData  ☐
4.3.4.31 GetVotingAgendaTemplateList  ☐
4.3.4.32 GetAgendaDetailById  ☐
4.3.4.33 GetAllMeetings  ☐
6.3.4.34 EditMeetingTitle  ☐

4.3.5 Voting
4.3.5.1 SetVotingState  ☐
4.3.5.2 AddInstantVote  ☐
4.3.5.3 AddVotingTemplate  ☐
4.3.5.4 GetVotingState  ☐
4.3.5.5 GetAmountOfVotes  ☐
4.3.5.6 GetGeneralVotingResults  ☐
4.3.5.7 GetGeneralVotingResults  ☐

4.3.6 Timer
4.3.6.1 Get  ☐
4.3.6.2 GetDelegateTimers  ☐
4.3.6.3 GetSeatTimers  ☐
4.3.6.4 GetGroupTimers  ☐
4.3.6.5 GetActiveTimers  ☐
4.3.6.6 SetDelegateTimer  ☐
4.3.6.7 SetGroupTimer  ☐
4.3.6.8 SetGlobalDelegateTimer  ☐
4.3.6.9 SetGlobalSeatTimer  ☐
4.3.6.10 SetGlobalGroupTimer  ☐
4.3.6.11 ResetDelegateTimer  ☐
4.3.6.12 ResetGlobalDelegateTimer  ☐
4.3.6.13 ResetGroupTimer  ☐
4.3.6.14 ResetGlobalGroupTimer  ☐

CoCon API 24 Dec 2021 20/184

API Module Cocon for Plixus Core
Plixus Core

4.3.6.15 ChangeDelegateTimer  ☐
4.3.6.16 ChangeGroupTimer  ☐
4.3.6.17 ChangeDelegateTimerState  ☐
4.3.6.18 ChangeGroupTimerState  ☐
4.3.7 Delegate
4.3.7.1 GetDelegatesInMeeting  ☐
4.3.7.2 GetDelegatesInCurrentMeeting  ☐
4.3.7.3 ClearAllDelegatesAndGroups  ☐
4.3.7.4 GetAllDelegates  ☐
4.3.7.5 AddDelegate  ☐
4.3.7.6 RemoveDelegate  ☐
4.3.7.7 EditDelegate  ☐
4.3.7.8 ImportDelegatesFromFile  ☐

4.3.8 Interactive
4.3.8.1 SetDelegateScreen  ☐
4.3.8.2 RemoveScreenLock  ☐
4.3.8.3 SetCustomButtonOnSeat  ☐
4.3.8.4 SetCustomButtonOnRoom  ☐
4.3.8.5 SetCustomLabelOnSeat  ☐
4.3.8.6 SetCustomLabelOnRoom  ☐
4.3.8.7 SetCustomScreenOnSeat  ☐
4.3.8.8 SetCustomScreenOnRoom  ☐
4.3.8.9 GetServiceList  ☐
4.3.8.10 GetServiceListbyMeetingId  ☐
4.3.8.11 SetServiceRequestState  ☐
4.3.8.12 GetServiceRequestStates  ☐
4.3.8.13 DisableDelegateScreen  ☐

4.3.9 Audio
4.3.9.1 GetCurrentAudioSoftwareConfiguration  ☐
4.3.9.2 GetCurrentAudioSoftwareConfigurationInDetails  ☐
4.3.9.3 GetAudioSoftwareConfigurations  ☐
4.3.9.4 GetAudioGroupsInCurrentConfiguration  ☐

CoCon API 24 Dec 2021 21/184

API Module Cocon for Plixus Core
Plixus Core

4.3.9.5 SetAudioSoftwareConfigurationById  
4.3.9.6 SetAudioSoftwareConfigurationByName  ☐
4.3.9.7 ChangeMatrixNodeStatus  
4.3.9.8 GetMatrixNodeStatus  
4.3.9.9 SaveAudioSoftwareConfiguration  

4.3.10 Logging
4.3.10.1 GetCUState  ☐
4.3.10.2 GetUnitErrorState  ☐

4.3.11 ButtonLED_Event
4.3.11.1 SetButtonsEnabled  
4.3.11.2 SetLED  
4.3.11.3 SetNextButtonEnabled  
4.3.11.4 SetPriorButtonEnabled  
4.3.11.5 SetNextButtonLedStatus  
4.3.11.6 SetPriorButtonLedStatus  

4.3.12 External
4.3.12.1 Send message to Operator  ☐
4.3.12.2 NotifyExternalCall  ☐

4.3.13 Interpretation
4.3.13.1 GetAllBoothsInRoom  
4.3.13.2 AddLanguage  
4.3.13.3 RemoveLanguage  
4.3.13.4 ClearLanguages  
4.3.13.5 AddInterpreterPreset  
4.3.13.6 DeleteInterpreterPreset  
4.3.13.7 ApplyInterpreterPreset  
4.3.13.8 GetActiveInterpreterPreset  
4.3.13.9 GetAllInterpreterPresets  
4.3.13.10 GetAllLanguages  
4.3.13.11 GetAllChannels  
4.3.13.12 AddChannel  

CoCon API 24 Dec 2021 22/184

API Module Cocon for Plixus Core
Plixus Core

4.3.13.12 AddChannels  
4.3.13.13 EditChannel  
4.3.13.14 DeleteChannel  
4.3.13.15 RemoveAllChannels  
4.3.13.16 SetDisplayText  
4.3.13.17 SaveInterpreterPresetAs  
4.3.13.18 GetAllChannelRealtimeData  
4.3.13.19 GetSpeakSlowerRequestList  
4.3.13.20 GetInterpreterPresetById  
4.3.13.21 AssignDeskToBooth  
4.3.13.22 UnassignDesk  
4.3.13.23 UpdateBooth  

4.3.14 API calls for Configurations

4.3.14.1 GetCuIpAddress  ☐
4.3.14.2 SetCuIpAddress  ☐
4.3.14.3 RestartRoomServer  ☐
4.3.14.4 GetCoconServerVersion  ☐

4.3.15 Recording ( AE-R & Plixus Core only)

4.3.15.1 GetRecordingFilesInfo ☐ 
4.3.15.2 Startrecording ☐ 
4.3.15.3 Stoprecording ☐ 
4.3.15.4 Getrecordingstate ☐ 

4.3.16 Wireless coupling

4.3.16.1 Getwcapinfo  
4.3.16.2 Getallwcapinfo  
4.3.16.3 SetWcapCoupledMode  

CoCon API 24 Dec 2021 23/184

2 How to activate the API
2.1 Plixus Core
Plixus Core REST API can be enabled/disabled via the Plixus Engine webserver > Menu > Network

In that case API connection needs to be made directly to the Plixus Engine ip address – port 8990 and REST
API needs to be enabled on the Plixus webserver

2.2 Cocon for Plixus Core

In that case API connection needs to be made to the Cocon server ip address – port 8990 , API needs to be
enabled in the Cocon server configuration wizard

CoCon API 24 Dec 2021 24/184

3 General communication structure
3.1 Communication format
3.1.1 REST/JSON
The technology being used for the CoCon API is REST (Representational State Transfer) with the JSON
(JavaScript Object Notation) used. More information can be found at:
http://en.wikipedia.org/wiki/Representational_state_transfer
http://en.wikipedia.org/wiki/Json

3.1.2 Long polling

Since REST is a framework that does not natively allow to send messages from the server-side to the client-
side, the CoCon API uses long polling to make sure that these messages can be sent. This means that a
connection between client and server is kept open for a longer period of time. Over this connection, the server
can then send information when and if it is available. See also the figure below:

3.2 Communication methods

Different Plixus setups are available. Depending on the Plixus system you have installed different use cases of
the API are possible:
• CoCon for Plixus Core: this is the CoCon software specifically designed to work with Plixus Core. Also
in this case the API will connect to the room server.

• Plixus Core: in this system part of the conference logic resides in the engine (such as initialization and
audio settings). Configuration of these features goes through a web server (which navigates to the IP
address of the engine). In this case the API connects to the Plixus engine.

CoCon API 24 Dec 2021 25/184

Note:
• The Plixus Core API is a subset of the Cocon Core API. Only a limited set of modules is possible with
the Plixus Core API. At the beginning of this document you can find an exhaustive list of all API
modules together with the system that supports it.

3.3 Publish/Subscribe
The CoCon API uses a Publish/Subscribe mechanism. This means that external clients who connect to the API
can choose of which events they are being informed.
As can be seen below, there are commands contained in the API to subscribe or unsubscribe from each of the
“Models”. Each model contains a certain set of functionality in relation to the conference room and software. The
currently available models are:

• Room: This module publish all necessary events for Room Initialization, Volume change, unit state.
• Microphone: this includes all events relating to microphone state change (on, off, in request) and
changes of the microphone mode.
• Meeting_Agenda: this model contains all events with relation to the meeting (start, stop, pause, title
change) and the agenda control in the meeting (next, previous, …)
• Voting: this model will publish all information with regard to voting. This can be voting start, stop,
pause, resume as well as individual and global voting results (if and when available).
• Timer: this model will publish all information about timers
• Delegate: this model contains all information about delegates in the meeting: detailed information,
badge events,
• Interactive: this model allows controlling interactive meeting sessions. This is only applicable for the
Televic uniCOS (PlixUs) CU and system.
• Audio : N/A
• Logging: This model will publish all status of connection between CoCon server and Database, Broken
unit status and CU status.
• ButtonLED_Event: this model allows to listen to button events on the delegate units and set LEDs
accordingly.
Some remarks specifically for this model:
o The order to use the commands is typically the following:
▪ “SetButtonsEnabled” to enable one or more buttons (section 4.3.11.1).
▪ Listen to the events “ButtonPressed”, which mean that a button was pressed on a unit
(section 4.2.10.1).
▪ Control the LEDs on the unit using the command “SetLED” (section 0).
o Note that CoCon does not guarantee that button events will always be sent out or set
LEDs always responded upon. This is because in certain phases of operation (most
notably voting sessions), the buttons and LEDs are used by CoCon for voting
functionality.

CoCon API 24 Dec 2021 26/184

 o When a voting session is active, the buttons and LEDs are controlled by CoCon, and cannot be
controlled externally by the API. This means that the ButtonLED_Event commands and events
can only be used or listened to if the VotingState is equal to “Clear”. See section Fout!
Verwijzingsbron niet gevonden. For the notification of this state to the API client.
o When the voting session is ended, the buttons that were enabled before the voting session, by
the ButtonLED_Event commands, are again enabled. However, the LED state is not restored.
Keeping track of LED-state and re-setting this state is the responsibility of the API client.
o The functionality of this model depends heavily on the type of CU (Central Unit) and/or DU
(Delegate Unit) to which CoCon is connected.
• External: This module send event for special button pressed by chairmen units.
• Interpretation: This module sent all the necessary events related to Interpretation.
• Intercom: This module send the events related to Intercom communication.

Note the following:

• Upon connection, clients are by default subscribed to almost ALL models. If some information is not
useful for the client in question, he can send commands to unsubscribe from certain of these models
(see below for the Unsubscribe command).
• Default events for module “ButtonLED_Event” will NOT be received, since these events are
‘blacklisted’. One will need to explicit subscribe to the “ButtonLED_Event” module.
• Clients can send commands to the CoCon API, independently from the models to which they are
described. This means for example: a client who is NOT subscribed to the Microphone model CAN
send a command to turn on a microphone, but will NOT be notified that the microphone has been
turned.
This means that the API client needs to judiciously select the models to which it will subscribe and
unsubscribe.
• Notification api call time-out :
o Response type 408 (intended to indicate time-outs)
o Time-out time of 30sec
o Response message : “Notification request timeout”
• Invalid notification (invalid id or id which has expired) :
o Response type 400 (bad request) for expired or invalid id
o Make clinet id expired if ther is no request of get notification in 180sec.
o Response message
▪ in case of expired session: "{"Notification" : "Error 400"}"
▪ in case of invalid id: "{"Notification" : "Error 400"}"

3.4 Setting up and operating the CoCon API connection

3.4.1 General
The CoCon API connection consists of a number of URI’s (Uniform Resource Identifier) which are exchanged
between the API client and the CoCon Server over a TCP/IP-connection.

In this document, it is assumed that the API Client and the CoCon Room Server are running on the same
computer. This means that the URI’s are using “localhost” as the target machine of the API-calls. Of course, if
the CoCon Room Server is running on another machine and you are connecting to this machine, then you have
to exchange “localhost” to the IP address or host name of the target machine.

Basically, the CoCon API uses two (or more) parallel HTTP-connections. These are the following:

• A “notification” connection that the client and Server keep open in case any information need to be
transferred from the Server to the client.
• Any other connection that is used to transfer information from the client to the Server.

CoCon API 24 Dec 2021 27/184

The notification connection should be initialized by the client, and is kept open by both sides. Then one of two
things can happen:
• The Server has information to send to the client and uses the notification connection for this. The
information is transferred and the connection is closed (as per the HTTP standard). After this, the client
needs to create a new notification connection. The Server will guarantee that no information is lost
during this short period where the client has no connection to the Server.
Note that the new notification connection needs to be created within 60 seconds. If this does not
happen, the Server will discard the client data.
• The HTTP-connection times out before the Server has any information to send to the client. At this
point, the client needs to create a new notification connection. Again, the Server will guarantee that
no information is lost.

3.4.2 REST/JSON Example

This section contains an example of the creation and operation of the API connection to the CoCon Server
using the REST/JSON format.

The first URI that has to be sent to the CoCon API is the Connect URI:

http://localhost:8890/CoCon/Connect

As a reply, the following JSON string will be sent back:

“{“Connect”:true,”id”:”3f5b8afe-6efb-4428-8762-e39d42a0762d”}”

The first parameter indicates that the connection has succeeded; the second parameter is the Id of this
connection that has to be used when opening the notification connection. In order to open this notification
connection, the following URI has to be sent to the Server:

http://localhost:8890/CoCon/Notification/id=3f5b8afe-6efb-4428-8762-e39d42a0762d

Now the notification connection is open and the Server can send updates to the client. This can for example be
the following:

{“MicrophoneMode”： {“Mode” :”:”Operator” ; “MaxNrActive” : <MaxActiveMicNumber> }}

This is an update of the Microphone Mode that is currently being used in the conference software and room. As
discussed above, the CoCon Server will send all applicable updates to the API clients that are subscribed to the
model that the event falls under. By default, clients are subscribed to all models. Unsubscribing can be done by
sending the following URI over the API:

http://localhost:8890/CoCon/Unsubscribe/?Model=Logging&id=3f5b8afe-6efb-4428-8762-
e39d42a0762d

This URI unsubscribes the current client from the Logging model. From this point onwards, no more events from
the specified model will be sent to this API client.

When a microphone is activated, the following information will be sent over the notification connection:

{“MicrophoneState”:{“Speakers”:[1,5];”Requests”:[7]}}

…which indicates that the microphones on seats 1 and 5 are on, and that the microphone on seat 7 is in
request. After receiving this information, the client must re-open the notification connection.

CoCon API 24 Dec 2021 28/184

The other way around, if the API client wants to activate a microphone, the following URI must be sent to the
CoCon Server:

http://localhost:8890/CoCon/Microphone/SetState/?State=On&SeatNr=9
…to turn on the microphone on seat 9.

3.4.3 Server return values

Over-all feedback from the CoCon during the 3rd party API communication.

Command request based on integer data type:

>> 0: Command received successfully to CoCon server and handle.
>> 1: Command sends from 3rd party with in-correct parameter value / parameter list.
>> -1: Command received correctly on CoCon server but exception happen due to the abnormal value
send by user.

Command request based on the string data type:

Server returns data when command successful handled.
Server returns hint information for the unhandled command.

CoCon API 24 Dec 2021 29/184

4 Operational commands
This chapter contains the description of all commands making up the API. Note that the format has been kept
general.

4.1 Data models

These models will be used to exchange information from and to the CoCon API.

4.1.1.1 AuthorityAssigned
This represents authority present voted, and register in the voting
Properties:
Name Description Type
The number of authorities that present in the
Present int
voting
The number of authorities that voted in the
Voted int
voting
The number of authorities that Register in the
Register int
voting

4.1.1.2 Meeting
Data model that represents meeting object
Properties:
Name Description Type

Id The id of the meeting int

Title The title of the meeting string

Description The description of the meeting string

StartTime The start time of the meeting string

The state of the meeting
Paused;
State string
Running;
Ended

4.1.1.3 VotingCountWeight
Data model that represents the voting count and weight pair

Name Description Type

Count The count of the voting int

Weight The weight of the voting double

4.1.1.4 VotingOption
Data model that represents the voting option

Name Description Type

Id The id of the voting option int

CoCon API 24 Dec 2021 30/184

 Name The name of the option string

Color The color of the voting option string

4.1.1.5 VotingOptionVoteDetail
Data model that represents the votingCountWeight of the voting option

Name Description Type

Option The related voting option VotingOption

OptionVoted The voted count and weight of the option VotingCountWeight

4.1.1.6 VotingResultSummary
Data model that represents the summary result of the voting

Name Description Type

Total The total voting count and weight VotingCountWeight

Voted The voted voting count and weight VotingCountWeight

NotVoted The not voted voting count and weight VotingCountWeight

Options Each voting option count and weight VotingOptionVoteDetail

AuthorityAssigned The authority used in the voting AuthorityAssigned

4.1.1.7 IndividualVote
Data model that represents the summary result of the voting

Name Description Type

DelegateID The ID of the delegate that has cast the vote int
The ID of the voting option for which the vote
VotingOptionID int
was cast

4.1.1.8 Timer
Data model that represents the timer

Name Description Type

TotalTime The total time (hh:mm:ss) string

TimeUsed Used time (hh:mm:ss) string

CountingDown Show counting down or up in CoCon bool

WarningTime Warning time in CoCon (hh:mm:ss) string

enabled Set enabled or disabled timer bool

4.1.1.9 BaseObjectTimer
Data model that represents the object’s timer

CoCon API 24 Dec 2021 31/184

 Name Description Type

Timer The timer of the object Timer

4.1.1.10 DelegateTimer : BaseObjectTimer

Data model that represents the delegate’s timer

Name Description Type

DelegateId The delegate’s Id int

4.1.1.11 GroupTimer : BaseObjectTimer

Data model that represents the group’s timer

Name Description Type

GroupId The delegate’s Id int

4.1.1.12 SeatTimer : BaseObjectTimer

Data model that represents the timer of the seat

Name Description Type

SeatNr The number of the seat int

4.1.1.13 Delegate
Data model that represents the delegate

Name Description Type

Id The id of the delegate int

FirstName The first name of the delegate string

Name The name of the delegate string

Street The street that the delegate lives string

StreetNumber The street number of that street int

PostCode The post code of the delegate that he lives string

City The city that the delegate lives string

Country The country that the delegate lives string

Title The title of the delegate string

BirthDate The birth date of the delegate string (format yyyy-MM-dd)

District The district of the delegate lives string

Biography The delegate’s biography string

Groups The groups of the delegate An array of Group

CoCon API 24 Dec 2021 32/184

4.1.1.14 Group
Data model that represents the group

Name Description Type

Id The id of the group int

Name The name of the group string

4.1.1.15 AgendaItem
Data model that represents the agenda item
Name Description Type

Id The id of the Agenda item string

string
Title The title of the agenda item

Description The description of the agenda item string

The type of the agenda item
VotingAgendaItem
Type string
LecturerAgendaItem
AgendaItem
State The state of the agenda item string

Children The Children agenda item of this agenda item List<AgendaItem>

4.1.1.16 VotingAgendaItem:AgendaItem
Data model that represent the voting agenda item
Name Description Type

VotingOptions The voting options List<VotingOption>

4.1.1.17 LecturerAgendaItem:AgendaItem
Data model that represent the lecturer agenda item
Name Description Type

Lectures The lecturers of this item List<Delegate>

4.1.1.18 AudioGroup
Data model that represent Audio group which contains routing input group and routing output group.
Name Description Type

Id The Id of the audio group int

Type The type of the audio group(input/output) string

Name The name of the audio group string

4.1.1.19 AudioMatrixNode
Data model that represent Audio matrix node.

Name Description Type

CoCon API 24 Dec 2021 33/184

 InputGroupName The name of the routing input group string

OutputGroupName The name of the routing output group string

MixValue The mix value of the matrix node(-100~0) int

Status The status of the matrix node(enable or not) bool

The backup status of the matrix node(enable
BackupStatus bool
or not)

4.1.1.20 AudioSoftwareConfiguration
Data model that represent Audio software configuration basic information.

Name Description Type

Id The Id of the audio software configuration int

Name The name of the audio software configuration string

4.1.1.21 AudioSoftwareConfigurationDetailed
Data model that represent Audio software configuration detail information.
Name Description Type

Id The Id of the audio software configuration int

Name The name of the audio software configuration string

AudioMatrixNodes All the audio matrix nodes List< AudioMatrixNode>

AudioGroups All the audio groups List< AudioGroup>

4.1.1.22 ScreenControlOptions

Properties: None (the inheriting objects will specify the necessary properties).

4.1.1.23 HomeControl : ScreenControlOptions

Properties: None

4.1.1.24 DiscussionControl : ScreenControlOptions

Properties:
Name Description Type
Set video viewing mode
0: disabled; no video shown
video int
1: normal
2: full screen

4.1.1.25 AgendaControl : ScreenControlOptions

Properties:
Name Description Type

select Select and show active agenda item bool

CoCon API 24 Dec 2021 34/184

4.1.1.26 DelegatesControl : ScreenControlOptions

Properties: None

4.1.1.27 VotingControl : ScreenControlOptions

Properties:
Name Description Type

res Show voting results bool

graph Show voting graph bool

4.1.1.28 DocumentsControl : ScreenControlOptions

Properties:
Name Description Type

doc Id of the document to select string

lck Lock the document (no selection) bool

page Page number to be scrolled to int

docfs Show the document fullscreen bool

4.1.1.29 MessagesControl : ScreenControlOptions

Properties: None

4.1.1.30 ServicesControl : ScreenControlOptions

Properties: None

4.1.1.31 ConfigurationControl : ScreenControlOptions

Properties: None

4.1.1.32 Unit
Data model that represent unit(like: microphone unit, vote unit,etc)
Name Description Type

RoomId The Id of the room int

SystemUnitId The Id of the unit int

SerialNumber The serial number of the unit string

UnitCapabilitiesInfo The capabilities information of the unit string

WirelessCapability If the unit has the wireless capability bool

VersionInfo The version of the unit string

4.1.1.33 Channel

CoCon API 24 Dec 2021 35/184

 Name Description Type

Id The Id of the preset int

Order The order of the channel int

Language The language name string

Set audio routing for the channel.
Plixus Core & CoCon For Plixus Core:
AudioRouting 'comma-separated-booth-numbers', Disabled, string
External, EmptyBooth

DisplayText The text will be displayed string

AutoFloor The channel is auto floor bool

BackupChannel The backup channel name String

Channel recording or not.
IsRecording bool
Optional parameter.

4.1.1.34 InterpreterPreset
Name Description Type

Id The Id of the interpreter preset int

Name The name of the interpreter preset string

Description The description of the interpreter preset string

DeskMode The mode between desks int

BoothMode The mode between booths int

State The state of the interpreter preset string

4.1.1.35 DeskUnitInChannel
Name Description Type

Name The name of the desk unit string

ActiveChannel The index of the active channel int

4.1.1.36 ChannelRealtimeData
Name Description Type

Order The order of the channel int

Language The name of the language string

Booth The name of the booth string

Desks The list of the desks in the channel List<IDeskUnitInChannel>

Relay The relay of the channel string

Quality The quality of the channel int

4.2 Server to client

This section describes all commands that the CoCon Server will send to the API clients, notifying them of any
events that have happened in the conference software or room.

CoCon API 24 Dec 2021 36/184

As discussed above, the functionality is divided into models. Each model will be discussed in a separate section
below. The first section is a general section.

4.2.1 Room

4.2.1.1 InitializationState

Cocon for Plixus Core

API Module Plixus Core
InitialisationState  ☐

This command is sent when Initialization state changes. The initialization states are:
• Start
• Stop
• Retrieve
• Auto
• Reset

Name: InitialisationState
REST/JON Example:
{"InitialisationState":"AUTO"}
(Note: uppercase letters will be used on return)

4.2.1.2 UnitStateChanged

Cocon for Plixus Core

API Module Plixus Core
UnitStateChanged  ☐

This notification is sent when a unit’s online state changes, i.e. if it goes offline of comes online again.

Parameters:
Name Description Type

UnitId The id of the unit int

The new state of the unit
State 0: offline <0/1>
1: online

Example:
Wired unit’s notification :
{“UnitStateChanged”:{“Id”:9,”State”:0}}

Wireless unit’s notification :

{"UnitStateChanged":{"Id":6,"State":0,"BatteryState":1448,"Snr":0,"PacketLoss":3}}

4.2.1.3 VolumeChangedForRoom
Cocon for Plixus Core
API Module Plixus Core
VolumeChangedForRoom  

This notification will send once default volume changed in room.

CoCon API 24 Dec 2021 37/184

Parameters:

Name Description Type

Id Connected room id int

Volume of the room
Volume int

REST/JON Example:
{"VolumeChangedForRoom":{"Id":1,"volume":24}}

4.2.1.4 UnitError
Cocon for Plixus Core
API Module Plixus Core
UnitError  

This notification will send out once the unit erro happen.

Parameters:

Name Description Type

State State of the unit string

UnitId
UnitId int

REST/JON Example:
{"UnitError":{"State":"Error","UnitId":6}}

4.2.2 Microphone

4.2.2.1 MicrophoneState

Cocon for Plixus Core

API Module Plixus Core
MicrophoneState  

This command is sent every time the state of a microphone changes. The different options of a microphone
state are:
• On = Speakers
• In Request = Requests
• Off

As indicated, the seat-numbers of the microphones that are On are contained in the “Speakers” array. The seat-
numbers of the microphones that are In Request are contained in the second parameter.

Name: MicrophoneState

Parameters:

Name Description Type

CoCon API 24 Dec 2021 38/184

 An array of the seatNrs of all currently active
Speakers microphones Array of integers

An array of the seatNrs of all the microphones

Requests that are currently in request Array of integers

An array of the seatNrs of all the microphones

Replies Array of integers
that are currently in replies

REST/JON Example:
{"MicrophoneState":{"Speakers":[6],"Requests":[],"Replies":[]}}

4.2.2.2 MicrophoneMode

Cocon for Plixus Core

API Module Plixus Core
MicrophoneMode  

This command is sent every time the microphone mode changes.

Name: MicrophoneMode

Parameters:

Name Description Type

The Microphone mode. Values:
Operator
DirectSpeak
Mode Request string
Vox
OnlyRequest

The maximum number of microphones active

MaxNrActive at the same time int

bool indicating whether the delegates are

AllowRequest allowed to request.
Not applicable for all modes. bool
Optional

bool indicating whether the delegates are

allowed to cancel their request.
AllowCancelRequest Not applicable for all modes. bool
Optional

bool indicating whether the FIFO mode is

active
FIFO Not applicable for all modes. bool
Optional

Bool indicating whether the delegate are

AllowSwitchOffMic bool
allowed to switch off their mic or not.
Indicating that the ReplyRequest (Replik)
ReplyRequest bool
function is enabled or not on Server.

REST/JON Example:
{"MicrophoneMode":{"Mode":"OnlyRequest","MaxNrActive":4,"AllowRequest":true,"AllowCancelRequest":false,"
FIFO":false,"ActivationType":"Toggle","AllowSwitchOffMic":True,"ReplyRequest":false}}

CoCon API 24 Dec 2021 39/184

4.2.2.3 MicButtonEvent

Cocon for Plixus Core

API Module Plixus Core
MicButtonEvent  

This event is sent every time a microphone button is pushed. It contains information about the seat that has
generated the event.

Name: MicButtonEvent

Parameters:

Name Description Type

The number of the seat
SeatNr int

Event The button event (up or down) string

REST/JON Example:
{"MicButtonEvent":{"SeatNr":2,"Event":"up"}}

4.2.2.4 MicrophoneSensitivityUpdated

Cocon for Plixus Core

API Module Plixus Core
MicrophoneSensitivityUpdated  ☐

This event notification for the seat (Microphone) sensitivity changed or updated.

Name: MicrophoneSensitivityUpdated

Parameters:

Name Description Type

The number of the seat
SeatId int
Value of the sensitivity
Range of value
Sensitivity int
+12 to -12
Ex. (12,11,10,9…-10,-11,-12)

REST/JON Example:
{"MicrophoneSensitivityUpdated":{"SeatId":1,"Sensitivity":-6}}

4.2.2.5 MicStateChangedInRunningMeeting

Cocon for Plixus Core

API Module Plixus Core
MicStateChangedInRunningMeeting  ☐

This event notification for the delegate on seat (Microphone) updated.

CoCon API 24 Dec 2021 40/184

Name: MicStateChangedInRunningMeeting

REST/JON Example:
{"MicStateChangedInRunningMeeting":{"SeatNr":1,"State":"On","User":{"Id":463,"FirstName":"Marcel","Name":"
Ackermann","MiddleName":null,"Street":"Route Principale
11c","StreetNumber":0,"PostCode":"2803","City":"Bourrignon","Country":"","Title":"Député","BirthDate":"","District
":"","Biography":"","Groups":[{"Id":21,"Name":"PDC"}],"SeatNumber":1,"BadgeNumber":"14EFB4E2","Fingerprint
erData":"","KeypadLoginCode":""}}}

4.2.3 Meeting_Agenda

4.2.3.1 MeetingTitleChanged

Cocon for Plixus Core

API Module Plixus Core
MeetingTitleChanged  ☐

This command is sent every time the active meeting title changed.

Name: MeetingTitleChanged

Parameters:

Name Description Type

MeetingId ID of the meeting int

The new meeting title
NewTitle string

REST/JON Example:

{"MeetingTitleChanged":{"Title":"2/11/2014 new Meeting"}}

4.2.3.2 MeetingStatus

Cocon for Plixus Core

API Module Plixus Core
MeetingStatus  ☐

This command is sent every time the state of current active meeting changed.

Name: MeetingStatus

Parameters:

Name Description Type

MeetingId The id of the meeting int

The state of the meeting include:
Paused;
State string
Running;
Ended

REST/JSON Example:

CoCon API 24 Dec 2021 41/184

{"MeetingStatus":{"MeetingId":14,"State":"Paused"}}
{"MeetingStatus":{"MeetingId":14,"State":"Running"}}
{"MeetingStatus":{"MeetingId":14,"State":"Ended"}}

4.2.3.3 MeetingAgendaChanged

Cocon for Plixus Core

API Module Plixus Core
MeetingAgendaChanged  ☐

This notification is sent out when the agenda has changed, i.e. when an agenda item is added, removed, edited
or moved. It is NOT sent when the active agenda item changes, since there is already another API command for
that (Agenda_ItemChanged).
The API client that is interested in the changes in the agenda, can get the entire agenda with
GetAgendaItemInformationInRunningMeeting

Parameters:
Name Description Type

MeetingId The id of the meeting int

REST/JSON Example:
{“MeetingAgendaChanged”:{“MeetingId”:9}}

4.2.3.4 Agenda_ItemChanged

Cocon for Plixus Core

API Module Plixus Core
Agenda_ItemChanged  ☐

This command is sent every time the state of an agenda item changes.

Name: Agenda_ItemChanged

Parameters:

Name Description Type

MeetingId The id of the meeting int

Agenda_ItemChanged The changed agenda item AgendaItem

IdInDb In CoCon DB Agenda ID int

REST/JON Example:
{"MeetingId":74,"Agenda_ItemChanged":{"Id":"4","Title":"","Description":"","Type":"VotingAgendaItem","State":"e
nded","VotingOptions":[{"Id":397,"Name":"1","Color":"#FF006400"},{"Id":398,"Name":"2","Color":"#FF008000"},{"I
d":399,"Name":"3","Color":"#FFFFFF00"},{"Id":400,"Name":"4","Color":"#FFFF0000"},{"Id":401,"Name":"5","Colo
r":"#FF8B0000"}],"Children":[],"IdInDb":131}}

CoCon API 24 Dec 2021 42/184

4.2.3.5 Keypad_login_code

Cocon for Plixus Core

API Module Plixus Core
keypad_login_code  ☐

This command is sent from Plixus FMM (IDC) to CoCon whenever user input numeric code and press the Ok.

Name: keypad_login_code

Parameters:

Name Description Type

SeatNr Seat number int

LoginCode Code entered by user from Plixus FMM (IDC) string

REST/JON Example:
{"keypad_login_code":{"SeatNr":4,"LoginCode":"1234"}}

4.2.3.6 FingerprintEvent

Cocon for Plixus Core

API Module Plixus Core
FingerprintEvent  ☐

This command is sent from Plixus FMM (IDC) to CoCon whenever user press finger on fingerprint device.

Name: FingerprintEvent

Parameters:

Name Description Type

SeatNr Seat number int

FingerprintEvent Fingerprint data from fingerprint device String

Delegate Id to which the fingerprint was
matched (processing taking place on the
unicos/unibox unit)
DelegateId int
0 : in case the fingerprint verification was not
able to match it to the fingerprints of delegate
part of the meeting

REST/JON Example:
{"FingerprintEvent":{"SeatNr":7,"FingerprintData":"464d520020323000000000f0000000b401000098009801000
0004923804d000fb400805b00222600807e00231300406300282400402b00333d00403e00343400806a003e25
008098003fb200407300441c00808a0044af0080a000453900407600613400805e00634600406e006747004061
0071ef00802b00794f004085007d8600804a007e53004094007f2000806a008b6800407d00900e00804a0094e5
008083009f0600805c00a86300803500ade400801900ae5700804300ba6200405100bcf700803c00c0ea004061
00c07600808400c00200804900ccf000404600d16700403000d9ee00802500ebeb000000", “DelegateId”:1063}}

CoCon API 24 Dec 2021 43/184

4.2.4 Voting

4.2.4.1 VotingState

Cocon for Plixus Core

API Module Plixus Core
VotingState  ☐

The voting state of current active voting agenda item

Name: VotingState

Parameters:

Name Description Type

Id ID of the VotingAgendaItem int

The state of voting, include:
Start;
State Stop string
Pause
Clear
The voting template that voting agenda item
VotingTemplate string
based on

REST/JON Example:
{"VotingState":{“Id”:11;"State":"Start","VotingTemplate":"3_Vote_Public"}}

4.2.4.2 VotingOutcome

Cocon for Plixus Core

API Module Plixus Core
VotingOutcome  ☐

The outcome message of voting result

Name: VotingOutcome

Parameters:

Name Description Type

Id ID of the VotingAgendaItem int

ID of the VotingOption that won, if applicable
VotingOptionId 0 if not applicable int

The outcome message of voting result

Outcome string

REST/JON Example:
{"VotingOutcome":{“Id”:11;”VotingOptionId”:1147;"OutCome":"Pass option1"}}

CoCon API 24 Dec 2021 44/184

4.2.4.3 GeneralVotingResults

Cocon for Plixus Core

API Module Plixus Core
GeneralVotingResults  ☐

The general voting results of current voting

Name: GeneralVotingResults

Parameters:

Name Description Type

Id ID of the VotingAgendaItem int

VotingResults The general results of current voting VotingResultSummary

REST/JON Example:
{"GeneralVotingResults":{“Id”:11;"VotingResults":{"Total":{"Count":10,"Weight":10},"Voted":{"Count":0,"Weight":0
},"NotVoted":{"Count":10,"Weight":10},"AuthorityAssigned":{"Present":0,"Voted":0,"Register":0}}}}

4.2.4.4 IndividualVotingResults

Cocon for Plixus Core

API Module Plixus Core
IndividualVotingResults  ☐

The individual voting results of current voting, whenever a new vote is available. Note the following:
• For every one vote, this event will only be sent once, at the moment of casting the vote.
• The delegate info and voting option info is not present in this command to optimize performance. Only
IDs are available.

Name: IndividualVotingResults

Parameters:

Name Description Type

Id ID of the VotingAgendaItem int

VotingResults An array with all the individual votes Array of IndividualVote

REST/JON Example:
{"IndividualVotingResults":{“Id”:11;"VotingResults":[{“DelegateID”:24;”VotingOptionID:2};…]}}

4.2.4.5 VotingTemplateAdded

Cocon for Plixus Core

API Module Plixus Core
VotingTemplateAdded  ☐

Event notification for the added new voting template or update voting template.

CoCon API 24 Dec 2021 45/184

Parameters:
Name Description Type
Name of the Voting template and will keep the
Title title doe that agenda
string

NrOfOptions Number of voting options int

IsPrinted Enabled the function for print after voting stop. bool
Enabled Symbol or Number for voting choice
IsVotingNumber Note: not applicable after 5.0 cocon
bool
Choose the Voting abstain Options
AbstainOption Value :1 to 3
int
Select abstain index for move voting for
AbstainIndex Value : 1 to .. based on the voting options.
int

Description1 Description for voting option 1 string

Voting Option Color
Ex→%23FFFFF000
Option1 (Option Color) Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex1 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour1 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain1 Enabled the abstain function bool

MsgOfMajority1 Message for majority string

Description2 Description for voting option 2 string

Voting Option Color
Ex→%23FFFFF000
Option2 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex2 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour2 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain2 Enabled the abstain function bool

MsgOfMajority2 Message for majority string

Description3 Description for voting option 3 string

Voting Option Color
Ex→%23FFFFF000
Option3 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex3 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour3 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain3 Enabled the abstain function bool

MsgOfMajority3 Message for majority string

Description4 Description for voting option 4 string

Voting Option Color
Ex→%23FFFFF000
Option4 Where %23 is Prefix and 8 chars of the RGB
string
value.

CoCon API 24 Dec 2021 46/184

 Note: Make sure for correct RGB value.

Buttons enabled for voting

SymbolIndex4 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour4 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain4 Enabled the abstain function bool

MsgOfMajority4 Message for majority string

Description5 Description for voting option 5 string

Voting Option Color
Ex→%23FFFFF000
Option5 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex5 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour5 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain5 Enabled the abstain function bool

MsgOfMajority5 Message for majority string

Description6 Description for voting option 6 string

Voting Option Color
Ex→%23FFFFF000
Option6 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex6 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour6 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain6 Enabled the abstain function bool

MsgOfMajority6 Message for majority string

Description7 Description for voting option 7 string

Voting Option Color
Ex→%23FFFFF000
Option7 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex7 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour7 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain7 Enabled the abstain function bool

MsgOfMajority7 Message for majority string

Description8 Description for voting option 8 string

Voting Option Color
Option8 Ex→%23FFFFF000
string

CoCon API 24 Dec 2021 47/184

 Where %23 is Prefix and 8 chars of the RGB
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex8 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour8 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain8 Enabled the abstain function bool

MsgOfMajority8 Message for majority string

Description9 Description for voting option 9 string

Voting Option Color
Ex→%23FFFFF000
Option9 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex9 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour9 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain9 Enabled the abstain function bool

MsgOfMajority9 Message for majority string

Description10 Description for voting option 10 string

Voting Option Color
Ex→%23FFFFF000
Option10 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex10 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour10 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain10 Enabled the abstain function bool

MsgOfMajority10 Message for majority string

Choose option for “Who can participate in
voting”
Value : 1 to 4
BadgeOption Ex. 4 = All voting units
int
Note: badge options will be available based on
the meeting type
Choose overall option “Who sees the overall
results during the vote ?
OverallOption Value : 1 to 4
int
1= no one
Choose the option for “Who sees the individual
voting results (during & after the vote)”
IndividualOption Value: 1 to 5
int
1= No one ;Never
Enabled the correction option
CanCorrect Value : True means user can change voting
bool
Enable the option for “Enter PinId for voting”
HasPin Note: it will be used for IDC only.
bool

CoCon API 24 Dec 2021 48/184

 Enable option to check the voting weight for
IsWeightUsed voting result calculation. bool

Vote indication
Enabled the Operator voting indication
IsOperatorIndicated Note: it can configure based on the individual
bool
voting setting.
Vote indication
Enabled the Signage voting indication
IsSignageIndicated Note: it can configure based on the individual
bool
voting setting.
Vote button indication
Chose the vote panel indication option
Value : 0 to 2
PanelIndicationOption 2 means “Real vote choice”
int
Note: it can configure based on the individual
voting setting.
EnableAgendaTimer Enabled the timer for Agenda bool
Total Time for Agenda
DurationOfAgendaTimer Ex. 00:05:00
String
Warning time for the Agenda
WarningOfAgendaTimer Ex. 00:01:00
String

CountDownOfAgendaTime Choose the agenda timer count-up / count-

Bool
r down

ExceedOfAgendaTimer Allow exceed agenda timer Bool

EnableVotingTimer Enabled the timer for voting Bool

Total Time for Agenda
DurationOfVotingTimer Ex. 00:05:00
String
Warning time for the Agenda
WarningOfVotingTImer Ex. 00:01:00
String
Choose the agenda timer count-up / count-
CountDownOfVotingTimer down
Bool

ExceedOfVotingTimer Allow exceed voting timer Bool

EnableQuorum Enabled the Quorum Functionality Bool

Choose Quorum define function for Absolute
or relative
AbsoluteOfQuorum Ex. True means Absolute enabled Bool
False means Relative option selected.
(enabled)
ValueOfQuorum Value of the Quorum decimal
Choose the options for Presence of
OptionOfQuorum determination. int
Value : 1 to 5
EnableQuorumMsg Enabled the Quorum message option bool

QuorumMsg Message for Quorum string

Choose Majority define function for Absolute or
relative
AbsoluteOfOutcome Ex. True means Absolute enabled bool
False means Relative option selected
(enabled).
ValueOfMajority Value of the Majority decimal
Choose the majority options
MajorityOption Value :1 to 2
int

EnableOutcomMsg Enabled Outcome message option. bool

PassedMsg Message for the Pass Majority string

FailedMsg Message for the Fail Majority string

HungMsg Message for the Hung Majority string

EnabledMajorityMsg Enabled Majority Achieved Details bool

Choose option for the hung vote solution
HungVoteSetting Value : 1 to 5 Int
Ex.

CoCon API 24 Dec 2021 49/184

 0 = Stop voting automatically.
1 = Keep the vote active until the Operator or
Chairman manually stops it.
2 = Restart voting with all options available
3 = Determined by chairmen votes in this
voting session.
4 = Stop voting and the operator decides.
5 = Determined by chairmen votes in a new
chairmen-only voting session.

If value is true, means Voting options for the

voting session decision made by operator
even thoug user can choose his own chose as
IsUnanimous well. (this option will used by the Cocon Op
bool
app only now)
Note: default value is false

REST/JON Example:
{"VotingTemplateAdded":{"Id":36,"Title":"TEST
501","NrOfOptions":5,"IsPrinted":false,"IsVotingNumber":false,"BadgeOption":1,"OverallOption":1,"Options":[{"Id
":157,"Description":"Pass","Option":"#0000FF","SymbolIndex":0,"LedColour":"Red","IsAbstain":true,"MsgOfMajo
rity":""},{"Id":158,"Description":"ABS","Option":"#FFFF0000","SymbolIndex":1,"LedColour":"Red","IsAbstain":fals
e,"MsgOfMajority":"Motion
Accepted"},{"Id":159,"Description":"Fail","Option":"#FFFFFF00","SymbolIndex":2,"LedColour":"Blue","IsAbstain":
false,"MsgOfMajority":"Motion
Postponed"},{"Id":160,"Description":"ISA","Option":"#39FF14","SymbolIndex":3,"LedColour":"Yellow","IsAbstain":
false,"MsgOfMajority":"Motion
Rejected"},{"Id":161,"Description":"XYZ","Option":"#FF00FF","SymbolIndex":4,"LedColour":"Magenta","IsAbstain
":false,"MsgOfMajority":""}],"IndividualOption":1,"CanCorrect":true,"HasPin":false,"IsWeightUsed":true,"IsOperat
orIndicated":true,"IsSignageIndicated":true,"PanelIndicationOption":1,"AgendaTimer":{"Id":73,"EnableAgendaTi
mer":true,"DurationOfAgendaTimer":"00:05:00","WarningOfAgendaTimer":"00:03:00","CountDownOfAgendaTim
er":false,"ExceedOfAgendaTimer":true},"VotingTimer":{"Id":74,"EnableVotingTimer":true,"DurationOfVotingTime
r":"00:05:00","WarningOfVotingTImer":"00:05:00","CountDownOfVotingTimer":false,"ExceedOfVotingTimer":true
},"EnableQuorum":true,"AbsoluteOfQuorum":false,"ValueOfQuorum":0.0,"OptionOfQuorum":1,"EnableQuorumM
sg":true,"QuorumMsg":"It
works","AbsoluteOfOutcome":false,"ValueOfMajority":10.0,"MajorityOption":1,"EnableOutcomMsg":true,"Passed
Msg":"Majority achieved","FailedMsg":"fail","HungMsg":"hung","EnabledMajorityMsg":true,"HungVoteSetting":4}}

Example 2 :
{"VotingTemplateAdded":{"Id":3,"Title":"Test
223","NrOfOptions":3,"IsPrinted":false,"IsVotingNumber":false,"BadgeOption":4,"OverallOption":4,"Options":[{"Id
":66,"Description":"","Option":"#FF008000","SymbolIndex":1,"LedColour":"Blue","IsAbstain":false,"MsgOfMajority
":"Motion
Accepted"},{"Id":67,"Description":"","Option":"#FFFFFF00","SymbolIndex":2,"LedColour":"Blue","IsAbstain":false,
"MsgOfMajority":"Motion
Postponed"},{"Id":68,"Description":"","Option":"#FFFF0000","SymbolIndex":3,"LedColour":"Blue","IsAbstain":fals
e,"MsgOfMajority":"Motion
Rejected"}],"IndividualOption":5,"CanCorrect":false,"HasPin":false,"IsWeightUsed":true,"IsOperatorIndicated":fal
se,"IsSignageIndicated":false,"PanelIndicationOption":0,"AgendaTimer":{"Id":109,"EnableAgendaTimer":false,"D
urationOfAgendaTimer":"00:00:00","WarningOfAgendaTimer":"00:00:00","CountDownOfAgendaTimer":true,"Exc
eedOfAgendaTimer":false},"VotingTimer":{"Id":110,"EnableVotingTimer":false,"DurationOfVotingTimer":"00:00:0
0","WarningOfVotingTImer":"00:00:00","CountDownOfVotingTimer":true,"ExceedOfVotingTimer":false},"Enable
Quorum":false,"AbsoluteOfQuorum":true,"ValueOfQuorum":0.0,"OptionOfQuorum":4,"EnableQuorumMsg":false,
"QuorumMsg":"Quorum not OK - voting
postponed","AbsoluteOfOutcome":true,"ValueOfMajority":1.0,"MajorityOption":2,"EnableOutcomMsg":false,"Pas
sedMsg":"Majority achieved","FailedMsg":"Majority not achieved","HungMsg":"Hung
vote","EnabledMajorityMsg":false,"HungVoteSetting":1,"IsUnanimous":false}}

CoCon API 24 Dec 2021 50/184

4.2.5 Timer

Note: default timer events will be send out every 5 seconds. However, there is a possibility to have timer events
send out with different time intervals. For this the "TimerEventIntervalSeconds" value can be changed inside
Cocon server xml configuration file.

4.2.5.1 MeetingTimerEvent

Cocon for Plixus Core

API Module Plixus Core
MeetingTimerEvent  ☐

The timer event of the current active meeting

Name: MeetingTimerEvent

Parameters:
Name Description Type

MeetingTimer The timer of current meeting BaseObjectTimer

REST/JON Example:
{"MeetingTimerEvent":{"MeetingTimer":{"Timer":{"TotalTime":"02:00:00","TimeUsed":"00:00:11","CountingDown
":true,"WarningTime":"00:05:00"}}}}

4.2.5.2 MeetingTimerStateChange

Cocon for Plixus Core

API Module Plixus Core
MeetingTimerPauseResumed  ☐

Pause or Resume current active meeting Timer

Name: MeetingTimerPauseResumed

Parameters:
Name Description Type

Paused The pause state of timer bool

MeetingTimer The timer of current meeting BaseObjectTimer

REST/JON Example:
{"MeetingTimerPauseResumed":{"Paused":true,"MeetingTimer":{"Timer":{"TotalTime":"02:00:00","TimeUsed":"0
0:02:35","CountingDown":true,"WarningTime":"00:05:00"}}}}

CoCon API 24 Dec 2021 51/184

4.2.5.3 DelegateTimerEvent

Cocon for Plixus Core

API Module Plixus Core
DelegateTimerEvent  ☐

The timer event of the delegate

Name: DelegateTimerEvent

Parameters:
Name Description Type

DelegateTimer The time of the delegate DelegateTimer : BaseObjectTimer

REST/JON Example:
{"DelegateTimerEvent":{"DelegateTimer":{"DelegateId":10,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:0
0","CountingDown":true,"WarningTime":"00:01:00"}}}}

4.2.5.4 DelegateTimerStateChange

Cocon for Plixus Core

API Module Plixus Core
DelegateTimerPauseResumed  ☐

Pause or resume the delegate timer

Name: DelegateTimerPauseResumed

Parameters:

Name Description Type

Paused The pause state of timer bool

DelegateTimer The timer of the delegate DelegateTimer : BaseObjectTimer

REST/JON Example:
{"DelegateTimerPauseResumed":{"Paused":true,"DelegateTimer":{"DelegateId":10,"Timer":{"TotalTime":"00:05:
00","TimeUsed":"00:00:00","CountingDown":true,"WarningTime":"00:01:00"}}}}

4.2.5.5 GroupTimerEvent

Cocon for Plixus Core

API Module Plixus Core
GroupTimerEvent  ☐

The timer event of the group

Name: GroupTimerEvent

Parameters:

CoCon API 24 Dec 2021 52/184

 Name Description Type

GroupTimer The time of the group GroupTimer : BaseObjectTimer

REST/JON Example:
{"GroupTimerEvent":{"GroupTimer":{"GroupId":1,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","Counti
ngDown":true,"WarningTime":"00:01:00"}}}}

4.2.5.6 GroupTimerStateChange

Cocon for Plixus Core

API Module Plixus Core
GroupTimerPauseResumed  ☐

Pause or resume the group timer

Name: GroupTimerPauseResumed

Parameters:

Name Description Type

Paused The pause state of timer bool

GroupTimer The timer of the delegate GroupTimer : BaseObjectTimer

REST/JON Example:
{"GroupTimerPauseResumed":{"Paused":true,"GroupTimer":{"GroupId":1,"Timer":{"TotalTime":"00:05:00","Time
Used":"00:00:00","CountingDown":true,"WarningTime":"00:01:00"}}}}

4.2.5.7 SeatTimerEvent

Cocon for Plixus Core

API Module Plixus Core
SeatTimerEvent  ☐

The timer event of the seat

Name: SeatTimerEvent

Parameters:

Name Description Type

SeatTimer The timer of the seat SeatTimer : BaseObjectTimer

REST/JON Example:
{"SeatTimerEvent":{"SeatTimer":{"SeatNr":1,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","CountingD
own":true,"WarningTime":"00:01:00"}}}}

CoCon API 24 Dec 2021 53/184

4.2.5.8 SeatTimerPauseResumed

Cocon for Plixus Core

API Module Plixus Core
SeatTimerPauseResumed  ☐

Pause or resume the seat timer

Name: SeatTimerPauseResumed

Parameters:

Name Description Type

Paused The pause state of timer bool

SeatTimer The timer of the seat SeatTimer : BaseObjectTimer

REST/JON Example:
{"SeatTimerPauseResumed":{"Paused":true,"SeatTimer":{"SeatNr":1,"Timer":{"TotalTime":"00:05:00","TimeUse
d":"00:00:00","CountingDown":true,"WarningTime":"00:01:00"}}}}

4.2.5.9 ActiveAgendaItemTimerEvent

Cocon for Plixus Core

API Module Plixus Core
ActiveAgendaItemTimerEvent  ☐

The timer event of the active agenda item

Name: ActiveAgendaItemTimerEvent

Parameters:

Name Description Type

ActiveAgendaItemTimer The timer of the active agenda item BaseObjectTimer

REST/JON Example:
{"ActiveAgendaItemTimerEvent":{"ActiveAgendaItemTimer":{"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00
:21","CountingDown":false,"WarningTime":"00:00:00"}}}}

4.2.5.10 ActiveAgendaItemTimerPauseResumed

Cocon for Plixus Core

API Module Plixus Core
ActiveAgendaItemTimerPauseResumed  ☐

Pause or resume the active agenda item timer

Name: ActiveAgendaItemTimerPauseResumed

Parameters:

CoCon API 24 Dec 2021 54/184

 Name Description Type

Paused The pause state of timer bool

ActiveAgendaItemTimer The timer of the seat BaseObjectTimer

REST/JON Example:
{"ActiveAgendaItemTimerPauseResumed":{"Paused":false,"ActiveAgendaItemTimer":{"Timer":{"TotalTime":"00:
05:00","TimeUsed":"00:00:00","CountingDown":false,"WarningTime":"00:00:00"}}}}

4.2.5.11 VotingTimerEvent

Cocon for Plixus Core

API Module Plixus Core
VotingTimerEvent  ☐

The timer event of the voting

Name: VotingTimerEvent

Parameters:

Name Description Type

VotingTimer The timer of the voting BaseObjectTimer

REST/JON Example:
{"VotingTimerEvent":{"VotingTimer":{"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:02","CountingDown":fal
se,"WarningTime":"00:00:00"}}}}

4.2.5.12 VotingTimerPauseResumed

Cocon for Plixus Core

API Module Plixus Core
VotingTimerPauseResumed  ☐

Pause or resume the voting

Name: VotingTimerPauseResumed

Parameters:

Name Description Type

Paused The pause state of timer bool

VotingTimer The timer of the seat BaseObjectTimer

REST/JON Example:
{"VotingTimerPauseResumed":{"Paused":true,"VotingTimer":{"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:0
0:32","CountingDown":false,"WarningTime":"00:00:00"}}}}

CoCon API 24 Dec 2021 55/184

4.2.6 Delegate

4.2.6.1 BadgeEvent

Cocon for Plixus Core

API Module Plixus Core
BadgeEvent  ☐

Delegate on the seat, insert badge to show the present. (Fixed seat insert badge for the present meeting mode.)

Name: BadgeEvent

Parameters:

Name Description Type

SeatNr The number of the seat int

Delegate The information of the delegate on seat Delegate

BadgeInserted Badge insert or not bool

REST/JON Example:

Meeting Running :
{"BadgeEvent":{"SeatNr":2,"Delegate":{"Id":463,"FirstName":"Marcel","Name":"Ackermann","MiddleName":null,"
Street":"Route Principale
11c","StreetNumber":0,"PostCode":"2803","City":"Bourrignon","Country":"","Title":"Député","BirthDate":"","District
":"","Biography":"","Groups":[{"Id":21,"Name":"PDC"}],"SeatNumber":2,"BadgeNumber":"14EFB4E2","Fingerprint
erData":"","KeypadLoginCode":""},"BadgeInserted":true,"bid":"14EFB4E2"}}

No Meeting running :
{"BadgeEvent":{"SeatNr":4,"Delegate":null,"BadgeInserted":true,"bid":"14EFB4E2"}}
Meeting Running :

4.2.6.2 DelegateOnSeat

Cocon for Plixus Core

API Module Plixus Core
DelegateOnSeat  ☐

When seat is empty, and meeting is free-seat, and delegates insert or remove their badges.

Name: DelegateOnSeat

Parameters:

Name Description Type

SeatNr The number of the seat int

Delegate The information of the delegate on seat Delegate

OnSeat Delegate is no seat or not bool

REST/JON Example:

CoCon API 24 Dec 2021 56/184

{"DelegateOnSeat":{"SeatNr":4,"Delegate":{"Id":463,"Title":"Député","FirstName":"Marcel","Name":"Ackermann",
"MiddleName":null,"Groups":[{"Id":21,"Name":"PDC"}]},"OnSeat":true,"bid":"14EFB4E2"}}

REST/JON Example: Remove delegate from a seat

{"DelegateOnSeat":{"SeatNr":2,"Delegate":"","OnSeat":false}}

4.2.6.3 DelegateSeatingUpdated

Cocon for Plixus Core

API Module Plixus Core
DelegateSeatingUpdated  ☐

When delegate removed from seat, this api call notified from server.

Name: DelegateSeatingUpdated

Parameters:

Name Description Type

DelegateId Delegate id from the meeting user table int

SeatId Seat number, where user was seated int

4.2.6.4 MeetingStartsUserInformation

Cocon for Plixus Core

API Module Plixus Core
MeetingStartsUserInformation  ☐

When meeting starts, send users in meeting to client.

Name: MeetingStartsUserInformation

Parameters:

Name Description Type

MeetingId ID of the meeting int

Users The Users in meeting List<Delegate>

REST/JON Example:
{"MeetingStartsUserInformation":{"Users":[{"Id":4,"FirstName":"11","Name":"Test1","Street":"","StreetNumber":n
ull,"PostCode":"","City":"","Country":"","Title":"","BirthDate":"","District":"","Biography":"","Groups":[{"Id":1,"Name":
"Group1"}],"SeatNumber":2},{"Id":5,"FirstName":"22","Name":"Test2","Street":"","StreetNumber":null,"PostCode":
"","City":"","Country":"","Title":"","BirthDate":"","District":"","Biography":"","Groups":[],"SeatNumber":3},{"Id":3,"Firs
tName":"asfwesw","Name":"wefwef","Street":"","StreetNumber":null,"PostCode":"","City":"","Country":"","Title":"T
est2","BirthDate":"","District":"","Biography":"","Groups":[{"Id":2,"Name":"Group2"}],"SeatNumber":5},{"Id":2,"First
Name":"wefwef","Name":"sdf","Street":"","StreetNumber":null,"PostCode":"","City":"","Country":"","Title":"Test1","
BirthDate":"","District":"","Biography":"","Groups":[{"Id":1,"Name":"Group1"}],"SeatNumber":1},{"Id":6,"FirstName"
:"33","Name":"Test3","Street":"","StreetNumber":null,"PostCode":"","City":"","Country":"","Title":"","BirthDate":"","
District":"","Biography":"","Groups":[{"Id":2,"Name":"Group2"}],"SeatNumber":4}]}}

CoCon API 24 Dec 2021 57/184

4.2.6.5 DelegateUpdated

Cocon for Plixus Core

API Module Plixus Core
DelegateUpdated  ☐

This event is sent if a delegate was edited.

Name: DelegateUpdated

Parameters:

Name Description Type

DelegateId The Id of the delegate int

Name The name of the delegate string

FirstName The first name of the delegate string

Title The title of the delegate string

MiddleName of the delegate
MiddleName string
[Optional parameter]
BadgeNr The badge number int

UserName The username for the delegate string

Password The password for the delegate string

Street The street for the delegate string

StreetNr The street number for the delegate string

City The city for the delegate string

PostalCode The postal code for the delegate string

Country The country for the delegate string

District The district for the delegate string

BirthDate The delegate’s birthday string

Email The delegate’s email address string

PhoneNr The delegate’s phone number string

VotingRight Does the delegate have the right to vote? Bool

VotingWeight The voting weight to apply for this delegate Int

PinId PinId to login for voting Int

Fingerprint data to open the Unicos IDC
FingerprinterData screen string
[Optional parameter]
Code to login into the Unicos FMM (IDC)
KeypadLoginCode int
[Optional parameter]

REST/JON Example:
{"DelegateUpdated":{"DelegateId":534,"Name":"Manoj","MiddleName":"Subhashbhai","FirstName":"Patel","Title"
:"Mr.","BadgeNr":"","UserName":"","Password":"","Street":"","StreetNr":"0","PostalCode":"","City":"","Country":"","
BirthDate":"","District":"","Email":"","PhoneNr":"","VotingRight":true,"VotingWeight":1,"PinId":"9876","Fingerprinte
rData":"","KeypadLoginCode":"1234"}}

4.2.6.6 DelegateAdded

CoCon API 24 Dec 2021 58/184

 Cocon for Plixus Core
API Module Plixus Core
DelegateAdded  ☐

This event is sent if a delegate was Added.

Name: DelegateAdded

Parameters:

Name Description Type

DelegateId The Id of the delegate int

Name The name of the delegate string

FirstName The first name of the delegate string

Title The title of the delegate string

MiddleName of the delegate
MiddleName string
[Optional parameter]
BadgeNr The badge number int

UserName The username for the delegate string

Password The password for the delegate string

Street The street for the delegate string

StreetNr The street number for the delegate string

City The city for the delegate string

PostalCode The postal code for the delegate string

Country The country for the delegate string

District The district for the delegate string

BirthDate The delegate’s birthday string

Email The delegate’s email address string

PhoneNr The delegate’s phone number string

VotingRight Does the delegate have the right to vote? Bool

VotingWeight The voting weight to apply for this delegate int

PinId PinId to login for voting Int

Fingerprint data to open the Unicos IDC
FingerprinterData screen string
[Optional parameter]
Code to login into the Unicos FMM (IDC)
KeypadLoginCode int
[Optional parameter]

REST/JON Example:
{"DelegateAdded":{"DelegateId":534,"Name":"Isha","MiddleName":null,"FirstName":"Sakhalakr","Title":"Mrs.","B
adgeNr":"","UserName":"","Password":"","Street":"","StreetNr":"0","PostalCode":"","City":"","Country":"","BirthDat
e":"","District":"","Email":"","PhoneNr":"","VotingRight":true,"VotingWeight":1,"PinId":"","FingerprinterData":"","Ke
ypadLoginCode":""}}

4.2.6.7 DelegateRemoved

CoCon API 24 Dec 2021 59/184

 Cocon for Plixus Core
API Module Plixus Core
DelegateRemoved  ☐

This event is sent if a delegate was removed from the database.

Name: DelegateRemoved

Parameters:

Name Description Type

DelegateId The Id of the delegate int

REST/JON Example:
{“DelegateRemoved”:{“DelegateId”:12 }}

4.2.6.8 DelegateSeatingUpdated

Cocon for Plixus Core

API Module Plixus Core
DelegateSeatingUpdated  ☐

This event is sent to all API clients when the delegate seating is changed (a delegate is added to or removed
from a seat).
{“DelegateSeatingUpdated”:[{“DelegateId”:1, “SeatId”:1}, {“DelegateId”:2, “SeatId”:0}]}

Parameters:
Name Description Type

DelegateId The id of the delegate int

The id of the seat.
SeatId 0 means that this delegate was not positioned int
on a seat yet

4.2.6.9 DelegatesInMeetingUpdated

Cocon for Plixus Core

API Module Plixus Core
DelegatesInMeetingUpdated  ☐

This event is sent if something changed to the list of delegates in a meeting (delegate added to or removed from
meeting.
Please note that we do not send the new list of delegates in the meeting. API clients that are interested in the
change, can request this list with “GetDelegatesInMeeting”.
{“DelegatesInMeetingUpdated”:{“MeetingId”:25}}

CoCon API 24 Dec 2021 60/184

4.2.7 Interactive

This section describes commands that are only applicable for the Televic Plixus MME.

4.2.7.1 ScreenLockRemoved

Cocon for Plixus Core

API Module Plixus Core
ScreenLockRemoved  ☐

The screen lock on the uniCOS has been removed

Name: ScreenLockRemoved

REST/JON Example:
{“ScreenLockRemoved” : true}

4.2.7.2 DelegateScreenSetChanged

Cocon for Plixus Core

API Module Plixus Core
DelegateScreenSetChanged  ☐

The screen on the Multimedia Unit changed event

Name: DelegateScreenSetChanged

Parameters:

Name Description Type

IsLocked Lock state of uniCOS Bool

IsGoTo Whether changed to the screen Bool

IsShow Show or hide the screen Bool

Screens on the uniCOS:
None
Home
Discussion
Agenda
Delegates
Screen Voting string
Documents
Messages
Web
Services
Configuration

Option Options for the screen ScreenControlOptions

REST/JON Example:
{“DelegateScreenSetChanged” : {“IsLocked”
false,“IsGoTo”:true,“IsShow”:true,“Screen”:“Agenda”,“Option”:{“selact”:true} }}

Example 2: (With additional parameter of video stream)

CoCon API 24 Dec 2021 61/184

{"DelegateScreenSetChanged":{"IsLocked":false,"IsGoTo":true,"IsShow":true,"Screen":"Discussion","Option":{"v
ideo":1,"stream":1}}}

4.2.7.3 CustomButtonEvent

Cocon for Plixus Core

API Module Plixus Core
CustomButtonEvent  ☐

This event is generated when the custom button is pushed or released.

REST/JON Example:
{“CustomButtonEvent” : {“SeatId”: 5, “ButtonId”:1, “Event”: “down”}}

4.2.7.4 ServiceRequestEvent

Cocon for Plixus Core

API Module Plixus Core
ServiceRequestEvent  ☐

This event is generated on service requested from Multimedia units.

REST/JON Example:
{"ServiceRequestEvent":{"SeatId":2,"ServiceId":1,"ServiceState":1}}

4.2.8 Audio

4.2.8.1 SetAudioSoftwareConfigurationById

Cocon for Plixus Core

API Module Plixus Core
SetAudioSoftwareConfigurationById  

Update event come from the Service & ERS for the SetAudioSoftwareConfigurationById active preset.

REST/JON Example:

>>>{"SetAudioSoftwareConfigurationById":{"AudioSoftwareConfiguration":{"Description":"Incoming audio from

microphone, auxiliary inputs 1, 2 & 3 and Dante input channel 1 is routed by default to the unit speakers,
auxiliary outputs 1, 2 & 3 and Dante output channel 1.","Id":1,"Name":"Normal
routing","Predefined":true,"State":"Active"}}}

4.2.8.2 CurrentAudioSoftwareConfigurationUpdated

Cocon for Plixus Core

API Module Plixus Core
CurrentAudioSoftwareConfigurationUpdated  

Update event come from the Server for the volume change for node in active preset.

REST/JON Example:
"CurrentAudioSoftwareConfigurationUpdated":1}

CoCon API 24 Dec 2021 62/184

4.2.9 Logging

4.2.9.1 ConnectionLost_CentralUnit

Cocon for Plixus Core

API Module Plixus Core
Connection_CentralUnit  ☐

Lost central unit connection message

Name: Connection_CentralUnit

Parameters:

Name Description Type

The state of the connection
State Connected string
Disconnected

REST/JON Example:
{"Connection_CentralUnit":{"State":<State>}}
{"Connection_CentralUnit":{"State":"Disconnected"}}

4.2.9.2 ConnectionLost_Database

Cocon for Plixus Core

API Module Plixus Core
Connection_Database  ☐

CoCon and database connection state

Name: Connection_Database

Parameters:

Name Description Type

The state of the connection
State Connected string
Disconnected

REST/JON Example:
{"Connection_Database":{"State":<State>}}

CoCon API 24 Dec 2021 63/184

4.2.10 ButtonLED_Event
Events from CoCon Server to API clients can only be sent after the buttons have been enabled, using the
command “SetButtonsEnabled”, described in section 4.3.11.1.

4.2.10.1 ButtonPressed
Cocon for Plixus Core
API Module Plixus Core
ButtonPressed  

A button was pressed on a unit.

Name: ButtonPressed

Parameters:

Name Description Type

The number of the seat on which a button
SeatNr was pressed. int

The number of the button which was

pressed
Possible values: 1-5, depending on the
possibilities of the delegate units.
ButtonNr int
For example: delegate units with 3
buttons only have buttons 2-3-4

REST/JSON Example:
{"ButtonPressed":{"SeatNr":2;”ButtonNr”:3}}

4.2.10.2 NextButtonPressed

Cocon for Plixus Core

API Module Plixus Core
NextButtonPressed  

Next button was pressed on a seat (unit).

Name: NextButtonPressed

Parameters:

Name Description Type

UnitId The seat Id int

REST/JSON Example:
{"NextButtonPressed":{"UnitId":2}

Important note: the return values mentions identifier “UnitId” however the number returned refers to the Seat Id.

CoCon API 24 Dec 2021 64/184

4.2.10.3 PriorButtonPressed

Cocon for Plixus Core

API Module Plixus Core
PriorButtonPressed  

Prior button was pressed on a seat (unit).

Name: PriorButtonPressed

Parameters:

Name Description Type

UnitId The seat Id int

REST/JSON Example:
{"PriorButtonPressed":{"UnitId":2}

Important note: the return values mentions identifier “UnitId” however the number returned refers to the Seat Id.

CoCon API 24 Dec 2021 65/184

4.2.11 Interpretation

4.2.11.1 IMicrophoneStateUpdated

Cocon for Plixus Core

API Module Plixus Core
IMicrophoneStateUpdated  

This function contain the microphone state changed events, channel changed events based on the desk.
Description:
When a microphone event of the ID s happens CoCon sends an update of the realtimedata. This contains all
the ID microphone statuses. This is not required. Only send the information of the microphone unit that was
changed.
Note:
Not necessary to subscribe to this module. It will send 3rdpart API based on the interpreter licensed
mode. And
MIC state: 0 = ON && 2 = OFF.
Ex.
{"IMicrophoneStateUpdated":{"Order":2,"Language":"French","Booth":"2","Desk":1, “Micstate”:0}}

4.2.11.2 IActivatedChannelUpdated

Cocon for Plixus Core

API Module Plixus Core
IActivatedChannelUpdated  

These events receive by API once the any channel updated on Interpreter desk.
Note:
A/B/C channel index: 0: Active channel A, 1: active channel B and 2 : active channel C (Interpreter Desk
output channel)

Ex: {"IActivatedChannelUpdated ":{"Order":2,"Language":"French","Booth":"2","Desk":1, “ActiveChannel”:0}}

4.2.11.3 SpeakSlowerRequest

Cocon for Plixus Core

API Module Plixus Core
SpeakSlowerRequest  

This event is sent when an interpreter has pressed the slow-down button on his unit.

Note: Speak Slow function should be enabed for receiving notification.

Parameters:
Name Description Type

UnitId The unit’s Id Int

Booth Booth id Int

Desk Desk id in the booth int

Return:
{"SpeakSlowerRequest":{"UnitId":8}}

CoCon API 24 Dec 2021 66/184

4.2.11.4 SpeakSlowerEnded

Cocon for Plixus Core

API Module Plixus Core
SpeakSlowerEnded  

These events receive by API once speak slower ended.

Return:
{"SpeakSlowerEnded":{"UnitId":8}}

4.2.11.5 ActivePresetStateChanged

Cocon for Plixus Core

API Module Plixus Core
ActivePresetStateChanged  

Received event once the active pre-set has been changed.

Note: Bool value received (True : active pre-set has changed.)
Ex: {ActivePresetStateChanged":"true"}

4.2.12 Rocording ( AE-R & Plixus Core only)

Notification for the recording module.

4.2.12.1 RecordingStatusUpdate

Cocon for Plixus Core

API Module Plixus Core
WcapInfoUpdated  

Notify the status change of the recording.

Return: string
{"RecordingStateUpdated":{"RecordingState":"idle"}}

CoCon API 24 Dec 2021 67/184

4.2.13 Wireless Coupling

Notification from the WCAP to rest api user.

4.2.13.1 WcapInfoUpdated

Cocon for Plixus Core

API Module Plixus Core
WcapInfoUpdated  

Notification for the update from WCAP.

Return: string
{"WcapInfoUpdated":{"chans":[],"cpld":1,"gtw":"192.168.8.1","hn":"admin","ipa":"192.168.8.210","mac":"1C:BA:8
C:99:FE:81","online":1,"op_mode":1,"reg":"Europe","sbm":"255.255.255.0","serial":352321544,"wlist":[]}}

4.2.13.2 WcapCoupledUpdated
Cocon for Plixus Core
API Module Plixus Core
WcapCoupledUpdated  

Notification for the update of WCAP coupling from WCAP.

Return: string
{"WcapCoupledUpdated":{"CoupledMode":true,"WcapSerial":352321544}}

4.2.13.3 AllWcapInfoUpdated
Cocon for Plixus Core
API Module Plixus Core
AllWcapInfoUpdated  

Notification for the update of all WCAP coupling from WCAP.

Return: string
{"AllWcapInfoUpdated":[{"chans":[],"cpld":1,"gtw":"192.168.8.1","hn":"admin","ipa":"192.168.8.210","mac":"1C:B
A:8C:99:FE:81","online":1,"op_mode":0,"reg":"Europe","sbm":"255.255.255.0","serial":352321544,"wlist":[35343
6539,353436545,353436622]}]}

CoCon API 24 Dec 2021 68/184

4.2.14 Operator Customization

Notification from custom buttons to rest api user. Note that these events only can be triggered in case a license
for the Operator Customization module is available.

4.2.14.1 CustomButtonPressed

Cocon for Plixus Core

API Module Plixus Core
CustomButtonPressed  ☐

Return: string
{"CustomButtonPressed":{"Id":1,"Text":"Button1"}}

CoCon API 24 Dec 2021 69/184

4.3 Client to server
For those methods that do not explicitly return a result (usually the methods starting with “Set”), the following
return values are used:
• 0: Command was successfully executed.
• 1: parameter or value passed in the API call was wrong. See the CoCon Server log file for more details.
• -1: Exception occurred on the CoCon API side. See the CoCon Server log file for more details.

4.3.1 General

4.3.1.1 Connect

Cocon for Plixus Core

API Module Plixus Core
Connect  

This is the first URI that has to be sent to initiate the API connection.

Structure:
http://localhost:8890/CoCon/Connect

Parameters: N/A

Example:
http://localhost:8890/CoCon/Connect

Return: {"Connect":<bool>;"id":"<id>"}
{"Connect":true,"id":"970196c9-6f6c-4601-b7d7-f27b1d591bc5"

4.3.1.2 Disconnect

Cocon for Plixus Core

API Module Plixus Core
Disconnect  ☐

This is the first URI that has to be sent to disconnect the API connection. Note however that the main principle
should not require a disconnect. In most cases, an API connected is setup and events are being continuously
received.

Structure:
http://localhost:8890/CoCon/Disonnect/?Id={Id}

Parameters: connection id

Example:
http://localhost:8890/CoCon/Disconnect/?Id=970196c9-6f6c-4601-b7d7-f27b1d591bc5

Return:
0 : OK
1 : Invalid ID or no API client found (please check parameters)

CoCon API 24 Dec 2021 70/184

4.3.1.3 Subscribe

4.3.1.4 Unsubscribe

Cocon for Plixus Core

API Module Plixus Core
Subscribe/ UnSubscribe  

Subscribe and Unsubscribe are the subscribe/publish mode of our system, by default, once connected to
CoCon the client subscribe all modes of cocon, include: Microphone, meetingAgenda, Voting, Timer, Delegate,
Audio, Logging.

Structure:
http://localhost:8890/CoCon/Subscribe/?Model={model}&id={id}&details={bool}
http://localhost:8890/CoCon/Unsubscribe/?Model={model}&id={id}

Parameters:
Name Description Type
The mode that want to subscribe/Unsubscribe
Room
Microphone
MeetingAgenda
Voting
Timer
Delegate
Model Audio string
Interpretation
Logging
ButtonLED_Event
Interactive
External
Intercom
Video
Id The id that is returned by connection String
To get all update events information in details
Details *Optional parameter. bool
Default value is true

Example:
http://localhost:8890/CoCon/Subscribe/?Model=Microphone&id=5a44aed8-e257-4b21-9240-efdd72bf866d
http://localhost:8890/CoCon/Unsubscribe/?Model=Microphone&id=a372c5d5-a5ce-4c3a-b401-53d6cd85dbeb

Return: {"Subscribe":{"Model":"Microphone","result":true,"details":true}}
{"UnSubscribe":{"Model":"Microphone","result":true}}

4.3.1.5 Notification

Cocon for Plixus Core

API Module Plixus Core
Notification  

Get notification from CoCon, this request should keep asking the CoCon.

Structure:
http://localhost:8890/CoCon/Notification/id={id}

CoCon API 24 Dec 2021 71/184

Parameters:
Name Description Type

id The id that is returned by connection string

Example:
http://localhost:8890/CoCon/Notification/id=5a44aed8-e257-4b21-9240-efdd72bf866d

Return:
without connection: {"Notification" : "Error 400"}
with connection {"EventName": Event Value}
with connectin "{"Notification" : "Error 408"}"

4.3.1.6 RebootSystem

Cocon for Plixus Core

API Module Plixus Core
RebootSystem  ☐

Reboot the CPU.

http://localhost:8890/CoCon/RebootSystem
Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 72/184

4.3.2 Room

4.3.2.1 GetRoomServerName
Cocon for Plixus
API Module Plixus Core Core
GetRoomServerName  ☐

Get the name of the current room server

Structure:
http://localhost:8890/CoCon/Room/GetRoomServerName

Example:
http://localhost:8890/CoCon/Room/GetRoomServerName

Return:
{"GetRoomServerName":{"Name":"Isha Test 250 API"}}

4.3.2.2 GetActiveRoomInfo

Cocon for Plixus Core

API Module Plixus Core
GetActiveRoomInfo  

Get the current room information from the room server.

Structure:
http://192.168.8.126:8890/CoCon/Room/GetActiveRoomInfo

Example:
http://192.168.8.126:8890/CoCon/Room/GetActiveRoomInfo

Return:
CoCon for Core :

{"GetActiveRoomInfo":{"ActiveRoom":{"RoomId":1,"Name":"CoCon 5.3.2.23
(230)","CoConServerVersion":"5.4.0.14","CRPVersion":"5.4.10","DBName":"LOCALHOSTSQLEXPRESS"}}}
Note: RoomId is CoCon DB Room Id.

Plixus Core :

{"GetActiveRoomInfo":{"ActiveRoom":{"RoomId":1}}}
Note: RoomId: active room on Plixus.

4.3.2.3 GetStatusOfCuAndDbConnection

Cocon for Plixus Core

API Module Plixus Core
GetStatusOfCuAndDbConnection  ☐

CoCon API 24 Dec 2021 73/184

Get the status of the CU connection and DB connection.

Structure:
http://localhost:8890/CoCon/Room/GetStatusOfCuAndDbConnection

Example:
http://localhost:8890/CoCon/Room/GetStatusOfCuAndDbConnection

Return:
{"GetStatusOfCuAndDbConnection":{"CuState":"Connected","DbState":"Connected"}}

4.3.2.4 SetInitializationState

Cocon for Plixus Core

API Module Plixus Core
SetInitializationState  

Set the initialization state.

Structure:
http://localhost:8890/CoCon/Room/SetInitializationState/?State={state}

Parameters:
Name Description Type
The initialization will be set.
The state could be like:
Reset(Manual init completely)
State Auto(Auto init compeletely)
string
Stop
Retrieve

Note:
Only “Reset” and “Stop” working in Cocon for Plixus Core and Plixus Core

Example:
http://localhost:8890/CoCon/Room/SetInitializationState/?State=Auto

Return:
0 : ok
-1: exception at CoCon side
1 : exception at 3rd party side.(please check parameters)

4.3.2.5 GetAllUnitsState

Cocon for Plixus Core

API Module Plixus Core
GetAllUnitsState  

Get all units state which is initialized in CoCon.

Parameters:
Name Description Type
The connected room id on CoCon DB.
Roomid int

Return State ： 0 = unit is offline 1 = unit is online.

Structure:
http://localhost:8890/CoCon/Room/GetAllUnitsState/?RoomId={roomId}

CoCon API 24 Dec 2021 74/184

 Example:
http://localhost:8890/CoCon/Room/GetAllUnitsState/?RoomId=1

Return by events:
{"GetAllUnitsState":{"Units":[{"State":1,"UnitId":0},{"State":1,"UnitId":1},{"State":1,"UnitId":2},{"State":1,"UnitId":
3}]}}

4.3.2.6 SetDefaultVolumeForRoom

Cocon for Plixus Core

API Module Plixus Core
SetDefaultVolumeForRoom  
Set default volume on CU.

Parameters:
Name Description Type
The connected room on CU (1)
Room int

Volume The number of volume (0-25) int

Return value: int
Structure:
http://localhost:8890/CoCon/Room/SetDefaultVolumeForRoom/?Room={roomNr}&Volume={volume}

Example:
http://localhost:8890/CoCon/Room/SetDefaultVolumeForRoom/?Room=1&Volume=24

Return by events:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

Update event :
{"VolumeChangedForRoom":{"Id":1,"Volume":24}}

4.3.2.7 GetDefaultMicrophoneModeForRoom

Cocon for Plixus Core

API Module Plixus Core
GetDefaultmicrophoneModeForRoom  ☐

Get default mic mode for the active room.

Structure:
http://localhost:8890/CoCon/Room/GetDefaultmicrophoneModeForRoom

Example:
http://localhost:8890/CoCon/Room/GetDefaultmicrophoneModeForRoom

Return by events:

{"GetDefaultMicrophoneModeForRoom":{"MicrophoneMode":{"AllowCancelRequest":true,"AllowSwitchOffMic":tr
ue,"FIFO":true,"MaxNrActive":1,"Mode":"DirectSpeak","ReplyRequest":false}}}

CoCon API 24 Dec 2021 75/184

4.3.2.8 SetDefaultMicrophoneModeForRoom

Cocon for Plixus Core

API Module Plixus Core
SetDefaultmicrophoneModeForRoom  

Set the default microphone mode for the room.

Parameters:
Name Description Type
The Mode of microphone
Operator
DirectSpeak
Request
Mode Vox (Cocon 5.0 :Vox become activation type
string
with Groupdiscussion.)
OnlyRequest

MaxNrActive The maximum number of active microphone int

bool indicating whether the delegates are
AllowRequest allowed to request.
Not applicable for all modes. bool
Optional

bool indicating whether the delegates are

allowed to cancel their request.
AllowCancelRequest Not applicable for all modes. bool
Optional

bool indicating whether the FIFO mode is

active
FIFO Not applicable for all modes. bool
Optional

bool indicating whether delegates can switch

AllowSwitchOffMic off their own microphones. bool
Optional

Structure:
Basic structure:
http://localhost:8890/CoCon/Room/SetDefaultMicrophoneModeForRoom/?Mode={mode}&MaxNrActive={MaxNr
Active}

Optional structure:
http://localhost:8890/CoCon/Room/SetDefaultMicrophoneModeForRoom/?Mode={mode}&
MaxNrActive={maxNrActive}&AllowRequest={allowRequest}&AllowCancelRequest={allowCancelRequest}&
FIFO={IsFIFO}&AllowSwitchOffMic={allowSwitchOffMic}

Example:
http://localhost:8890/CoCon/Room/SetDefaultmicrophoneModeForRoom/?Mode=DirectSpeak&MaxNrActive=4
& AllowRequest=False&AllowCancelRequest=False&AllowSwitchOffMic=True&FIFO=true

Return by events:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 76/184

4.3.2.9 SetVolumeForRoom

Cocon for Plixus Core

API Module Plixus Core
SetVolumeForRoom  

Set volume on CU. This will be temp; once the CU re-start it will back as default value.

Parameters:
Name Description Type
The connected room on CU (1)
Room int

Volume The number of volume (0-25) int

Return value: int

Structure:
http://localhost:8890/CoCon/Room/SetVolumeForRoom/?Room={roomNr}&Volume={volume}

Example:
http://localhost:8890/CoCon/Room/SetVolumeForRoom/?Room=1&Volume=24

Return by events:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.2.10 AddSynoptic

Cocon for Plixus Core

API Module Plixus Core
AddSynoptic  ☐

Add new synoptic to current active room.

Note : It will only create new Synoptic if no any synoptic in active room.

Structure:
http://localhost:8890/CoCon/Room/AddSynoptic

Example:
http://localhost:8890/CoCon/Room/AddSynoptic

Return by events: string

{"AddSynoptic":{"RoomSynoptic":{"SynopticId":2,"SynopticName":"Manoj T2_1","IsMaster":true}}}

CoCon API 24 Dec 2021 77/184

4.3.2.11 GetSynoptic

Cocon for Plixus Core

API Module Plixus Core
GetSynoptic  ☐

Retrieves information (including seat position and label) regarding room synoptics

Parameter:
Name Description Type

SynopticId Synoptic identifier (optional) int

Structure:
http://localhost:8890/CoCon/Room/GetSynoptic/?SynopticId={synopticId}

Example:
http://localhost:8890/CoCon/Room/GetSynoptic/?SynopticId=4

Return by events: string

{"GetSynoptic":{"RoomSynoptic":[{"SynopticId":4,"SynopticName":"Allen","IsMaster":false,"SynopticNode":[
{"SeatId":"2","X":273.0,"Y":306.0,"Lable":"Node"},{"SeatId":"3","X":534.0,"Y":203.0,"Lable":"Node"},{"SeatId":"5",
"X":179.0,"Y":219.0,"Lable":"Node"}]}]}}

4.3.2.12 GetAllSeats

Cocon for Plixus Core

API Module Plixus Core
GetAllSeats  

Get all seats from the Room.

Structure:
http://localhost:8890/CoCon/Room/GetAllSeats/?RoomId={roomId}

Example:
http://localhost:8890/CoCon/Room/GetAllSeats/?RoomId=1

Return by events: string

{"GetAllSeats":{"Seats":[{"IsChairMan":false,"SeatId":"0","SeatName":"Seat_0","UnitId":"0"},{"IsChairMan":false
,"SeatId":"1","SeatName":"Seat_1","UnitId":"1"},{"IsChairMan":true,"SeatId":"2","SeatName":"Seat_2","UnitId":"
2"},{"IsChairMan":false,"SeatId":"3","SeatName":"Seat_3","UnitId":"3"}]}}

CoCon API 24 Dec 2021 78/184

4.3.2.13 GetBooths

Cocon for Plixus Core

API Module Plixus Core
GetBooths  

Get all boot inform from the current room.

Structure:
http://localhost:8890/CoCon/Room/GetBooths

Example:
http://localhost:8890/CoCon/Room/GetBooths

Return:

{"GetBooths":{"Booths":[{"Order":1,"Units":[{"UnitId":1}]}]}}

4.3.2.14 EditSeat

Cocon for Plixus Core

API Module Plixus Core
 
Note: Not all Note: Not all
options are options are
implemented, implemented,
chairman chairman should
should work work
EditSeat

This api call will allow user to edit seat properties based on the seat number.
Note: After edit seat, user should have to send the SaveRoomConfig command to make sure modification take
correct action.

Parameters:
Name Description Type

SeatNumber Existing seat number from the active room. int

Is intercom is enabled for the seat
Intercom (True/ False)
bool

Description Description String

Change seat priority
IsChairMen (True/False)
bool

Return value: string

Structure:
http://localhost:8890/CoCon/Room/EditSeat/?SeatNumber={seatNumber}&Intercom={isIntercom}&Description={
description}&IsChairMan={IsChairMan}

Example:
http://localhost:8890/CoCon/Room/EditSeat/?SeatNumber=3&Intercom=True&Description=hi&IsChairMan=True

Return by events: string

{"EditSeat":{"SeatId":3,"SeatName":"Seat
3","Description":"hi","UnitId":"","Type":"","IsIntercom":true,"IsChairman":true}}

1: for fail / Exception string in log.

CoCon API 24 Dec 2021 79/184

4.3.2.15 GetAllUnits

Cocon for Plixus Core

API Module Plixus Core
GetAllUnits  

Get all Units from the CU.

Parameters:
Name Description Type
The type of units to retrieve from the CU (e.g. IDesk)
Type Optional string

Returns: String.
Note:
- return 1 if a) no database or b) no room
- return an empty list in case no units in room (but there is a database and a room)
- return list of units --> normal case

Structure:
http://localhost:8890/CoCon/Room/GetAllUnits

Example:
http://localhost:8890/CoCon/Room/GetAllUnits

Return by events:
{"GetAllUnits":{"Units":[{"RoomId":1,"SystemUnitId":1,"SerialNumber":"15200241","UnitType":"Plixus
NE"},{"RoomId":1,"SystemUnitId":2,"SerialNumber":"153a003d","UnitType":"Confidea T Delegate
Unit"},{"RoomId":1,"SystemUnitId":3,"SerialNumber":"15511567","UnitType":"Confidea F-
CS"},{"RoomId":1,"SystemUnitId":4,"SerialNumber":"141a0007","UnitType":"uniCOS
F/MM"},{"RoomId":1,"SystemUnitId":5,"SerialNumber":"161a0004","UnitType":"uniCOS F/MM
10""},{"RoomId":1,"SystemUnitId":6,"SerialNumber":"157b034f","UnitType":"Confidea F-
DIVC"},{"RoomId":1,"SystemUnitId":7,"SerialNumber":"157b002d","UnitType":"Confidea F-
DIVC"},{"RoomId":1,"SystemUnitId":8,"SerialNumber":"14200197","UnitType":"Lingua ID"}]}}

4.3.2.16 SetOperatingMode

Cocon for Plixus Core

API Module Plixus Core
SetOperatingMode  

Set Operating mode for CU.

Note: On set operating mode need to stop the init by calling “ Room/SetInitializationState/?State=Stop” on the
necessary mode.
Ex. If user send this call “Room/SetOperatingMode/?Mode=3&Append=False” they have to send the stop init
call to stop the init and it will update the CoCon DB.

Parameters:
Name Description Type
Set the Config mode (0 to 4)

Mode 0 -> default int

1 -> open_access

CoCon API 24 Dec 2021 80/184

 2 -> from_config (If Append is true and
ConfigName is empty, it will just load the
current configuration again)
3 -> auto_init
4 -> man_init

Append Set append mode bool

ConfigName Set the description of the configuration string

Returns: int.

Structure:
http://localhost:8890/CoCon/Room/SetOperatingMode/?Mode={mode}&Append={bAppend}&ConfigName={conf
igName}

Example:
http://localhost:8890/CoCon/Room/SetOperatingMode/?Mode=3&Append=True
Or
http://localhost:8890/CoCon/Room/SetOperatingMode/?Mode=3&Append=True&ConfigName=XYZ

Return by events: int

0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.2.17 GetOperatingMode

Cocon for Plixus Core

API Module Plixus Core
GetOperatingMode  
Get Operating mode from CU

Structure:
http://localhost:8890/CoCon/Room/GetOperatingMode

Example:
http://localhost:8890/CoCon/Room/GetOperatingMode

Returns:
{"GetOperatingMode":{"OperatingInfo":{"Mode":2,"Append":true,"ConfigName":"Default Configuration"}}}

4.3.2.18 ClearAllMeetingAndDelegateData

Cocon for Plixus Core

API Module Plixus Core
ClearAllMeetingAndDelegateData  ☐

This API will clear the all meeting & Meeting template data as well as clear the Delegate list from DB.
Note: this api keep the room configuration as it is. (Ex. Synoptic & units etc.)

Structure:
http://localhost:8890/CoCon/Room/ClearAllMeetingAndDelegateData/?IncludeService={isIncludeService}

CoCon API 24 Dec 2021 81/184

Parameters:
Name Description Type
Service data can be keep or remove by
choice.
IncludeService True = clear service data bool
False = keep service related data.
(Optional Parameter)

Example:
http://localhost:8890/CoCon/Room/ClearAllMeetingAndDelegateData

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.2.19 SetSeatPriority

Cocon for Plixus Core

API Module Plixus Core
SetSeatPriority  ☐

This API allows to configure the priority for the seats in the room

Structure:
http://localhost:8890/CoCon/Room/SetSeatPriority/?SeatNumber={seatNumber}&Priority={priority}

Parameters:
Name Description Type

SeatNumber Seat id Int

Desired priority from list
Priority ‘Delegate’, ‘Vip’, ‘Chairman’
String

Example:
http://localhost:8890/CoCon/Room/SetSeatPriority/?SeatNumber=3&Priority=Vip

Return:
0 → operation success
1 → Operation fail (not valid value: non existing seat, invalid priority value)
-1 → exception

CoCon API 24 Dec 2021 82/184

4.3.3 Microphone

4.3.3.1 SetState

Cocon for Plixus Core

API Module Plixus Core
SetState  

Set the state of the microphone

Structure:
http://localhost:8890/CoCon/Microphone/SetState/?State={State}&SeatNr={seatNr}

Parameters:
Name Description Type
The state of microphone
On
Off
State Request
string
Toggle

seatNr The number of the seat int

Example:
http://localhost:8890/CoCon/Microphone/SetState/?State=On&SeatNr=1

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.3.2 SetMicrophoneMode

Cocon for Plixus Core

API Module Plixus Core
SetMicrophoneMode  

Set the mode of the microphone

Structure:
Basic structure:
http://localhost:8890/CoCon/Microphone/SetMicrophoneMode/?Mode={mode}&MaxNrActive={MaxNrActive}

Optional structure:
http://localhost:8890/CoCon/Microphone/SetMicrophoneMode/?Mode={mode}&MaxNrActive={maxNrActive}&
&AllowRequest={allowRequest}&AllowCancelRequest={allowCancelRequest}&FIFO={IsFIFO}&AllowSwitchOff
Mic={allowSwitchOffMic}

Parameters:
Name Description Type
The Mode of microphone
Operator
DirectSpeak
Request
Mode Vox (Cocon 5.0 :Vox become activation type
string
with Groupdiscussion.)
OnlyRequest

CoCon API 24 Dec 2021 83/184

 MaxNrActive The maximum number of active microphone int
bool indicating whether the delegates are
AllowRequest allowed to request.
Not applicable for all modes. bool
Optional

bool indicating whether the delegates are

allowed to cancel their request.
AllowCancelRequest Not applicable for all modes. bool
Optional

bool indicating whether the FIFO mode is

active
FIFO Not applicable for all modes. bool
Optional

bool indicating whether delegates can switch

AllowSwitchOffMic off their own microphones. bool
Optional

Example:
http://localhost:8890/CoCon/Microphone/SetMicrophoneMode/?Mode=OnlyRequest&MaxNrActive=4&AllowReq
uest=False&AllowCancelRequest=False&AllowSwitchOffMic=True

Return by events:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.3.3 SetActivationType

Cocon for Plixus Core

API Module Plixus Core
SetActivationType  

Set activation type is used for the change the microphone activation type available on the current microphone
mode.
Structure:
http://localhost:8890/CoCon/Microphone/SetActivationType/?ActivationType={activationType}

Parameters:
Name Description Type
Optional
User can set the activation type base on the
active mic mode.
ActivationType Ex: Direct speaker :”Push Or Toggle”
string
Request(Group discussion) : “Push Or Toggle
Or Vox”.
Example:
http://192.168.8.250:8890/CoCon/Microphone/SetActivationType/?ActivationType=Toggle

Return by events:
Int: 0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.3.4 SetMicrophoneSensitivity

CoCon API 24 Dec 2021 84/184

 Cocon for Plixus Core
API Module Plixus Core
SetMicrophoneSensitivity  

Set microphone sensitivity for the seat (Microphone).

Structure:
http://localhost:8890/CoCon/Microphone/SetMicrophoneSensitivity/?SeatId={seatId}&Sensitivity={sensitivity}

Parameters:

Name Description Type

The number of the seat
SeatId int
Value of the sensitivity
Range of value
Sensitivity int
+12 to -12
Ex. (12,11,10,9…-10,-11,-12)

REST/JON Example:
http://localhost:8890/CoCon/Microphone/SetMicrophoneSensitivity/?SeatId=1&Sensitivity=0

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 85/184

4.3.3.5 Get

Cocon for Plixus Core

API Module Plixus Core
Get  

Get all information of Cocon

Structure:
http://localhost:8890/CoCon/Microphone/Get

Example:
http://localhost:8890/CoCon/Microphone/Get

Return:
{“Get” : {“MicrophoneMode” : {“Mode” : “Operator”, “MaxNrActive” : 4}, “State” : {“Speakers”: [], “Requests” :
[],"Replies":[]}}}

{"Get":{"MicrophoneMode":{"MaxNrActive":4,"Mode":"Request"},"State":{"Requests":[],"Speakers":[]}}}

4.3.3.6 GetState

Cocon for Plixus Core

API Module Plixus Core
GetState  

Get all microphones state of CoCon

Structure:
http://localhost:8890/CoCon/Microphone/GetState

Example:
http://localhost:8890/CoCon/Microphone/GetState

Return:
{"GetState":{"State":{"Speakers":[5],"Requests":[4],"Replies":[]}}}

4.3.3.7 ClearMicrophoneList

Cocon for Plixus Core

API Module Plixus Core
ClearMicrophoneList  

Clear microphone list.

Structure:
http://localhost:8890/CoCon/Microphone/ClearMicrophoneList/?Type={type}

Parameters:
Name Description Type
SpeakersAndRequests (Include Chiarman)
Type Speakers (not Include chairman) string
Requests

Example:
http://localhost:8890/CoCon/Microphone/ClearMicrophoneList/?Type=SpeakersAndRequests

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 86/184

4.3.3.8 GetMicrophoneMode

Cocon for Plixus Core

API Module Plixus Core
GetMicrophoneMode  

Get microphone mode of CoCon

Structure:
http://localhost:8890/CoCon/Microphone/GetMicrophoneMode

Example:
http://localhost:8890/CoCon/Microphone/GetMicrophoneMode

Return:

{"GetMicrophoneMode":{"MicrophoneMode":{"AllowCancelRequest":true,"AllowSwitchOffMic":true,"FIFO":true,"
MaxNrActive":4,"Mode":"Request","ReplyRequest":false}}}

4.3.3.9 GetActivationType

Cocon for Plixus Core

API Module Plixus Core
GetActivationType  

Get activation type used for changing the microphone activation.

Structure:
http://localhost:8890/CoCon/Microphone/GetActivationType

Example:
http://192.168.8.250:8890/CoCon/Microphone/GetActivationType

Return:
{\"GetActivationType\":{\"ActivationType\":\"Toggle\"}}

4.3.3.10 ActivateNextMicrophone

Cocon for Plixus Core

API Module Plixus Core
ActivateNextMicrophone  

Activate the next microphone in the request list

Structure:
http://localhost:8890/CoCon/Microphone/ActivateNextMicrophone

Example:
http://localhost:8890/CoCon/Microphone/ActivateNextMicrophone

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 87/184

4.3.4 Meeting_Agenda

4.3.4.1 SetMeetingState

Cocon for Plixus Core

API Module Plixus Core
SetMeetingState  ☐

Set the state of selected meeting

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/SetMeetingState/?State=<State>&MeetingId=<MeetingId>

Parameters:
Name Description Type
The state of meeting
Running
State Ended
string
Paused
MeetingId The id of the meeting int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/SetMeetingState/?State=Running&MeetingId=8

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.2 StartEmptyMeeting

Cocon for Plixus Core

API Module Plixus Core
StartEmptyMeeting  ☐

Start an empty meeting directly

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/StartEmptyMeeting/?Title=<meetingTitle>&From=<meetingFrom>
&To=<meetingTo>&LoginMethod=<loginMethod>

Parameters:
Name Description Type

Title The title of the empty meeting string

The time of the meeting to be started
From (the time must be a future time)
DateTime
The time of the meeting to be finished
To (the time must be after From time)
DateTime
(Option field)
Default login method = 2
LoginMethod 0 = Fixed seat + insert Badge int
1 = Fixed seat ignore badge.
2 = Free seat meeting.

Example:
http://localhost:8890/CoCon /Meeting_Agenda/StartEmptyMeeting/?Title=This is a empty
meeting&From=2017/6/5 00:00:00&To=2017/6/5 00:10:00&LoginMethod=1

CoCon API 24 Dec 2021 88/184

Return:
{"StartEmptyMeeting":{"Result":true,"MeetingId":23,"MeetingTitle":"This is a empty
meeting","NewMeetingFrom":"2021/02/04 00:09:00","NewMeetingTo":"2021/10/28 00:10:00","LoginMethod":2,
"AuthenticationType":3, "AuthenticationMode":1}}

4.3.4.3 GetMeetingsForToday

Cocon for Plixus Core

API Module Plixus Core
GetMeetingsForToday  ☐

Return all meeting scheduled for today

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetMeetingsForToday

Example:
http://localhost:8890/CoCon/Meeting_Agenda/GetMeetingsForToday

Return:
{"GetMeetings":{"Meetings":[{"Id":1,"Title":"Fixed seat metign ","Description":"Fixed seat metign
","StartTime":"2018/12/10 10:18:32","State":"Ended","Nameplate_Layout":null},{"Id":3,"Title":"Title
hjhhj","Description":"","StartTime":"2018/12/10
13:49:47","State":"Ended","Nameplate_Layout":null},{"Id":4,"Title":"This is a empty
meeting","Description":"","StartTime":"2018/12/10 13:52:32","State":"Running","Nameplate_Layout":""}]}}

4.3.4.4 GetAllMeetingsForDate

Cocon for Plixus Core

API Module Plixus Core
GetAllMeetingsForDate  ☐

Return all the meetings for a period of 24 hours after the given Date/Time combination
Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetAllMeetingsForDate/?Time=<Time>
Time format : YYYY/MM/DD HH:mm:ss
Note that the HH:mm:ss can be omitted to retrieve all the meetings taking place on the given date.

Example:
http://localhost:8890/CoCon/Meeting_Agenda/GetAllMeetingsForDate/?Time=2018/06/08

Return:
{"GetMeetings":{"Meetings":[{"Id":2,"Title":"This is a empty meeting","Description":"","StartTime":"2018/12/10
13:52:17","State":"Running","Nameplate_Layout":""}]}}

Parameters:
Name Description Type

Time The date time (YYYY/MM/DD HH:mm:ss) DateTime

4.3.4.5 GetMeetingById

Cocon for Plixus Core

API Module Plixus Core
GetMeetingById  ☐

CoCon API 24 Dec 2021 89/184

Returns the meeting identified by the certain MeetingId.
Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetMeetingById/?MeetingId=<MeetingId>

Parameters:
Name Description Type

MeetingId The id of the meeting to get int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/GetMeetingById/?MeetingId=497

Return:
{"GetMeeting":{"Meeting":{"Id":497,"Title":"Title dtrte","Description":"","StartTime":"2017/08/29
12:53:47","State":"Ended"}}}

{"GetMeeting":{"Meeting":{"Id":2,"Title":"This is a empty meeting","Description":"","StartTime":"2018/12/10

13:52:17","State":"Running","Nameplate_Layout":""}}}

4.3.4.6 SetActiveAgendaItemByDirection

Cocon for Plixus Core

API Module Plixus Core
SetActiveAgendaItemByDirection  ☐

Active agenda item by next and previous command

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/SetActiveAgendaItemByDirection/?Direction=<Direction>

Parameters:
Name Description Type
The direction of active agenda item
Direction Next string
Previous

Example:
http://localhost:8890/CoCon/Meeting_Agenda/SetActiveAgendaItemByDirection/?Direction=Next

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.7 SetActiveAgendaItemById

Cocon for Plixus Core

API Module Plixus Core
SetActiveAgendaItemById  ☐

Active agenda item by Id of the agenda item

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/SetActiveAgendaItemById/?Id=<Id>

Parameters:

CoCon API 24 Dec 2021 90/184

 Name Description Type

Id The Id of the agenda item to activate string

Example:
http://localhost:8890/CoCon/Meeting_Agenda/SetActiveAgendaItemById/?Id=3

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.8 GetAgendaItemInformationInRunningMeeting

Cocon for Plixus Core

API Module Plixus Core
GetAgendaItemInformationInRunningMeeting  ☐

Get all the agenda item information in running meeting

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetAgendaItemInformationInRunningMeeting

Example:
http://localhost:8890/CoCon/Meeting_Agenda/GetAgendaItemInformationInRunningMeeting

Return: string
Reply with the all agenda in running meeting.

{"GetAgendaItemInformationInRunningMeeting":{"AgendaItems":[{"Id":"1","Title":"Test Discussion
1","Description":"Test Discussion
1","Type":"AgendaItem","State":"notstarted","IdInDb":16,"Children":[]},{"Id":"2","Title":"Test Voting
1_3_Vote_Public","Description":"Test Voting
1_3_Vote_Public","Type":"VotingAgendaItem","State":"active","VotingOptions":[{"Id":45,"Name":"","Color":"#FF0
08000"},{"Id":46,"Name":"","Color":"#FFFFFF00"},{"Id":47,"Name":"","Color":"#FFFF0000"}],"Children":[{"Id":"2.1"
,"Title":"Test Voting 2_2_Vote_Public","Description":"Test Voting
2_2_Vote_Public","Type":"VotingAgendaItem","State":"notstarted","VotingOptions":[{"Id":40,"Name":"","Color":"#
FF008000"},{"Id":41,"Name":"","Color":"#FFFF0000"}],"Children":[],"IdInDb":18}],"IdInDb":17}]}}

4.3.4.9 GetAgendaItemInformationInMeetingById

Cocon for Plixus Core

API Module Plixus Core
GetAgendaItemInformationInMeetingById  ☐

Get all the agenda item information in the meeting identified by a given MeetingId.
Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetAgendaItemInformationInMeetingById/?MeetingId=<MeetingI
d>

Parameters:
Name Description Type

MeetingId The Id of the meeting int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/GetAgendaItemInformationInMeetingById/?MeetingId=498

CoCon API 24 Dec 2021 91/184

Return: string
Reply with the all agenda in running meeting.

{"GetAgendaItemInformationInMeetingById":{"AgendaItems":[{"Id":"1","Title":"Test Discussion
1","Description":"Test Discussion
1","Type":"AgendaItem","State":"notstarted","IdInDb":16,"Children":[]},{"Id":"2","Title":"Test Voting
1_3_Vote_Public","Description":"Test Voting
1_3_Vote_Public","Type":"VotingAgendaItem","State":"ended","VotingOptions":[{"Id":45,"Name":"","Color":"#FF0
08000"},{"Id":46,"Name":"","Color":"#FFFFFF00"},{"Id":47,"Name":"","Color":"#FFFF0000"}],"Children":[{"Id":"2.1"
,"Title":"Test Voting 2_2_Vote_Public","Description":"Test Voting
2_2_Vote_Public","Type":"VotingAgendaItem","State":"active","VotingOptions":[{"Id":40,"Name":"","Color":"#FF0
08000"},{"Id":41,"Name":"","Color":"#FFFF0000"}],"Children":[],"IdInDb":18}],"IdInDb":17}]}}

4.3.4.10 GetAgendaItemById

Cocon for Plixus Core

API Module Plixus Core
GetAgendaItemById  ☐

Get the agenda item by agenda item id.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetAgendaItemById/?Id=<Id>

Parameters:
Name Description Type

Id The Id of the agenda item string

Example:
http://localhost:8890/CoCon/Meeting_Agenda/GetAgendaItemById/?Id=2

Return: string
{"GetAgendaItemById":{"AgendaItem":{"Id":"2","Title":"Test Voting 1_3_Vote_Public","Description":"Test Voting
1_3_Vote_Public","Type":"VotingAgendaItem","State":"ended","VotingOptions":[{"Id":45,"Name":"","Color":"#FF0
08000"},{"Id":46,"Name":"","Color":"#FFFFFF00"},{"Id":47,"Name":"","Color":"#FFFF0000"}],"Children":[{"Id":"2.1"
,"Title":"Test Voting 2_2_Vote_Public","Description":"Test Voting
2_2_Vote_Public","Type":"VotingAgendaItem","State":"active","VotingOptions":[],"Children":[],"IdInDb":18}],"IdIn
Db":17}}}

4.3.4.11 StartMeetingViaMeetingTemplate

Cocon for Plixus Core

API Module Plixus Core
StartMeetingViaMeetingTemplate  ☐

Start the meeting via template meeting name

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/StartMeetingViaMeetingTemplate/?TemplateName={templateNa
me}

Parameters:
Name Description Type

TemplateName Name of the existing meeting template string

CoCon API 24 Dec 2021 92/184

Example:
http://localhost:8890/CoCon/Meeting_Agenda/StartMeetingViaMeetingTemplate/?TemplateName=Test meeting

Return:
{"StartMeetingViaMeetingTemplate":{"Result":true,"MeetingId":500}}
new created meetingId

4.3.4.12 StartMeetingViaXMLimport

Cocon for Plixus Core

API Module Plixus Core
StartMeetingViaXMLimport  ☐

Start the meeting from an imported XML template. The XML file, containing the meeting data to be imported,
should be uploaded to an integrated FTP-server, hosted by the CoCon Server.

FTP Server IP: CoCon Server IP

Port: 2125
User Name: televic
Password: tlv
Path: default path.

Hint: if you want to put the file directly on to the CoCon Server, the actual path on the CoCon Server PC (for
Windows 7)is:

C:\Users\<CoCon Server login user>\AppData\Local\Televic Conference\CoCon\Doc\Server\

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/StartMeetingViaXMLimport/?XMLName={xml_name}&Type={type
}

Return:
new created meetingId, or -1 when the import has failed

Parameters:
Name Description Type

XMLName The name of the XML file to be used for import string
The type of the XML file for import. Possible
values:

“Generated”: the XML-format used by the

Save Offline function in the Meeting Manager
Note : Group list or Grouprelated info should
Type not be a part of generated xml meeting else string
meeting start will fail.

“Readable”: the XML format as described in

section 10.6.3 “Readable XML” of the CoCon
manual

Example:
http://192.168.8.171:8890/CoCon/Meeting_Agenda/StartMeetingViaXMLimport/?XMLName=test-
meeting.xml&Type=Readable

CoCon API 24 Dec 2021 93/184

4.3.4.13 AddAgendaItem

Cocon for Plixus Core

API Module Plixus Core
AddAgendaItem  ☐

Add a new agenda item to the agenda.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/AddAgendaItem/?Title={title}&Des={description}&Sequence={seq
uence}&Type={type}&VotingTemplate={template}

Parameters:
Name Description Type

Title The title of agenda item string

Des The description of agenda item string

The sequence string of agenda item, eg:
Sequence 1.2.1
string
The type of agenda item:
Discussion
Type Lecture string
Voting

The template of voting (optional, if Type is

VotingTemplate (optional) Voting)
string

Example:
http://localhost:8890/CoCon/Meeting_Agenda/AddAgendaItem/?Title=Test Agedna 1&Des=Test Agedna
1&Sequence=2.1&Type=Discussion

Return:
{"AddNewAgendaItem":{"Id":"2.1"}}

4.3.4.14 GetLoginMethodForMeeting

Cocon for Plixus Core

API Module Plixus Core
GetLoginMethodForMeeting  ☐

Get login method for the delegates in a meeting

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetLoginMethodForMeeting/?MeetingId=<MeetingId>
Parameters:
Name Description Type

MeetingId The Id of the meeting int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/GetLoginMethodForMeeting/?MeetingId=500

Return: string
A string which is one of the following Strings:

CoCon API 24 Dec 2021 94/184

1. FixedSeatWithBadge
2. FixedSeatWithoutBadge
3. FreeSeating
4. “”(Empty string,It means get login method failure)

{"GetLoginMethodForMeeting":"FreeSeating"}
{"GetLoginMethodForMeeting":"FixedSeatWithoutBadge"}

4.3.4.15 RemoveAgendaItemById

Cocon for Plixus Core

API Module Plixus Core
RemoveAgendaItemById  ☐

Remove the agenda item by agenda item id.

Note: It will delete the child item as well.
Structure:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveAgendaItemById/?Id=<Id>

Parameters:
Name Description Type

Id The Id of the agenda item string

Example:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveAgendaItemById/?Id=2

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.16 DeleteAllAgendaItems

Cocon for Plixus Core

API Module Plixus Core
DeleteAllAgendaItems  ☐

Delete all the agenda items in meeting

Structure:
http://localhost:8890/CoCon/ Meeting_Agenda/DeleteAllAgendaItems/?Id=<meetingId>

Parameters:
Name Description Type

Id The Id of the meeting int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/DeleteAllAgendaItems/?Id=500

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 95/184

4.3.4.17 MoveAgendaItem

Cocon for Plixus Core

API Module Plixus Core
MoveAgendaItem  ☐

Move agenda item location; it provides four type of movement, Up/Down/LevelUp/LevelDown

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/MoveAgendaItem/?Id=<agendaId>&Move=<movement>

Parameters:
Name Description Type

Id The Id of the agenda item string

Include four options

Move (Up/Down/LevelUp/LevelDown)
string

Example:
http://localhost:8890/CoCon/Meeting_Agenda/MoveAgendaItem/?Id=2.1&Move=LevelUp

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.18 EditAgendaItem

Cocon for Plixus Core

API Module Plixus Core
EditAgendaItem  ☐

Edit agenda item based on the order for the running meeting.
Structure:
http://localhost:8890/CoCon/Meeting_Agenda/EditAgendaItem/?Id=<id>&Title={title}&Des={Des}

Parameters:
Name Description Type

Id The Id(order / sequence id) of the agenda. string

Title Title user defined string

Des Description for the agenda. string

Return : String.
Example:
http://localhost:8890/CoCon/Meeting_Agenda/EditAgendaItem/?Id=1.1&Title=test agenda item&Des=New
agenda item

Reply : agenda item with data.

{"EditedAgendaItem":"Id":"1.1","Title":"TestTitle","Des":"Description of the item."}

CoCon API 24 Dec 2021 96/184

4.3.4.19 AddDelegateToMeeting

Cocon for Plixus Core

API Module Plixus Core
AddDelegateToMeeting  ☐

Add delegate to the meeting.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/AddDelegateToMeeting/?DelegateId={DelegateId}&MeetingId={M
eetingId}

Parameters:
Name Description Type

DelegateId The Delegate id from DB int

MeetingId Meeting id. int

Return : int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/AddDelegateToMeeting/?DelegateId=43&MeetingId=11

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

{"DelegatesInMeetingUpdated":{"MeetingId":11}}

4.3.4.20 AddDelegatesToMeeting

Cocon for Plixus Core

API Module Plixus Core
AddDelegateToMeeting  ☐

Add delegates to the meeting. (Multiple delegates can be added at same time)
Structure:
http://localhost:8890/CoCon/Meeting_Agenda/AddDelegatesToMeeting/? DelegatesId={DelegatesId}&
MeetingId={MeetingId}

Parameters:
Name Description Type

DelegatesId The Delegates id from DB string

MeetingId Meeting id. int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/AddDelegatesToMeeting/?DelegatesId=487,486,485&MeetingId=
483

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

0,sucess but these delegates: 487 486 failed,because they not exist in the database
{"DelegatesInMeetingUpdated":{"MeetingId":11}}

CoCon API 24 Dec 2021 97/184

4.3.4.21 RemoveDelegateFromMeeting

Cocon for Plixus Core

API Module Plixus Core
RemoveDelegateFromMeeting  ☐

Remove delegate from the meeting.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveDelegateFromMeeting/?DelegateId={DelegateId}&Meetin
gId={MeetingId}

Parameters:
Name Description Type

DelegateId The Delegate id from DB int

MeetingId Meeting id. int

Return : int

Note: Removing a delegate from the meeting is NOT allowed if the delegate has already participated in voting
session in this meeting.

Example:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveDelegateFromMeeting/?DelegateId=43&MeetingId=11

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

{"DelegatesInMeetingUpdated":{"MeetingId":11}}

4.3.4.22 GetDelegateSeating

Cocon for Plixus Core

API Module Plixus Core
GetDelegateSeating  ☐

Get delegate seating form the synoptic.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetDelegateSeating/?MeetingId={MeetingId}

Parameters:
Name Description Type

MeetingId Meeting id. int

Return : int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/GetDelegateSeating/?MeetingId=11

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

{"GetDelegateSeating":{"DelegateSeating":[{"DelegateId":44,"SeatId":0},{"DelegateId":43,"SeatId":1},{"DelegateI
d":45,"SeatId":0}]}}

CoCon API 24 Dec 2021 98/184

4.3.4.23 AddDelegateToSeat

Cocon for Plixus Core

API Module Plixus Core
AddDelegateToSeat  ☐

Add Delegate to seat.

Note: if delegate is in DB that will be added to meeting user(if not a meeting user) and set on seat.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/AddDelegateToSeat/?MeetingId=12&DelegateId=45&SeatId=4
Parameters:
Name Description Type

MeetingId Meeting id int

DelegateId Delegate id from db int

SeatId Seat id on room (Synoptic) int

Return : int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/AddDelegateToSeat/?MeetingId=13&DelegateId=45&SeatId=2

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

{"DelegatesInMeetingUpdated":{"MeetingId":13}}

4.3.4.24 AddDelegatesToSeats

Cocon for Plixus Core

API Module Plixus Core
AddDelegatesToSeats  ☐

Add Delegates to seats API call will allow to assign delegates on seats like list as one time.
Note: if delegate is in DB that will be added to meeting user (if not a meeting user) and set on seat.
Structure:
http://localhost:8890/CoCon/Meeting_Agenda/AddDelegatesToSeats/?
MeetingId={meetingId}&DelegateIds=1,2,3&SeatIds=2,3,4

Parameters:
Name Description Type

MeetingId Meeting id int

DelegateIds Delegate id from db int

SeatIds Seat id on room (Synoptic) int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/AddDelegatesToSeats/?MeetingId=13&DelegateIds=2,101,125,
3&SeatIds=2,3,4

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

{"DelegatesInMeetingUpdated":{"MeetingId":13}}

CoCon API 24 Dec 2021 99/184

4.3.4.25 RemoveDelegateFromSeat

Cocon for Plixus Core

API Module Plixus Core
RemoveDelegateFromSeat  ☐

Remove the delegate from seat.

Important note: removing delegate(s) from seat is only allowed in case of fixed seating meeting (not in case of
free seating meeting)

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveDelegateFromSeat/?MeetingId={MeetingId}&DelegateId=
{delegateId}

Parameters:
Name Description Type

MeetingId Meeting id. int

DelegateId The Delegate id from DB int

Return : int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveDelegateFromSeat/?MeetingId=12&DelegateId=43

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.26 RemoveDelegatesFromSeat

Cocon for Plixus Core

API Module Plixus Core
RemoveDelegatesFromSeat  ☐

Remove the delegates from seat. (Multiple delegates can remove in 1 api call)
Important note: removing delegate(s) from seat is only allowed in case of fixed seating meeting (not in case of
free seating meeting)

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/RemovesDelegateFromSeat/?MeetingId={MeetingId}&DelegateId
s={delegateId}

Parameters:
Name Description Type

MeetingId Meeting id. int

DelegateIds The Delegate ids from DB int

Return : int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveDelegatesFromSeat/?MeetingId=59&DelegateIds=101,3
47,381

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 100/184

4.3.4.27 RemoveAllDelegatesFromSeat

Cocon for Plixus Core

API Module Plixus Core
RemoveAllDelegatesFromSeat  ☐

Remove all delegates from a seats based on meeting id. (this api will not work for ended meeting)
Important note: removing delegate(s) from seat is only allowed in case of fixed seating meeting (not in case of
free seating meeting)

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveAllDelegatesFromSeat/?MeetingId={MeetingId}

Parameters:
Name Description Type

MeetingId Meeting id. int

Return : int

Example:
http://localhost:8890/CoCon/Meeting_Agenda/RemoveAllDelegatesFromSeat/?MeetingId=59

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.28 ApplyDelegatesToSystem

Cocon for Plixus Core

API Module Plixus Core
ApplyDelegatesToSystem  ☐

Apply the seat modification to H/W.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/ApplyDelegatesToSystem

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.29 EndActiveMeeting

Cocon for Plixus Core

API Module Plixus Core
EndActiveMeeting  ☐

End the current active meeting.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/EndActiveMeeting

Returns:
{"EndActiveMeeting":{"MeetingId":12}}

CoCon API 24 Dec 2021 101/184

4.3.4.30 ResendMeetingData

Cocon for Plixus Core

API Module Plixus Core
ResendMeetingData  ☐

Resend meeting data for current active meeting. (helping to open the IDC log in screen if it not open after restart
IDC and delegate already on seat).

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/ResendMeetingData

Returns:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.4.31 GetVotingAgendaTemplateList

Cocon for Plixus Core

API Module Plixus Core
GetVotingAgendaTemplateList  ☐

API will help user to get the full details of all existing voting templates from cocon DB, so user can edit or reuse
the exiting voting templates.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetVotingAgendaTemplateList

Returns: string
It will return with all Voting templates from Cocon Database, including all settings and details values.

4.3.4.32 GetAgendaDetailById

Cocon for Plixus Core

API Module Plixus Core
GetAgendaDetailById  ☐

This api will help user to get all details information of any agenda item to check all setting is correct or any
modification is required.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetAgendaDetailById/?Id=1&MeetingId=9

Returns: string
>>>{"GetAgendaDetailById":{"AgendaItem":{"NrOfVotingOption":3,"IsCorrection":true,"IsOutcomeEnable":false,"
IsQuorumEnable":false,"IsQuorumAbsolute":true,"QuorumValue":0.0000,"QuorumDeterminedBy":4,"IsMajorityE
nable":true,"IsMajorityAbsolute":true,"MajorityValue":1.0000,"HungVoteSetting":4,"BadgeOption":4,"VotingTemp
lateTitle":"test
2","IsPrint":false,"SeeIndividualVoteResultOption":5,"SeeOverallVoteResultOption":4,"IsOperatorIndicate":false,
"IsSignageIndicate":false,"VotePanelIndicateChoice":0,"AllocateAbstainOption":1,"AllocateAbstainVoteIndex":0,"
VoteState":"New","IsVotingChoiceNumber":false,"PassMsg":"","HungMsg":"","FailMsg":"","IsEnableQuorumMsg"
:false,"QuorumFailedMsg":"","MajorityOption":2,"VotingStartTime":"0001-01-
01T00:00:00","VotingEndTime":"0001-01-
01T00:00:00","IsVotingWithPin":false,"IsMajorityAchievedDetailsEnabled":false,"IsIncludingVotingWeight":true,"I

CoCon API 24 Dec 2021 102/184

sUnanimous":false,"IsMultipleSelectionEnabled":false,"MultipleSelectionNumber":0,"VotingOptions":[{"Id":169,"
Name":"#FF008000","Description":"","OptionChoice":1,"IsAbstain":false,"Index":1,"LedColor":"Blue","MajorityAc
hievedDetail":""},{"Id":170,"Name":"#FFFFFF00","Description":"","OptionChoice":2,"IsAbstain":false,"Index":2,"L
edColor":"Blue","MajorityAchievedDetail":""},{"Id":171,"Name":"#FFFF0000","Description":"","OptionChoice":3,"Is
Abstain":false,"Index":3,"LedColor":"Blue","MajorityAchievedDetail":""}],"AgendaItemSpeechTimeSettings":{"$id"
:"1","EntityKey":null,"IsGlobal":true,"CoCoSEditState":0,"CountForEverySpeaker":false,"Id":0,"AgendaItem":null,
"IsEnabled":false,"Meeting":[],"SpeechTime":"00:05:00","VotingTemplate":null,"WarningTime":"00:01:00","AutoS
witchOff":false,"IncludeChairman":false,"CanGoNegative":false,"SpeechTimeUsed":"00:00:00","ResetAfterTurn
Off":false,"CountDown":false,"IsRunning":false,"TotalSpeechTimeUsed":"00:00:00","HasBeenDisabled":false,"Is
Different":false},"VotingAgendaTimeSettings":{"$id":"2","EntityKey":null,"VotingAgendaItem":null,"CoCoSEditSta
te":0,"Meetings":[],"Id":0,"VotingTemplate":null,"IsEnabled":false,"SpeechTime":"00:05:00","WarningTime":"00:0
5:00","AutoSwitchOff":false,"IncludeChairman":false,"CanGoNegative":false,"SpeechTimeUsed":"00:00:00","Re
setAfterTurnOff":false,"CountDown":true,"IsRunning":false,"TotalSpeechTimeUsed":"00:00:00","HasBeenDisabl
ed":false,"IsDifferent":false},"Id":"1","Title":"test
2","Description":"","Type":"VotingAgendaItem","State":"notstarted","IdInDb":50}}}

4.3.4.33 GetAllMeetings

Cocon for Plixus Core

API Module Plixus Core
GetAllMeetings  ☐

This api returns all meetings (not the meeting templates) with their state.

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetAllMeetings

Returns: string
{"GetAllMeetings":{"Meetings":[{"Id":2,"Title":"fixed seating ignore
authentication","Description":"","StartTime":"2021/04/16 17:05:19","EndTime":"2021/04/16
17:08:04","State":"Ended"},{"Id":3,"Title":"fixed seating ignore
authentication","Description":"","StartTime":"2021/04/19
11:30:17","EndTime":"","State":"Paused"},{"Id":4,"Title":"fixed seating ignore
authentication","Description":"","StartTime":"2021/04/19
11:45:00","EndTime":"","State":"New"},{"Id":5,"Title":"New meeting -
4/19/2021","Description":"","StartTime":"2021/04/19 12:00:00","EndTime":"","State":"New"}]}}

CoCon API 24 Dec 2021 103/184

4.3.4.34 EditMeetingTitle

Cocon for Plixus Core

API Module Plixus Core
EditMeetingTitle  ☐

This api allows to change the meeting title of:

• The running meeting (no MeetingId is provided)
• A prepared meeting (when MeetingId is provided)

Structure:
http://localhost:8890/CoCon/Meeting_Agenda/GetAllMeetings

Parameters:
Name Description Type
Meeting ID
MeetingId which is optional in case you want to change Int
the meeting title of the running meeting
Title (new) meeting title string

Return:
0 → operation success
1 → Operation fail
* No Title parameter specified
* No MeetingId specified and no running meeting in the room
* MeetingId specified, but is not valid/know
* MeetingId specified, but is a template meeting
* MeetingId specified, but meeting is In ‘paused’ or ‘ended’ state
-1 → exception

CoCon API 24 Dec 2021 104/184

4.3.5 Voting

4.3.5.1 SetVotingState

Cocon for Plixus Core

API Module Plixus Core
SetVotingState  ☐

Set the voting state of current active voting agenda item

Structure:
http://localhost:8890/CoCon/Voting/SetVotingState/?State=<State>

Parameters:
Name Description Type
The state of voting
Start
Stop
State Pause string
Resume
Restart
Clear

Following voting states and transitions are allowed:

Start : VotingIdle {means voting is clear}
Stop : VotingPaused and VotingStarted
Pause : VotingStarted
Resume : VotingPaused
Clear : VotingStopped
Restart : VotingStarted and VotingStopped

Example:
http://localhost:8890/CoCon/Voting/SetVotingState/?State=Start

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 105/184

4.3.5.2 AddInstantVote
Cocon for Plixus Core
API Module Plixus Core
AddInstantVote  ☐

Adds a new instance voting item

Structure:
http://localhost:8890/CoCon/Voting/AddInstantVote/?VotingTemplate=<VotingTemplate>

Parameters:
Name Description Type
The voting template name that instance voting
VotingTemplate based on
string

Example:
http://localhost:8890/CoCon/Voting/AddInstantVote/?VotingTemplate=3_Vote_Public

Return:
{"AddInstantVote":{"Result":true}}

4.3.5.3 AddVotingTemplate

Cocon for Plixus Core

API Module Plixus Core
AddVotingTemplate  ☐

Will allow user to add new voting template.

Note: Some special character need to replace with other

CoCon API 24 Dec 2021 106/184

Structure:
http://localhost:8890/CoCon/Voting/AddVotingTemplate/?
Title={title}&NrOfOptions={nrOfOptions}&IsPrinted={isPrintedWhenStop}&IsVotingNumber={isVotingNumber}&A
bstainOption={abstainOption}&AbstainIndex={abstainIndex}&
Description1={description1}&Option1={option1}&SymbolIndex1={symbolIndex1}&LedColour1={ledColor1}&IsAb
stain1={isAbstain1}&MsgOfMajority1={msgOfMajority1}&
Description2={description2}&Option2={option2}&SymbolIndex2={symbolIndex2}&LedColour2={ledColor2}&IsAb
stain2={isAbstain2}&MsgOfMajority2={msgOfMajority2}&
Description3={description3}&Option3={option3}&SymbolIndex3={symbolIndex3}&LedColour3={ledColor3}&IsAb
stain3={isAbstain3}&MsgOfMajority3={msgOfMajority3}&
Description4={description4}&Option4={option4}&SymbolIndex4={symbolIndex4}&LedColour4={ledColor4}&IsAb
stain4={isAbstain4}&MsgOfMajority4={msgOfMajority4}&
Description5={description5}&Option5={option5}&SymbolIndex5={symbolIndex5}&LedColour5={ledColor5}&IsAb
stain5={isAbstain5}&MsgOfMajority5={msgOfMajority5}&
Description6={description6}&Option6={option6}&SymbolIndex6={symbolIndex6}&LedColour6={ledColor6}&IsAb
stain6={isAbstain6}&MsgOfMajority6={msgOfMajority6}&
Description7={description7}&Option7={option7}&SymbolIndex7={symbolIndex7}&LedColour7={ledColor7}&IsAb
stain7={isAbstain7}&MsgOfMajority7={msgOfMajority7}&
Description8={description8}&Option8={option8}&SymbolIndex8={symbolIndex8}&LedColour8={ledColor8}&IsAb
stain8={isAbstain8}&MsgOfMajority8={msgOfMajority8}&
Description9={description9}&Option9={option9}&SymbolIndex9={symbolIndex9}&LedColour9={ledColor9}&IsAb
stain9={isAbstain9}&MsgOfMajority9={msgOfMajority9}&
Description10={description10}&Option10={option10}&SymbolIndex10={symbolIndex10}&LedColour10={ledColo
r10}&IsAbstain10={isAbstain10}&MsgOfMajority10={msgOfMajority10}&
BadgeOption={badgeOption}&OverallOption={overallOption}&IndividualOption={individualOption}&CanCorrect=
{canCorrect}&HasPin={hasPin}&IsWeightUsed={isWeightUsed}&
IsOperatorIndicated={isOperatorIndicated}&IsSignageIndicated={isSignageIndicated}&PanelIndicationOption={p
anelIndicationOption}&
EnableAgendaTimer={isEnabledOfAgendaTimer}&DurationOfAgendaTimer={durationOfAgendaTimer}&Warnin
gOfAgendaTimer={warningOfAgendaTimer}&CountDownOfAgendaTimer={isCountDownOfAgendaTimer}&Exce
edOfAgendaTimer={canExceedOfAgendaTimer}&
EnableVotingTimer={isEnabledOfVotingTimer}&DurationOfVotingTimer={durationOfVotingTimer}&WarningOfVo
tingTImer={warningOfVotingTimer}&CountDownOfVotingTimer={isCountDownOfVotingTimer}&ExceedOfVoting
Timer={canExceedOfVotingTimer}&
EnableQuorum={isEnabledOfQuorum}&AbsoluteOfQuorum={isAbsoluteOfQuorum}&ValueOfQuorum={valueOf
Quorum}&OptionOfQuorum={optionOfQuorum}&EnableQuorumMsg={isEnabledOfQuorumMsg}&QuorumMsg={
quorumMsg}&
AbsoluteOfOutcome={isAbsoluteOfOutcome}&ValueOfMajority={valueOfMajority}&MajorityOption={majorityOpti
on}&
EnableOutcomMsg={isEnabledOfOutcomeMsg}&PassedMsg={passedMsg}&FailedMsg={failedMsg}&HungMsg
={hungMsg}&EnabledMajorityMsg={isEnabledOfMajorityMsg}&
HungVoteSetting={hungVoteSetting}&IsUnanimous={ isUnanimous}

Parameters:
Name Description Type
Name of the Voting template and will keep the
Title title doe that agenda
string

NrOfOptions Number of voting options int

IsPrinted Enabled the function for print after voting stop. bool
Enabled Symbol or Number for voting choice
IsVotingNumber Note: not applicable after 5.0 cocon
bool
Choose the Voting abstain Options
AbstainOption Value :1 to 3
int
Select abstain index for move voting for
AbstainIndex Value : 1 to .. based on the voting options.
int

Description1 Description for voting option 1 string

Voting Option Color
Ex→%23FFFFF000
Option1 (Option Color) Where %23 is Prefix and 8 chars of the RGB
string
value.

CoCon API 24 Dec 2021 107/184

 Note: Make sure for correct RGB value.

Buttons enabled for voting

SymbolIndex1 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour1 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain1 Enabled the abstain function bool

MsgOfMajority1 Message for majority string

Description2 Description for voting option 2 string

Voting Option Color
Ex→%23FFFFF000
Option2 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex2 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour2 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain2 Enabled the abstain function bool

MsgOfMajority2 Message for majority string

Description3 Description for voting option 3 string

Voting Option Color
Ex→%23FFFFF000
Option3 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex3 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour3 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain3 Enabled the abstain function bool

MsgOfMajority3 Message for majority string

Description4 Description for voting option 4 string

Voting Option Color
Ex→%23FFFFF000
Option4 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex4 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour4 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain4 Enabled the abstain function bool

MsgOfMajority4 Message for majority string

Description5 Description for voting option 5 string

Voting Option Color
Ex→%23FFFFF000
Option5 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.

CoCon API 24 Dec 2021 108/184

 Buttons enabled for voting
SymbolIndex5 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
LedColour5 Blue, White, Green, Yellow, Red, Magenta,
string
Cyan
IsAbstain5 Enabled the abstain function bool

MsgOfMajority5 Message for majority string

Description6 Description for voting option 6 string

Voting Option Color
Ex→%23FFFFF000
Option6 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex6 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour6 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain6 Enabled the abstain function bool

MsgOfMajority6 Message for majority string

Description7 Description for voting option 7 string

Voting Option Color
Ex→%23FFFFF000
Option7 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex7 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour7 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain7 Enabled the abstain function bool

MsgOfMajority7 Message for majority string

Description8 Description for voting option 8 string

Voting Option Color
Ex→%23FFFFF000
Option8 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex8 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour8 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain8 Enabled the abstain function bool

MsgOfMajority8 Message for majority string

Description9 Description for voting option 9 string

Voting Option Color
Option9 Ex→%23FFFFF000
string

CoCon API 24 Dec 2021 109/184

 Where %23 is Prefix and 8 chars of the RGB
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex9 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour9 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain9 Enabled the abstain function bool

MsgOfMajority9 Message for majority string

Description10 Description for voting option 10 string

Voting Option Color
Ex→%23FFFFF000
Option10 Where %23 is Prefix and 8 chars of the RGB string
value.
Note: Make sure for correct RGB value.
Buttons enabled for voting
SymbolIndex10 Index : 0 to 9 based on the options. int
Ex.
Voting LED color
We support only 7 color now.
Blue, White, Green, Yellow, Red, Magenta,
LedColour10 Cyan
string
Note: LED color not support for more than 5
button options.
IsAbstain10 Enabled the abstain function bool

MsgOfMajority10 Message for majority string

Choose option for “Who can participate in
voting”
Value : 1 to 4
Ex.
1 = Only delegates with Badge
2 = Only delegates positioned on a seat
BadgeOption 3 = Delegates with a badge or positioned on a int
seat.
4 = All voting units
Note: badge options will be available based on
the meeting type
Note: Options is availabled based on the
meeting login method.
Choose overall option “Who sees the overall
results during the vote ?
Value : 1 to 4
1= no one
2 = Choose this option if the overall result
should only be shown to the vote master. This
is an option that can be selected in the
OverallOption Operator application.
int
3 = Choose this option if all Operator
application should showthe overall results
during the vote.
4 = Choose this option if all operator &
Signage application should show the overall
results.
Choose the option for “Who sees the individual
voting results (during & after the vote)”
Value: 1 to 5
1= No one ;Never
IndividualOption 2 = No one during the vote int
3 = Only vote master
4 = All operators applications
5 = Choose this option if everybody should see
the individual results during the vote.
Enabled the correction option
CanCorrect Value : True means user can change voting
bool

CoCon API 24 Dec 2021 110/184

 Enable the option for “Enter PinId for voting”
HasPin Note: it will be used for IDC only.
bool
Enable option to check the voting weight for
IsWeightUsed voting result calculation. bool

Vote indication
Enabled the Operator voting indication
IsOperatorIndicated Note: it can configure based on the individual
bool
voting setting.
Vote indication
Enabled the Signage voting indication
IsSignageIndicated Note: it can configure based on the individual
bool
voting setting.
Vote button indication
Chose the vote panel indication option
Value : 0 to 2
PanelIndicationOption 2 means “Real vote choice”
int
Note: it can configure based on the individual
voting setting.
EnableAgendaTimer Enabled the timer for Agenda bool
Total Time for Agenda
DurationOfAgendaTimer Ex. 00:05:00
String
Warning time for the Agenda
WarningOfAgendaTimer Ex. 00:01:00
String

CountDownOfAgendaTime Choose the agenda timer count-up / count-

Bool
r down

ExceedOfAgendaTimer Allow exceed agenda timer Bool

EnableVotingTimer Enabled the timer for voting Bool

Total Time for Agenda
DurationOfVotingTimer Ex. 00:05:00
String
Warning time for the Agenda
WarningOfVotingTImer Ex. 00:01:00
String
Choose the agenda timer count-up / count-
CountDownOfVotingTimer down
Bool

ExceedOfVotingTimer Allow exceed voting timer Bool

Enabled the Quorum Functionality
0 = Not enabled
EnableQuorum 1 = Enabled
Bool
Default value is 0
Choose Quorum define function for Absolute
or relative
AbsoluteOfQuorum Ex. True means Absolute enabled Bool
False means Relative option selected.
(enabled)
ValueOfQuorum Value of the Quorum decimal
Choose the options for Presence of
determination.
Value : 1 to 5
1 = Introduced badges
OptionOfQuorum 2 = Presence detection phase before vote
int
3 = Delegates positioned on a seat
4 = Entered manually by operator
5 = Total number of votes
EnableQuorumMsg Enabled the Quorum message option bool

QuorumMsg Message for Quorum string

Choose Majority define function for Absolute or
relative
AbsoluteOfOutcome Ex. True means Absolute enabled bool
False means Relative option selected
(enabled).
ValueOfMajority Value of the Majority decimal
Choose the majority options
Value :1 to 2
MajorityOption 1 = Number of delegates entitled to vote is
int
used for majority calculation.

CoCon API 24 Dec 2021 111/184

 2 = Number of votes cast is used for majority
calculation.
Note: option 1 can only be selectable if the
relative option is slected.
EnableOutcomMsg Enabled Outcome message option. bool

PassedMsg Message for the Pass Majority string

FailedMsg Message for the Fail Majority string

HungMsg Message for the Hung Majority string

EnabledMajorityMsg Enabled Majority Achieved Details bool

Choose option for the hung vote solution
Value : 1 to 5
Ex.
0 = Stop voting automatically.
1 = Keep the vote active until the Operator or
Chairman manually stops it.
HungVoteSetting 2 = Restart voting with all options available Int
3 = Determined by chairmen votes in this
voting session.
4 = Stop voting and the operator decides.
5 = Determined by chairmen votes in a new
chairmen-only voting session.

If value is true, means Voting options for the

voting session decision made by operator
even thoug user can choose his own chose as
IsUnanimous well. (this option will used by the Cocon Op
bool
app only now)
Note: default value is false

Example 1:
http://localhost:8890/CoCon/Voting/AddVotingTemplate/?Title=Test 223

Example 2:
http://localhost:8890/CoCon/Voting/AddVotingTemplate/?Title=TEST 201
&NrOfOptions=5&IsPrinted=false&Description1=Pass&Option1=%230000FF&SymbolIndex1=0&LedColour1=R
ed&Description2=ABS&Option2=%23FFFF0000&SymbolIndex2=1&LedColour2=Red&Description3=Fail&Optio
n3=%23FFFFFF00&SymbolIndex3=2&LedColour3=Blue&Description4=ISA&Option4=%2339FF14&SymbolInde
x4=3&LedColour4=Yellow&Description5=XYZ&Option5=%23FF00FF&SymbolIndex5=4&LedColour5=Magenta
&EnableQuorum=True&AbsoluteOfQuorum=False&OptionOfQuorum=1&EnableQuorumMsg=True&QuorumMs
g=It
works&AbsoluteOfOutcome=False&ValueOfMajority=10&MajorityOption=1&EnableOutcomMsg=True&Passed
Msg=Majority
achieved&FailedMsg=fail&HungMsg=hung&EnabledMajorityMsg=True&HungVoteSetting=4&BadgeOption=1&E
nableAgendaTimer=True&EnableVotingTimer=True&DurationOfAgendaTimer=00%3A05%3A00&WarningOfAg
endaTimer=00%3A03%3A00&CountDownOfAgendaTimer=False&ExceedOfAgendaTimer=True&DurationOfVot
ingTimer=00%3A05%3A00&WarningOfVotingTImer=00%3A05%3A00&CountDownOfVotingTimer=False&Exce
edOfVotingTimer=True&OverallOption=1&IndividualOption=1&CanCorrect=True&IsWeightUsed=True&IsOperat
orIndicated=True&IsSignageIndicated=True&PanelIndicationOption=1

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

Update event for Example 1:

{"VotingTemplateAdded":{"Id":35,"Title":"Test
223","NrOfOptions":3,"IsPrinted":false,"IsVotingNumber":false,"BadgeOption":4,"OverallOption":4,"Options":[{"Id
":154,"Description":"","Option":"#FF008000","SymbolIndex":1,"LedColour":"Blue","IsAbstain":false,"MsgOfMajorit
y":"Motion
Accepted"},{"Id":155,"Description":"","Option":"#FFFFFF00","SymbolIndex":2,"LedColour":"Blue","IsAbstain":fals
e,"MsgOfMajority":"Motion
Postponed"},{"Id":156,"Description":"","Option":"#FFFF0000","SymbolIndex":3,"LedColour":"Blue","IsAbstain":fal
se,"MsgOfMajority":"Motion

CoCon API 24 Dec 2021 112/184

Rejected"}],"IndividualOption":5,"CanCorrect":false,"HasPin":false,"IsWeightUsed":true,"IsOperatorIndicated":fal
se,"IsSignageIndicated":false,"PanelIndicationOption":0,"AgendaTimer":{"Id":71,"EnableAgendaTimer":false,"Du
rationOfAgendaTimer":"00:00:00","WarningOfAgendaTimer":"00:00:00","CountDownOfAgendaTimer":true,"Exce
edOfAgendaTimer":false},"VotingTimer":{"Id":72,"EnableVotingTimer":false,"DurationOfVotingTimer":"00:00:00",
"WarningOfVotingTImer":"00:00:00","CountDownOfVotingTimer":true,"ExceedOfVotingTimer":false},"EnableQuo
rum":false,"AbsoluteOfQuorum":true,"ValueOfQuorum":0.0,"OptionOfQuorum":4,"EnableQuorumMsg":false,"Qu
orumMsg":"Quorum not OK - voting
postponed","AbsoluteOfOutcome":true,"ValueOfMajority":1.0,"MajorityOption":2,"EnableOutcomMsg":false,"Pas
sedMsg":"Majority achieved","FailedMsg":"Majority not achieved","HungMsg":"Hung
vote","EnabledMajorityMsg":false,"HungVoteSetting":1}}

Update event for Example 2:

{"VotingTemplateAdded":{"Id":33,"Title":"TEST 201
","NrOfOptions":5,"IsPrinted":false,"IsVotingNumber":false,"BadgeOption":1,"OverallOption":1,"Options":[{"Id":14
4,"Description":"Pass","Option":"#0000FF","SymbolIndex":0,"LedColour":"Red","IsAbstain":false,"MsgOfMajority
":""},{"Id":145,"Description":"ABS","Option":"#FFFF0000","SymbolIndex":1,"LedColour":"Red","IsAbstain":false,"
MsgOfMajority":"Motion
Accepted"},{"Id":146,"Description":"Fail","Option":"#FFFFFF00","SymbolIndex":2,"LedColour":"Blue","IsAbstain":
false,"MsgOfMajority":"Motion
Postponed"},{"Id":147,"Description":"ISA","Option":"#39FF14","SymbolIndex":3,"LedColour":"Yellow","IsAbstain":
false,"MsgOfMajority":"Motion
Rejected"},{"Id":148,"Description":"XYZ","Option":"#FF00FF","SymbolIndex":4,"LedColour":"Magenta","IsAbstain
":false,"MsgOfMajority":""}],"IndividualOption":1,"CanCorrect":true,"HasPin":false,"IsWeightUsed":true,"IsOperat
orIndicated":true,"IsSignageIndicated":true,"PanelIndicationOption":1,"AgendaTimer":{"Id":67,"EnableAgendaTi
mer":true,"DurationOfAgendaTimer":"00:05:00","WarningOfAgendaTimer":"00:03:00","CountDownOfAgendaTim
er":false,"ExceedOfAgendaTimer":true},"VotingTimer":{"Id":68,"EnableVotingTimer":true,"DurationOfVotingTime
r":"00:05:00","WarningOfVotingTImer":"00:05:00","CountDownOfVotingTimer":false,"ExceedOfVotingTimer":true
},"EnableQuorum":true,"AbsoluteOfQuorum":false,"ValueOfQuorum":0.0,"OptionOfQuorum":1,"EnableQuorumM
sg":true,"QuorumMsg":"It
works","AbsoluteOfOutcome":false,"ValueOfMajority":10.0,"MajorityOption":1,"EnableOutcomMsg":true,"Passed
Msg":"Majority achieved","FailedMsg":"fail","HungMsg":"hung","EnabledMajorityMsg":true,"HungVoteSetting":4}}

Example 3:
http://localhost:8890/CoCon/Voting/AddVotingTemplate/?Title=TEST
501&NrOfOptions=5&IsPrinted=false&Description1=Pass&Option1=%230000FF&SymbolIndex1=0&LedColour1
=Red&Description2=ABS&Option2=%23FFFF0000&SymbolIndex2=1&LedColour2=Red&Description3=Fail&Op
tion3=%23FFFFFF00&SymbolIndex3=2&LedColour3=Blue&Description4=ISA&Option4=%2339FF14&SymbolIn
dex4=3&LedColour4=Yellow&Description5=XYZ&Option5=%23FF00FF&SymbolIndex5=4&LedColour5=Magen
ta&EnableQuorum=True&AbsoluteOfQuorum=False&OptionOfQuorum=1&EnableQuorumMsg=True&QuorumM
sg=It
works&AbsoluteOfOutcome=False&ValueOfMajority=10&MajorityOption=1&EnableOutcomMsg=True&Passed
Msg=Majority
achieved&FailedMsg=fail&HungMsg=hung&EnabledMajorityMsg=True&HungVoteSetting=4&BadgeOption=1&E
nableAgendaTimer=True&EnableVotingTimer=True&DurationOfAgendaTimer=00%3A05%3A00&WarningOfAg
endaTimer=00%3A03%3A00&CountDownOfAgendaTimer=False&ExceedOfAgendaTimer=True&DurationOfVot
ingTimer=00%3A05%3A00&WarningOfVotingTImer=00%3A05%3A00&CountDownOfVotingTimer=False&Exce
edOfVotingTimer=True&OverallOption=1&IndividualOption=1&CanCorrect=True&IsWeightUsed=True&IsOperat
orIndicated=True&IsSignageIndicated=True&PanelIndicationOption=1&IsAbstain1=True&AbstainOption=3&Abs
tainIndex=2

Update event for Example 4 :

>>>{"VotingTemplateAdded":{"Id":36,"Title":"TEST
501","NrOfOptions":5,"IsPrinted":false,"IsVotingNumber":false,"BadgeOption":1,"OverallOption":1,"Options":[{"Id
":157,"Description":"Pass","Option":"#0000FF","SymbolIndex":0,"LedColour":"Red","IsAbstain":true,"MsgOfMajo
rity":""},{"Id":158,"Description":"ABS","Option":"#FFFF0000","SymbolIndex":1,"LedColour":"Red","IsAbstain":fals
e,"MsgOfMajority":"Motion
Accepted"},{"Id":159,"Description":"Fail","Option":"#FFFFFF00","SymbolIndex":2,"LedColour":"Blue","IsAbstain":
false,"MsgOfMajority":"Motion
Postponed"},{"Id":160,"Description":"ISA","Option":"#39FF14","SymbolIndex":3,"LedColour":"Yellow","IsAbstain":
false,"MsgOfMajority":"Motion

CoCon API 24 Dec 2021 113/184

Rejected"},{"Id":161,"Description":"XYZ","Option":"#FF00FF","SymbolIndex":4,"LedColour":"Magenta","IsAbstain
":false,"MsgOfMajority":""}],"IndividualOption":1,"CanCorrect":true,"HasPin":false,"IsWeightUsed":true,"IsOperat
orIndicated":true,"IsSignageIndicated":true,"PanelIndicationOption":1,"AgendaTimer":{"Id":73,"EnableAgendaTi
mer":true,"DurationOfAgendaTimer":"00:05:00","WarningOfAgendaTimer":"00:03:00","CountDownOfAgendaTim
er":false,"ExceedOfAgendaTimer":true},"VotingTimer":{"Id":74,"EnableVotingTimer":true,"DurationOfVotingTime
r":"00:05:00","WarningOfVotingTImer":"00:05:00","CountDownOfVotingTimer":false,"ExceedOfVotingTimer":true
},"EnableQuorum":true,"AbsoluteOfQuorum":false,"ValueOfQuorum":0.0,"OptionOfQuorum":1,"EnableQuorumM
sg":true,"QuorumMsg":"It
works","AbsoluteOfOutcome":false,"ValueOfMajority":10.0,"MajorityOption":1,"EnableOutcomMsg":true,"Passed
Msg":"Majority achieved","FailedMsg":"fail","HungMsg":"hung","EnabledMajorityMsg":true,"HungVoteSetting":4}}

Update event for Example 5 : With additional para “IsUnanimous”

{"VotingTemplateAdded":{"Id":3,"Title":"Test
223","NrOfOptions":3,"IsPrinted":false,"IsVotingNumber":false,"BadgeOption":4,"OverallOption":4,"Options":[{"Id
":66,"Description":"","Option":"#FF008000","SymbolIndex":1,"LedColour":"Blue","IsAbstain":false,"MsgOfMajority
":"Motion
Accepted"},{"Id":67,"Description":"","Option":"#FFFFFF00","SymbolIndex":2,"LedColour":"Blue","IsAbstain":false,
"MsgOfMajority":"Motion
Postponed"},{"Id":68,"Description":"","Option":"#FFFF0000","SymbolIndex":3,"LedColour":"Blue","IsAbstain":fals
e,"MsgOfMajority":"Motion
Rejected"}],"IndividualOption":5,"CanCorrect":false,"HasPin":false,"IsWeightUsed":true,"IsOperatorIndicated":fal
se,"IsSignageIndicated":false,"PanelIndicationOption":0,"AgendaTimer":{"Id":109,"EnableAgendaTimer":false,"D
urationOfAgendaTimer":"00:00:00","WarningOfAgendaTimer":"00:00:00","CountDownOfAgendaTimer":true,"Exc
eedOfAgendaTimer":false},"VotingTimer":{"Id":110,"EnableVotingTimer":false,"DurationOfVotingTimer":"00:00:0
0","WarningOfVotingTImer":"00:00:00","CountDownOfVotingTimer":true,"ExceedOfVotingTimer":false},"Enable
Quorum":false,"AbsoluteOfQuorum":true,"ValueOfQuorum":0.0,"OptionOfQuorum":4,"EnableQuorumMsg":false,
"QuorumMsg":"Quorum not OK - voting
postponed","AbsoluteOfOutcome":true,"ValueOfMajority":1.0,"MajorityOption":2,"EnableOutcomMsg":false,"Pas
sedMsg":"Majority achieved","FailedMsg":"Majority not achieved","HungMsg":"Hung
vote","EnabledMajorityMsg":false,"HungVoteSetting":1,"IsUnanimous":false}}

4.3.5.4 GetVotingState

Cocon for Plixus Core

API Module Plixus Core
GetVotingState  ☐

Gets the voting state of currently active agenda item. Only applicable for voting items.
If the currently active agenda item is not a voting agenda item, then the state Stop will be returned
Structure:
http://localhost:8890/CoCon/Voting/GetVotingState

Parameters:
Name Description Type
The state of voting
Start
Stop
State Pause
string
(Idle)Clear
Retrieve

Example:
http://localhost:8890/CoCon/Voting/GetVotingState

Return:
{"GetVotingState":{"State":"VotingIdle"}}

CoCon API 24 Dec 2021 114/184

4.3.5.5 GetAmountOfVotes

Cocon for Plixus Core

API Module Plixus Core
GetAmountOfVotes  ☐

Will help user to get the current vote amount during the voting. (voting is running / paused or stopped)
Note: if voting state is idle then it will reply with no voting is running.

Structure:
http://localhost:8890/CoCon/Voting/GetAmountOfVotes
Example:
http://localhost:8890/CoCon/Voting/GetAmountOfVotes

Return:
{"GetAmountOfVotes":{"Total voted":0,"Total not voted":15,"Entitled to vote":15}}
If voting is not running :
There is no running voting

4.3.5.6 GetGeneralVotingResults

Cocon for Plixus Core

API Module Plixus Core
GetGeneralVotingResults  ☐

Will help user to get the overall voting result for the active voting agenda after the voting stop.

Structure:
http://localhost:8890/CoCon/Voting/GetGeneralVotingResults/?Id={id}
Example:
http://localhost:8890/CoCon/Voting/GetGeneralVotingResults/?Id=20

Return:
{"GetGeneralVotingResults":{"Id":100,"VotingResults":{"Total":{"Count":4,"Weight":4.0},"Voted":{"Count":1,"Weig
ht":1.0},"NotVoted":{"Count":3,"Weight":3.0},"Options":[{"Id":181,"Name":"","Color":"#FF008000","Votes":{"Count
":0,"Weight":0.0}},{"Id":182,"Name":"","Color":"#FFFFFF00","Votes":{"Count":0,"Weight":0.0}},{"Id":183,"Name":"
","Color":"#FFFF0000","Votes":{"Count":1,"Weight":1.0}}],"AuthorityAssigned":{"Present":0,"Voted":0,"Register":
0}}}}

1 : if agedna is not voting agenda or voting agenda does not have result.
-1 : internal exception.

4.3.5.7 GetIndividualVotingResults
Cocon for Plixus Core
API Module Plixus Core
GetGeneralVotingResults  ☐

This api will help user to get voting individual result for active voting agenda, if it has voting result.
Where Id is Agenda id from db.

Structure:
http://localhost:8890/CoCon/Voting/ GetIndividualVotingResults /?Id={id}
Example:
http://localhost:8890/CoCon/Voting/GetIndividualVotingResults/?Id=112

CoCon API 24 Dec 2021 115/184

Return:
{"IndividualVotingResults":{"Id":112,"VotingResults":[{"DelegateId":174,"VotingOptionId":247,"SeatNumber":13}]}
}

4.3.5.8 DeleteVotingTemplate
Cocon for Plixus Core
API Module Plixus Core
DeleteVotingTemplate  ☐

This api will delete a voting template. The template needs to be identified by its title

Structure:
http://localhost:8890/CoCon/Voting/DeleteVotingTemplate/?Title={title}
Example:
http://localhost:8890/CoCon/Voting/DeleteVotingTemplate/?Title=MyVotingTemplateExample

Return:
0 → operation success; 1 → Operation fail (template not found) -1 → exception

4.3.6 Timer

4.3.6.1 Get

Cocon for Plixus Core

API Module Plixus Core
Get  ☐

Gets an update of all timers

Structure:
http://localhost:8890/CoCon/Timer/Get

Return:
{"GetAllTimers":{"MeetingTimer":{"Timer":{"TotalTime":"02:00:00","TimeUsed":"00:31:23","CountingDown":true,"
WarningTime":"00:05:00"}},"ActiveAgendaItemTimer":{"Timer":{"TotalTime":"02:00:00","TimeUsed":"00:31:23","
CountingDown":true,"WarningTime":"00:05:00"}},"VotingTimer":{"Timer":null},"SeatsTimer":[{"SeatNr":1,"Timer":
{"TotalTime":"00:05:00","TimeUsed":"00:00:00","CountingDown":true,"WarningTime":"00:01:00"}}],"DelegatesTi
mer":[{"DelegateId":10,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","CountingDown":true,"WarningTi
me":"00:01:00"}}],"GroupsTimer":[{"GroupId":1,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","Countin
gDown":true,"WarningTime":"00:01:00"}},{"GroupId":11,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","
CountingDown":true,"WarningTime":"00:01:00"}}]}}

4.3.6.2 GetDelegateTimers

Cocon for Plixus Core

API Module Plixus Core
GetDelegateTimers  ☐

Get all delegates timer. (meeting users)

Note： Delegate on seat only can have timer.
Structure:

CoCon API 24 Dec 2021 116/184

http://localhost:8890/CoCon/Timer/GetDelegateTimers

Return:
{"GetDelegateTimers":[{"DelegateId":2,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","CountingDown":
true,"WarningTime":"00:01:00"}},{"DelegateId":3,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","Counti
ngDown":true,"WarningTime":"00:01:00"}},{"DelegateId":4,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:0
0","CountingDown":true,"WarningTime":"00:01:00"}}]}

4.3.6.3 GetSeatTimers

Cocon for Plixus Core

API Module Plixus Core
GetSeatTimers  ☐

Get all seat timers. （empty seat without delegate on seat.）

Structure:
http://localhost:8890/CoCon/Timer/GetSeatTimers

Return:
{"GetSeatTimers":[{"SeatNr":4,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","CountingDown":true,"Wa
rningTime":"00:01:00"}},{"SeatNr":5,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","CountingDown":tru
e,"WarningTime":"00:01:00"}}]}

4.3.6.4 GetGroupTimers

Cocon for Plixus Core

API Module Plixus Core
GetGroupTimers  ☐

Get all groups timer. （Meeting groups timer only）

Structure:
http://localhost:8890/CoCon/Timer/GetGroupTimers

Return:
{"GetGroupTimers":[{"GroupId":3,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","CountingDown":tr
ue,"WarningTime":"00:01:00"}},{"GroupId":4,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:00","Counti
ngDown":true,"WarningTime":"00:01:00"}}]}

4.3.6.5 GetActiveTimers

Cocon for Plixus Core

API Module Plixus Core
GetActiveTimers  ☐

Get all active timers info. （Seat timer; Delegate timer ; Group timer ）
Structure:
http://localhost:8890/CoCon/Timer/GetActiveTimers
Return:
{"GetActiveTimers":{"SeatsTimer":[{"SeatNr":8,"Timer":{"TotalTime":"00:05:00","TimeUsed":"00:00:15","Coun
tingDown":true,"WarningTime":"00:01:00"}}],"DelegatesTimer":[{"DelegateId":43,"Timer":{"TotalTime":"00:05
:00","TimeUsed":"00:00:17","CountingDown":true,"WarningTime":"00:01:00"}}],"GroupsTimer":[]}}

CoCon API 24 Dec 2021 117/184

4.3.6.6 SetDelegateTimer

Cocon for Plixus Core

API Module Plixus Core
SetDelegateTimer  ☐

Set delegate timer.

Note: Delegate timer will enabled auto and set timer, if timer was not enabled.
Structure:
http://localhost:8890/CoCon/Timer/SetDelegateTimer/?DelegateId={delegateId}&EndTime={endTime}&Warni
ngTime={warningTime}&CountDown={countDown}&IncludeChairman={includeChairman}&SpeechTimeCanExc
eed={speechTimeCanExceed}&AutoSwitchOffMic={autoSwitchOffMic}&ResetWhenMicOff={resetWhenMicOff}
&Enable={enable}

Parameters:
Name Description Type

DelegateId The Delegate id from DB int

EndTime End time for the timer string

WarningTime Warning time for the timer string

CountDown Counting up or down for timer bool

IncludeChairman Include chairman bool

SpeechTimeCanExceed Speech time can exceed (high priority) bool

AutoSwitchOffMic Auto switch off mic if time is over (Low Priority) bool

ResetWhenMicOff Reset timer once mic off. bool

Enable Set enabled / disabled timer bool

Note: if SpeechTimeCanExceed =True and AutoSwitchOffMic = True, then SpeechTimeCanExceed has higher
priority than AutoSwitchOffMic.

Example:
http://localhost:8890/CoCon/Timer/SetDelegateTimer/?DelegateId=2&EndTime=00:01:00&WarningTime=00:00:
30&CountDown=True&IncludeChairman=True&SpeechTimeCanExceed=True&AutoSwitchOffMic=True&Reset
WhenMicOff=True&Enable=True

Return: string
{"SetDelegateTimer":{"DelegateId":71,"Endtime":"00:01:00","WarningTime":"00:00:30","CountDown":true,"Includ
eChairman":true,"SpeechTimeCanExceed":true,"AutoSwitchOffMic":false,"ResetWhenMicOff":false,"Enable":tru
e}}

4.3.6.7 SetGroupTimer

Cocon for Plixus Core

API Module Plixus Core
SetGroupTimer  ☐

Set group timer.

Note: Delegate timer will enabled auto and set timer, if timer was not enabled.
Structure:

CoCon API 24 Dec 2021 118/184

http://localhost:8890/CoCon/Timer/SetGroupTimer/?GroupId={groupId}&EndTime={endTime}&WarningTime={w
arningTime}&CountDown={countDown}&IncludeChairman={includeChairman}&SpeechTimeCanExceed={speec
hTimeCanExceed}&AutoSwitchOffMic={autoSwitchOffMic}&CountForEverySpeaker={countForEverySpeaker} &
Enable={enable}

Parameters:
Name Description Type

GroupId The Group id from DB int

EndTime End time for the timer string

WarningTime Warning time for the timer string

CountDown Counting up or down for timer bool

IncludeChairman Include chairman bool

SpeechTimeCanExceed Speech time can exceed (high priority) bool

AutoSwitchOffMic Auto switch off mic if time is over (Low Priority) bool

CountForEverySpeaker Count for every speaker belong to that group bool

Enable Set enabled / disabled timer bool

Note: if SpeechTimeCanExceed =True and AutoSwitchOffMic = True, then SpeechTimeCanExceed has higher
priority than AutoSwitchOffMic.

Example:
http://localhost:8890/CoCon/Timer/SetGroupTimer/?GroupId=1&EndTime=00:10:00&WarningTime=00:01:30&C
ountDown=True&IncludeChairman=True&SpeechTimeCanExceed=True&AutoSwitchOffMic=True&CountForEv
erySpeaker=True&Enable=True

Return: string
{"SetGroupTimer":{"GroupId":9,"Endtime":"00:03:00","WarningTime":"00:01:30","CountDown":true,"IncludeChair
man":true,"SpeechTimeCanExceed":true,"AutoSwitchOffMic":false,"CountForEverySpeaker":true,"Enable":true}}

4.3.6.8 SetGlobalDelegateTimer

Cocon for Plixus Core

API Module Plixus Core
SetGroupTimer  ☐

Set global delegate timer. (for all meeting user )

Note: Delegate timer will enabled auto and set timer, if timer was not enabled.
Structure:
http://localhost:8890/CoCon/Timer/SetGlobalDelegateTimer/?EndTime={endTime}&WarningTime={warningTim
e}&CountDown={countDown}&IncludeChairman={includeChairman}&SpeechTimeCanExceed={speechTimeCa
nExceed}&AutoSwitchOffMic={autoSwitchOffMic}&ResetWhenMicOff={resetWhenMicOff} &Enable={enable}

Parameters:
Name Description Type

EndTime End time for the timer string

WarningTime Warning time for the timer string

CountDown Counting up or down for timer bool

IncludeChairman Include chairman bool

SpeechTimeCanExceed Speech time can exceed (high priority) bool

CoCon API 24 Dec 2021 119/184

 AutoSwitchOffMic Auto switch off mic if time is over (Low Priority) bool

ResetWhenMicOff Reset timer once mic off. bool

Enable Set enabled / disabled timer bool

Note: if SpeechTimeCanExceed =True and AutoSwitchOffMic = True, then SpeechTimeCanExceed has higher
priority than AutoSwitchOffMic.

Example:
http://localhost:8890/CoCon/Timer/SetGlobalDelegateTimer/?EndTime=00:02:00&WarningTime=00:00:30&Cou
ntDown=False&IncludeChairman=True&SpeechTimeCanExceed=True&AutoSwitchOffMic=True&ResetWhenMi
cOff=True&Enable=True

Return: string
{"SetGlobalDelegateTimer":{"Endtime":"00:02:00","WarningTime":"00:00:30","CountDown":false,"IncludeChairm
an":true,"SpeechTimeCanExceed":true,"AutoSwitchOffMic":false,"ResetWhenMicOff":true}}

4.3.6.9 SetGlobalSeatTimer

Cocon for Plixus Core

API Module Plixus Core
SetGlobalSeatTimer  ☐

Set global seat timer. (For all empty seat in running meeting.)
Note: Delegate timer will enabled auto and set timer, if timer was not enabled.
Structure:
http://localhost:8890/CoCon/Timer/SetGlobalSeatTimer/?EndTime={endTime}&WarningTime={warningTime}&C
ountDown={countDown}&IncludeChairman={includeChairman}&SpeechTimeCanExceed={speechTimeCanExce
ed}&AutoSwitchOffMic={autoSwitchOffMic}&ResetWhenMicOff={resetWhenMicOff} &Enable={enable}

Parameters:
Name Description Type

EndTime End time for the timer string

WarningTime Warning time for the timer string

CountDown Counting up or down for timer bool

IncludeChairman Include chairman bool

SpeechTimeCanExceed Speech time can exceed (high priority) bool

AutoSwitchOffMic Auto switch off mic if time is over (Low Priority) bool

ResetWhenMicOff Reset timer once mic off. bool

Enable Set enabled / disabled timer bool

Note: if SpeechTimeCanExceed =True and AutoSwitchOffMic = True, then SpeechTimeCanExceed has higher
priority than AutoSwitchOffMic.

Example:
http://localhost:8890/CoCon/Timer/SetGlobalSeatTimer/?EndTime=00:02:00&WarningTime=00:00:30&CountDo
wn=True&IncludeChairman=True&SpeechTimeCanExceed=True&AutoSwitchOffMic=True&ResetWhenMicOff=
True&Enable=True

Return: string

{"SetGlobalSeatTimer":{"Endtime":"00:01:00","WarningTime":"00:00:30","CountDown":true,"IncludeChairman":tr
ue,"SpeechTimeCanExceed":true,"AutoSwitchOffMic":false,"ResetWhenMicOff":true}}

CoCon API 24 Dec 2021 120/184

4.3.6.10 SetGlobalGroupTimer

Cocon for Plixus Core

API Module Plixus Core
SetGlobalSeatTimer  ☐

Set global group timer. (For all running meeting groups.)

Note: Delegate timer will enabled auto and set timer, if timer was not enabled.
Structure:
http://localhost:8890/CoCon/Timer/SetGlobalGroupTimer/?EndTime={endTime}&WarningTime={warningTime}&
CountDown={countDown}&IncludeChairman={includeChairman}&SpeechTimeCanExceed={speechTimeCanEx
ceed}&AutoSwitchOffMic={autoSwitchOffMic}&CountForEverySpeaker={countForEverySpeaker} &Enable={enab
le}

Parameters:
Name Description Type

EndTime End time for the timer string

WarningTime Warning time for the timer string

CountDown Counting up or down for timer bool

IncludeChairman Include chairman bool

SpeechTimeCanExceed Speech time can exceed (high priority) bool

AutoSwitchOffMic Auto switch off mic if time is over (Low Priority) bool

CountForEverySpeaker Count for every speaker belong to that group bool

Enable Set enabled / disabled timer bool

Note: if SpeechTimeCanExceed =True and AutoSwitchOffMic = True, then SpeechTimeCanExceed has higher
priority than AutoSwitchOffMic.

Example:
http://localhost:8890/CoCon/Timer/SetGlobalGroupTimer/?EndTime=00:01:00&WarningTime=00:00:30&Count
Down=True&IncludeChairman=True&SpeechTimeCanExceed=True&AutoSwitchOffMic=True&CountForEveryS
peaker=False&Enable=True

Return: string
{"SetGlobalGroupTimer":{"Endtime":"00:01:00","WarningTime":"00:00:30","CountDown":true,"IncludeChairman":
true,"SpeechTimeCanExceed":true,"AutoSwitchOffMic":false,"CountForEverySpeaker":false}}

4.3.6.11 ResetDelegateTimer

Cocon for Plixus Core

API Module Plixus Core
ResetDelegateTimer  ☐

Reset delegate timer to the configured time if user have running or used timer in active meeting.
Note: Delegate should be a meeting user and his timer should be enabled

Structure:
http://localhost:8890/CoCon/Timer/ResetDelegateTimer/?DelegateId={id}

Parameters:
Name Description Type

CoCon API 24 Dec 2021 121/184

 DelegateId Id of the delegate string

Example:
http://192.168.8.165:8890/CoCon/Timer/ResetDelegateTimer/?DelegateId=10

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.6.12 ResetGlobalDelegateTimer

Cocon for Plixus Core

API Module Plixus Core
ResetGlobalDelegateTimer  ☐

Reset global delegate timer to the configured time for the all meeting user whos timer is enabled in active
meeting.

Structure:
http://localhost:8890/CoCon/Timer/ResetGlobalDelegateTimer

Example:
http://localhost:8890/CoCon/Timer/ResetGlobalDelegateTimer

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.6.13 ResetGroupTimer

Cocon for Plixus Core

API Module Plixus Core
ResetGroupTimer  ☐

Reset group timer to the configured time if the group has running or used timer in active meeting.
Note: Group should be a meeting Group and his timer should be enabled

Structure:
http://localhost:8890/CoCon/Timer/ResetDelegateTimer/?DelegateId={id}

Parameters:
Name Description Type

GroupId Id of the meeting group string

Example:
http://192.168.8.165:8890/CoCon/Timer/ResetGroupTimer/?GroupId=1

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 122/184

4.3.6.14 ResetGlobalGroupTimer

Cocon for Plixus Core

API Module Plixus Core
ResetGlobalGroupTimer  ☐

Reset global group timer to the configured time for the all meeting Group whose timer is enabled in active
meeting.

Structure:
http://192.168.8.165:8890/CoCon/Timer/ResetGlobalGroupTimer

Example:
http://192.168.8.165:8890/CoCon/Timer/ResetGlobalGroupTimer
Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 123/184

4.3.6.15 ChangeDelegateTimer

Cocon for Plixus Core

API Module Plixus Core
ChangeDelegateTimer  ☐

Change delegate timer to the configured time if user have running or used timer in active meeting.
Note: Delegate should be a meeting user and his timer should be enabled.

Structure:
http://localhost:8890/CoCon/Timer/ChangeDelegateTimer/?DelegateId={delegateId}&UsedTime={usedTime}

Parameters:
Name Description Type

DelegateId Id of the delegate String

UsedTime Time which user would like to update String

Example:
http://192.168.8.165:8890/CoCon/Timer/ChangeDelegateTimer/?DelegateId=9&UsedTime=00:00:30

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.6.16 ChangeGroupTimer
Cocon for Plixus Core
API Module Plixus Core
ChangeGroupTimer  ☐

Change group timer to the configured time if the group has running or used timer in active meeting.
Note: Group should be a meeting Group and his timer should be enabled

Structure:
http://localhost:8890/CoCon/Timer/ChangeGroupTimer/?GroupId={groupId}&UsedTime={usedTime}

Parameters:
Name Description Type

GroupId Id of the meeting group string

Example:
http://192.168.8.165:8890/CoCon/Timer/ChangeGroupTimer/?GroupId=1&UsedTime=00:01:00

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 124/184

4.3.6.17 ChangeDelegateTimerState
Cocon for Plixus Core
API Module Plixus Core
ChangeDelegateTimerState  ☐

Change delegate timer state.

Note: This call can only be performed on a running meeting, when delegate is in meeting and microphone of
that delegate is enabled. Of course timer functionality must also be enabled.

Structure:
http://localhost:8890/CoCon/Timer/ChangeDelegateTimerState/?DelegateId={delegateId}&TimerState={state}

Parameters:
Name Description Type

DelegateId Id of the delegate integer

String
TimerState State of the timer [“Pause”, “Resume”, “Restart”]

Example:
http://192.168.8.165:8890/CoCon/Timer/ChangeDelegateTimerState/?DelegateId=1&TimerState=Pause

Return: int
0 → operation success
1 → operation fail (wrong TimerState value, no meeting running, delegate not in meeting, microphone not on
or timers not enabled)
-1 → exception

4.3.6.18 ChangeGroupTimerState
Cocon for Plixus Core
API Module Plixus Core
ChangeGroupTimerState  ☐

Change group timer state.

Note: This call can only be performed on a running meeting and when group is in meeting. Of course timer
functionality must also be enabled.

Structure:
http://localhost:8890/CoCon/Timer/ChangeGroupTimerState/?GroupId={groupId}&TimerState={state}

Parameters:
Name Description Type

GroupId Id of the group integer

String
TimerState State of the timer [“Pause”, “Resume”, “Restart”]

Example:
http://192.168.8.165:8890/CoCon/Timer/ChangeGroupTimerState/?GroupId=1&TimerState=Pause

Return: int
0 → operation success
1 → operation fail (wrong TimerState value, no meeting running, group not in meeting or timers not enabled)
-1 → exception

CoCon API 24 Dec 2021 125/184

4.3.7 Delegate

4.3.7.1 GetDelegatesInMeeting

Cocon for Plixus Core

API Module Plixus Core
GetDelegatesInMeeting  ☐

Get all the delegates information in the special meeting

Structure:
http://localhost:8890/CoCon/Delegate/GetDelegatesInMeeting/?MeetingId=<MeetingId>

Parameters:
Name Description Type

MeetingId The id of the meeting those delegates in int

Example:
http://localhost:8890/CoCon/Delegate/GetDelegatesInMeeting/?MeetingId=8

Return:
{"GetDelegatesInMeeting":{"Delegates":[{"Id":240,"FirstName":"","Name":"AUCOUTURIER","MiddleName":null,"
Street":"","StreetNumber":0,"PostCode":"","City":"","Country":null,"Title":"","BirthDate":"","District":null,"Biography
":"","Groups":[{"Id":9,"Name":"G9"}],"SeatNumber":2,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginC
ode":""},{"Id":274,"FirstName":"","Name":"AUDIBERT8TROIN","MiddleName":null,"Street":"","StreetNumber":0,"
PostCode":"","City":"","Country":null,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"Id":10,"Name
":"G10"}],"SeatNumber":3,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":275,"FirstNa
me":"","Name":"BARREILLE","MiddleName":null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country":n
ull,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"Id":10,"Name":"G10"}],"SeatNumber":null,"Bad
geNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":261,"FirstName":"","Name":"BATTIN","Middl
eName":null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country":null,"Title":"Mr","BirthDate":"","District
":null,"Biography":"","Groups":[{"Id":10,"Name":"G10"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterDat
a":"","KeypadLoginCode":""},{"Id":418,"FirstName":"David","Name":"Balmer","MiddleName":null,"Street":"Les
Gasses
27","StreetNumber":0,"PostCode":"2946","City":"Miécourt","Country":null,"Title":"Député","BirthDate":"","District":
null,"Biography":"","Groups":[{"Id":18,"Name":"PLR"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData
":"","KeypadLoginCode":""},{"Id":348,"FirstName":"D.","Name":"BATAILLE","MiddleName":null,"Street":"","Street
Number":0,"PostCode":"","City":"","Country":null,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"I
d":14,"Name":"GROUPE
PS"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":336,"FirstNam
e":"B.","Name":"BAUDOUX","MiddleName":null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country":nu
ll,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"Id":13,"Name":"GROUPE
PC"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":334,"FirstNam
e":"C.","Name":"BEAUCHAMP","MiddleName":null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country"
:null,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"Id":13,"Name":"GROUPE
PC"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":457,"FirstNam
e":"Elisabeth","Name":"Baume-Schneider","MiddleName":null,"Street":"Rue du 24-Septembre
2","StreetNumber":0,"PostCode":"2800","City":"Delémont","Country":"","Title":"Ministre","BirthDate":"","District":""
,"Biography":"","Groups":[{"Id":20,"Name":"PS"}],"SeatNumber":null,"BadgeNumber":"A4F538DE","Fingerprinter
Data":"","KeypadLoginCode":""}]}}

CoCon API 24 Dec 2021 126/184

4.3.7.2 GetDelegatesInCurrentMeeting

Cocon for Plixus Core

API Module Plixus Core
GetDelegatesInCurrentMeeting  ☐

Get all the delegates information in the current running meeting

Structure:
http://localhost:8890/CoCon/Delegate/GetDelegatesInCurrentMeeting

Return:
{"GetDelegatesInCurrentMeeting":{"IsMeetingRunning":true,"Delegates":[{"Id":240,"FirstName":"","Name":"AUC
OUTURIER","MiddleName":null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country":null,"Title":"","Birt
hDate":"","District":null,"Biography":"","Groups":[{"Id":9,"Name":"G9"}],"SeatNumber":2,"BadgeNumber":null,"Fin
gerprinterData":"","KeypadLoginCode":""},{"Id":274,"FirstName":"","Name":"AUDIBERT8TROIN","MiddleName":
null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country":null,"Title":"","BirthDate":"","District":null,"Biogr
aphy":"","Groups":[{"Id":10,"Name":"G10"}],"SeatNumber":3,"BadgeNumber":null,"FingerprinterData":"","Keypad
LoginCode":""},{"Id":275,"FirstName":"","Name":"BARREILLE","MiddleName":null,"Street":"","StreetNumber":0,"
PostCode":"","City":"","Country":null,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"Id":10,"Name
":"G10"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":261,"FirstN
ame":"","Name":"BATTIN","MiddleName":null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country":null,
"Title":"Mr","BirthDate":"","District":null,"Biography":"","Groups":[{"Id":10,"Name":"G10"}],"SeatNumber":null,"Bad
geNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":418,"FirstName":"David","Name":"Balmer","
MiddleName":null,"Street":"Les Gasses
27","StreetNumber":0,"PostCode":"2946","City":"Miécourt","Country":null,"Title":"Député","BirthDate":"","District":
null,"Biography":"","Groups":[{"Id":18,"Name":"PLR"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData
":"","KeypadLoginCode":""},{"Id":348,"FirstName":"D.","Name":"BATAILLE","MiddleName":null,"Street":"","Street
Number":0,"PostCode":"","City":"","Country":null,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"I
d":14,"Name":"GROUPE
PS"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":336,"FirstNam
e":"B.","Name":"BAUDOUX","MiddleName":null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country":nu
ll,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"Id":13,"Name":"GROUPE
PC"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":334,"FirstNam
e":"C.","Name":"BEAUCHAMP","MiddleName":null,"Street":"","StreetNumber":0,"PostCode":"","City":"","Country"
:null,"Title":"","BirthDate":"","District":null,"Biography":"","Groups":[{"Id":13,"Name":"GROUPE
PC"}],"SeatNumber":null,"BadgeNumber":null,"FingerprinterData":"","KeypadLoginCode":""},{"Id":457,"FirstNam
e":"Elisabeth","Name":"Baume-Schneider","MiddleName":null,"Street":"Rue du 24-Septembre
2","StreetNumber":0,"PostCode":"2800","City":"Delémont","Country":"","Title":"Ministre","BirthDate":"","District":""
,"Biography":"","Groups":[{"Id":20,"Name":"PS"}],"SeatNumber":null,"BadgeNumber":"A4F538DE","Fingerprinter
Data":"","KeypadLoginCode":""}]}}

4.3.7.3 ClearAllDelegatesAndGroups

Cocon for Plixus Core

API Module Plixus Core
ClearAllDelegatesAndGroups  ☐

Clear all the delegates and groups in the database.

Structure:
http://localhost:8890/CoCon/Delegate/ClearAllDelegatesAndGroups

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

Update event:

CoCon API 24 Dec 2021 127/184

{"DelegateRemoved":[2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26,27,28,29,30,31,32,3
3,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51,52,53,54,55,56,57,58,59,60,61,62,63,64,65,66,67,68,
69,70,71,72,73,74,75,76,77,78,79,80,81,82,83,84,85,86,87,88,89,90,91,92,93,94,95,96,97,98,99,100,101,102,1
03,104,105,106,107,108,109,110,111,112,113,114,115,116,117,118,119,120,121,122,123,124,125,126,127,12
8,129,130,131,132,133,134,135,136,137,138,139,140,141,142,144]}

4.3.7.4 GetAllDelegates

Cocon for Plixus Core

API Module Plixus Core
GetAllDelegates  ☐

Get all delegates list from the DB

Structure:
http://localhost:8890/CoCon/Delegate/GetAllDelegates

Example:
http://localhost:8890/CoCon/Delegate/GetAllDelegates

Return:
>>>{"GetAllDelegates":{"Delegates":[{"Id":81,"Name":"Vande
Lanotte","MiddleName":null,"FirstName":"Johan","Title":"Mr","BadgeNumber":null,"UserName":null,"Password":n
ull,"Street":"","StreetNumber":"","City":"","PostCode":"","Country":"","District":"","BirthDate":"","Email":null,"Phone
Nr":null,"VotingRight":true,"VotingWeight":1,"FingerprinterData":"","KeypadLoginCode":""},{"Id":101,"Name":"Aer
s","MiddleName":null,"FirstName":"Wilfried","Title":"Mr","BadgeNumber":"64CBA3DB","UserName":"","Password
":null,"Street":"","StreetNumber":"","City":"","PostCode":"","Country":"","District":"","BirthDate":"","Email":"","Phon
eNr":"","VotingRight":true,"VotingWeight":1,"FingerprinterData":"","KeypadLoginCode":""},{"Id":372,"Name":"66",
"MiddleName":null,"FirstName":"","Title":"","BadgeNumber":null,"UserName":null,"Password":null,"Street":"","Str
eetNumber":"","City":"","PostCode":"","Country":null,"District":null,"BirthDate":"","Email":null,"PhoneNr":null,"Voti
ngRight":true,"VotingWeight":1,"FingerprinterData":"","KeypadLoginCode":""},{"Id":463,"Name":"Ackermann","Mi
ddleName":null,"FirstName":"Marcel","Title":"Député","BadgeNumber":"14EFB4E2","UserName":"","Password":
null,"Street":"Route Principale
11c","StreetNumber":"","City":"Bourrignon","PostCode":"2803","Country":"","District":"","BirthDate":"","Email":"","
PhoneNr":"","VotingRight":true,"VotingWeight":1,"FingerprinterData":"","KeypadLoginCode":""},{"Id":532,"Name":
"76","MiddleName":null,"FirstName":"76","Title":"","BadgeNumber":null,"UserName":null,"Password":null,"Street"
:"","StreetNumber":"","City":"","PostCode":"","Country":null,"District":null,"BirthDate":"","Email":null,"PhoneNr":nul
l,"VotingRight":true,"VotingWeight":1,"FingerprinterData":"","KeypadLoginCode":""}]}}

4.3.7.5 AddDelegate

Cocon for Plixus Core

API Module Plixus Core
AddDelegate  ☐

Add delegate to the DB.

Structure:
http://localhost:8890/CoCon/Delegate/AddDelegate/?Name={name}&FirstName={firstName}&Title={title}&
MiddleName ={ middleName }&BadgeNr={badgeNr}&UserName={userName}&Password={password}
&Street={street}&StreetNr={streetNr}&City={city}&PostalCode={postalCode}&Country={country}&District={distric
t}&BirthDate={birthDate}
&Email={email}&PhoneNr={phoneNr}&Biography={biography}&VotingRight={votingRight}&VotingWeight={votin
gWeight}&PinId={pinId}&FingerprinterData={ fingerprinterData }&KeypadLoginCode={ keypadLoginCode }

CoCon API 24 Dec 2021 128/184

 Name Description Type

Name The name of the delegate string

FirstName The first name of the delegate string

The title of the delegate
Title string
[Optional parameter]
MiddleName of the delegate
MiddleName string
[Optional parameter]
The badge number
BadgeNr int
[Optional parameter]
The username for the delegate
UserName string
[Optional parameter]
The password for the delegate
Password string
[Optional parameter]
The street for the delegate
Street string
[Optional parameter]
The street number for the delegate
StreetNr string
[Optional parameter]
The city for the delegate
City string
[Optional parameter]
The postal code for the delegate
PostalCode string
[Optional parameter]
The country for the delegate
Country string
[Optional parameter]
The district for the delegate
District string
[Optional parameter]
The delegate’s birthday
BirthDate string
[Optional parameter]
The delegate’s email address
Email string
[Optional parameter]
The delegate’s phone number
PhoneNr String
[Optional parameter]
Biography of the delegate
Biography string
[Optional parameter]
Does the delegate have the right to vote?
VotingRight Default value : True Bool
[Optional parameter]
The voting weight to apply for this delegate
VotingWeight Default value : 1 Int
[Optional parameter]
PinId to login for voting
PinId Must be 4 number only (0-9) Int
[Optional parameter]
Fingerprint data to open the Unicos IDC
FingerprinterData screen string
[Optional parameter]
Code to login into the Unicos FMM (IDC)
KeypadLoginCode int
[Optional parameter]

Example:
http://localhost:8890/CoCon/Delegate/AddDelegate/?Name=Isha&FirstName=Sakhalakr&Title=Mrs.
http://localhost:8890/CoCon/Delegate/AddDelegate/?Name=Isha&FirstName=Sakhalakr&Title=Mrs.&PinId=123
4

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

Update event :
{"DelegateAdded":{"DelegateId":534,"Name":"Isha","MiddleName":null,"FirstName":"Sakhalakr","Title":"Mrs.","
BadgeNr":"","UserName":"","Password":"","Street":"","StreetNr":"0","PostalCode":"","City":"","Country":"","Birth
Date":"","District":"","Email":"","PhoneNr":"","VotingRight":true,"VotingWeight":1,"PinId":"","FingerprinterData":""
,"KeypadLoginCode":""}}

CoCon API 24 Dec 2021 129/184

4.3.7.6 RemoveDelegate

Cocon for Plixus Core

API Module Plixus Core
RemoveDelegate  ☐

Remove delegate from the DB.

Structure:
http://localhost:8890/CoCon/Delegate/RemoveDelegate/?DelegateId={delegateId}

Example:
http://localhost:8890/CoCon/Delegate/RemoveDelegate/?DelegateId=40
Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

Update Event :
{"DelegateRemoved":[40]}

4.3.7.7 EditDelegate

Cocon for Plixus Core

API Module Plixus Core
EditDelegate  ☐

Edit exiting delegate in DB.

Structure:
http://localhost:8890/CoCon/Delegate/EditDelegate/?DelegateId={delegateId}&Name={name}&FirstName={first
Name}&Title={title}&MiddleName={middleName}&BadgeNr={badgeNr}&UserName={userName}&Password={pa
ssword}&Street={street}&StreetNr={streetNr}&City={city}&PostalCode={postalCode}&Country={country}&District
={district}&BirthDate={birthDate}&Email={email}&PhoneNr={phoneNr}&Biography={biography}&VotingRight={vo
tingRight}&VotingWeight={votingWeight}&PinId={pinId}&FingerprinterData={ fingerprinterData
}&KeypadLoginCode={ keypadLoginCode }

Name Description Type

DelegateId The Id of the delegate int

Name The name of the delegate string

FirstName The first name of the delegate string

The title of the delegate
Title string
[Optional parameter]
MiddleName of the delegate
MiddleName string
[Optional parameter]
The badge number
BadgeNr int
[Optional parameter]
The username for the delegate
UserName string
[Optional parameter]
The password for the delegate
Password string
[Optional parameter]
The street for the delegate
Street string
[Optional parameter]
The street number for the delegate
StreetNr string
[Optional parameter]
The city for the delegate
City string
[Optional parameter]
The postal code for the delegate
PostalCode string
[Optional parameter]

CoCon API 24 Dec 2021 130/184

 The country for the delegate
Country string
[Optional parameter]
The district for the delegate
District string
[Optional parameter]
The delegate’s birthday
BirthDate string
[Optional parameter]
The delegate’s email address
Email string
[Optional parameter]
The delegate’s phone number
PhoneNr String
[Optional parameter]
Biography of the delegate
Biography string
[Optional parameter]
Does the delegate have the right to vote?
VotingRight Bool
[Optional parameter]
The voting weight to apply for this delegate
VotingWeight Int
[Optional parameter]
PinId to login for voting
PinId Must be 4 number only (0-9) Int
[Optional parameter]
Fingerprint data to open the Unicos IDC
FingerprinterData screen string
[Optional parameter]
Code to login into the Unicos FMM (IDC)
KeypadLoginCode int
[Optional parameter]

Example:
http://localhost:8890/CoCon/Delegate/EditDelegate/?DelegateId=505&Name=Manoj&FirstName=Patel&Title=M
r.&PinId=9876

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

Update Event :
{"DelegateUpdated":{"DelegateId":534,"Name":"Manoj","MiddleName":"Subhashbhai","FirstName":"Patel","Title"
:"Mr.","BadgeNr":"","UserName":"","Password":"","Street":"","StreetNr":"0","PostalCode":"","City":"","Country":"","
BirthDate":"","District":"","Email":"","PhoneNr":"","VotingRight":true,"VotingWeight":1,"PinId":"9876","Fingerprinte
rData":"","KeypadLoginCode":"1234"}}

4.3.7.8 ImportDelegatesFromFile

Cocon for Plixus Core

API Module Plixus Core
ImportDelegatesFromFile  ☐

Import delegate from the file. (Note: it should be work wit the same version of the installer).

Structure:
http://localhost:8890/CoCon/Delegate/ImportDelegatesFromFile/?FilePath={filePath}

Example:
http://localhost:8890/CoCon/Delegate/ImportDelegatesFromFile/?FilePath=C:\Users\MP\Desktop\ERS\3.1-05-
15-38-fullname.xml

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 131/184

4.3.7.9 GetAuthorityOverview

Cocon for Plixus Core

API Module Plixus Core
GetAuthorityOverview  ☐

API call to get overview of delegate authority. It details the delegates whose authority is passed to another
delegate. When no meeting is active, this call will return all authority data.

Structure:
http://localhost:8890/CoCon/Delegate/GetAuthorityOverview

Example:
http://localhost:8890/CoCon/Delegate/GetAuthorityOverview

Return:
0 → operation success; -1 → exception

CoCon API 24 Dec 2021 132/184

4.3.8 Interactive
This section describes commands that are only applicable for the Televic uniCOS (PlixUs) hardware.

4.3.8.1 SetDelegateScreen
Set the delegate screen on the IDCs as well as screen options.
Only applicable for uniCOS (PlixUs).

Parameters applicable for ALL screens:

Name Description Type

IsLocked Lock state of IDC Bool

bool indicating whether the IDC should change
IsGoTo to the specified screen Bool

IsShow Show or hide the screen Bool

Note that the specific screens described below might have more additional parameters

4.3.8.1.1 Home

Cocon for Plixus Core

API Module Plixus Core
Home  ☐

Structure:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Home/?IsLocked={bool}&IsGoTo={bool}&IsShow={
bool}

Example:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Home/?IsLocked=True&IsGoTo=True&IsShow=Tru
e

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.8.1.2 Discussion
Cocon for Plixus Core
API Module Plixus Core
Discussion  ☐

Additional parameters
Name Description Type
Set video viewing mode
0: disabled; no video shown
Video int
1: normal
2: full screen
Set video stream for Multimedia units.
VideoStream int
(VideoStream: 1 to 6 number)

Structure
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Discussion/?IsLocked={bool}&IsGoTo={bool}&IsSho
w={bool}&Video={int}&VideoStream={videoStream}

CoCon API 24 Dec 2021 133/184

Example 1:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Discussion/?IsLocked=True&IsGoTo=True&IsShow
=True&Video=1

Example 2:
http://192.168.8.230:8890/CoCon/Interactive/SetDelegateScreen/Discussion/?IsLocked=True&IsGoTo=True&Is
Show=True&Video=1&VideoStream=2

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.8.1.3 Agenda

Cocon for Plixus Core

API Module Plixus Core
Agenda  ☐

Additional parameters
Name Description Type

Select Select and show active agenda item bool

Structure

http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Agenda/?IsLocked={bool}&IsGoTo={bool}&IsShow=
{bool}&Select={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Agenda/?IsLocked=True&IsGoTo=True&IsShow=Tr
ue&Select=True

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.8.1.4 Delegates

Cocon for Plixus Core

API Module Plixus Core
Delegates  ☐

Structure
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Delegates/?IsLocked={bool}&IsGoTo={bool}&IsSho
w={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Delegates/?IsLocked=True&IsGoTo=True&IsShow=
True

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 134/184

 4.3.8.1.5 Voting

Cocon for Plixus Core

API Module Plixus Core
Voting  ☐

Additional parameters
Name Description Type

Res Show voting results bool

Graph Show voting graph bool

Structure
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Voting/?IsLocked={bool}&IsGoTo={bool}&IsShow={
bool}&Res={bool}&Graph={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Voting/?IsLocked=True&IsGoTo=True&IsShow=Tru
e&Res=True&Graph=True

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.8.1.6 Documents

Cocon for Plixus Core

API Module Plixus Core
Documents  ☐

Additional parameters
Name Description Type

Doc Id of the document to select string

Lck Lock the document (no selection) bool

Page Page number to be scrolled to int

Docfs Show the document fullscreen bool

Structure
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Documents/?IsLocked={bool}&IsGoTo={bool}&IsSh
ow={bool}&Doc={string}&Lck={bool}&Page={int}&Docfs={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Documents/?IsLocked=True&IsGoTo=True&IsShow
=True&Doc=Cocon-manual&Lck=True&Page=1&Docfs=True

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 135/184

 4.3.8.1.7 Messages

Cocon for Plixus Core

API Module Plixus Core
Messages  ☐

Structure
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Messages/?IsLocked={bool}&IsGoTo={bool}&IsSho
w={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Messages/?IsLocked=True&IsGoTo=True&IsShow=
True

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.8.1.8 Services

Cocon for Plixus Core

API Module Plixus Core
Services  ☐

Structure
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Services/?IsLocked={bool}&IsGoTo={bool}&IsShow
={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Services/?IsLocked=True&IsGoTo=True&IsShow=T
rue

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.8.1.9 Configuration

Cocon for Plixus Core

API Module Plixus Core
Configuration  ☐

Structure
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Configuration/?IsLocked={bool}&IsGoTo={bool}&IsS
how={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetDelegateScreen/Configuration/?IsLocked=True&IsGoTo=True&IsSh
ow=True

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 136/184

4.3.8.2 RemoveScreenLock

Cocon for Plixus Core

API Module Plixus Core
RemoveScreenLock  ☐

Remove the screen lock on the Multimedia Unit.

Only applicable for uniCOS (PlixUs)

Structure:
http://localhost:8890/CoCon/Screen/RemoveScreenLock

Return:
{RemoveScreenLock : {“success” : “true”}}

4.3.8.3 SetCustomButtonOnSeat

Cocon for Plixus Core

API Module Plixus Core
SetCustomButtonOnSeat  ☐

Configure a custom button on a seat

Structure
http://localhost:8890/CoCon/Interactive/SetCustomButtonOnSeat?SeatId={int}&ButtonId={int}&Text={string}&Fg
Color={string}&BgColor={string}&Show={bool}&EnableDown={bool}&EnableUp={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetCustomButtonOnSeat?SeatId=5&ButtonId=1&Text=Request
Floor&FgColor=black&BgColor=white&Show=True&EnableDown=True&EnableUp=False

Return:
{“SetCustomButtonOnSeat”: {“success”: “true”}}

4.3.8.4 SetCustomButtonOnRoom

Cocon for Plixus Core

API Module Plixus Core
SetCustomButtonOnRoom  ☐

Configure a custom button on a seat

Structure
http://localhost:8890/CoCon/Interactive/SetCustomButtonOnRoom?
ButtonId={int}&Text={string}&FgColor={string}&BgColor={string}&Show={bool}&EnableDown={bool}&EnableUp
={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetCustomButtonOnRoom?ButtonId=1&Text=Request
Floor&FgColor=black&BgColor=white&Show=True&EnableDown=True&EnableUp=False

Return:
{“SetCustomButtonOnRoom”: {“success”: “true”}}

CoCon API 24 Dec 2021 137/184

4.3.8.5 SetCustomLabelOnSeat

Cocon for Plixus Core

API Module Plixus Core
SetCustomLabelOnSeat  ☐

Configure a custom button on a seat

Structure
http://localhost:8890/CoCon/Interactive/SetCustomLabelOnSeat?SeatId={int}&LabelId={int}&Text={string}&FgC
olor={string}&BgColor={string}&Show={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetCustomLabelOnSeat?SeatId=5&LabelId=1&Text=Floor
Requested&FgColor=black&BgColor=white&Show=True

Return:
{“SetCustomLabelOnSeat”: {“success”: “true”}}

4.3.8.6 SetCustomLabelOnRoom

Cocon for Plixus Core

API Module Plixus Core
SetCustomLabelOnRoom  ☐

Configure a custom button on a seat

Structure
http://localhost:8890/CoCon/Interactive/SetCustomLabelOnRoom?LabelId={int}&Text={string}&FgColor={string}
&BgColor={string}&Show={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetCustomLabelOnRoom?LabelId=1&Text=Floor
Requested&FgColor=black&BgColor=white&Show=True

Return:
{“SetCustomLabelOnRoom”: {“success”: “true”}}

4.3.8.7 SetCustomScreenOnSeat

Cocon for Plixus Core

API Module Plixus Core
SetCustomScreenOnSeat  ☐

Configure a custom screen on a seat (see specific notes in API call SetCustomScreenOnRoom)
Structure
http://localhost:8890/CoCon/Interactive/SetCustomScreenOnSeat?SeatId={int}&Lock={bool}&Go={bool}&Show=
{bool}&CustomScreenId={int}&Title={string}&Content={String}&fullscreen={bool}

Example (also see extended example and notes in SetCustomScreenOnRoom):

http://192.168.8.120:8890/CoCon/Interactive/SetCustomScreenOnSeat?SeatId=2&Lock=False&Go=False&Sho
w=True&CustomScreenId=1&Title=Custom
Tab&Content=<HTML><HEAD><TITLE>UNIT1</TITLE></HEAD><BODY><H1>Custom screen</H1><P>This
is a custom screen.</P></BODY></HTML>

Return:
{“SetCustomScreenOnSeat”: {“success”: “true”}}

CoCon API 24 Dec 2021 138/184

4.3.8.8 SetCustomScreenOnRoom

Cocon for Plixus Core

API Module Plixus Core
SetCustomScreenOnRoom  ☐

Configure a custom button on a seat

Structure
http://localhost:8890/CoCon/Interactive/SetCustomScreenOnRoom?Lock={bool}&Go={bool}&Show={bool}&Cus
tomScreenId={int}&Title={string}&Content={String}&fullscreen={bool}

Example:
http://localhost:8890/CoCon/Interactive/SetCustomScreenOnRoom?Lock=False&Go=False&Show=True&Custo
mScreenId=1&Title=Custom
Tab&Content=<HTML><HEAD><TITLE>UNIT1</TITLE></HEAD><BODY><H1>Custom screen</H1><P>This
is a custom screen.</P></BODY></HTML>

Extended example with styling, embedded image and javascript:

http://localhost:8890/CoCon/Interactive/SetCustomScreenOnRoom?Lock=False&Go=False&Show=True&Custo
mScreenId=1&Title=Custom&Content=< iframe style="height:449px;"
srcdoc="<html><head><style>h1{color:red;}</style></head><body><h1 id='myheader'>Header h1</h1><img
src='data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAMAAAC67D%2BPAAAAGXRFW
HRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAyZpVFh0WE1MOmNvbS5hZG9iZS54bXAAAAAAA
Dw/eHBhY2tldCBiZWdpbj0i77u/IiBpZD0iVzVNME1wQ2VoaUh6cmVTek5UY3prYzlkIj8%2BIDx4OnhtcG1ldGEg
eG1sbnM6eD0iYWRvYmU6bnM6bWV0YS8iIHg6eG1wdGs9IkFkb2JlIFhNUCBDb3JlIDUuNi1jMTQ1IDc5LjE2M
zQ5OSwgMjAxOC8wOC8xMy0xNjo0MDoyMiAgICAgICAgIj4gPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8v
d3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4gPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9Ii
IgeG1sbnM6eG1wPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvIiB4bWxuczp4bXBNTT0iaHR0cDovL2
5zLmFkb2JlLmNvbS94YXAvMS4wL21tLyIgeG1sbnM6c3RSZWY9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzE
uMC9zVHlwZS9SZXNvdXJjZVJlZiMiIHhtcDpDcmVhdG9yVG9vbD0iQWRvYmUgUGhvdG9zaG9wIENDIDIwMT
kgKFdpbmRvd3MpIiB4bXBNTTpJbnN0YW5jZUlEPSJ4bXAuaWlkOjg2NkYzNDFGMzBGNTExRTk5REU0QzMy
MkU4Q0VDNjQ4IiB4bXBNTTpEb2N1bWVudElEPSJ4bXAuZGlkOjg2NkYzNDIwMzBGNTExRTk5REU0QzMyM
kU4Q0VDNjQ4Ij4gPHhtcE1NOkRlcml2ZWRGcm9tIHN0UmVmOmluc3RhbmNlSUQ9InhtcC5paWQ6ODY2RjM
0MUQzMEY1MTFFOTlERTRDMzIyRThDRUM2NDgiIHN0UmVmOmRvY3VtZW50SUQ9InhtcC5kaWQ6ODY2R
jM0MUUzMEY1MTFFOTlERTRDMzIyRThDRUM2NDgiLz4gPC9yZGY6RGVzY3JpcHRpb24%2BIDwvcmRmOl
JERj4gPC94OnhtcG1ldGE%2BIDw/eHBhY2tldCBlbmQ9InIiPz4zwT8RAAAABlBMVEUAAP8AAAB7Yr8%2BAA
AADklEQVR42mJgoCcACDAAAG4AARwPxJAAAAAASUVORK5CYII='/><script
type='text/javascript'>document.body.innerHTML %2B= '<p>This text was added in
JavaScript!</p>';</script></body></html>"></iframe>

Notes:
• The complete URL (including base64 string) needs to be encoded. You can use
https://www.urlencoder.org/ to do so. The “+” character is e.g. converted to “%2B”
• An iframe is not required, unless you want to use CSS for styling. Alternatively you can configure
everything through the style attribute
• The height of 449px corresponds to unicos 7” unit, use 649px for unicos 10” unit
• Javascript is possible, but will be (re-)activated when entering in the specific tab
• Don’t use hyperlinks
• Not possible to use e.g. remote image sources
• A special use-case could be to navigate to intranet page which is hosted on webserver which is
connected with the Plixus NEXT LAN interface. This will also require a DHCP server. Please be aware
of limitations and ask more information regarding this use-case.

Return:
{“SetCustomScreenOnRoom”: {“success”: “true”}}

CoCon API 24 Dec 2021 139/184

4.3.8.9 GetServiceList

Cocon for Plixus Core

API Module Plixus Core
GetServiceList  ☐

This api will help user to get all service list which is present on Cocon Database.
Structure:
http://localhost:8890/CoCon/Interactive/GetServiceList

Example:
http://localhost:8890/CoCon/Interactive/GetServiceList

Return:
{"ServiceList":{"Services":[{"Id":1,"Name":"Tea"},{"Id":2,"Name":"Coffee"},{"Id":3,"Name":"Cake"}]}}

4.3.8.10 GetServiceListbyMeetingId
This api will help user to get list of service based on meeting id.

Cocon for Plixus Core

API Module Plixus Core
GetServiceListbyMeetingId  ☐

Structure：
http://localhost:8890/CoCon/Interactive/GetServiceListbyMeetingId/?MeetingId={int}

Example:
http://localhost:8890/CoCon/Interactive/GetServiceListbyMeetingId/?MeetingId=17

Return:
{"ServiceList":{"Services":[{"Id":1,"Name":"Tea"},{"Id":2,"Name":"Coffee"}]}}

4.3.8.11 SetServiceRequestState

Cocon for Plixus Core

API Module Plixus Core
SetServiceRequestState  ☐

Configure Service Request State

Structure：
http://localhost:8890/CoCon/Interactive/SetServiceRequestState?SeatId={int}&ServiceId={int}&ServiceState={int
}

Example:
http://localhost:8890/CoCon/Interactive/SetServiceRequestState?SeatId=2&ServiceId=1&ServiceState=0

Return:
Update Event:
{"ServiceRequestEvent":{"SeatId":2,"ServiceId":1,"ServiceState":0}}

4.3.8.12 GetServiceRequestStates

CoCon API 24 Dec 2021 140/184

 Cocon for Plixus Core
API Module Plixus Core
GetServiceRequestStates  ☐

This api will help user to get list of service based on meeting id.
Structure：
http://localhost:8890/CoCon/Interactive/GetServiceRequestStates

Example:
http://localhost:8890/CoCon/Interactive/GetServiceRequestStates

Return:
{"ServiceRequestEvent":{"Seats":[{"SeatId":2,"Services":[{"ServiceId":1,"ServiceState":1},{"ServiceId":2,"Service
State":1}]}]}}

4.3.8.13 DisableDelegateScreen

Cocon for Plixus Core

API Module Plixus Core
DisableDelegateScreen  ☐

This API allows to disable uniCOS delegate screens

Notes:
• It doesn’t apply to uniBOX units
• It only applies to the uniCOS F/MM7 (71.98.2002), F/MM10 (71.98.2001) and T/MM10 (71.98.2003). Or
on the customized units based on these uniCOS unit generation

Structure：
http://localhost:8890/CoCon/Interactive/DisableDelegateScreen/?Disable={isDisabled}

Example:
http://localhost:8890/CoCon/Interactive/DisableDelegateScreen/?Disable=false

Return:
0 succeed
-1 exception

4.3.8.14 ResetScreen

Cocon for Plixus Core

API Module Plixus Core
ResetScreen  ☐

This API allows to reset the software of unicos/unibox units. The behavior is identical to “reset screen”
functionality which is offered through the Cocon Operator application. Important to mention that a meeting
pause/resume or resend meeting data is required to have the unit back in correct meeting state.

Structure：
http://localhost:8890/CoCon/Interactive/ResetScreen/?SeatId={seatNumber}

Example:
http://localhost:8890/CoCon/Interactive/ResetScreen/?SeatId=2

Return:

CoCon API 24 Dec 2021 141/184

 0 succeed
-1 exception
1 seat not found

Note: HTTP status code 503 in case central unit is not connected.

CoCon API 24 Dec 2021 142/184

4.3.9 Audio

4.3.9.1 GetCurrentAudioSoftwareConfiguration

Cocon for Plixus Core

API Module Plixus Core
GetCurrentAudioSoftwareConfiguration  

Structure：
http://localhost:8890/CoCon/Audio/GetCurrentAudioSoftwareConfiguration

Example:
http://localhost:8890/CoCon/Audio/GetCurrentAudioSoftwareConfiguration

Return:

{"GetCurrentAudioSoftwareConfiguration":{"AudioSoftwareConfiguration":{"Id":3,"Name":"External equalizer"}}}

4.3.9.2 GetCurrentAudioSoftwareConfigurationInDetails

Cocon for Plixus Core

API Module Plixus Core
GetCurrentAudioSoftwareConfigurationInDetail  
s

Structure：
http://localhost:8890/CoCon/Audio/GetCurrentAudioSoftwareConfigurationInDetails

Example:
http://localhost:8890/CoCon/Audio/GetCurrentAudioSoftwareConfigurationInDetails

Note: This call returns the details of the current SAVED audio configuration. If changes were applied one will
only observe these through this call after saving the configuration.

Return:

{"GetCurrentAudioSoftwareConfigurationInDetails":{"AudioSoftwareConfiguration":{"Id":1,"Name":"Normal
routing","MatrixNodes":[{"InputGroupName":"Floor IN","OutputGroupName":"Floor
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"AUX
IN","OutputGroupName":"Floor
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Dante
IN","OutputGroupName":"Floor
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"AUX OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"AUX
IN","OutputGroupName":"AUX
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Dante
IN","OutputGroupName":"AUX
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Dante
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"AUX
IN","OutputGroupName":"Dante
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Dante
IN","OutputGroupName":"Dante
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang1

CoCon API 24 Dec 2021 143/184

OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang1
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang1
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang1
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang1
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang2
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang2
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang2
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang2
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang2
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang3
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang3
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang3

CoCon API 24 Dec 2021 144/184

OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang3
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang3
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang4
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang4
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang4
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang4
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang4
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang5
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang5
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang5
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang5
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang5

CoCon API 24 Dec 2021 145/184

OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang5
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang6
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang6
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang6
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang6
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang6
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang7
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang7
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang7
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang7
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang7

CoCon API 24 Dec 2021 146/184

OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang7
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang8
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang8
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang8
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang8
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang8
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang9
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang9
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang9
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang9
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang9

CoCon API 24 Dec 2021 147/184

OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang9
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang10
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang10
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang10
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang10
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang10
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang11
IN","OutputGroupName":"Lang11
OUT","MixValue":0,"Status":true,"BackupStatus":false},{"InputGroupName":"Floor
IN","OutputGroupName":"Lang11
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"AUX
IN","OutputGroupName":"Lang11
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Dante
IN","OutputGroupName":"Lang11
OUT","MixValue":0,"Status":false,"BackupStatus":true},{"InputGroupName":"Lang1
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang2
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang3
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang4
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang5
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang6
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang7
IN","OutputGroupName":"Lang11

CoCon API 24 Dec 2021 148/184

OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang8
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang9
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false},{"InputGroupName":"Lang10
IN","OutputGroupName":"Lang11
OUT","MixValue":33,"Status":false,"BackupStatus":false}],"AudioGroups":[{"Id":0,"Name":"Floor
IN","Type":"Input"},{"Id":1,"Name":"AUX IN","Type":"Input"},{"Id":2,"Name":"Dante
IN","Type":"Input"},{"Id":3,"Name":"Lang1 IN","Type":"Input"},{"Id":4,"Name":"Lang2
IN","Type":"Input"},{"Id":5,"Name":"Lang3 IN","Type":"Input"},{"Id":6,"Name":"Lang4
IN","Type":"Input"},{"Id":7,"Name":"Lang5 IN","Type":"Input"},{"Id":8,"Name":"Lang6
IN","Type":"Input"},{"Id":9,"Name":"Lang7 IN","Type":"Input"},{"Id":10,"Name":"Lang8
IN","Type":"Input"},{"Id":11,"Name":"Lang9 IN","Type":"Input"},{"Id":12,"Name":"Lang10
IN","Type":"Input"},{"Id":13,"Name":"Lang11 IN","Type":"Input"},{"Id":1,"Name":"Floor
OUT","Type":"Output"},{"Id":2,"Name":"AUX OUT","Type":"Output"},{"Id":3,"Name":"Dante
OUT","Type":"Output"},{"Id":4,"Name":"Lang1 OUT","Type":"Output"},{"Id":5,"Name":"Lang2
OUT","Type":"Output"},{"Id":6,"Name":"Lang3 OUT","Type":"Output"},{"Id":7,"Name":"Lang4
OUT","Type":"Output"},{"Id":8,"Name":"Lang5 OUT","Type":"Output"},{"Id":9,"Name":"Lang6
OUT","Type":"Output"},{"Id":10,"Name":"Lang7 OUT","Type":"Output"},{"Id":11,"Name":"Lang8
OUT","Type":"Output"},{"Id":12,"Name":"Lang9 OUT","Type":"Output"},{"Id":13,"Name":"Lang10
OUT","Type":"Output"},{"Id":14,"Name":"Lang11 OUT","Type":"Output"}]}}}

4.3.9.3 GetAudioSoftwareConfigurations

Cocon for Plixus Core

API Module Plixus Core
GetAudioSoftwareConfigurations  

Structure：
http://localhost:8890/CoCon/Audio/GetAudioSoftwareConfigurations

Example:
http://localhost:8890/CoCon/Audio/GetAudioSoftwareConfigurations

Return:
{"GetAudioSoftwareConfigurations":{"AudioSoftwareConfigurations":[{"Id":1,"Name":"Normal
routing","Description":"Incoming audio from microphone ,auxiliary inputs 1 - 2 & 3 and dante input channel 1 is
routed by default to the unit speakers ,auxiliary outputs 1 - 2 & 3 and dante output channel
1.","Predefined":true,"State":"New"},{"Id":2,"Name":"Distance conferencing","Description":"Incoming audio from
microphone ,auxiliary inputs 1 - 2 & 3 and dante input channel 1 is routed by default to the unit speakers.
Incoming audio from microphone is routed by default to the auxiliary outputs 1 - 2 &3 and dante output channel
1.","Predefined":true,"State":"New"},{"Id":3,"Name":"External equalizer","Description":"Incoming audio from
auxiliary inputs 1 - 2 & 3 and dante input channel 1 is routed by default to the unit speakers. Incoming audio
from microphone is routed by default to the auxiliary outputs 1 - 2 & 3 and dante output channel
1.","Predefined":true,"State":"New"},{"Id":4,"Name":"New Preset","Description":"This is a new
preset","Predefined":false,"State":"Running"}]}}

4.3.9.4 GetAudioGroupsInCurrentConfiguration

Cocon for Plixus Core

API Module Plixus Core
GetAudioGroupsInCurrentConfiguration  

This command will reply with all groups from running (Active) Preset.
Structure：
http://localhost:8890/CoCon/Audio/GetAudioGroupsInCurrentConfiguration

CoCon API 24 Dec 2021 149/184

Example:
http://localhost:8890/CoCon/Audio/GetAudioGroupsInCurrentConfiguration

Return:

{"GetAudioGroupsInCurrentConfiguration":{"AudioGroups":[{"Id":0,"Name":"Floor
IN","Type":"Input"},{"Id":1,"Name":"AUX IN","Type":"Input"},{"Id":2,"Name":"Dante
IN","Type":"Input"},{"Id":3,"Name":"Lang1 IN","Type":"Input"},{"Id":4,"Name":"Lang2
IN","Type":"Input"},{"Id":5,"Name":"Lang3 IN","Type":"Input"},{"Id":6,"Name":"Lang4
IN","Type":"Input"},{"Id":7,"Name":"Lang5 IN","Type":"Input"},{"Id":8,"Name":"Lang6
IN","Type":"Input"},{"Id":9,"Name":"Lang7 IN","Type":"Input"},{"Id":10,"Name":"Lang8
IN","Type":"Input"},{"Id":11,"Name":"Lang9 IN","Type":"Input"},{"Id":12,"Name":"Lang10
IN","Type":"Input"},{"Id":13,"Name":"Lang11 IN","Type":"Input"},{"Id":1,"Name":"Floor
OUT","Type":"Output"},{"Id":2,"Name":"AUX OUT","Type":"Output"},{"Id":3,"Name":"Dante
OUT","Type":"Output"},{"Id":4,"Name":"Lang1 OUT","Type":"Output"},{"Id":5,"Name":"Lang2
OUT","Type":"Output"},{"Id":6,"Name":"Lang3 OUT","Type":"Output"},{"Id":7,"Name":"Lang4
OUT","Type":"Output"},{"Id":8,"Name":"Lang5 OUT","Type":"Output"},{"Id":9,"Name":"Lang6
OUT","Type":"Output"},{"Id":10,"Name":"Lang7 OUT","Type":"Output"},{"Id":11,"Name":"Lang8
OUT","Type":"Output"},{"Id":12,"Name":"Lang9 OUT","Type":"Output"},{"Id":13,"Name":"Lang10
OUT","Type":"Output"},{"Id":14,"Name":"Lang11 OUT","Type":"Output"}]}}

4.3.9.5 SetAudioSoftwareConfigurationById

Cocon for Plixus Core

API Module Plixus Core
SetAudioSoftwareConfigurationById  

Parameters:
Name Description Type

Id The id of the audio software configuration int

Structure:
http://localhost:8890/CoCon/Audio/SetAudioSoftwareConfigurationById/?Id={id}

Example:
http://localhost:8890/CoCon/Audio/SetAudioSoftwareConfigurationById/?Id=1

Return:

{"SetAudioSoftwareConfigurationById":{"AudioSoftwareConfiguration":{"Description":"Incoming audio from

microphone, auxiliary inputs 1, 2 & 3 and Dante input channel 1 is routed by default to the unit speakers,
auxiliary outputs 1, 2 & 3 and Dante output channel 1.","Id":1,"Name":"Normal
routing","Predefined":true,"State":"Active"}}}

4.3.9.6 SetAudioSoftwareConfigurationByName

Cocon for Plixus Core

API Module Plixus Core
SetAudioSoftwareConfigurationByName  

Name: SetAudioSoftwareConfigurationByName
Parameters:

CoCon API 24 Dec 2021 150/184

 Name Description Type

Name The Name of the audio software configuration string

Structure:
http://localhost:8890/CoCon/Audio/SetAudioSoftwareConfigurationByName/?Name={name}

Example:
http://localhost:8890/CoCon/Audio/SetAudioSoftwareConfigurationByName/?Name=Normal routing 123

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.9.7 ChangeMatrixNodeStatus

Cocon for Plixus Core

API Module Plixus Core
ChangeMatrixNodeStatus  

This command will apply on the current running (active) preset only.

Parameters:
Name Description Type
InputGroupName The name of routing input group string

OutputGroupName The name of routing output group string

The matrix node status(enable or not)
Status bool
True/False
The matrix node backup status(enable or not)
BackupStatus bool
True/False
MixValue The mix value of the group(-100~0) int

Structure:
http://localhost:8890/CoCon/Audio/ChangeMatrixNodeStatus/?InputGroupName={inputGroupName}&OutputGro
upName={outputGroupName}&Status={status}&BackupStatus={backupStatus}&MixValue={mixValue}

Example:
http://localhost:8890/CoCon/Audio/ChangeMatrixNodeStatus/?InputGroupName=Floor
In&OutputGroupName=Floor Out&Status=False&BackupStatus=False&MixValue=-20

Return:
{"ChangeMatrixNodeStatus":{"MatrixNode":{"InputGroupName":"Floor In","OutputGroupName":"Floor
out","MixValue":-20,"Status":false,"BackupStatus":false,"Id":201}}}

4.3.9.8 GetMatrixNodeStatus

Cocon for Plixus Core

API Module Plixus Core
GetMatrixNodeStatus  

Get the status of a specific node in running (Active) audio preset. The input group and output group are
required.

CoCon API 24 Dec 2021 151/184

 Name Description Type

InputGroupName The name of routing input group String

OutputGroupName The name of routing output group string

Structure:
http://localhost:8890/CoCon/Audio/GetMatrixNodeStatus/?InputGroupName={inputGroupName}&OutputGroupN
ame={inputGroupName}

Example:
http://localhost:8890/CoCon/Audio/GetMatrixNodeStatus/?InputGroupName=Floor In&OutputGroupName=Floor
Out

Return:
{"GetMatrixNodeStatus":{"MatrixNode":{"InputGroupName":"Floor In","OutputGroupName":"Floor
out","MixValue":-20,"Status":false,"BackupStatus":true,"Id":201}}}

4.3.9.9 SaveAudioSoftwareConfiguration

Cocon for Plixus Core

API Module Plixus Core
SaveAudioSoftwareConfiguration  

If the ” name ” corresponding configuration not exists in the database, it will create a new configuration and
If the ” name ” is exists in the database then save it.
Note: CoCon will ignore the text case for the preset name.

Parameters:
Name Description Type
Name of the configuration
Name string
Description of the configuration
Description string

Structure：
http://localhost:8890/CoCon/Audio/SaveAudioSoftwareConfiguration/?Name={name}&Description={description}

Example:
http://localhost:8890/CoCon/Audio/SaveAudioSoftwareConfiguration/?Name=Audio Preset
Test&Description=Audio Preset Test

Return:
{"SaveAudioSoftwareConfiguration":{"AudioSoftwareConfiguration":{"Id":16,"Name":"Audio Preset
Test","Description":"Audio Preset Test","Predefined":false,"State":"New"}}}

Return for CoCon for Plixus Core & Plixus Core:

Note: only the second reply contains the right data, so user have to send 2 time api call to get the updated info.

CoCon API 24 Dec 2021 152/184

4.3.10 Logging

4.3.10.1 GetCUState

Cocon for Plixus Core

API Module Plixus Core
GetCUState  ☐

Get the status of the Plixus engine

Structure:
http://localhost:8890/CoCon/Logging/GetCUState

Return:
{"GetCUState":{"CuState":"Connected"}}
{"GetCUState":{"CuState":"Disconnected"}}

4.3.10.2 GetUnitErrorState

Cocon for Plixus Core

API Module Plixus Core
GetUnitErrorState  

Gets the IDs of the units which are currently in error state.

Structure:
http://localhost:8890/CoCon/Logging/GetUnitErrorState

Return:
{"GetUnitErrorState":{"Units":[{"UnitId":1},{"UnitId":2},{"UnitId":6},{"UnitId":7}]}}

4.3.11 ButtonLED_Event

4.3.11.1 SetButtonsEnabled

Cocon for Plixus Core

API Module Plixus Core
SetButtonsEnabled  

Set the buttons of one or more seats to enabled or disabled.

If the buttons are disabled, no button events are possible.
Set the enabled to true to allow CoCon, and the API, to receive button events from the units.

The event “ButtonPressed” (see section 4.2.10.1) can only be received by the API clients after one or more of
the buttons have been enabled, using the command “SetButtonsEnabled”.

Structure:
http://localhost:8890/CoCon/ButtonLED_Event/SetButtonsEnabled/?SeatNr=<SeatNr>&ButtonNr=<ButtonNr>&
Enabled=<Enabled>

CoCon API 24 Dec 2021 153/184

Parameters:
Name Description Type
The number of the seat on which the
buttons are enable/disabled.
SeatNr int
Use 9999 for all units

The number of the button which was

pressed.
Possible values: 1-5, depending on the
possibilities of the delegate units.
ButtonNr int
For example: delegate units with 3
buttons only have buttons 2-3-4

True to enable buttons

Enabled False to disable buttons bool

Example:
http://localhost:8890/CoCon/ButtonLED_Event/SetButtonsEnabled/?SeatNr=5&ButtonNr=2&Enabled=true

Return:
0 → operation success; 1 → Operation fail (not valid value); -1 → exception

4.3.11.2 SetLED

Cocon for Plixus Core

API Module Plixus Core
SetLED  

Sets the LED of one or more seats.

Structure:
http://localhost:8890/CoCon/ButtonLED_Event/SetLED/?SeatNr=<SeatNr>&LEDNr=<LEDNr>&State=<State>

Parameters:
Name Description Type
The number of the seat on which the LEDs are set.
SeatNr Use 9999 for all units int

The number of the LED which should be set.

Possible values:
1-5, depending on the possibilities of the delegate units.
LEDNr int
For example: delegate units with 3 buttons only have
buttons 2-3-4

The state to which the LED should be set

Values:
On
State string
Off
Blinking

Example:
http://localhost:8890/CoCon/ButtonLED_Event/SetLED/?SeatNr=4&LEDNr=2&State=Blinking

Return:
0 → operation success; 1 → Operation fail (not valid value); -1 → exception

CoCon API 24 Dec 2021 154/184

4.3.11.3 SetNextButtonEnabled

Cocon for Plixus Core

API Module Plixus Core
SetNextButtonEnabled ☐ 

Enables the Next button of a unit. When enabled and a button up event is triggered, an API event will be sent
out. The events will remain active for each button up event until the next system reboot or until they are explicitly
de-activated through this API call.

Note: This api call will work only on delegate(no chairmen) seat where unit have Next & Prior physical buttons
and configurable by Room server xml file.

Structure:
http://localhost:8890/CoCon/ButtonLED_Event/SetNextButtonEnabled/?SeatNr={SeatNr}&Enabled={Enabled}

Parameters:
Name Description Type
The seat number
SeatNr int
Use 9999 for all units
Enabled true, false boolean

Example:
http://localhost:8890/CoCon/ButtonLED_Event/SetNextButtonEnabled/?SeatNr=7&Enabled=true

Return:
0 → operation success; 1 → Operation fail (not valid value); -1 → exception

4.3.11.4 SetPriorButtonEnabled

Cocon for Plixus Core

API Module Plixus Core
SetPriorButtonEnabled ☐ 

Enables the Prior button of a unit. When enabled and a button up event is triggered, an API event will be sent
out. The events will remain active for each button up event until the next system reboot or until they are explicitly
de-activated through this API call.

Note: This api call will work only on delegate(no chairmen) seat where unit have Next & Prior physical buttons
and configurable by Room server xml file..

Structure:
http://localhost:8890/CoCon/ButtonLED_Event/SetPriorButtonEnabled/?SeatNr={SeatNr}&Enabled={Enabled}

Parameters:
Name Description Type
The seat number
SeatNr int
Use 9999 for all units
Enabled true, false boolean
Example:
http://localhost:8890/CoCon/ButtonLED_Event/SetPriorButtonEnabled/?SeatNr=7&Enabled=true

Return:
0 → operation success; 1 → Operation fail (not valid value); -1 → exception

CoCon API 24 Dec 2021 155/184

4.3.11.5 SetNextButtonLedStatus

Cocon for Plixus Core

API Module Plixus Core
SetNextButtonLedStatus  

Sets the Next button LED status

As for the LED color:
• Confidea-F: Red
• Confidea-T: Blue
• Confidea-FLEX : White
• Confidea wireless G3: NOT SUPPORTED

Structure:
http://localhost:8890/CoCon/ButtonLED_Event/SetNextButtonLedStatus/?SeatNr={seatnr}&State={state}

Parameters:
Name Description Type

SeatNr The seat number int

State supported values : On, Off, Fast, Slow, Medium string

Example:
http://localhost:8890/CoCon/ButtonLED_Event/SetNextButtonLedStatus/?SeatNr=1&State=on

Return:
0 → operation success; 1 → Operation fail (not valid value); -1 → exception

4.3.11.6 SetPriorButtonLedStatus

Cocon for Plixus Core

API Module Plixus Core
SetPriorButtonLedStatus  

Sets the Prior button LED status

As for the LED color:
• Confidea-F: Red
• Confidea-T: Blue
• Confidea-FLEX : White
• Confidea wireless G3: NOT SUPPORTED

Structure:
http://localhost:8890/CoCon/ButtonLED_Event/SetPriorButtonLedStatus/?SeatNr={seatnr}&State={state}

Parameters:
Name Description Type

SeatNr The seat number Int

State Supported values : On, Off, Fast, Slow, Medium string

Example:
http://localhost:8890/CoCon/ButtonLED_Event/SetPriorButtonLedStatus/?SeatNr=7&State=fast

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

CoCon API 24 Dec 2021 156/184

4.3.12 External

4.3.12.1 Send message to Operator

Cocon for Plixus Core

API Module Plixus Core
SendMsgToOperato  

Structure:
http://localhost:8890/CoCon/External/SendMsgToOperator/?Message={msg}
Example:
http://localhost:8890/CoCon/External/SendMsgToOperator/?Message={“This is an example msg”}

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.12.2 NotifyExternalCall

Cocon for Plixus Core

API Module Plixus Core
NotifyExternalCall  ☐

Notification to Interpreter Desk for the external call.

Structure:
http://localhost:8890/CoCon/External/NotifyExternalCall/?To={unitIds}&Beep={isBeep}

Parameters:
Name Description Type
The unit ids list separate by comma.
UnitIds srting
2,5,10
True/ False
Beep bool
To send Beep sound on the desk

Example:
http://localhost:8890/CoCon/External/NotifyExternalCall/?To=2,3,4&Beep=True

Returns: string
{"NotifyExternalCall":true}

CoCon API 24 Dec 2021 157/184

4.3.13 Interpretation
Interpreter management and configuration commands

4.3.13.1 GetAllBoothsInRoom

Cocon for Plixus Core

API Module Plixus Core
GetAllBoothsInRoom  

Get all booths name from current active room.

Structure:
http://localhost:8890/CoCon/Interpretation/GetAllBoothsInRoom

Example:
http://localhost:8890/CoCon/Interpretation/GetAllBoothsInRoom

Return:
{"GetAllBoothsInRoom":{"Booths":[{"BoothId":1,"Desks":[10,7]}]}}

4.3.13.2 AddLanguage

Cocon for Plixus Core

API Module Plixus Core
AddLanguage  

Add new language to DB.

Structure:
http://localhost:8890/CoCon/Interpretation/AddLanguage/?Name={name}&ISO={iso}
Parameters:
Name Description Type

Name Name of the Language string

ISO 2/3 letters code for the Language string

Return: int

Example:
http://localhost:8890/CoCon/Interpretation/AddLanguage/?Name=English&ISO=EN

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.13.3 RemoveLanguage

Cocon for Plixus Core

API Module Plixus Core
RemoveLanguage  

Remove language from the existing list of language.

Structure:
http://localhost:8890/CoCon/Interpretation/RemoveLanguage/?Name={name}
Parameters:

CoCon API 24 Dec 2021 158/184

 Name Description Type

Name Name of the Language string

Return: int

Example:
http://localhost:8890/CoCon/Interpretation/RemoveLanguage/?Name=English

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

4.3.13.4 ClearLanguages

Cocon for Plixus Core

API Module Plixus Core
ClearLanguages  

Clear all the language from the language list.

Structure:
http://localhost:8890/CoCon/Interpretation/ClearLanguages
Return: int

Example:
http://localhost:8890/CoCon/Interpretation/ClearLanguages

Return:
0 → operation success (reply not send in Cocon for Plixus Core and Plixus Core); 1 → Operation fail (not valid
value) -1 → exception

4.3.13.5 AddInterpreterPreset

Cocon for Plixus Core

API Module Plixus Core
AddInterpreterPreset  

Add new interpreter preset

Structure:
http://localhost:8890/CoCon/Interpretation/AddInterpreterPreset/?Name={name}&Description={description}&Mic
Mode={micMode}&BoothMode={boothMode}

New Optional Structure :

http://localhost:8890/CoCon/Interpretation/AddInterpreterPreset/?Name={name}&Description={description}&Mic
Mode={micMode}&BoothMode={boothMode}&MultipleChannelActivation={multipleChannelActivation}&IsOverrid
eChannel={isOverrideChannel}&IsAllActiveMicsLEDBlink={isAllActiveMicsLEDBlink}&AllActiveMicsLEDBlinkTim
e={allActiveMicsLEDBlinkTime}&IsSlowDownImplementedExternally={isSlowDownImplementedExternally}&IsLi
stenerCountConfigurator={isListenerCountConfigurator}&ListenerCountConfiguratorTime={listenerCountConfigu
ratorTime}

Parameters:
Name Description Type
Name The name of Interpreter preset (Required) string
The description of the interpreter preset
Description string
(Optional)

CoCon API 24 Dec 2021 159/184

 Interpretation mic mode
0 = override mode
MicMode int
1 = mixed mode
(Optional)
Interpretation mode between booths
0 = override mode
BoothMode 1 = mixed mode Int
2 = Lock on A. Override on B
(Optional)
Allow multiple channel can active on same
MultipleChannelActivation booth (True / False : Optional parameter, Bool
Default value : False)
Allow only one channel can active in one booth
IsOverrideChannel (True / False : Optional parameter, Default Bool
value : False)
All active mics LED blinking if the speak slow
function enabled
IsAllActiveMicsLEDBlink Bool
(True / False : Optional parameter, Default
value : False)
Speak slow function Enabled + configure the
time for the mic led blinking for speak slow
AllActiveMicsLEDBlinkTime int
function.
(Optional parameter, Default value : 5 sec)
Send notification for the speak low to external
IsSlowDownImplementedExternall API user.
Bool
y (True / False : Optional parameter, Default
value : True)
Listener Count function enabled
IsListenerCountConfigurator (True / False : Optional parameter, Default Bool
value : False)
Configure the time for the listener count event
ListenerCountConfiguratorTime from CU to Server int
(Optional parameter, Default value : 60 sec)

Example:
http://localhost:8890/CoCon/Interpretation/AddInterpreterPreset/?Name=My first test &Description=Test first
test&MicMode=0&BoothMode=0

Return:
{"AddInterpreterPreset":{"InterpreterPreset":{"Id":11,"Name":"My first test ","Description":"Test first
test","DeskMode":0,"BoothMode":0,"State":"Inactive"}}}

New Return value :

{"AddInterpreterPreset":{"InterpreterPreset":{"Id":10,"Name":" MTest
1","Description":"","DeskMode":0,"BoothMode":0,"MultipleChannelActivation":false,"IsOverrideChannel":false,"Is
AllActiveMicsLEDBlink":false,"AllActiveMicsLEDBlinkTime":5,"IsSlowDownImplementedExternally":true,"IsListen
erCountConfigurator":false,"ListenerCountConfiguratorTime":60,"State":"Inactive"}}}

4.3.13.6 DeleteInterpreterPreset

Cocon for Plixus Core

API Module Plixus Core
DeleteInterpreterPreset  

Delete the existing interpreter preset by Preset id

Structure:
http://localhost:8890/CoCon/Interpretation/DeleteInterpreterPreset/?Id={presetId}

Parameters:
Name Description Type
PresetId The Id of Interpreter Preset int

CoCon API 24 Dec 2021 160/184

Return: int

Note: Active preset can’t be deleted.

Example:
http://localhost:8890/CoCon/Interpretation/DeleteInterpreterPreset/?Id=2

Return:
0 → operation success (reply not send in Cocon for Plixus Core and Plixus Core); 1 → Operation fail (not valid
value) -1 → exception

4.3.13.7 ApplyInterpreterPreset

Cocon for Plixus Core

API Module Plixus Core
ApplyInterpreterPreset  

Send interpreter Preset to activate preset by ID

Structure:
http://localhost:8890/CoCon/Interpretation/ApplyInterpreterPreset/?Id={presetId}

Parameters:
Name Description Type
PresetId The Id of Interpreter Preset int

Return: int

Example:
http://localhost:8890/CoCon/Interpretation/ApplyInterpreterPreset/?Id=2

Return:
0 → operation success (reply not send in Plixus Core); 1 → Operation fail (not valid value) -1 → exception

Return for CoCon for Plixus Core & Plixus Core:

Note: Api call will work as expected and update event will recived instead of “0”
String : {"ApplyInterpreterPreset":2}

4.3.13.8 GetActiveInterpreterPreset

Cocon for Plixus Core

API Module Plixus Core
GetActiveInterpreterPreset  

Get current active interpreter preset information.

Structure:
http://localhost:8890/CoCon/Interpretation/GetActiveInterpreterPreset

Example:
http://localhost:8890/CoCon/Interpretation/GetActiveInterpreterPreset

Return: string

CoCon API 24 Dec 2021 161/184

{"GetActiveInterpreterPreset":{"InterpreterPreset":{"Id":0,"Name":"Default","Description":"The default
configuration with English, French, German and
Dutch.","DeskMode":0,"BoothMode":0,"MultiChannelActivation":false,"Locked":false,"AudienceIndication":false,"
AudienceIndicationInterval":60,"State":"Active","Channels":[{"Order":1,"Language":"01
EN","Booth":"1","Desks":[{"Name":"1","ActiveChannel":0,"Relays":["Floor","Floor","Floor","Floor","Floor","Floor"]}]
,"Quality":0,"IsRecording":false},{"Order":2,"Language":"02
FR","Booth":"EmptyBooth","Desks":[],"Quality":0,"IsRecording":false},{"Order":3,"Language":"03
DE","Booth":"EmptyBooth","Desks":[],"Quality":0,"IsRecording":false},{"Order":4,"Language":"04
NL","Booth":"EmptyBooth","Desks":[],"Quality":0,"IsRecording":false},{"Order":5,"Language":"05
TA","Booth":"EmptyBooth","Desks":[],"Quality":0,"IsRecording":false}]}}}

4.3.13.9 GetAllInterpreterPresets

Cocon for Plixus Core

API Module Plixus Core
GetAllInterpreterPresets  

Get all interpreter presets from the current room.

Structure:
http://localhost:8890/CoCon/Interpretation/GetAllInterpreterPresets

Example:
http://localhost:8890/CoCon/Interpretation/GetAllInterpreterPresets

Return: string
{"GetAllInterpreterPresets":{"InterpreterPreset":[{"Id":7,"Name":"Test
1","Description":"","DeskMode":0,"BoothMode":0,"MultipleChannelActivation":false,"IsOverrideChannel":true,"Is
AllActiveMicsLEDBlink":true,"AllActiveMicsLEDBlinkTime":5,"IsSlowDownImplementedExternally":true,"IsListen
erCountConfigurator":true,"ListenerCountConfiguratorTime":10,"State":"Active"},{"Id":9,"Name":"My first test
","Description":"Test first
test","DeskMode":0,"BoothMode":0,"MultipleChannelActivation":false,"IsOverrideChannel":false,"IsAllActiveMics
LEDBlink":false,"AllActiveMicsLEDBlinkTime":5,"IsSlowDownImplementedExternally":true,"IsListenerCountConfi
gurator":false,"ListenerCountConfiguratorTime":60,"State":"Inactive"}]}}

4.3.13.10 GetAllLanguages

Cocon for Plixus Core

API Module Plixus Core
GetAllLanguages  

Get all languages which is available in language list.

Structue :
http://localhost:8890/CoCon/Interpretation/GetAllLanguages
Example:
http://localhost:8890/CoCon/Interpretation/GetAllLanguages

Return: string
{"GetAllLanguages":{"Languages":[{"Name":"Bulgarian","ISO":"BG"},{"Name":"Bosnian","ISO":"BS"},{"Name":"Bi
hari","ISO":"BH"},{"Name":"Czech","ISO":"CS"},{"Name":"Cree","ISO":"CR"},{"Name":"Dutch","ISO":"NL"},{"Nam
e":"Divehi","ISO":"DV"},{"Name":"Hebrew","ISO":"HE"},{"Name":"Haitian","ISO":"HT"},{"Name":"Limburgish","IS
O":"LI"}]}}

4.3.13.11 GetAllChannels

CoCon API 24 Dec 2021 162/184

 Cocon for Plixus Core
API Module Plixus Core
GetAllChannels  

Get all channels list by existing preset id.

Structure:
http://localhost:8890/CoCon/Interpretation/GetAllChannels/?PresetId={presetId}

Example:
http://localhost:8890/CoCon/Interpretation/GetAllChannels/?PresetId=2

Return: String
{"GetAllChannels":{"Channels":[{"Order":1,"Language":"English","AudioRouting":"1","DisplayText":"01
EN","AutoFloor":false,"BackupChannel":"Floor"},{"Order":2,"Language":"Chinese","AudioRouting":"2","DisplayTe
xt":"02
ZH","AutoFloor":false,"BackupChannel":"Floor"},{"Order":3,"Language":"Dutch","AudioRouting":"3","DisplayText"
:"03
NL","AutoFloor":false,"BackupChannel":"Floor"},{"Order":4,"Language":"French","AudioRouting":"External","Disp
layText":"04
FR","AutoFloor":false,"BackupChannel":"Floor"},{"Order":5,"Language":"Hindi","AudioRouting":"Disabled","Displ
ayText":"05 HI","AutoFloor":false,"BackupChannel":"Floor"}]}}

4.3.13.12 AddChannel

Cocon for Plixus Core

API Module Plixus Core
AddChannel  

Add channel to existing preset via preset Id.

Please note that for now, channels should always be added at the end of the channel list (i.e., you have to
supply the next free channel number to the “Order” parameter.

Parameters:
Name Description Type
PresetId The Id of Interpreter Preset int

Order Number of the channels int

Language Language name string

Display text: Text that is shown on the channel
DisplayText string
selector. E.g.: 02 ENG
Set audio routing for the channel.
Plixus Core & CoCon For Plixus Core:
AudioRouting 'comma-separated-booth-numbers', Disabled, string
External, EmptyBooth

Set the backup channel

Floor
BackupChannel string
(Now only floor is backup channel)
Optional parameter.
Set auto floor is enabled or disabled
False
AutoFloor bool
(CoCon 5.1does not support auto floor yet)
Optional parameter.
Channel recording or not.
IsRecording bool
Optional parameter.
Structure:
http://localhost:8890/CoCon/Interpretation/AddChannel/?PresetId={presetId}&Order={channelNumber}&Langua
ge={language}&DisplayText={displayText}&AudioRouting={audioRouting}&BackupChannel={backupChannel}&
AutoFloor={autoFloor}&IsRecording={ IsRecording}

CoCon API 24 Dec 2021 163/184

Example:

http://192.168.8.120:8890/CoCon/Interpretation/AddChannel/?PresetId=5&Order=4&Language=English&Displa
yText=EN&AudioRouting=1,2&BackupChannel=Floor&AutoFloor=False&IsRecording=False

Return:

"AddChannel":{"Channel":{"Order":1,"Language":"English","AudioRouting":"1,2","DisplayText":"EN","AutoFloor":f
alse,"IsRecording":false,"BackupChannel":"Floor"}}}

**Log file will have detail for wrong order : You gave an inappropriate channel order, and it has been changed
from 5 to 3!

4.3.13.13 AddChannels

Cocon for Plixus Core

API Module Plixus Core
AddChannels  

Add channels to existing preset via preset Id.

Parameters:
Name Description Type
The Id of Interpreter Preset
Every configuration has a unique ID, you need.
PresetId When creating a new configuration you will int
find this, or you can use the command
/CoCon/Interpretation/GetAllInterpreterPresets
Language name list
comma separated list of languages. This will
add a channel per language in that list to the
configuration. It’s not needed that the
language is 1 of the existing languages.
Language string
Important is that the language is unique and is
not already used in the configuration.
To have a list of existing languages with their
ISO you can use this API:
/CoCon/Interpretation/GetAllLanguages
Display text list: Text that is shown on the
DisplayText string
channel selector. E.g.: 02 ENG
Set audio routing for the channels.
list of comma separated audioroutings per
channel/language. Options:
• number → The corresponding
channel/language will be used in 1
booth (booth number)
• (comma separated list of numbers)
→ the corresponding
channel/language will be used in
multiple booths. All the numbers of
AudioRouting the list are all the booths that will be string
used.
• EmptyBooth → the corresponding
channel/language is an active
channel but there is no booth
assigned to it
• External → the channel/language is
an external channel
• Disabled → the corresponding
channel/language is disabled.

CoCon API 24 Dec 2021 164/184

Structure:
http://localhost:8890/CoCon/Interpretation/AddChannels/?PresetId={presetId}&Language={languageList}&Displ
ayText={displayTextList}&AudioRouting={audioRoutingList}

Example:

http://192.168.8.120:8890/CoCon/Interpretation/AddChannels/?PresetId=5&Language=French,English,Dutch,G
erman,Spanish&DisplayText=02FR,03ENG,04NLD,05GER,06SPA&AudioRouting=1,(2,3,4,10),EmptyBooth,Ext
ernal,Disabled

This command will add 5 channels, first channel with language ‘French’ (and display text ‘02FR’) assigned to
booth 1, second will be a channel with language ‘English’ (and display text ‘03ENG’) assigned to booth 2,3,4
and 10, third will be a channel with language ‘Dutch’ (and display text ‘04NLD’) not assigned to a booth (but still
enabling this language to be spoken on B/C channel of interpreter desks), etc
The arrays for Language and DisplayText and AudioRouting need to be of equal length.

4.3.13.14 EditChannel

Cocon for Plixus Core

API Module Plixus Core
EditChannel  

Edit the existing channel via preset id. (Overwrite the existing channel.)
Please note that it is not allowed to change the Language Name for a channel.
Structure:
http://localhost:8890/CoCon/Interpretation/EditChannel/?PresetId={presetId}&Order={channelNumber}&Langua
ge={language}&DisplayText={displayText}&AudioRouting={audioRouting}&BackupChannel={backupChannel}&
AutoFloor={autoFloor}&IsRecording={ IsRecording}

Parameters:
Name Description Type
PresetId The Id of Interpreter Preset int

Order Order of the channel int

Language Language name string

Display text: Text that is shown on the channel
DisplayText string
selector. E.g.: 02 ENG
Set audio routing for the channel.
Plixus Core & CoCon For Plixus Core:
AudioRouting 'comma-separated-booth-numbers', Disabled, string
External, EmptyBooth

Set the backup channel

BackupChannel Floor string
(Now only floor is backup channel)
Set auto floor is enabled or disabled
AutoFloor False bool
(CoCon 4.0 does not support auto floor yet)
Channel recording or not.
IsRecording bool
Optional parameter.
Return: string
{"EditChannel":{"Channel":{"Order":4,"Language":"Hindi","AudioRouting":"External","DisplayText":"04
HI","AutoFloor":false,"BackupChannel":"Floor ",”IsRecording”:false }}}

Example:
http://localhost:8890/CoCon/Interpretation/EditChannel/?PresetId=21&Order=4&Language=Hindi&DisplayText=
HI&AudioRouting=External&BackupChannel=Floor&AutoFloor=False&IsRecording=False

CoCon API 24 Dec 2021 165/184

This command can be used to swap languages between 2 booths. For example, we start from a situation where
Booth 1 is English and Booth 2 is French. If we want to swap them, we need to execute the following sequence
of commands:
• Change the audio routing for the English channel to “Disabled” (“freeing” Booth 1):
http://localhost:8890/CoCon/Interpretation/EditChannel/?PresetId=21&Order=1&Language=English&Dis
playText=01 EN&AudioRouting=Disabled&BackupChannel=Floor&AutoFloor=False
• Move the French channel to Booth 1:
http://localhost:8890/CoCon/Interpretation/EditChannel/?PresetId=21&Order=2&Language=French&Dis
playText=01 FR&AudioRouting=1&BackupChannel=Floor&AutoFloor=False
• Move the English channel to Booth 2:
http://localhost:8890/CoCon/Interpretation/EditChannel/?PresetId=21&Order=1&Language=English&Dis
playText=02 EN&AudioRouting=2&BackupChannel=Floor&AutoFloor=False

4.3.13.15 DeleteChannel

Cocon for Plixus Core

API Module Plixus Core
DeleteChannel  

Delete channel form the preset via channel id.

Structure:
http://localhost:8890/CoCon/Interpretation/DeleteChannel/?PresetId={presetId}&Order={ordernumber}

Parameters:
Name Description Type
PresetId The Id of Interpreter Preset int

Order The order of the channel int

Example:
http://localhost:8890/CoCon/Interpretation/DeleteChannel/?PresetId=21&Order=18

Return: int
0 → operation success (reply not send in Cocon for Plixus Core and Plixus Core); 1 → Operation fail (not valid
value) -1 → exception

4.3.13.16 RemoveAllChannels

Cocon for Plixus Core

API Module Plixus Core
RemoveAllChannels  

Remove all the channels from the existing preset.

Structure:
http://localhost:8890/CoCon/Interpretation/RemoveAllChannels/?PresetId={presetId}

Parameters:
Name Description Type
PresetId The Id of Interpreter Preset int
Example:
http://localhost:8890/CoCon/Interpretation/RemoveAllChannels/?PresetId=21

CoCon API 24 Dec 2021 166/184

 Return: int
0 → operation success (reply not send in Cocon for Plixus Core and Plixus Core); 1 → Operation fail (not valid
value) -1 → exception

4.3.13.17 SetDisplayText

Cocon for Plixus Core

API Module Plixus Core
SetDisplayTex  

Set / modify display text for the existing channel via channel Id.
Structure:
http://localhost:8890/CoCon/Interpretation/SetDisplayText/?PresetId={presetId}Order={order}&NewText={text}

Parameters:
Name Description Type
PresetId The preset of the Id which will be used int

Order The order of the channel int

NewText Text for display on channel selector. string

Example:
http://localhost:8890/CoCon/Interpretation/SetDisplayText/?PresetId=12&Order=2&NewText=ENG

Return: int
0 → operation success (reply not send in Cocon for Plixus Core and Plixus Core); 1 → Operation fail (not valid
value) -1 → exception

4.3.13.18 SaveInterpreterPresetAs

Cocon for Plixus Core

API Module Plixus Core
SaveInterpreterPresetAs  

It will save the preset with new name, based on the existing preset id.

Structure:
http://localhost:8890/CoCon/Interpretation/SaveInterpreterPresetAs/?Id={id}&Name={name}&Description={
description}&MicMode={micMode}&BoothMode={boothMode}

New Structure with additional optional fields :

http://localhost:8890/CoCon/Interpretation/SaveInterpreterPresetAs/?Id={id}&Name={name}&Descrip
tion={description}&MicMode={micMode}&BoothMode={boothMode}&MultipleChannelActivation={mul
tipleChannelActivation}&IsOverrideChannel={isOverrideChannel}&IsAllActiveMicsLEDBlink={isAllActi
veMicsLEDBlink}&AllActiveMicsLEDBlinkTime={allActiveMicsLEDBlinkTime}&IsSlowDownImplemen
tedExternally={isSlowDownImplementedExternally}&IsListenerCountConfigurator={isListenerCountC
onfigurator}&ListenerCountConfiguratorTime={listenerCountConfiguratorTime}

Parameters:

CoCon API 24 Dec 2021 167/184

 Name Description Type
Id Existing Preset’s id (Required) int

Name The name of Interpreter preset (Required) string

The description of the interpreter preset
Description string
(Optional)
Interpretation mic mode
MicMode 0 = override mode int
1 = mixed mode
Interpretation mode between booths
0 = override mode
BoothMode 1 = mixed mode Int
2 = Lock on A. Override on B
(Optional)
Allow multiple channel can active on same
booth (True / False : Optional parameter,
MultipleChannelActivation Bool
Default value : False)
(Optional)
Allow only one channel can active in one booth
IsOverrideChannel (True / False : Optional parameter, Default Bool
value : False)
All active mics LED blinking if the speak slow
function enabled
IsAllActiveMicsLEDBlink Bool
(True / False : Optional parameter, Default
value : False)
Speak slow function Enabled + configure the
time for the mic led blinking for speak slow
AllActiveMicsLEDBlinkTime int
function.
(Optional parameter, Default value : 5 sec)
Send notification for the speak low to external
IsSlowDownImplementedExternall API user.
Bool
y (True / False : Optional parameter, Default
value : True)
Listener Count function enabled
IsListenerCountConfigurator (True / False : Optional parameter, Default Bool
value : False)
Configure the time for the listener count event
ListenerCountConfiguratorTime from CU to Server int
(Optional parameter, Default value : 60 sec)

Return:
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

{"ActivePresetUpdated":{"InterpreterPreset":{"InterpreterPreset":{"Id":4,"Name":"New Preset
1","Description":"","DeskMode":1,"BoothMode":0,"MultipleChannelActivation":true,"IsOverrideChannel":false,"Is
AllActiveMicsLEDBlink":true,"AllActiveMicsLEDBlinkTime":5,"IsSlowDownImplementedExternally":true,"IsListe
nerCountConfigurator":true,"ListenerCountConfiguratorTime":60,"State":"Active","Channels":[{"Order":1,"Langu
age":"English","Booth":"1","Desks":[{"Name":"1","ActiveChannel":0,"Relays":[]}],"Quality":3,"IsRecording":false},
{"Order":2,"Language":"Chinese","Booth":"EmptyBooth","Desks":[],"Quality":3,"IsRecording":false}]}}}}

Note: CoCon for Plixus Core & PlixusCore:

This call will update the preset based on the Preset id, not create new preset. (Function like update existing
preset).

4.3.13.19 GetAllChannelRealtimeData

Cocon for Plixus Core

API Module Plixus Core
GetAllChannelRealtimeData  

Get real time data for channels based on the active interpreter preset.

Note: user should request for this command.

CoCon API 24 Dec 2021 168/184

 The quality of the channel
Cocon for Core / Plixus Core
floor 0
translation from floor 1
2nd translation from floor 2
3rd translation from floor 3
4th translation from floor 4
...
Listening to own translation 255

Structure:
http://localhost:8890/CoCon/Interpretation/GetAllChannelRealtimeData

Example:
http://localhost:8890/CoCon/Interpretation/GetAllChannelRealtimeData

Return:

CoCon for Core & Plixus Core:

{"GetAllChannelRealTimeData":[{"Order":1,"Language":"Hindi","Booths":[]},{"Order":2,"Language":"English","Bo
oths":[{"Name":1,"Desks":[{"Name":1,"ActiveChannel":1,"Relay":"English"}],"Quality":255}]},{"Order":3,"Languag
e":"Chinese","Booths":[]}]}

4.3.13.20 GetSpeakSlowerRequestList

Cocon for Plixus Core

API Module Plixus Core
GetSpeakSlowerRequestList  

Get event form Interpreter desk for the speck slow button pressed.
Structure:
http://localhost:8890/CoCon/Interpretation/GetSpeakSlowerRequestList

Example:
http://localhost:8890/CoCon/Interpretation/GetSpeakSlowerRequestList

Return:
{"SpeakSlowerRequest":{"UnitId":3}}

4.3.13.21 GetInterpreterPresetById

Cocon for Plixus Core

API Module Plixus Core
GetInterpreterPresetById  

Get full information of interpreterpreset by id.

Structure:
http://localhost:8890/CoCon/Interpretation/GetInterpreterPresetById/?Id=2

CoCon API 24 Dec 2021 169/184

 Example:
http://localhost:8890/CoCon/Interpretation/GetInterpreterPresetById/?Id=2

Return:
{"GetInterpreterPresetById":{"InterpreterPreset":{"Id":12,"Name":"Test
100","Description":"XYZ","DeskMode":0,"BoothMode":0,"MultipleChannelActivation":false,"IsOverrideChannel":f
alse,"IsAllActiveMicsLEDBlink":false,"AllActiveMicsLEDBlinkTime":5,"IsSlowDownImplementedExternally":true,"I
sListenerCountConfigurator":false,"ListenerCountConfiguratiorTime":60,"State":"Active","Channels":[{"Order":1,"
Language":"Hindi","Booth":"1","Desks":[{"Name":"1","ActiveChannel":0,"Relays":[]},{"Name":"2","ActiveChannel":
0,"Relays":[]}],"IsRecording":false},{"Order":2,"Language":"English","Booth":"2","Desks":[{"Name":"1","ActiveCha
nnel":0,"Relays":[]}],"IsRecording":false}]}}}

4.3.13.22 AssignDeskToBooth
Cocon for Plixus Core
API Module Plixus Core
AssignDeskToBooth  

Moves any desk (unassigned or already assigned at other booth) by its seat ID to the specified booth.

Structure:
http://localhost:8890/CoCon/Interpretation/AssignDeskToBooth?DeskSeatId=\{seat}&BoothId={booth}

Parameters:
Name Description Type
DeskSeatID Seat Id for Interpreter desk (Required) Int

BoothID Booth Id in which desk to add (Required) int

Example:
http://localhost:8890/CoCon/Interpretation/AssignDeskToBooth?DeskSeatId=4&BoothId=5

Return: int
0 → operation success; 1 → Operation fail (not valid value); -1 → exception

4.3.13.23 UnassignDesk
Cocon for Plixus Core
API Module Plixus Core
UnassignDesk  

If assigned to a booth, removes the desk from its booth. If the booth is empty, it is deleted.

Structure:
http://localhost:8890/CoCon/Interpretation/Unassigndesk?DeskSeatId=\{seat}

Parameters:
Name Description Type
DeskSeatID Seat Id for Interpreter desk (Required) Int

CoCon API 24 Dec 2021 170/184

 Example:
http://localhost:8890/CoCon/Interpretation/Unassigndesk?DeskSeatId=1

Return: int
0 → operation success; 1 → Operation fail (not valid value); -1 → exception

4.3.13.24 UpdateBooth

Cocon for Plixus Core

API Module Plixus Core
UpdateBooth  

Allow user to update Booth.

Structure:
http://localhost:8890/CoCon/Interpretation/UpdateBooth?BoothId=\{booth}&Label={label}&Intercom={intercom}
Parameters:
Name Description Type
BoothID Booth Id which need to update (Required) Int

Intercom Enabled intercom on Booth (Optional) boolean

Label Add label for booth (Optional) string

Example:
http://localhost:8890/CoCon/Interpretation/UpdateBooth?BoothId=5&Label=NewLabel
http://localhost:8890/CoCon/Interpretation/UpdateBooth?BoothId=1&Intercom=false

Return: int
0 → operation success; 1 → Operation fail (not valid value); -1 → exception

4.3.14 API calls for Configurations

4.3.14.1 GetCuIpAddress

Cocon for Plixus Core

API Module Plixus Core
GetCuIpAddress  ☐

Get CU IP address from the Room server config file (which CU is currently connected).

Structure:
http://localhost:8890/CoCon/GetCuIpAddress

Return:
{"GetCuIpAddress":{"IpAddress":"192.168.8.110"}}

CoCon API 24 Dec 2021 171/184

4.3.14.2 SetCuIpAddress

Cocon for Plixus Core

API Module Plixus Core
SetCuIpAddress  ☐

Set / Update CU IP address API will update the CoCon room server config file and Room service config file, for
the taking impact of the modified IP address user should have to restart room server and Room service as well.

Note: Room server and Room service must have to restart after this API call, else the new IP address will not
take impact.

Structure:
http://localhost:8890/CoCon/SetCuIpAddress/?IpAddress=192.168.8.110

Return:
{"SetCuIpAddress":{"Result":true,"IpAddress":"192.168.8.110"}}

4.3.14.3 RestartRoomServer

Cocon for Plixus Core

API Module Plixus Core
RestartRoomServer  ☐

Restart Room server.

Structure:
http://localhost:8890/CoCon/RestartRoomServer

Return:
Simply 3rd party tool lost connection.

4.3.14.4 GetCoconServerVersion

Cocon for Plixus Core

API Module Plixus Core
GetCoconServerVersion  ☐

This API calls reply with the Cocon room server version.

Structure:
http://localhost:8890/CoCon/GetCoconServerVersion

Return: string
{"GetCoconServerVersion":{"Version":"5.3.0.52"}}

CoCon API 24 Dec 2021 172/184

4.3.15 Recording ( AE-R & Plixus Core only)

4.3.15.1 Getrecordingfilesinfo
Cocon for Plixus Core_AE-R
API Module Plixus Core
GetRecordingFilesInfo ☐ 

This api call we return of the recored files information from CU.

Structure:
http://192.168.8.235:8890/CoCon/Recording/getrecordingfilesinfo

Return: string
{"GetRecordingFilesInfo":{"RecordingFilesInfo":[{"RecordingFiles":[{"Name":"/audio/internal/1970-01-
01_00h04m36s_01-EN_00.mp3"},{"Name":"/audio/internal/1970-01-
01_00h04m36s_Floor_00.mp3"},{"Name":"/audio/internal/1970-01-01_00h05m20s_01-
EN_00.mp3"},{"Name":"/audio/internal/1970-01-
01_00h05m20s_Floor_00.mp3"},{"Name":"/audio/internal/test_1970-01-01_00h06m01s_01-
EN_Test_00.mp3"},{"Name":"/audio/internal/test_1970-01-
01_00h06m01s_Floor_Test_00.mp3"},{"Name":"/audio/internal/test_1970-01-01_00h08m20s_01-
EN_Test_00.mp3"},{"Name":"/audio/internal/test_1970-01-
01_00h08m20s_Floor_Test_00.mp3"}],"StorageType":"internal"},{"RecordingFiles":[],"StorageType":"external"}]}
}

4.3.15.2 Startrecording
Cocon for Plixus Core_AE-R
API Module Plixus Core
Startrecording ☐ 

This api call will start recording and store the file based on the configuration.

NOTE1: Both these arguments are optional. If the arguments are not present ( eg: Recording/StartRecording ),
the last set prefix and suffix are used. To clear the prefix and/or suffix the argument must be passed with ""
(Prefix="")

If Succeeded: RecordingState: Active

When an invalid string is passed as Prefix or Suffix:

Errors: {RecordError: kErrorIllegalSuffix} and/or {RecordError: kErrorIllegalPrefix}
NOTE2: These ONLY appear in case of an error, if the strings are ok there is no Errors field.
NOTE3: Even if these appear, the recording will start. The recording file will simply omit the invalid prefix or
suffix and an empty prefix or suffix.
NOTE4: This function will start recording the floor if no channels have been selected to record in a previous
setup.

Parameters:
Name Description Type
Prefix File name start with (Optional) string

Suffix File name end with (Optional) string

Structure:
http://192.168.8.235:8890/CoCon/Recording/Startrecording

CoCon API 24 Dec 2021 173/184

http://192.168.8.235:8890/CoCon/Recording/Startrecording/?Prefix={prefix}&Suffix={suffix}

Example :

http://192.168.8.235:8890/CoCon/Recording/Startrecording/?Prefix=Room1&Suffix=Televic

Return: string
{"StartRecording":{"RecordingState":"active"}}

Update event :
{"RecordingStateUpdated":{"RecordingState":"active"}}

4.3.15.3 Stoprecording

Cocon for Plixus Core_AE-R

API Module Plixus Core
Stoprecording ☐ 

This api call will stop the current recording.

Structure:
http://192.168.8.235:8890/CoCon/Recording/Stoprecording

Return: string
{"StopRecording":{"RecordingState":"idle"}}

Update Event :
{"RecordingStateUpdated":{"RecordingState":"idle"}}

4.3.15.4 Getrecordingstate

Cocon for Plixus Core_AE-R

API Module Plixus Core
Getrecordingstate ☐ 

This api will get the current state of the recording.

State can be:

active
error
idle
paused
unknown.

Note: There is also one Server to Client call whenever the RecordingState on the device is updated:

Structure:
http://192.168.8.235:8890/CoCon/Recording/Getrecordingstate

Return: string
{"GetRecordingState":{"RecordingState":"idle"}}

CoCon API 24 Dec 2021 174/184

4.3.16 Wireless coupling

4.3.16.1 Getwcapinfo
Cocon for Plixus Core
API Module Plixus Core
Getwcapinfo  

This api call will get the information of the WCAP.

Structure:

http://192.168.8.240:8890/CoCon/Wireless/Getwcapinfo/?WcapSerial={wcapSerial_number}

Example :
http://192.168.8.240:8890/CoCon/Wireless/Getwcapinfo/?WcapSerial=352321544

Return: string
{"WcapInfoUpdated":{"chans":[],"cpld":0,"gtw":"192.168.8.1","hn":"admin","ipa":"192.168.8.210","mac":"1C:BA:8
C:99:FE:81","online":1,"op_mode":1,"reg":"Europe","sbm":"255.255.255.0","serial":352321544,"wlist":[]}}

4.3.16.2 Getallwcapinfo

Cocon for Plixus Core

API Module Plixus Core
Getallwcapinfo  

This api call will get All WCAP information which is connected.

Structure:
http://192.168.8.235:8890/CoCon/Wireless/Getallwcapinfo

Return: string
{"AllWcapInfoUpdated":[{"chans":[],"cpld":1,"gtw":"192.168.8.1","hn":"admin","ipa":"192.168.8.210","mac":"1C:B
A:8C:99:FE:81","online":1,"op_mode":1,"reg":"Europe","sbm":"255.255.255.0","serial":352321544,"wlist":[]}]}

4.3.16.3 SetWcapCoupledMode

Cocon for Plixus Core

API Module Plixus Core
SetWcapCoupledMode  

Set the WCAP coupling mode.

Structure:
http://192.168.8.120:8890/CoCon/Wireless/SetWcapCoupledMode/?WcapSerial=352321544&CoupledMode=F
alse

Return: int
0 → operation success; 1 → Operation fail (not valid value) -1 → exception

Update Event :
{"WcapCoupledUpdated":{"CoupledMode":false,"WcapSerial":352321544}}

CoCon API 24 Dec 2021 175/184

4.3.17 Operator Customization

Important notes:
• all functionality within this module is only available in case “operator customization” license is present. It
allows to have a tab in the operator application ribbon with place for custom labels and buttons. The
buttons can trigger API events which can be handled by 3rd parties.
• First configure how many buttons and labels will be used before configuring the custom buttons and
labels.

4.3.17.1 GetCustomButtons

Cocon for Plixus Core

API Module Plixus Core
GetCustomButtons  ☐

This API call provides an overview of the configured custom buttons.

Structure:
http://localhost:8890/CoCon/OperatorCustomization/GetCustomButtons

4.3.17.2 GetCustomLabels

Cocon for Plixus Core

API Module Plixus Core
GetCustomButtons  ☐

This API call provides an overview of the configured custom labels.

Structure:
http://localhost:8890/CoCon/OperatorCustomization/GetCustomLabels

4.3.17.3 SetCustomButton

Cocon for Plixus Core

API Module Plixus Core
SetCustomButton  ☐

This API call allows to configure a custom button.

Parameters:
Name Description Type
Id Id of the button Int

Text Text shown in the button string

(optional) font color of the text in the button
FontColorHex Hex string
Example black color (R=0, G=0, B=0) is ‘#000000’ which should be
passed as ‘%23000000’
(optional) background color of the button
BackgroundColorHex Hex string
Example for white color (R=255, G=255, B=255) is ‘#FFFFFF’ which
should be passed as ‘%23FFFFFF’

CoCon API 24 Dec 2021 176/184

Structure:
http://localhost:8890/CoCon/OperaorCustomization/SetCustomButton/?Id={id}&Text={text}&FontColorHex={font
ColorHex}&BackgroundColorHex={backgroundColorHex}

Example:
http://localhost:8890/CoCon/OperatorCustomization/SetCustomButton/?Id=1&Text=test&FontColorHex=%23DC
143C&BackgroundColorHex=%23E0FFFF

Return: int
0 → operation success; 1 → Operation fail (button not found); HTTP status code 404 → no valid license

4.3.17.4 SetCustomLabel

Cocon for Plixus Core

API Module Plixus Core
SetCustomLabel  ☐

This API call allows to configure a custom label.

Parameters:
Name Description Type
Id Id of the label Int

Text Text shown in the label string

(optional) font color of the text in the label
FontColorHex Hex string
Example black color (R=0, G=0, B=0) is ‘#000000’ which should be
passed as ‘%23000000’

Structure:
http://localhost:8890/CoCon/OperaorCustomization/SetCustomLabel/?Id={id}&Text={text}&FontColorHex={fontC
olorHex}

Example:
http://localhost:8890/CoCon/OperatorCustomization/SetCustomLabel/?Id=1&Text=test&FontColorHex=%23DC1
43C

Return: int
0 → operation success; 1 → Operation fail (button not found); HTTP status code 404 → no valid license

CoCon API 24 Dec 2021 177/184

4.3.17.5 SetCustomButtonState

Cocon for Plixus Core

API Module Plixus Core
SetCustomButtonState  ☐

This API call allows to configure a custom button state.

Parameters:
Name Description Type
Id Id of the button Int
State of the button
State string
{“Enable”,”Disable”}

Structure:
http://localhost:8890/CoCon/OperatorCustomization/SetCustomButtonState/?Id={id}&State={state}

Example:
http://localhost:8890/CoCon/OperatorCustomization/SetCustomButtonState/?Id=1&State=Disable

Return: int
0 → operation success; 1 → Operation fail (wrong state parameter or button not found)
HTTP status code 404 → no valid license

4.3.17.6 SetNumberOfCustomButtons

Cocon for Plixus Core

API Module Plixus Core
SetNumberOfCustomButtons  ☐

This API call allows to configure the amount of custom buttons.

Parameters:
Name Description Type
Number of buttons
Number Int
(value >= 0)

Structure:
http://localhost:8890/CoCon/OperatorCustomization/SetNumberOfCustomButtons/?Number={number}

Example:
http://localhost:8890/CoCon/OperatorCustomization/SetNumberOfCustomButtons/?Number=2

Return: int
0 → operation success; 1 → Operation fail (wrong parameter)
HTTP status code 404 → no valid license

CoCon API 24 Dec 2021 178/184

4.3.17.7 SetNumberOfCustomLabels

Cocon for Plixus Core

API Module Plixus Core
SetNumberOfCustomLabels  ☐

This API call allows to configure the amount of custom labels.

Parameters:
Name Description Type
Number of labels
Number Int
(value >= 0)

Structure:
http://localhost:8890/CoCon/OperatorCustomization/SetNumberOfCustomLabels/?Number={number}

Example:
http://localhost:8890/CoCon/OperatorCustomization/SetNumberOfCustomLabels/?Number=2

Return: int
0 → operation success; 1 → Operation fail (wrong parameter)
HTTP status code 404 → no valid license

CoCon API 24 Dec 2021 179/184

5 Future commands
5.1 Server to client

5.2 Client to server

CoCon API 24 Dec 2021 180/184

6 Best practice for use of API
6.1 Setting up and operating the CoCon API connection
6.1.1 General
The CoCon API connection consists of a number of URI’s (Uniform Resource Identifier) which are
exchanged between the API client and the CoCon Server over a TCP/IP-connection.
Basically, the CoCon API uses two (or more) parallel HTTP-connections. These are the following:
• A “notification” connection that the client and Server keep open in case any information need to
be transferred from the Server to the client.
• Any other connection that is used to transfer information from the client to the Server.

The notification connection should be initialized by the client, and is kept open by both sides. Then
one of two things can happen:
• The Server has information to send to the client and uses the notification connection for this. The
information is transferred and the connection is closed (as per the HTTP standard). After this, the
client needs to create a new notification connection. The Server will guarantee that no
information is lost during this short period where the client has no connection to the Server.
Note that the new notification connection needs to be created within 30 seconds. If this does not
happen, the Server will discard the client data.
• The HTTP-connection times out before the Server has any information to send to the client. At
this point, the client needs to create a new notification connection. Again, the Server will
guarantee that no information is lost.

6.1.2 Wireshark log screenshot of API connection

In below screenshot an example of communication between API client and Cocon/ERS server is shown : this
illustrates the following

1) Setup connection between server and client ; a connection ID is returned

2) Client sends a notification request with this connection ID to request information

3) After some time , If there is no information to be send , server will return “request time out” , which has
to be replied immediately by a new notification request

4) …….

5) Each time information was send by the server (e.g. mic button event) this has to be followed by a

new notification request by the client

CoCon API 24 Dec 2021 181/184

CoCon API 24 Dec 2021 182/184
6.2 Advised way of working
In order to optimize the performance of the external developed REST API client application we propose the following:

• Make sure that only a single connect is done.

• The id returned by the connect call must be used to make a quickly as possible a notification call. This
notification call can:

o Return immediately if the id is invalid (HTTP 400) → In this case a new connection should be opened.
This can e.g. take place if Plixus CU is restarted.

o Return after a period of time (30sec) when no message is send (HTTP 408). → In this case a new
notification call should be opened as quick as possible.

o Return a message before time-out → In this case the message should be send/processed and a new
notification call should be openend as quick as possible.

• It is strongly advised that for quick handling of messages, there is a separate thread for handling notifications. It
should be avoided that there are gaps in open notification calls

• In case REST API client program also involved business logic and/or UI, this is best placed in separate thread with
quick communication from the notification thread.

The above way of working will guarantee quick and proper handling of REST API notifcations.

A schematic representation is given in the picture on next page.

Important remark:

When opening a connection, by default notification from ALL modules will be received. One can unsubscribe to specific
modules. The advantages of unsubscribing to modules for which the notification are not needed/desired are the
following:

• Plixus CU will not be processing and sending out unwanted messages

• Client API program will not spend any time receiving and processing packets which are of no interest for the
application.

CoCon API 24 Dec 2021 183/184

6.3 To be avoided
Common mistake is that with very short intervals , new connections are established by the API client : this
creates lots of unnecessary traffic , which is to be avoided. So through notification requests , the ongoing
connection needs to be reused and kept open.

CoCon API 24 Dec 2021 184/184