vitero web service interface v10 · vitero web service interface v10.0 o v2009en16 vitero gmbh o...

vitero Web Service Interface v10.0

The Vitero Management System (VMS) extends the vitero software by

adding a flexible, sophisticated and future-proof web service interface.

Thereby, learning management systems (such as ILIAS, Moodle, SAP

Enterprise Learning, …), personal information manager (such as Outlook

and Lotus Notes), LDAP based systems as well as portals and self-

developed solutions can be connected to vitero without any difficulty.

Please be aware that this is a provisional version of the vitero web service

documentation which may be changed or complemented due to ongoing

development.

Attachment: vitero Web Service Documentation

1 SOAP Web Services .......................................................... 6

2 Changelog ........................................................................ 7

3 Authentication ................................................................ 13

4 Web Services Definitions ................................................ 15

4.1 Data Types ....................................................................... 15

4.1.1 Standard types .............................................................. 15

4.1.2 Binary content (MTOM) ................................................... 15

4.1.3 The locale ...................................................................... 16

4.1.4 The time-zone ................................................................ 16

4.1.5 The display type ............................................................. 21

4.2 The successResponse ....................................................... 22

4.3 The user contract ............................................................. 22

4.3.1 getUser ......................................................................... 22

4.3.2 getUserList .................................................................... 25

4.3.3 getUserListByPosition ...................................................... 27

4.3.4 getUserListByCustomer ................................................... 30

4.3.5 getUserListByGroup ........................................................ 32

4.3.6 getUserListByFields......................................................... 34

4.3.7 createUser ..................................................................... 38

4.3.8 updateUser .................................................................... 42

4.3.9 deleteUser ..................................................................... 44

4.3.10 getUserCount ................................................................. 45

4.3.11 changePassword ............................................................. 47

4.3.12 loadAvatar ..................................................................... 47

4.3.13 storeAvatar ................................................................... 47

4.3.14 storeAvatarUsingBase64String ......................................... 48

4.3.15 generatePasswordLink .................................................... 49

4.4 The customer contract (optional) ..................................... 50

4.4.1 getCustomer .................................................................. 51

4.4.2 getCustomerByName ...................................................... 53

4.4.3 getCustomerList ............................................................. 55

4.4.4 createCustomer.............................................................. 58

4.4.5 updateCustomer ............................................................. 59

4.4.6 deleteCustomer .............................................................. 61

4.4.7 addUserToCustomer ....................................................... 61

4.4.8 removeUserFromCustomer .............................................. 62

4.4.9 moveUserToCustomer ..................................................... 63

4.4.10 moveAllUsersToCustomer ................................................ 65

4.5 The group contract ........................................................... 65

4.5.1 getGroup ....................................................................... 66

4.5.2 getGroupByName ........................................................... 68

4.5.3 getGroupListByCustomer ................................................. 70

4.5.4 createGroup .................................................................. 72

4.5.5 updateGroup.................................................................. 73

4.5.6 deleteGroup ................................................................... 75

4.5.7 addUserToGroup ............................................................ 75

4.5.8 removeUserFromGroup ................................................... 76

4.5.9 changeGroupRole ........................................................... 77

4.5.10 changeEnabled ............................................................... 79

4.5.11 getParticipant ................................................................ 80

4.5.12 isUserInGroup ................................................................ 81

4.6 The booking contract ........................................................ 83

4.6.1 getBookingById .............................................................. 83

4.6.2 getBookingByBookingTimeId ............................................ 88

4.6.3 getBookingTimeById ....................................................... 89

4.6.4 getBookingListByGroupAndDate ....................................... 92

4.6.5 getBookingListByGroupInFuture ....................................... 93

4.6.6 getBookingListByUserAndDate ......................................... 94

4.6.7 getBookingListByUserAndDateAndCustomer....................... 96

4.6.8 getBookingListByUserInFuture ......................................... 97

4.6.9 getBookingListByUserAndCustomerInFuture ...................... 98

4.6.10 getBookingListByDate ..................................................... 99

4.6.11 createBooking .............................................................. 101

4.6.12 updateBooking ............................................................. 106

4.6.13 deleteBooking .............................................................. 108

4.7 The cms contract ............................................................ 110

4.7.1 getGroupFolder ............................................................ 110

4.7.2 getCustomerFolder ....................................................... 113

4.7.3 createFolder ................................................................ 113

4.7.4 deleteNode .................................................................. 115

4.7.5 renameNode ................................................................ 116

4.7.6 copyNode .................................................................... 117

4.7.7 moveNode ................................................................... 118

4.7.8 changeDisplaytype ....................................................... 119

4.7.9 changeVisibility ............................................................ 121

4.7.10 getDisplaytype ............................................................. 122

4.7.11 loadFile ....................................................................... 123

4.7.12 storeFile ...................................................................... 123

4.8 The statistic contract (optional) ..................................... 123

4.8.1 getSessionRecordingById .............................................. 123

4.8.2 getUserRecordingById ................................................... 126

4.8.3 getSessionAndUserRecordingsBySessionId ...................... 128

4.8.4 getSessionRecordingsByTimeSlot ................................... 134

4.8.5 getSessionAndUserRecordingsByTimeSlot ........................ 139

4.8.6 getCapacityRecordingByDate ......................................... 145

4.8.7 getCapacityRecordingsByTimeSlot .................................. 148

4.9 The session code contract .............................................. 151

4.9.1 createPersonalBookingSessionCode ................................ 152

4.9.2 createPersonalGroupSessionCode ................................... 153

4.9.3 createBookingSessionCode ............................................ 155

4.9.4 createVmsSessionCode ................................................. 157

4.9.5 deleteSessionCode ....................................................... 160

4.9.6 getSessionCodeInformation ........................................... 161

4.9.7 getPersonalBookingSessionCodes ................................... 163

4.9.8 getPersonalGroupSessionCodes ...................................... 164

4.9.9 getTestroomSessionCode .............................................. 167

4.9.10 createAppointmentConfirmationSessionCode ................... 168

4.9.11 createWebaccessSessionCode ........................................ 170

4.9.12 createGroupSessionCode ............................................... 172

4.10 The licence contract .................................................... 175

4.10.1 getBookableModulesForGroup ........................................ 175

4.10.2 getBookableRoomsForGroup .......................................... 177

4.10.3 groupHasBookableModule .............................................. 179

4.10.4 isPhoneAvailable .......................................................... 181

4.10.5 getModulesForCustomer ................................................ 183

4.10.6 getAllModules .............................................................. 185

4.11 The MTOM contract ...................................................... 186

4.11.1 loadAvatar ................................................................... 186

4.11.2 storeAvatar ................................................................. 188

4.11.3 loadFile ....................................................................... 189

4.11.4 storeFile ...................................................................... 191

4.12 The config contract ...................................................... 192

4.12.1 getConfigProperty ........................................................ 193

4.12.2 changeConfigProperty ................................................... 195

4.12.3 changeValidityLevel ...................................................... 197

5 Error Processing ........................................................... 200

5.1 Case 1: Authentication failed .......................................... 200

5.2 Case 2: Validation failed ................................................. 201

5.3 Case 3: Error .................................................................. 202

5.3.1 Error codes .................................................................. 203

vitero Web Service Interface v10.0 o V2009EN16

vitero GmbH o Nobelstr. 15 o 70569 Stuttgart

Stuttgart local court, HRB 720267 o Managing directors: Heidi Sigel, Dr. Fabian Kempf

6/206

1 SOAP Web Services

These Web Services are implemented using SOAP (Simple Object Access

Protocol). SOAP is a lightweight protocol for exchange of information in a

decentralized, distributed environment. It is an XML based protocol that

consists of three parts: an envelope that defines a framework for

describing what is in a message and how to process it, a set of encoding

rules for expressing instances of application-defined datatypes, and a

convention for representing remote procedure calls and responses.

(http://www.w3.org/TR/2000/NOTE-SOAP-20000508/)

http://www.w3.org/TR/2000/NOTE-SOAP-20000508/




7/206

2 Changelog

- Version 10.0

• Statistic contract

▪ getCapacityRecordingsByDate and

getCapacityRecordingsByTimeSlot return the inspire user

count.

• Booking contract

▪ Update booking got new flag “inspire” to change the

client technology of an existing booking.

- Version 9.8

• User contract

▪ New service getUserListByFields to search for users by

specific fields (username, email, ..).

- Version 9.6

• Iframes

▪ Iframes are not supported anymore. Due to the security

reasons, the X-Frame-Options are denied.


▪ New error code 313 “essentials not allowed” is thrown if

you try to book the essentials client, but only inspire is

allowed for your group/customer/system.

- Version 9.5

• Statistic contract

▪ Bugfix: getSessionRecordingsByTimeSlot and

getSessionAndUserRecordingsByTimeSlot ignored the

bookingId.

- Version 9.2


▪ New pattern for repetitions: two weeks.




8/206

- Version 9.1.2


▪ Flag “inspire” to book the new inspire client.

- Version 9.0

• Customer contract (only system administrator)

▪ New flag “children” for getCustomerList to control if the

customer’s users and groups are returned or not (for

better performance).

• Bugfixes

▪ CMS contract: It is not possible anymore to set more

than one “agenda” folder in one group. A second one will

stay as displaytype “VMS” (no error is thrown to stay

backward compatible). The same behavior applies for

displaytype “welcome”.

▪ SessionCodeContract: createGroupSessionCode

responded wrongly with a

“createBookingSessionCodeResponse”. By now, the

name of the response is

“createGroupSessionCodeResponse” (as it is

documtented).

- Version 8.1

• Session code contract

▪ New service: createGroupSessionCode

▪ New optional flag allownotassignedusers in

createBookingSessionCodeRequest

▪ New optional flag allownotexistingusers in

createBookingSessionCodeRequest


▪ New flag html5client. Note that this flag has no

functionality in this version, as the HTML5 Client is not

released yet.

- Version 8.0




9/206


▪ New optional fields for event manager: eventsubtitle,

eventreferent, eventcompany, eventcomment.

- Version 7.0

• Configuration contract: New contract for configurations.

• Cms contract

▪ New service changeVisibility: In the VMS, hidden folders

are only visible for team leaders or administrators and

are not available in the virtual team room.

▪ New service getDisplaytype: Returns the displaytype of a

specific node.

▪ createFolder: New attribute visible.

▪ getGroupFolder, getCustomerfolder: returns displaytype

▪ New display type: 6 (recording)

• MTOM contract has its own chapter (changes concern only this

documentation).

• Statistic contract: Filter by booking, booking time or user in

getSessionRecordingsByTimeSlot and

getSessionAndUserRecordingsByTimeSlot.

• Group contract

▪ New service getParticipant

▪ New service isUserInGroup


▪ createBooking:

• audience can be booked (as this module is

bookable since this version).

• If a phone conference is booked, you can add the

new feature “connect participant by telephone”

- Version 6.3

• User contract




10/206

▪ New optional attributes: domainForIwa,

principalNameForIwa, sidForIwa for users. These

attributes are only needed if vitero clients are allowed to

use single sign on with Integrated Windows

Authentication.

- Version 6.2

• User contract

▪ New service generates password link: generate a

password link with which a user can define his password.

• createUser

▪ forcenewpassword: force the user to change his

password

▪ generatepasswordlink: generate a password link

• updateUser

▪ forcenewpassword: force the user to change his

password

▪ accountnotlocked: lock or unlock the account of a user

▪ password: change the password of an existing user

- Version 6.1

• New Locale pattern (see below). You still can use “de” and “en”.

• New languages: French, Chinese, Dutch, Spanish and Turkish.

- Version 6.0

• Session code contract

▪ New service createWebaccessSessionCode.

▪ createBookingSessionCode and

createAppointmentConfirmationSessionCode accept new

role “automatic role assignment”.

▪ createAppointmentConfirmationSessionCode: new

attribute “registrationlimit".

• Statistic contract: user recordings can return credit points,

participated interactions and additional field values.




11/206

- Version 5.8

• New services in booking contract:

getBookingListByUserAndDateAndCustomer and

getBookingListByUserAndCustomerInFuture.

- Version 5.7

• The statistic contract can return the group role -1 (anonymous).

- Version 5.6

• Bookings can have event names.

• New service: createAppointmentConfirmationSessionCode:

Create a session code for a booking to allow users to register

themselves for this event.

• New modules in licence contract.

- Version 5.4

• The system/customer needs the webservice module. Otherwise

you will get the error code 309.




12/206

- Version 5.1

• New Service: storeAvatarUsingBase64String: As an alternative

to the storeAvatar service, you can Base64 encode your Image

and add it to the XML. We still recommend using the

storeAvatar service. This new service is just a workaround for

those who cannot use MTOM.

- Version 4.4

• New Service: CreateVmsSessionCode: You can include

frameless websites of the Vitero Management System without

an additional authentication.

• New Service: GetTestroomSessionCode: Get a sessioncode for a

specific user which leads him directly in his testroom without

authentication or group selection.

• If there is an active session for a group, the manipulating

services of the cms contract deny the access to all folders of this

group (error code 607).

• The group contract is extended by the service changeEnabled. If

you set it to false, the user will not be able to enter the group.

- Version 4.3

• The most contracts can be accessed by a customer

administrator, in parts restricted. See “Required rights” in the

description.

• The response of createFolder in the cms contract changed. Now,

you get the id of the created node directly.

• The requests of the functions getUserCount and

getBookingListByDate were extended by a (for a system

administrator) optional parameter customerid.

• New service: updateBooking (booking contract)




13/206

3 Authentication

The header of a SOAP-request must contain a username token to

authenticate the client. This token contains the username and the

password. If the authentication fails, an Authentication fault-string will be

returned (see Case 1: Authentication failed).

NOTE: The vitero-account you send with the SOAP-request must have

admin-rights! Otherwise the request won´t be handled and you´ll get an

error-response with error code 4 (insufficient rights).

Sample Request-header:

<SOAP-ENV:Envelope xmlns:SOAP-

ENV="http://schemas.xmlsoap.org/soap/envelope/">

<SOAP-ENV:Header>

<wsse:Security xmlns:wsse="http://docs.oasis-

open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"

SOAP-ENV:mustUnderstand="1">

<wsse:UsernameToken xmlns:wsu="http://docs.oasis-

open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"

wsu:Id="XWSSGID-12385980298751391139757"

xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/

oasis-200401-wss-wssecurity-secext-1.0.xsd">

<wsse:Username>myUserName</wsse:Username>

<wsse:Password Type="http://docs.oasis-

open.org/wss/2004/01/oasis-200401-wss-username-token-profile-

1.0#PasswordText">secret</wsse:Password>

<wsse:Nonce EncodingType="http://docs.oasis-

open.org/wss/2004/01/oasis-200401-wss-soap-message-security

-1.0#Base64Binary">L/TCdGJPn5P6VBbSWN6YM9vA</wsse:Nonce>

<wsu:Created xmlns:wsu="http://docs.oasis-

open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility1.0.xsd">

2009-04-01T15:00:30.546Z

</wsu:Created>




14/206

</wsse:UsernameToken>

</wsse:Security>

</SOAP-ENV:Header>

<SOAP-ENV:Body>

...

</SOAP-ENV:Body>

</SOAP-ENV:Envelope>




15/206

4 Web Services Definitions

4.1 Data Types

4.1.1 Standard types

integer/long: the value must be a number. Otherwise the web service

won’t handle the request.

string: the value can be any string.

date: a string value in the format YYYYMMDDhhmm. Example:

201001201651 for the 20th Januarry 2010 at 16:51.

idlist: the value must be a list of space-separated integers. Example:

<idlist>110 238 52</idlist>

4.1.2 Binary content (MTOM)

For file transfers the functions are using MTOM. MTOM is the W3C Message

Transmission Optimization Mechanism, a method of efficiently sending

binary data to and from web services. It uses XOP (XML-binary Optimized

Packaging) to transmit binary data and is intended to replace both MIME

and DIME attachments. See http://www.w3.org/TR/soap12-mtom/ for

more information.

Note, that all functions that are using MTOM are using the namespace

http://www.vitero.de/schema/mtom. The contract which contains these

functions can be found on https://[hostname]/vitero/services/mtom.wsdl.

http://www.w3.org/TR/soap12-mtom/




16/206

4.1.3 The locale

The locale contains information about the language. The locale is declared

as a lowercase ISO 639 code and an uppercase ISO 3166 code.

Supported languages are:

• de_DE - German

• en_GB - English

• fr_FR – French

• zh_CN – Chinese

• tr_TR - Turkish

• nl_NL – Dutch

• es_ES – Spanish

• ru_RU - Russian

4.1.4 The time-zone

The table below shows all supported timezones. A <timezone>-tag must

be one of the TimeZone-Ids. The Description shows you the UTC-

Difference and some popular cities which use this timezone.

Timezone-Id Description

Pacific/Apia (UTC -11:00) Midway, Samoa

Pacific/Fakaofo (UTC -10:00) Hawaii, Tahiti

America/Adak (UTC -10:00) Adak, Atka

Pacific/Marquesas (UTC -09:30) Marquesas

Pacific/Gambier (UTC -09:00) Gambier Islands

America/Anchorage (UTC -09:00) Alaska

America/Ensenada (UTC -08:00) Tijuana, Baja California (Mexico)

Pacific/Pitcairn (UTC -08:00) Pitcairn Islands

America/Dawson (UTC -08:00) Los Angeles, Vancouver

America/Chihuahua (UTC -07:00) Chihuahua, Mazatlan




17/206

America/Boise (UTC -07:00) Denver, Salt Lake City, Calgary

America/Dawson_Creek (UTC -07:00) Dawson Creek, Hermosillo,

Phoenix

America/Belize (UTC -06:00) Costa Rica, Guatemala, Managua

Pacific/Easter (UTC -06:00) Easter Island

America/Chicago (UTC -06:00) Chicago, Winnipeg

America/Cancun (UTC -06:00) Cancun, Mexico City, Monterrey

America/Havana (UTC -05:00) Havana

America/Detroit (UTC -05:00) Detroit, New York, Toronto

America/Atikokan (UTC -05:00) Bogota, Lima, Panama

America/Caracas (UTC -04:30) Caracas

America/Glace_Bay (UTC -04:00) Bermuda, Halifax

America/Campo_Grande (UTC -04:00) Campo Grande, Cuiaba

America/Goose_Bay (UTC -04:00) Goose Bay (East Labrador)

America/Anguilla (UTC -04:00) Barbados, Manaus, Puerto Rico

America/Asuncion (UTC -04:00) Asuncion

America/Santiago (UTC -04:00) Santiago

Atlantic/Stanley (UTC -04:00) Stanley (Falkland Islands)

America/St_Johns (UTC -03:30) St. John's (Newfoundland)

America/Montevideo (UTC -03:00) Montevideo

America/Miquelon (UTC -03:00) Miquelon

America/Sao_Paulo (UTC -03:00) Sao Paulo

America/Godthab (UTC -03:00) Godthab

America/Argentina/Buenos_Aires (UTC -03:00) Buenos Aires, Cordoba

America/Araguaina (UTC -03:00) Mendoza, Recife, San Luis




18/206

America/Noronha (UTC -02:00) Central Atlantic

Atlantic/Cape_Verde (UTC -01:00) Cape Verde

America/Scoresbysund (UTC -01:00) Azores

Africa/Abidjan (UTC +00:00) Casablanca, Reykjavik

Atlantic/Canary (UTC +00:00) Dublin, Lisbon, London

Africa/Windhoek (UTC +01:00) Windhoek

Africa/Algiers (UTC +01:00) Algier, Porto Novo

Africa/Ceuta (UTC +01:00) Berlin, Oslo, Paris, Rome,

Stockholm

Africa/Tunis (UTC +01:00) Tunis

Africa/Cairo (UTC +02:00) Cairo

Asia/Amman (UTC +02:00) Amman

Asia/Gaza (UTC +02:00) Gaza

Asia/Beirut (UTC +02:00) Beirut

Asia/Jerusalem (UTC +02:00) Jerusalem, Tel Aviv

Europe/Kaliningrad (UTC +02:00) Kaliningrad, Minsk

Asia/Damascus (UTC +02:00) Damascus

Asia/Istanbul (UTC +02:00) Athens, Helsinki, Istanbul, Riga

Africa/Blantyre (UTC +02:00) Johannesburg, Tripoli

Africa/Addis_Ababa (UTC +03:00) Addis Ababa, Baghdad, Kuwait

Europe/Moscow (UTC +03:00) Moscow, Volgograd

Asia/Riyadh87 (UTC +03:07) Riyadh

Asia/Tehran (UTC +03:30) Tehran

Asia/Dubai (UTC +04:00) Dubai, Mahe, Reunion

Asia/Baku (UTC +04:00) Baku




19/206

Indian/Mauritius (UTC +04:00) Mauritius

Asia/Yerevan (UTC +04:00) Yerevan, Samara

Asia/Kabul (UTC +04:30) Kabul

Asia/Aqtau (UTC +05:00) Maldives, Karachi, Tashkent

Asia/Yekaterinburg (UTC +05:00) Yekaterinburg

Asia/Calcutta (UTC +05:30) Calcutta, Colombo

Asia/Katmandu (UTC +05:45) Katmandu

Asia/Novosibirsk (UTC +06:00) Novosibirsk, Omsk

Asia/Almaty (UTC +06:00) Almaty, Dhaka

Asia/Rangoon (UTC +06:30) Rangoon

Asia/Bangkok (UTC +07:00) Bangkok, Jakarta

Asia/Krasnoyarsk (UTC +07:00) Krasnoyarsk

Asia/Brunei (UTC +08:00) Hong Kong, Perth, Singapore

Asia/Irkutsk (UTC +08:00) Irkutsk

Australia/Eucla (UTC +08:45) Eucla

Asia/Dili (UTC +09:00) Seoul, Tokyo

Asia/Yakutsk (UTC +09:00) Yakutsk

Australia/Darwin (UTC +09:30) Darwin

Australia/Adelaide (UTC +09:30) Adelaide

Asia/Sakhalin (UTC +10:00) Vladivostok

Australia/Brisbane (UTC +10:00) Guam, Port Moresby

Australia/ACT (UTC +10:00) Canberra, Melbourne, Sydney

Australia/LHI (UTC +10:30) Lord Howe Island

Pacific/Efate (UTC +11:00) New Caledonia, Solomon Islands

Asia/Magadan (UTC +11:00) Magadan




20/206

Pacific/Norfolk (UTC +11:30) Norfolk Island

Asia/Anadyr (UTC +12:00) Kamchatka

Pacific/Fiji (UTC +12:00) Fiji Islands, Marshall Islands

Pacific/Auckland (UTC +12:00) Auckland

Pacific/Chatham (UTC +12:45) Chatham

Pacific/Enderbury (UTC +13:00) Tongatapu

Pacific/Kiritimati (UTC +14:00) Kiritimati




21/206

4.1.5 The display type

Folders of the Contents area of the Vitero Management System can have

different behaviors. Each folder has one of the following Display Types:

Display type Value Description

default 0

Only for public (customer-related) folders. A folder which

has been tagged as default is automatically copied in the

team folder of a newly created team.

agenda 1

Only for team (group-related) folders. Only one agenda

folder can be created within a team folder. The contents of

the agenda folder can be accessed in the virtual team

room via the “Agenda” button.

deactivated 2

The folders and its contents are hidden and can only be

viewed by team leaders, assistans as well as system or

customer administrators and are not available in the

virtual team room.

presentation 3

Only for team (group-related) folders. The contents of the

agenda folder can be accessed in the virtual team room via

the “Media” button.

vms 4

Those folders can not be accessed in the virtual team room

(only in the Vitero Management System). This display type

is the default value if you do not choose a specific display

type.

welcome 5

Only for team (group-related) folders. Only one welcome

folder can be created within a team folder. The contents of

the welcome folder can be accessed in the virtual team

room. The content is automatically shown on the

conference table when entering the virtual team room.




22/206

4.2 The successResponse

A successResponse is returned if the request has no output parameters (a

manipulating request like updateUserRequest). The successResponse

contains a <request>-attribute which shows the name of the request that

was successful.

Example: the updateUserRequest was successful

<successResponse xmlns="http://www.vitero.de/schema/user">

<request>updateUserRequest</request>

</successResponse>

4.3 The user contract

The user contract contains functions to manipulate, create and get

informations about the users.

You can use these functions by calling the following URL:

https://[hostname]/vitero/services/.

The namespace of this contract is: http://www.vitero.de/schema/user

The contract (user.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/user.wsdl

4.3.1 getUser

• Description: Returns a user by a given id.

• Required rights: System administrator or customer administrator

for at least one of the customers, the user is assigned to.

• Request:

• Requestname: <getUserRequest>

• Input parameters (root-element: <getUserRequest>):

Tag Type Optional Value Description

userid integer no > 0 The id of the searched user. The

user must exist in the database.




23/206

• Sample Request:

<getUserRequest xmlns="http://www.vitero.de/schema/user">

<userid>4711</userid>

</getUserRequest>

• Response:

• Responsename: <getUserResponse>

• Output parameters (root-element: <user>):

Tag Type Description

id integer the id of the user

username string the username

title string the title

surname string the surname

firstname string the first name

email string the Email-Address

company string the company

locale string a lowercase ISO 639 / ISO 3166 code for the

locale

timezone string a timezone

phone string the phone number

fax string the fax number

mobile string the mobile number

country string the country

zip string the postal code

domainForIwa string The windows domain used for single sign on

with IWA

principalName

ForIwa string

The user principalName used for single sign on

with IWA




24/206

sidForIwa string The windows object sid used for single sign on

with IWA

city string the city

street string the street

pcstate string the pc state

technicalnote string a technical note

customer custom

er

The customers to which this user is assigned.

See below.

• Output parameters (root-element: <customer>):


customerid integer the id of the customer

admin boolean indicates if the user is administrator of this

customer

• Sample Response:

<getUserResponse xmlns="http://www.vitero.de/schema/user">

<user>

<id>11</id>

<username>mustermannm</username>

<title>Dr.</title>

<surname>Mustermann</surname>

<firstname>Max</firstname>

<email>[email protected]</email>

<company>vitero GmbH</company>

<locale>de_DE</locale>

<timezone>Europe/Berlin</timezone>

<phone>0711/6868988-0</phone>




25/206

<fax>0711/6868988-80</fax>

<mobile>0173/1234567-0</mobile>

<country>Germany</country>

<zip>70569</zip>

<city>Stuttgart</city>

<street>Nobelstr. 15</street>

<pcstate>ERROR</pcstate>

<technicalnote>the user has problems with the

firewall.</technicalnote>

<customer>

<customerid>23</customerid>

<admin>false</admin>

</customer>

</user>

</getUserResponse>

• Possible errors:

• the requested user does not exist (53)

• the id is <= 0 (303)

• insufficient rights (4)

4.3.2 getUserList

• Description: Returns the list of all users.

• Required rights: Only system administrators.

• Request:

• Requestname: <getUserListRequest>

• Input parameters (root-element:

<getUserListRequest>): none

• Sample Request:

<getUserListRequest xmlns="http://www.vitero.de/schema/user" />




26/206

• Response:

• Responsename: <getUserListResponse>










locale string a lowercase ISO 639 / ISO 3166 code

for the locale



<getUserListResponse xmlns="http://www.vitero.de/schema/user">

<user>

<id>11</id>








</user>




27/206

<user>

<id>12</id>

<username>maierh</username>

<surname>Maier</surname>

<firstname>Hans</firstname>



<locale>en_GB</locale>

<timezone>USA/Los_Angeles</timezone>

</user>

</getUserListResponse>



4.3.3 getUserListByPosition

• Description: Returns a part of the list of all users.

• Request:

• Requestname: <getUserListByPositionRequest>



<getUserListByPositionRequest>):


firstposition integer no 0 > value <

lastposition

The first position in the list

of all users.

lastposition integer no 0 > value >

firstposition

The last position in the list

of all users. The value

must be > firstposition.




28/206

• Sample Request:

<getUserListByPositionRequest

xmlns="http://www.vitero.de/schema/user">

<firstposition>20</firstposition>

<lastposition>40</lastposition>

</getUserListByPositionRequest>

• Response:

• Responsename: <getUserListByPositionResponse>











for the locale



<getUserListByPositionResponse


<user>

<id>11</id>


<title>Dr.</title>




29/206







</user>

<user>

<id>12</id>








</user>

</getUserListByPositionResponse>


• the <lastposition> is higher than the count of users in the

system (302)

• the <firstposition> is < 0 (302)

• the <firstposition> is higher than the <lastposition> (302)





30/206

4.3.4 getUserListByCustomer

• Description: Returns a list of all users which belong to a specific

customer. If the customer doesn´t exist, you´ll get an empty

response.


for the given customer.

• Request:

• Requestname: <getUserListByCustomerRequest>


<getUserListByCustomerRequest>):


customerid integer no 0 > The id of the

customer.

• Sample Request:

<getUserListByCustomerRequest



</getUserListByCustomerRequest>




31/206

• Response:

• Responsename: <getUserListByCustomerResponse>











for the locale



<getUserListByCustomerResponse


<user>

<id>11</id>








</user>




32/206

<user>

<id>12</id>








</user>

</getUserListByCustomerResponse>


• the customer doesn´t exist (101)

• the <customerid> is <= 0 (303)


4.3.5 getUserListByGroup

• Description: Returns a list of all users which belong to a specific

group. If the group doesn´t exist, you´ll get an empty response.


for the customer, to which the group belongs.

• Request:

• Requestname: <getUserListByGroupRequest>


<getUserListByGroupRequest>):


groupid integer no 0 > The id of the group.




33/206

• Sample Request:

<getUserListByGroupRequest


<groupid>123</groupid>

</getUserListByGroupRequest>

• Response:

• Responsename: <getUserListByGroupResponse>










locale string a lowercase ISO 639 / ISO 3166 code for the locale



<getUserListByGroupResponse


<user>

<id>11</id>


<title>Dr.</title>







34/206




</user>

<user>

<id>12</id>








</user>

</getUserListByGroupResponse>


• the group doesn´t exist (151)

• the <groupid> is <= 0 (303)


4.3.6 getUserListByFields

• Description: Returns a list of all users matching the given fields. It

is sufficient to match a partial string. If you search for

<email>@vitero.de</email> for example, all users with a vitero

email address (like [email protected]) are returned. Customer

administrators must set their customerid, only users assigned to

this customer are returned in this case. If multiple fields are given,

the users must match all of them.


if a specific customerid is given.

mailto:[email protected]




35/206

• Request:

• Requestname: <getUserListByFieldsRequest>


<getUserListByFieldsRequest>):


custom

erid integer yes > 0

The id of the

customer where the

users are searched.

If this field is not

set, the users of all

customers are

searched (requires

system

administrator

rights).

userid integer Yes > 0 The id of a user.

userna

me string yes

The username (or a

part of it).

surnam

e string yes

The surname (or a

part of it).

firstnam

e string yes

The firstname (or a

part of it).

email string yes The email (or a part

of it).

compan

y string yes

The company (or a

part of it).

pcstate string yes

OK,

ERRO

R or

NOT_

TESTE

D

The pc state of the

user.




36/206

domain

ForIwa string yes

The domain for the

IWA (or a part of

it).

principa

lNameF

orIwa

string yes

The principal name

for the IWA (or a

part of it).

sidForI

wa string yes

The sid for the IWA

(or a part of it).

• Sample Request:

<getUserListByFieldsRequest



<email>@vitero.de</email>


</getUserListByFieldsRequest>

• Response:

• Responsename: <getUserListByFieldsResponse>










locale string a lowercase ISO 639 / ISO 3166 code for the locale





37/206


<getUserListByFieldsResponse


<user>

<id>11</id>


<title>Dr.</title>







</user>

<user>

<id>12</id>








</user>

</getUserListByFieldsResponse>



• invalid attribute (303)




38/206

4.3.7 createUser

• Description: Creates a new user.


for all of the customers, the user should be assigned to.

• Request:

• Requestname: <createUserRequest>

• Input parameters (root-element: <user>):

Tag Type Option

al Value Description

username string no not empty the username

title string yes not empty the title

surname string no not empty the surname

firstname string no not empty the first name

email string no not empty the Email-Address

company string yes the company

locale string yes

a lowercase ISO

639 / ISO 3166

code for the locale

(e.g. de_DE for

Germany)

timezone string yes a timezone the timezone

phone string yes the phone number

fax string yes the fax number

mobile string yes the mobile

number

country string yes the country

zip string yes the postal code

city string yes the city




39/206

street string yes the street

domainForIw

a string yes

The windows

domain used for

single sign on with

IWA

principalNam

eForIwa string yes

The user

principalName

used for single

sign on with IWA

sidForIwa string yes

The windows

object sid used for

single sign on with

IWA

pcstate string yes

OK,

NOT_TESTE

D or ERROR

the pc state

technicalnote string yes a technical note

forcenewpass

word boolean yes

true forces the

user to change his

password

generatepass

wordlink boolean yes

generates a

password link with

which the user

can define his

password

password string no not empty the password for

this account

customeridlist idList no not empty

a list of the ids of

the customers to

which the user

belongs




40/206

• Sample Request:

<createUserRequest xmlns="http://www.vitero.de/schema/user">

<user>








<phone>0711/6868988-0</phone>

<fax>0711/6868988-80</fax>

<mobile>0173/1234567-0</mobile>


<zip>70569</zip>


<street>Nobelstr. 15</street>

<pcstate>ERROR</pcstate>

<technicalnote>the user has problems with the

firewall.</technicalnote>

<password>changeme</password>

<customeridlist>134</customeridlist>

</user>

</createUserRequest>




41/206

• Response:

• Responsename: <createUserResponse>

• Output parameters (root-element:

<createUserResponse>):


userid integer the id of the new

user

passw

ordlin

k

string

the link with which

the user can define

his password


<createUserResponse xmlns="http://www.vitero.de/schema/user">

<userid>15</userid>

<passwordlink>

http://localhost/vitero/pw.htm?id=b736c4cb4c</passwordlink>

</createUserResponse>


• the <username> already exists (51)

• the <email> already exists (52)

• a customer of the <customeridlist> does not exist (101)

• password links are not allowed (206)

• a value is invalid (303)

• the <timezone> is invalid (304)

• the <locale> is invalid (305)





42/206

4.3.8 updateUser

• Description: Updates an existing user.


for all customers, the user is assigned to. If the requested user has

system administrator rights, the authenticated user needs them too.

• Request:

• Requestname: <updateUserRequest>

• Input parameters (root-element: <user>):


id integer no > 0 the id of the user

username string yes not empty the username

title string yes not empty the title

surname string yes not empty the surname

firstname string yes not empty the first name

email string yes not empty the Email-Address

company string yes the company

locale string yes

a lowercase ISO 639 /

ISO 3166 code for the

locale (e.g. de_DE for

Germany)

timezone string yes a timezone the timezone

phone string yes the phone number

fax string yes the fax number

mobile string yes the mobile number

country string yes the country

zip string yes the postal code

city string yes the city




43/206

street string yes the street

domainForIw

a string yes

The windows domain

used for single sign on

with IWA

principalNam

eForIwa string yes

The user principalName


with IWA

sidForIwa string yes

The windows object sid


with IWA

pcstate string yes

OK,

NOT_TESTED

or ERROR

the pc state.

technicalnote string yes a technical note

forcenewpas

sword

boolea

n yes

true: forces the user to

change his password

accountnotlo

cked

boolea

n yes

locks (false) or unlocks

(true) the account of a

user

password string yes the password

• Sample Request:

<updateUserRequest xmlns="http://www.vitero.de/schema/user">

<user>

<id>11</id>





<company>Muster AG</company>




44/206



<phone>0711/123456</phone>

<fax>0711/654321</fax>

<mobile>0173/1234567-0</mobile>


<zip>70569</zip>


<street>Hauptstr. 112</street>

<pcstate>OK</pcstate>

<technicalnote>all problems are solved.</technicalnote>

</user>

</createUserRequest>

• Response: <successResponse>


• the <username> already exists (51)

• the <email> already exists (52)


• the <timezone> is invalid (304)

• the <locale> is invalid (305)


4.3.9 deleteUser

• Description: Deletes an existing user.

• Required rigths: A system administrator deletes the user from the

system. A customer administrator removes the user from all

customers for which he has administrator rights. If the user has

been removed from all customers, he will be deleted from the

system.




45/206

• Request:

• Requestname: <deleteUserRequest>


<deleteUserRequest>):


userid integer no > 0 the id of the user that will be

deleted

• Sample Request:

<deleteUserRequest xmlns="http://www.vitero.de/schema/user">

<userid>11</userid>

</deleteUserRequest>



• the user does not exist (53)

• the userid is <= 0 (303)


4.3.10 getUserCount

• Description: Returns the number of existing users in the system.






46/206

• Request:

• Requestname: <getUserCountRequest>


<getUserCountRequest>):


custo

merid integer

Optional

for

system

administr

ator

> 0 the id of the customer

• Sample Request:

<getUserCountRequest xmlns="http://www.vitero.de/schema/user" />

• Response:

• Responsename: <getUserCountResponse>


<getUserCountResponse>):


count integer the count of existing users in the

system


<getUserCountResponse xmlns="http://www.vitero.de/schema/user">

<count>563</count>

</getUserCountResponse>








47/206

4.3.11 changePassword

• Description: Changes the password of a user.




• Request:

• Requestname: <changePasswordRequest>


<changePasswordRequest>):


userid integer no > 0 the id of the user

password string no not empty the new password

• Sample Request:

<changePasswordRequest xmlns="http://www.vitero.de/schema/user">

<userid>11</userid>

<password>foo</password>

</changePasswordRequest>




• the <password> is empty (303)


4.3.12 loadAvatar

See chapter 4.11.1

4.3.13 storeAvatar

See chapter 4.11.2




48/206

4.3.14 storeAvatarUsingBase64String

• Description: Stores a binary file to the server as avatar image. The

binary content is set in the file-tag as a Base64 string. If you have

the possibility to use MTOM, we recommend using the service

storeAvatar instead.



• Request:

• Requestname: <storeAvatarUsingBase64StringRequest>


<storeAvatarUsingBase64StringRequest>):



type integer yes 0 or 1

The type:

• 0 - standard

picture

(default)

• 1 - alternative

picture

filename string no not null the name of the file

file string no the binary content

• Sample Request:

<storeAvatarUsingBase64StringRequest



<filename>picture.jpg</filname>

<type>0</type>

<file> iVBORw0KGgo…SUhEUgAAAEAb+A==</file>

</storeAvatarUsingBase64StringRequest>




49/206





• filesize exceeded (451)

• filetype not allowed (452)

• node not found (601)


4.3.15 generatePasswordLink

• Description: Generates a password link with which the user can

define a password. Note that password links must be allowed in the

configuration of the Vitero Managent System to use this function.




• Request:

• Requestname: <generatePasswordLinkRequest>


<generatePasswordLinkRequest>):


userid integer > 0 the id of the user

• Sample Request:

<generatePasswordLinkRequest



</generatePasswordLinkRequest>




50/206

• Response:

• Responsename: <generatePasswordLinkResponse>


<generatePasswordLinkResponse>):


passw

ordlin

k

string the count link with which the user can

define his password


<generatePasswordLinkResponse


<passwordlink>

http://localhost/vitero/pw.htm?id=b736c4cb4c</passwordlink>

</generatePasswordLinkResponse>




• password links are not allowed (206)


4.4 The customer contract (optional)

The customer contract contains functions to manipulate, create and get

informations about the customers.

You can use this functions by calling the following URL:


The namespace of this contract is: http://www.vitero.de/schema/customer

The contract (customer.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/customer.wsdl

This contract is optional! An additional function to make the VMS multi-

client capable has to be licensed and system administrator rights are

required.




51/206

4.4.1 getCustomer

• Description: Returns a customer by a given id.


• Request:

• Requestname: <getCustomerRequest>


<getCustomerRequest>):


customerid integer no > 0 the id of the searched

customer

• Sample Request:

<getCustomerRequest xmlns="http://www.vitero.de/schema/customer">


</getCustomerRequest>

• Response:

• Responsename: <getCustomerResponse>



id integer the id of the customer

shortname string the unique name of the customer

displayname string the name of the customer that will be

displayed in the VMS

groupidlist idlist a list of the ids of all groups that belong to this

customer

user user A user who is assigned to this customer. See

below.




52/206



userid integer the id of the user

admin boolea

n

indicates if the user is an administrator of this

customer


<getCustomerResponse

xmlns="http://www.vitero.de/schema/customer">

<customer>

<id>134</id>

<shortname>vitero</shortname>

<displayname>vitero GmbH</shortname>

<user>

<userid>11</userid>


</user>

<user>

<userid>57</userid>

<admin>true</admin>

</user>

<groupidlist>55 83 95</groupidlist>

</customer>

</getCustomerResponse>



• the customerid is <= 0 (303)

• VMS is not multi-client capable (307)





53/206

4.4.2 getCustomerByName

• Description: Returns a customer by a given unique name

(shortname).


• Request:

• Requestname: <getCustomerByNameRequest>


<getCustomerByNameRequest>):


customername string no not

empty

the shortname of the

customer

• Sample Request:

<getCustomerByNameRequest


<customername>vitero</customername>

</getCustomerByNameRequest>

• Response:

• Responsename: <getCustomerByNameResponse>





displayname string the name of the customer that will be displayed

in the VMS


customer


below.




54/206




admin boolea

n

indicates if the user is an administrator of this

customer


<getCustomerByNameResponse


<customer>

<id>134</id>




<user>

<userid>11</userid>


</user>

<user>

<userid>57</userid>

<admin>true</admin>

</user>

</customer>

</getCustomerByNameResponse>



• the <customername> is empty (303)






55/206

4.4.3 getCustomerList

• Description: Returns a list of all customers.


• Request:

• Requestname: <getCustomerByNameRequest>


<getCustomerByNameRequest>):

Tag Type Option


customername string no not

empty

the shortname of the

customer

children boolean yes

controls if groupidlist and

user is added to the

response (select false for

better performance)

• Sample Request:

<getCustomerListRequest

xmlns="http://www.vitero.de/schema/customer" />

• Response:

• Responsename: <getCustomerListResponse>





displayname string the name of the customer that will be displayed

in the VMS


customer


below.




56/206




admin boolean indicates if the user is an administrator of

this customer




57/206


<getCustomerListResponse


<customer>

<id>134</id>




<user>

<userid>11</userid>


</user>

<user>

<userid>57</userid>

<admin>true</admin>

</user>

</customer>

<customer>

<id>139</id>

<shortname>muster</shortname>

<displayname>Muster AG</shortname>

<groupidlist>65</groupidlist>

<user>

<userid>11</userid>


</user>

<user>

<userid>57</userid>

<admin>true</admin>




58/206

</user>

</customer>

</getCustomerListResponse>




4.4.4 createCustomer

• Description: Creates a new customer.


• Request:

• Requestname: <createCustomerRequest>

• Input parameters (root-element: <customer>):


shortname string no not

empty

the unique name of the

customer

displayname string no not

empty

the name of the customer that

will be displayed in the VMS

• Sample Request:

<createCustomerRequest


<customer>



</customer>

</createCustomerRequest>




59/206

• Response:

• Responsename: <createCustomerResponse>


<createCustomerResponse>):


customerid integer the id of the new

customer


<createCustomerResponse



</createCustomerResponse>


• the <shortname> already exists (102)




4.4.5 updateCustomer

• Description: Updates an existing customer. If an optional attribute

does not exist in the request or the value is empty

(<displayname></displayname>), the old value remains constant.





60/206

• Request:

• Requestname: <updateCustomerRequest>

• Input parameters (root-element: <customer>):


id integer no > 0 the id of the customer

shortname string yes not

empty

the unique name of the

customer

displayname string yes not

empty

the name of the customer

that will be displayed in the

VMS

• Sample Request:

<updateCustomerRequest


<customer>

<id>139</id>

<shortname>muster</shortname>

<displayname>new Company Name</shortname>

</customer>

</updateCustomerRequest>




• the <shortname> already exists (102)







61/206

4.4.6 deleteCustomer

• Description: Deletes an existing customer.


• Request:

• Requestname: <deleteCustomerRequest>


<deleteCustomerRequest>):


customerid integer no > 0 the id of the

customer

• Sample Request:

<deleteCustomerRequest



</deleteCustomerRequest>




• cannot delete last customer (104)




4.4.7 addUserToCustomer

• Description: Adds a user to a customer.





62/206

• Request:

• Requestname: <addUserToCustomerRequest>


<addUserToCustomerRequest>):



customer


• Sample Request:

<addUserToCustomerRequest



<userid>11</userid>

</addUserToCustomerRequest>



• the user doesn´t exist (53)


• an id is <= 0 (303)



4.4.8 removeUserFromCustomer

• Description: Removes a user from a customer.





63/206

• Request:

• Requestname: <removeUserFromCustomerRequest>


<removeUserFromCustomerRequest>):



customer


• Sample Request:

<removeUserFromCustomerRequest



<userid>11</userid>

</removeUserFromCustomerRequest>





• user has no customer (54)

• an id is <= 0 (303)



4.4.9 moveUserToCustomer

• Description: Moves a user from one customer to another.





64/206

• Request:

• Requestname: <moveUserToCustomerRequest>


<moveUserToCustomerRequest>):



sourcecustomerid integer no > 0

the id of the customer

from which the user will

be removed

destcustomerid integer no > 0


to which the user will be

added

• Sample Request:

<moveUserToCustomerRequest


<userid>11</userid>

<sourcecustomerid>139</customerid>

<destcustomerid>134</customerid>

</moveUserToCustomerRequest>





• the user is not attached to the source customer (103)

• an id is <= 0 (303)






65/206

4.4.10 moveAllUsersToCustomer

• Description: Moves all users from one customer to another.


• Request:

• Requestname: <moveAllUsersToCustomerRequest>


<moveAllUsersToCustomerRequest>):

Tag Type Optiona

l Value Description

sourcecustomerid integer no > 0


from which the users

will be removed

destcustomerid integer no > 0


to which the users will

be added

• Sample Request:

<moveAllUsersToCustomerRequest


<sourcecustomerid>139</customerid>

<destcustomerid>134</customerid>

</moveAllUsersToCustomerRequest>



• a customer doesn´t exist (101)

• an id is <= 0 (303)


4.5 The group contract

The group contract contains functions to manipulate, create and get

informations about the groups.




66/206



The namespace of this contract is: http://www.vitero.de/schema/group

The contract (group.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/group.wsdl

4.5.1 getGroup

• Description: Returns a group by a given id.



• Request:

• Requestname: <getGroupRequest>


<getGroupRequest>):


groupid integer no > 0 the id of the searched

group

• Sample Request:

<getGroupRequest xmlns="http://www.vitero.de/schema/group">


</getGroupRequest>

• Response:

• Responsename: <getGroupResponse>

• Output parameters (root-element: <group>):


id integer the id of the group

name string the name of the group

customerid integer the id of the customer to which the group belongs

participant particip

ant several participant tags, see below




67/206

• Output parameters (root-element: <participant>):



role integer

the group role:

• 0 - participant

• 1 - assistant

• 2 – teamleader

• 3 - audience

enabled boolean indicates if this participant is able to enter the

teamroom for this group


<getGroupResponse xmlns="http://www.vitero.de/schema/group">

<group>

<id>55</id>

<name>Testgruppe</name>


<participant>

<userid>11</userid>

<role>0</role>

<enabled>true</enabled>

</participant>

<participant>

<userid>12</userid>

<role>1</role>


</participant>

</group>




68/206

</getGroupResponse>





4.5.2 getGroupByName

• Description: Returns a group by a given name and customerId.



• Request:

• Requestname: <getGroupByNameRequest>


<getGroupByNameRequest>):


groupname string no not

empty the name of the searched group

customerid integer no > 0 the id of the customer to which

the group belongs

• Sample Request:

<getGroupByNameRequest

xmlns="http://www.vitero.de/schema/group">

<groupname>Testgruppe</groupname>


</getGroupByNameRequest>




69/206

• Response:

• Responsename: <getGroupByNameResponse>





customerid integer the id of the customer to which the group belongs

participant particip

ant several participant tags, see below

• Output parameters (root-element: <participant>):



role integer

the group role:

• 0 - participant

• 1 - assistant


• 3 - audience




<getGroupByNameResponse


<group>

<id>55</id>



<participant>




70/206

<userid>11</userid>

<role>0</role>


</participant>

<participant>

<userid>12</userid>

<role>1</role>


</participant>

</group>

</getGroupByNameResponse>


• the group doesn´t exist; this could also be a subsequent

error if the customer doesn´t exist (151)

• invalid value (303)


4.5.3 getGroupListByCustomer

• Description: Returns a list of all groups which belong to a given

customer. If the customer doesn´t exist, you´ll get an empty

response.



• Request:

• Requestname: <getGroupListByCustomerRequest>


<getGroupListByCustomerRequest>):



customer




71/206

• Sample Request:

<getGroupListByCustomerRequest



</getGroupListByCustomerRequest>

• Response:

• Responsename: <getGroupListByCustomerResponse>





customerid integer the id of the customer to which the group

belongs


<getGroupListByCustomerResponse


<group>

<id>55</id>



</group>

<group>

<id>65</id>

<name>Technical checks</name>


</group>

</getGroupListByCustomerResponse>




72/206



• the customer does not exist (101)


4.5.4 createGroup

• Description: Creates a new group.



• Request:

• Requestname: <createGroupRequest>

• Input parameters (root-element: <group>):


groupname string no not empty

the name of the

group (the name

must be unique

within one customer)


customer

• Sample Request:

<createGroupRequest xmlns="http://www.vitero.de/schema/group">

<group>

<groupname>My new group</groupname>


</group>

</createGroupRequest>




73/206

• Response:

• Responsename: <createGroupResponse>


<createGroupResponse>):


groupid integer the id of the new

group


<createGroupResponse xmlns="http://www.vitero.de/schema/group">


</createGroupResponse>



• the name of the group already exists for this customer (152)


• the <groupname> is empty (303)


4.5.5 updateGroup

• Description: Updates an existing group.






74/206

• Request:

• Requestname: <updateGroupRequest>

• Input parameters (root-element: <group>):


id integer no > 0 the id of the group

name string no not empty

the new name of the

group (the new name

must be unique within

one customer)

• Sample Request:

<updateGroupRequest xmlns="http://www.vitero.de/schema/group">

<group>

<id>55</id>

<name>New group name</name>

</group>

</updateGroupRequest>




• the name of the group already exists for this customer (152)

• the <id> is <= 0 (303)

• the <name> is empty (303)





75/206

4.5.6 deleteGroup

• Description: Deletes an existing group.



• Request:

• Requestname: <deleteGroupRequest>


<deleteGroupRequest>):

Tag Type Optional Description

groupid integer no the id of the group

• Sample Request:

<deleteGroupRequest xmlns="http://www.vitero.de/schema/group">


</deleteGroupRequest>






4.5.7 addUserToGroup

• Description: Adds an user to a group.






76/206

• Request:

• Requestname: <addUserToGroupRequest>


<addUserToGroupRequest>):


groupid integer the id of the group


• Sample Request:

<addUserToGroupRequest xmlns="http://www.vitero.de/schema/group">



</addUserToGroupRequest>




• the user is not attached to the customer (to which this group

belongs) (103)


• an id is <= 0 (303)


4.5.8 removeUserFromGroup

• Description: Removes a user from a group.






77/206

• Request:

• Requestname: <removeUserFromGroupRequest>


<removeUserFromGroupRequest>):


groupid integer no the id of the group

userid integer no the id of the user

• Sample Request:

<removeUserFromGroupRequest




</removeUserFromGroupRequest>





• an id is <= 0 (303)


4.5.9 changeGroupRole

• Description: Changes the role of a user in a specific group.






78/206

• Request:

• Requestname: <changeGroupRoleRequest>


<changeGroupRoleRequest>):


groupid integer no > 0 the id of the group


role integer no 0 <= value <=

3

the group role:

• 0 - participant

• 1 - assistant

• 2 - teamleader

• 3 - audience

• Sample Request:

<changeGroupRoleRequest




<role>2</role>

</changeGroupRoleRequest>





• the user is not attached to the group (153)






79/206

4.5.10 changeEnabled

• Description: Changes the enabled state of a user in a group. A

user is only allowed to enter the group, if enabled is true.



• Request:

• Requestname: <changeEnabledRequest>


<changeGroupRoleRequest>):

Tag Type Optiona

l Value Description



enabled boolean no true or false

• true – the user

is allowed to

enter the

group

• false – the

user cannot

enter the

group

• Sample Request:

<changeEnabledRequest xmlns="http://www.vitero.de/schema/group">



<enabled>false</enabled>

</changeEnabledRequest>





80/206




• the user is not attached to the group (153)



4.5.11 getParticipant

• Description: Returns a participant by a group id and a user id.



• Request:

• Requestname: <getParticipantRequest>


<getParticipantRequest>):




• Sample Request:

<getParticipantRequest xmlns="http://www.vitero.de/schema/group">



</getParticipantRequest>




81/206

• Response:

• Responsename: <getParticipantResponse>


<getParticipantResponse>):


role integer

the group role:

• 0 - participant

• 1 - assistant


• 3 - audience




<getParticipantResponse xmlns="http://www.vitero.de/schema/group">

<role>0</role>


</getParticipantResponse>




• the user is not assigned to the group (153)



4.5.12 isUserInGroup

• Description: Checks if a specific user is member of a specific

group. Compared with getParticipant, error 153 is not thrown if the

user is not a group member.




82/206



• Request:

• Requestname: <isUserInGroupRequest>

• Input parameters (root-element: <isUserInGroup>):




• Sample Request:

<isUserInGroupRequest xmlns="http://www.vitero.de/schema/group">



</isUserInGroupRequest>

• Response:

• Responsename: <isUserInGroupResponse>


<isUserInGroupResponse>):


groupmem

ber

boolea

n True, if the user is assgined to this group


<isUserInGroupResponse xmlns="http://www.vitero.de/schema/group">

<groupmember>true</groupmember>

</isUserInGroupResponse>







83/206

4.6 The booking contract

The booking contract contains functions to manipulate, create and get

informations about the bookings.



The namespace of this contract is: http://www.vitero.de/schema/booking

The contract (booking.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/booking.wsdl

4.6.1 getBookingById

• Description: Returns a booking with a specific id.


for the customer, to which the booking belongs.

• Request:

• Requestname: <getBookingByIdRequest>


<getBookingByIdRequest>):


bookingid integer no > 0 The id of the booking.

timezone timezone yes The timezone to which the

dates refer.

• Sample Request:

<getBookingByIdRequest

xmlns="http://www.vitero.de/schema/booking">

<bookingid>11</bookingid>

<timezone>Africa/Ceuta</timezone>

</getBookingByIdRequest>

• Response:

• Responsename: <getBookingByIdResponse>




84/206

• Output parameters (root-element: <booking>):


bookingid integer the id of the booking


roomsize integer the roomsize (e.g. 12 participants)

cafe boolean indicates if a Corporate Café is booked

capture boolean indicates if a vitero session recorder

module is booked

phone see

below

see table Output parameters (root-element:

<phone>)

pcstateokrequ

ired boolean

indicates if every participant of the group can

enter the teamroom or only those who set

their pc-state to “OK”

start date the start date of the booking

end date the end date of the booking

startbuffer int the start buffer in minutes

endbuffer int the end buffer in minutes

eventname string the event name

eventsubtitle string the event subtitle (only event manager)

eventreferent string the event referent (only event manager)

eventcompan

y string the event company (only event manager)

eventcommen

t string the event comment (only event manager)

repetitionpatt

ern int

The repetition pattern. Possible values are:

• 0 – once (no repetition)

• 1 - daily




85/206

• 2 – weekly

• 3 – workdays

• 4 – weekends

• 5 – two weeks

repetitionend

date date

The date of the last repetition. No tag for

repetition pattern 0. If the repetition is

endless, you´ll get the licence expiration date.

inspire boolean

Indicates if the inspire client is used for this

booking. Note that this flag replaced the old

html5client.

addexceptions bookingt

ime

Dates, where the room is booked additional to

the repetition pattern. This will be

implemented in a future release. See below.

subtractexcep

tions

bookingt

ime

Dates, where the room is not booked although

it should be because of the repetition pattern.

This will be implemented in a future release.

See below.

• Output parameters (root-element: <phone>):


phoneconfere

nce boolean indicates if a telephone conference is booked

showdialogue boolean if true, the telephone dialogue is shown

automatically when a user enters the room

dialout boolean if true, a dial out (the system calls the user) is

allowed

dialoutphonep

articipant boolean

if true, a team leader is allowed to connect

participants by telephone




86/206


<addexceptions><bookingtime>):


bookingtimeid integer the id of the booking time







<subtractexceptions><bookingtime>):





A daily repetition booking from 22.01.2010 until 28.01.2010. The

bookings are from 14:00 to 16:00, except on 24th, where the booking

ends at 17:00.

<getBookingByIdResponse


<booking>



<roomsize>22</roomsize>

<cafe>false</cafe>

<capture>true</capture>

<phone>




87/206

<phoneconference>false</phoneconference>

</phone>

<pcstateokrequired>false</pcstateokrequired>

<start>201001221400</start>

<end>201001221600</end>

<startbuffer>15</startbuffer>

<endbuffer>30</endbuffer>

<repetitionpattern>1</repetitionpattern>

<repetitionenddate>201001281600</repetitionenddate>

<inspire>false</inspire>

<addexceptions>

<bookingtime>

<bookingtimeid>44</bookingtimeid>


<start>201001241400</start>

<end>201001241700</end>



</bookingtime>

</addexceptions>

<subtractexceptions>

<bookingtime>

<start>201001241400</start>

<end>201001241600</end>

</bookingtime>

</subtractexceptions>

</booking>

</getBookingByIdResponse>




88/206


• the id is <= 0 (303)

• the booking does not exist (506)


4.6.2 getBookingByBookingTimeId

• Description: Returns a booking from a specific bookingtime id. A

booking consists of several bookingtimes, one for each repetition. If

the repetition pattern is 0 (once), there is only one bookingtime.



• Request:

• Requestname: <getBookingByBookingTimeIdRequest>

Input parameters (root-element:

<getBookingByBookingTimeIdRequest>):


bookingtimeid integer no > 0 The id of the booking

time.


dates refer.

• Sample Request:

<getBookingByBookingTimeIdRequest




</getBookingByBookingTimeIdRequest>

• Response:

• Responsename: <getBookingByBookingTimeIdResponse>

• Output parameters and Sample response see

getBookingByIdResponse




89/206


• the id is <= 0 (303)



4.6.3 getBookingTimeById

• Description: Returns a bookingtime with a specific id.



• Request:

• Requestname: <getBookingTimeByIdRequest>


<getBookingTimeByIdRequest>):


bookingtimeid integer no > 0 The id of the booking.


dates refer.

• Sample Request:

<getBookingTimeByIdRequest




</getBookingByIdRequest>

• Response:

• Responsename: <getBookingTimeByIdResponse>




90/206

• Output parameters (root-element: <bookingtime>):


bookingtimeid integer the id of the bookingtime

bookingid integer the id of the booking



cafe boolea

n indicates if Corporate Café is booked

capture boolea

n

indicates if a vitero session recorder module

is booked

phone see

below

see table Output parameters (root-element:

<phone>)

pcstateokrequ

ired

boolea

n

indicates if every participant of the group can

enter the teamroom or only those who set their

pc-state to “OK”





eventname string the event name

eventsubtitle string the event subtitle (only event manager)

eventreferent string the event referent (only event manager)

eventcompan

y string the event company (only event manager)

eventcommen

t string the event comment (only event manager)




91/206

• Output parameters (root-element: <phone>):


phoneconfere

nce

boolea

n indicates if a telephone conference is booked

showdialogue boolea

n

if true, the telephone dialogue is shown

automatically when a user enters the room

dialout boolea

n

if true, a dial out (the system calls the user) is

allowed

dialoutphonep

articipant

boolea

n

if true, a team leader is allowed to connect

participants by telephone


<getBookingTimeByIdResponse


<bookingtime>





<cafe>false</cafe>


<phone>

<phoneconference>false</phoneconference>

</phone>

<pcstateokrequired>false</pcstateokrequired>

<start>201001221400</start>

<end>201001221600</end>






92/206

</bookingtime>

</getBookingTimeByIdResponse>


• the id is <= 0 (303)



4.6.4 getBookingListByGroupAndDate

• Description: Returns a list of all bookings of a group in a specific

time frame.



• Request:

• Requestname: <getBookingListByGroupAndDateRequest>


<getBookingListByGroupAndDateRequest>):


groupid integer no > 0 The id of the group.

start date no The date where the time frame

begins.

end date no The date where the time frame

ends.

timezone timezone yes The time zone for the dates.

Default is the server time zone.

• Sample Request:

<getBookingListByGroupAndDateRequest



<start>201001010000</start>




93/206

<end>201003010000</end>

</getBookingListByGroupAndDateRequest>

• Response:

• Responsename:

<getBookingListByGroupAndDateResponse>




• the group does not exist (151)

• the id is <= 0 (303)


4.6.5 getBookingListByGroupInFuture

• Description: Returns a list of all bookings of a group in the future.



• Request:

• Requestname: <getBookingListByGroupInFutureRequest>


<getBookingListByGroupInFutureRequest>):


groupid integer no > 0 The id of the

group.

timezo

ne

timezon

e yes

The time zone

for the dates.

Default is the

server time

zone.




94/206

• Sample Request:

<getBookingListByGroupInFutureRequest



</getBookingListByGroupInFutureRequest>

• Response:

• Responsename:

<getBookingListByGroupInFutureResponse>





• the id is <= 0 (303)


4.6.6 getBookingListByUserAndDate

• Description: Returns a list of all bookings of the groups to which a

user belongs in a specific time frame.


for all of the customers, the user is assigned to.

• Request:

• Requestname: <getBookingListByUserAndDateRequest>




95/206


<getBookingListByUserAndDateRequest>):


userid integer no > 0 The id of the user.

start date no The date where the time

frame begins.

end date no The date where the time

frame ends.

timezone timezone yes

The time zone for the dates.

Default is the server time

zone.

• Sample Request:

<getBookingListByUserAndDateRequest



<start>201001010000</start>

<end>201003010000</end>

</getBookingListByUserAndDateRequest>

• Response:

• Responsename: <getBookingListByUserAndDateResponse>





• the id is <= 0 (303)





96/206

4.6.7 getBookingListByUserAndDateAndCustomer

• Description: Returns a list of all bookings of the groups of a

specific customer to which a user belongs in a specific time frame.


of the specified customer id.

• Request:

• Requestname:

<getBookingListByUserAndDateAndCustomerRequest>


<getBookingListByUserAndDateAndCustomerRequest>):



customerid integer No > 0 The id of the customer.


frame begins.


frame ends.


The time zone for the

dates. Default is the server

time zone.

• Sample Request:

<getBookingListByUserAndDateAndCustomerRequest




<start>201001010000</start>

<end>201003010000</end>

</getBookingListByUserAndDateAndCustomerRequest>




97/206

• Response:

• Responsename:

<getBookingListByUserAndDateAndCustomerResponse>





• the id is <= 0 (303)


4.6.8 getBookingListByUserInFuture

• Description: Returns a list of all bookings of the groups to which a

user belongs in the future.


for all of the customers, the user is assigned to.

• Request:

• Requestname: <getBookingListByUserInFutureRequest>


<getBookingListByUserInFutureRequest>):





dates. Default is the

server time zone.

• Sample Request:

<getBookingListByUserInFutureRequest



</getBookingListByUserInFutureRequest>




98/206

• Response:

• Responsename: <getBookingListByUserInFutureResponse>





• the id is <= 0 (303)


4.6.9 getBookingListByUserAndCustomerInFuture

• Description: Returns a list of all bookings of the groups of a

specific customer to which a user belongs in the future.


for the specified customer id.

• Request:

• Requestname:

<getBookingListByUserAndCustomerInFutureRequest>


<getBookingListByUserAndCustomerInFutureRequest>):



customerid integer no > 0 The id of the

customer.




server time zone.

• Sample Request:

<getBookingListByUserAndCustomerInFutureRequest





99/206



</getBookingListByUserAndCustomerInFutureRequest>

• Response:

• Responsename:

<getBookingListByUserAndCustomerInFutureResponse>





• the id is <= 0 (303)


4.6.10 getBookingListByDate

• Description: Returns a list of all bookings in a specific time frame.






100/206

• Request:

• Requestname: <getBookingListByDateRequest>


<getBookingListByUserAndDateRequest>):



frame begins.


frame ends.

customerid integer

Optional for

system

administrator

> 0

The id of one specific

customer.




server time zone.

• Sample Request:

<getBookingListByDateRequest


<start>201001010000</start>

<end>201003010000</end>

</getBookingListByDateRequest>

• Response:

• Responsename: <getBookingListByDateResponse>









101/206

4.6.11 createBooking

• Description: Creates a new booking.



• Request:

• Requestname: <createBookingRequest>

• Input parameters (root-element: <booking>):


start date no The date where the

booking begins.

end date no The date where the

booking ends.

startbuffer integer no >= 0 The buffer before the

start time in minutes

endbuffer integer no >= 0 The buffer after the

end time in minutes

groupid integer no > 0 The date where the

booking ends.

roomsize integer no > 0

The room size (max.

count of chairs in the

virtual team room).

ignorefaults boolean yes

If true, the system

will ignore faults. e.g.

if you book a room

with 5 repeatings, but

one of the repeatings

cannot be booked

because of a collision,

the system will book

the other 4 repeatings

anyway. The default

value is false (in this




102/206

case the whole

booking fails).

cafe boolean yes

Declares, if the

booking is a

Corporate Café (only

if licenced).

capture boolean yes

Declares, if vitero

session recorder is

allowed (only if you

have licenced this

module).

phone see

below yes

see table Output

parameters (root-

element: <phone>)

audience boolean yes

Declares, if vitero

audience is allowed

(only if you have

licenced this module).

pcstateokrequired boolean yes

Indicates if every

participant of the

group can enter the

teamroom or only

those who set their

pc-state to “OK”.

Default is false.

eventname string Yes The event name

eventsubtitle string Yes The event subtitle

(only event manager)

eventreferent string Yes The event referent


eventcompany string Yes

The event company





103/206

eventcomment string Yes The event comment

(only event manager).

repetitionpattern string yes see

description

The repetition

pattern:

once: no repetition

(default)

daily: every day

weekly: every week

workdays: only from

monday to friday

weekends: only on

saturday and sunday

twoweeks: every two

weeks

repetitiondate date yes

The date where the

repetition ends.

Default is endless

(expect in case of

repetition=once)




server time zone.

inspire boolean yes

Indicates if the inspire

client is used for this

booking. If this

attribute is empty, the

default value of the

customer is used.

Note that inspire=true

(false) may cause

error 312 (313) if this

group does not allow

inspire (essentials).




104/206

• Input parameters (root-element: <phone>):


phoneconference boolean yes

Indicates if a

telephone conference

is booked. Default is

false.

showdialogue boolean yes

If true, the telephone

dialogue is shown

automatically when a

user enters the room.

Default is false.

dialout boolean yes

If true, a dial out (the

system calls the user)

is allowed. Default is

false.

dialoutphonepart

icipant boolean yes

If true, a team leader

is allowed to connect

participants by

telephone. Default is

false.

• Sample Request:

<createBookingRequest xmlns="http://www.vitero.de/schema/booking">

<booking>

<start>201001011400</start>

<end>201001011500</end>





<ignorefaults>false</ignorefaults>

<cafe>false</cafe>




105/206


<audience>false</audience>

<phone>

<phoneconference>true</phoneconference>

<dialout>true</dialout>

<dialoutphoneparticipant>false</dialoutphoneparticipant>

</phone>

<repetitionpattern>daily</repetitionpattern>

<repetitionenddate>201001051500</repetitionenddate>


</booking>

</createBookingRequest>

• Response:

• Responsename: <createBookingResponse>


<createBookingResponse>):


bookingid integer no the id of the booking

bookingcollision boolean yes

flag that indicates if there were

collisions (only if ignorefaults is

true)

modulecollision boolean yes

flag that indicates if a booked

module was not available (only if

ignorefaults is true)


<createBookingResponse






106/206

<bookingcollision>true</bookingcollision>

<modulecollision>false</modulecollision>

</createBookingResponse>

• or:

<createBookingResponse



</createBookingResponse>


• invalid module selection (502)

• booking collision (501)

• booking in past (505)

• no rooms available (508)

• available quota exhausted (704)

• quota not yet valid (706)


4.6.12 updateBooking

• Description: Changes an existing booking.



• Request:

• Requestname: <updateBookingRequest>


<updateBookingRequest>):



start date yes The date where the

booking begins.




107/206

end

date

yes

The date where the

booking ends.

startbuffer integer yes >= 0 The buffer before the

start time in minutes

endbuffer integer yes >= 0 The buffer after the

end time in minutes

timezone string yes timezone The timezone for start

and end

eventname string yes The event name

eventsubtitle string Yes The event subtitle


eventreferent string Yes The event referent


eventcompany string Yes The event company


eventcomment string Yes The event comment


inspire boolean Yes

Indicates if the inspire

client is used for this

booking. Note that

inspire=true (false)

may cause error 312

(313) if this group

does not allow inspire

(essentials).

• Sample Request:

<updateBookingRequest xmlns="http://www.vitero.de/schema/booking">


<start>201001011400</start>

<end>201001011500</end>




108/206



</updateBookingRequest>



• booking collision (501)

• booking in past (505)

• No rooms available (508)

• quota not yet valid (706)


4.6.13 deleteBooking

• Description: Deletes an existing booking.



• Request:

• Requestname: <deleteBookingRequest>


<deleteBookingRequest>):



• Sample Request:

<deleteBookingRequest xmlns="http://www.vitero.de/schema/booking">


</deleteBookingRequest>




109/206

• Response:

• Responsename: <deleteBookingResponse>


<deleteBookingResponse>):


deletestate integer no

the delete state:

0 - all events were deleted

1 - some events were deleted

2 - no event was deleted

eventlocked boolean yes one of the events was locked

eventsinpast integer yes count of events that are in the past

(and cannot be deleted)


<deleteBookingResponse


<deletestate>2</deletestate>

<eventlocked>false</eventlocked>

<eventsinpast>3</eventsinpast>

</deleteBookingResponse>

• or:

<deleteBookingResponse


<deletestate>0</deletestate>

</deleteBookingResponse>

Possible errors:

• the <bookingid> is <= 0 (303)

• booking does not exist (506)





110/206

4.7 The cms contract

The cms contract contains functions to manage the folders and files of the

customer- and group-folders.



The namespace of this contract is: http://www.vitero.de/schema/cms

The contract (cms.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/cms.wsdl

4.7.1 getGroupFolder

• Description: Returns the structure of a group-folder.



• Request:

• Requestname: <getGroupFolderRequest>


<getGroupFolderRequest>):


groupid integer no > 0 the id of the searched

group

• Sample Request:

<getGroupFolderRequest xmlns="http://www.vitero.de/schema/cms">


</getGroupFolderRequest>

• Response:

• Responsename: <getGroupFolderResponse>


<getGroupFolderResponse>):


folder see below the requested folder




111/206

• <folder>


nodeid long the id of the node

name string the name of the folder

displayt

ype int

the displaytype, see chapter 0:

• 0 - default

• 1 - agenda

• 2 - deactivated

• 3 - presentation

• 4 - vms (default-value)

• 5 - welcome

• 6 - recording

children complex type the folders and files in this

folder

• <file>


nodeid long the id of the node

name string the name of the

folder




112/206


<getGroupFolderResponse xmlns="http://www.vitero.de/schema/cms">

<folder>

<nodeid>183</nodeid>

<name>MyGroup</name>

<displaytype>4</displaytype>

<children>

<folder>


<name>preload</name>


<children>

<folder>


<name>presentation</name>


</folder>

<file>


<name>picture.jpg</name>

</file>

</children>

</folder>

<folder>


<name>old_slides</name>


</folder>




113/206

</children>

</folder>

</getGroupFolderResponse>

In this case, the folder MyGroup has two subfolders: preload and

old_slides. While old_slides is empty, the preload-folder contains an empty

subfolder (presentation) and a file (picture.jpg)


• the <groupid> is invalid (303)




4.7.2 getCustomerFolder

• Description: Returns the structure of a customer-folder. See

getGroupFolder, the only difference is that you use a <customerid>

instead of a <groupid>.

4.7.3 createFolder

• Description: Creates a new folder.


for the customer, to which the node belongs.

• Request:

• Requestname: <createFolderRequest>




114/206


<createFolderRequest>):

Tag Type Optio

nal Value Description

nodeid long no > 0 the id of the folder in which

the folder will be created

name string no not

empty the name of the new folder

authorid

Integer

yes

> 0

the id of the user which

creates the folder (if it´s not

the user which authenticates

to the webservice)

visible boolean yes

if false, the folder is only

visible for team leaders or

administrators in the VMS

and is not available in the

virtual team room (default

value is true)

displaytype integer yes

0<=

value <=

6

the displaytype, default-

value is 4 (vms), see chapter

0:

• 0 - default

• 1 - agenda

• 2 - deactivated


• 4 - vms (default-

value)

• 5 - welcome

• 6 - recording




115/206

• Sample Request:

<createFolderRequest xmlns="http://www.vitero.de/schema/cms">


<name>newFolder</name>

</createFolderRequest>

• Response:

• Responsename: <createFolderResponse>


<createFolderResponse>):


nodeid integer the id of the

created node


<createFolderResponse xmlns="http://www.vitero.de/schema/cms">


</createFolderResponse>




• node is locked (607)


4.7.4 deleteNode

• Description: Deletes a file or a folder.






116/206

• Request:

• Requestname: <deleteNodeRequest>


<deleteNodeRequest>):


nodeid long no > 0 the id of the folder that will be

deleted

• Sample Request:

<deleteNodeRequest xmlns="http://www.vitero.de/schema/cms">


</deleteNodeRequest>






• cannot manipulate root folder (609)


4.7.5 renameNode

• Description: Renames a folder or file.






117/206

• Request:

• Requestname: <renameNodeRequest>


<renameNodeRequest>):


nodeid long no > 0 the id of the folder or will which

will be renamed

name string no not

empty the new name of the folder or file

• Sample Request:

<renameNodeRequest xmlns="http://www.vitero.de/schema/cms">


<name>newName</name>

</renameNodeRequest>








4.7.6 copyNode

• Description: Copies a node to another folder.






118/206

• Request:

• Requestname: <copyNodeRequest>


<copyNodeRequest>):


sourcenodeid long no > 0 the id of the node that will be

copied

destnodeid long no > 0 the id of the folder in which the

sourcenode will be copied

• Sample Request:

<copyNodeRequest xmlns="http://www.vitero.de/schema/cms">

<sourcenodeid>238</sourcenodeid>

<destnodeid>240</destnodeid>

</copyNodeRequest>

See example for getGroupFolderResponse: in this case picture.jpg is

copied in the old_slides folder







4.7.7 moveNode

• Description: Removes a node to another folder.






119/206

• Request:

• Requestname: <moveNodeRequest>


<moveNodeRequest>):


sourcenodeid long no > 0 the id of the node that will be

moved

destnodeid long no > 0 the id of the folder in which the

sourcenode will be moved

• Sample Request:

<moveNodeRequest xmlns="http://www.vitero.de/schema/cms">

<sourcenodeid>238</sourcenodeid>

<destnodeid>240</destnodeid>

</moveNodeRequest>

See example for getGroupFolderResponse: in this case picture.jpg is

moved to the old_slides folder








4.7.8 changeDisplaytype

• Description: Changes the displaytype of a node.






120/206

• Request:

• Requestname: <changeDisplaytypeRequest>


<changeDisplaytypeRequest>):


nodeid long no > 0 the id of the node

displaytype integer no 0<= value

<= 6

the displaytype, default-

value is 4 (vms), see

chapter 0:

• 0 - default

• 1 - agenda

• 2 - deactivated


• 4 - vms (default-

value)

• 5 - welcome

• 6- recording

• Sample Request:

<changeDisplaytypeRequest xmlns="http://www.vitero.de/schema/cms">



</changeDisplaytypeRequest>











121/206

4.7.9 changeVisibility

• Description: Changes the visibility of a node.



• Request:

• Requestname: <changeVisibilityRequest>


<changeVisibilityRequest>):

Tag Type Option



visible boolean no

the visibility of the node: In

the VMS, hidden folders are

only visible for team leaders

or administrators and are

not available in the virtual

team room.

• Sample Request:

<changeVisibilityRequest xmlns="http://www.vitero.de/schema/cms">


<visible>false</visible>

</changeVisibilityRequest>











122/206

4.7.10 getDisplaytype

• Description: Returns the display type of a node.



• Request:

• Requestname: <getDisplaytypeRequest>


<getDisplaytypeRequest>):

Tag Type Option



• Sample Request:

<getDisplaytypeRequest xmlns="http://www.vitero.de/schema/cms">


</getDisplaytypeRequest>

• Response:

• Responsename: <getDisplaytypeResponse>


<getDisplaytypeResponse>):


displaytype integer

the displaytype, see chapter 0:

• 0 - default

• 1 - agenda

• 2 - deactivated


• 4 - vms (default-value)

• 5 - welcome

• 6- recording


<getDisplaytypeResponse xmlns="http://www.vitero.de/schema/cms">




123/206


</getDisplaytypeResponse>





4.7.11 loadFile

See chapter 4.11.3

4.7.12 storeFile

See chapter 4.11.4

4.8 The statistic contract (optional)

The statistics contract contains functions to get information about the

statistical recordings. You can use these functions by calling the following

URL: https://[hostname]/vitero/services/.

The namespace of this contract is: http://www.vitero.de/schema/statistic

The contract (statistic.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/statistic.wsdl

This contract is optional! A vitero monitoring module is required.

4.8.1 getSessionRecordingById

• Description: Gets information about one specific session.


for the customer, to which the recording belongs.




124/206

• Request:

• Requestname: <getSessionRecordingByIdRequest>


<getSessionRecordingByIdRequest>):


sessionrecor

dingid integer no > 0 the session recording id




server time zone.

• Sample Request:

<getSessionRecordingByIdRequest

xmlns="http://www.vitero.de/schema/statistic">

<sessionrecordingid>4711</sessionrecordingid>

<timezone>Africa/Cairo</timezone>

</getSessionRecordingById>

• Response:

• Responsename: <getSessionRecordingByIdResponse>


<sessionrecording>):


sessionrecordi

ngid integer the session recording id

sessionstart date the start date and time of this session

sessionend date the end date and time of this session

sessionduratio

n integer the duration of this session in seconds

accumulatedu integer the accumulated user duration of this session in




125/206

serduration seconds

usercount integer the count of users who participated in this

session

bookingid integer the id of the booking time (NOT the booking,

semantic error!)

customerid integer the id of the customer to which this group

belongs

customernam

e string the name of the customer

groupid integer the group id

groupname string the name of the group


<getSessionRecordingByIdResponse


<sessionrecording>


<sessionstart>201001271404</sessionstart>

<sessionend>201001271522</sessionend>

<sessionduration>4686</ sessionduration >

<accumulateduserduration>16574</accumulateduserduration>

<usercount>5</usercount>



<customername>vitero GmbH</customername>


<groupname>vitero Demo</groupname>

</sessionrecording>

</getSessionRecordingByIdResponse>




126/206



• invalid time zone (304)

• no monitoring (306)

• recording does not exist (308)


4.8.2 getUserRecordingById

• Description: Gets information about one specific user activity.



• Request:

• Requestname: <getUserRecordingByIdRequest>


<getUserRecordingByIdRequest>):


userrecordingid

integer

no

> 0

the user recording id




server time zone.

• Sample Request:

<getUserRecordingByIdRequest


<userrecordingid>123</userrecordingid>

</getUserRecordingByIdRequest>




127/206

• Response:

• Responsename: <getUserRecordingByIdResponse>

• Output parameters (root-element: <userrecording>):


userrecordingid integer the user recording id

userstart date the point of time of the login

userend date the point of time of the logout

userduration integer the duration of the user´s participance in

seconds



firstname string the firstname of the user

surname string the surname of the user

grouproletype integer

the group role:

• -1 – anonymous

• 0 - participant

• 1 - assistant

• 2 - teamleader

• 3 - audience

additionalfield string the value of an additional field of this group

(optional)

creditpoints string the amount of credit points for this session

(optional)

activities string the activities in this session (optional, may be

needed to calculate the credit points)

Sessionrecordin

gid integer the id of the sessionrecording




128/206


<getUserRecordingByIdResponse


<userrecording>


<userstart>201001271404</userstart>

<userend>201001271434</userend>

<userduration>1802</userduration>

<userid>5</userid>




<grouproletype>0</grouproletype>

<additionalfield>agency XY</additionalfield>

<creditpoints>3</creditpoints>

<activities>14:25 text: 1 // 14:28 mc: 0</activities>


</userrecording>

</ getUserRecordingByIdResponse>







4.8.3 getSessionAndUserRecordingsBySessionId

• Description: Gets information about one specific session including

the userrecordings.




129/206



• Request:

• Requestname:

<getSessionAndUserRecordingsBySessionIdRequest>


<getSessionAndUserRecordingsBySessionIdRequest>):


sessionrecordi

ngid integer no > 0 the session recording id

userattributes

boolean

yes

Indicates if the response

contains the attributes

<username>,

<firstname> and

<surname>. Default is

true.

usersortorder

string

Yes

See

Descrip

tion

The order in which the

user recordings are

sorted. The following

values are possible:

• startTime

• endTime

• duration




server time zone.




130/206

• Sample Request:

<getSessionAndUserRecordingsBySessionIdRequest



<userattributes>false</userattributes>

<usersortorder>duration</usersortorder>

</getSessionAndUserRecordingsBySessionIdRequest>




131/206

• Response:

• Responsename:

<getSessionAndUserRecordingsBySessionIdResponse>




sessionrecordi




sessionduratio


accumulatedu

serduration integer

the accumulated user duration of this session in

seconds


session


semantic error!)


belongs

customernam




userrecording

<userr

ecordin

g>

a user recording




132/206



userrecordingi

d integer the user recording id




seconds




Surname String the surname of the user


the group role:

• 1 – anonymous

• 0 - participant

• 1 - assistant

• 2 - teamleader

• 3 - audience


(optional)


(optional)



sessionrecordi

ngid integer the id of the sessionrecording




133/206


<getSessionAndUserRecordingsBySessionIdResponse


<sessionrecording>












<userrecording>





<userid>5</userid>






</userrecording>

<userrecording>





134/206




<userid>6</userid>

<username>neumanni</username>

<firstname>Inga</firstname>

<surname>Neumann</surname>



</userrecording>

…

</sessionrecording>

</ getSessionAndUserRecordingsBySessionIdResponse>







4.8.4 getSessionRecordingsByTimeSlot

• Description: Gets information about session recordings in a specific

time slot.






135/206

• Request:

• Requestname: <getSessionRecordingsByTimeSlotRequest>


<getSessionRecordingsByTimeSlotRequest>):


timeslotstart date no

the earliest point of time

to which a session has

begun

timeslotend date no

the latest point of time


ended

customerid integer

Optional

for

system

administr

ators

> 0


customer. If this value is

not set, the response will

contain the results of all

customers.

groupid integer yes > 0


group. If this value is



groups (of this customer

if the customerid is set).

bookingid integer yes > 0

If you set this attribute,

the result is filtered by

one specific booking.

bookingtimei

d integer yes > 0



one specific booking

time.

userid integer yes > 0



one specific user.




136/206

sessionsorto

rder string yes

See

Descri

ption


user recordings are



• startTime

(default)

• endTime

• duration

• userCount




server time zone.

• Sample Request:

<getSessionRecordingsByTimeSlotRequest


<timeslotstart>201001270000</timeslotstart>

<timeslotend>201001280000</timeslotend>



<sessionsortorder>userCount</sessionsortorder>

</getSessionRecordingsByTimeSlotRequest>




137/206

• Response:

• Responsename:

<getSessionRecordingsByTimeSlotResponse>




sessionrecordi




sessionduratio


accumulatedu

serduration integer

the accumulated user duration of this session in

seconds


session


semantic error!)


belongs

customernam





<getSessionRecordingsByTimeSlotResponse


<sessionrecording>





138/206











</sessionrecording>

<sessionrecording>









<customername>Firma XY</customername>


<groupname>Beispielgruppe</groupname>

</sessionrecording>

</getSessionRecordingsByTimeSlotResponse>




139/206






4.8.5 getSessionAndUserRecordingsByTimeSlot

• Description: Gets information about session recordings including

the user recordings in a specific time slot.



• Request:

• Requestname:

<getSessionAndUserRecordingsByTimeSlotRequest>


<getSessionAndUserRecordingsByTimeSlotRequest>):



the earliest point of time


begun

timeslotend date no

the latest point of time


ended

customerid integer

Optional

for

system

administr

ator

> 0


customer. If this value is



customers.

groupid integer yes > 0


group. If this value is





140/206


groups (of this customer

if the customerid is set).

bookingid integer yes > 0



one specific booking.

bookingtimei

d integer yes > 0



one specific booking

time.

userid integer yes > 0



one specific user.

sessionsorto

rder string yes

See

Descri

ption


user recordings are



• startTime

(default)

• endTime

• duration

• userCount

userattribut

es boolean Yes

Indicates if the response

contains the attributes

<username>,

<firstname> and

<surname> in the

<userrecording>-

Attributes. Default is

true.




server time zone.




141/206

• Sample Request:

<getSessionRecordingByTimeSlotRequest






<sessionsortorder>userCount</sessionsortorder>

<userattributes>false</userattributes>

</getSessionRecordingByTimeSlotRequest>




142/206

• Response:

• Responsename:

<getSessionAndUserRecordingsByTimeSlotResponse>




sessionrecordin

gid integer the session recording id



sessionduration integer the duration of this session in seconds

accumulatedus

erduration integer

the accumulated user duration of this session

in seconds


session


semantic error!)


belongs

customername string the name of the customer



userrecording

<userr

ecordin

g>

a user recording




143/206



userrecordingi

d integer the user recording id




seconds




surname string the surname of the user


the group role:

• -1 – anonymous

• 0 - participant

• 1 - assistant

• 2 - teamleader

• 3 - audience


(optional)


(optional)



sessionrecordi

ngid integer the id of the sessionrecording




144/206


<getSessionAndUserRecordingsByTimeSlotResponse


<sessionrecording>












<userrecording>





<userid>5</userid>






</userrecording>

<userrecording>





145/206




<userid>6</userid>

<username>neumanni</username>

<firstname>Inga</firstname>

<surname>Neumann</surname>



</userrecording>

…

</sessionrecording>

</getSessionAndUserRecordingsByTimeSlotResponse>






4.8.6 getCapacityRecordingByDate

• Description: Gets information about the capacity to a specific date.

The information you get is the peak value in a time slot from 15

minutes.





146/206

• Request:

• Requestname: <getCapacityRecordingByDateRequest>


<getCapacityRecordingByDateRequest>):


date date no the date in which the

recording has started




server time zone.

• Sample Request:

<getCapacityRecordingByDateRequest


<date>201001271810</date>

</getCapacityRecordingByDateRequest>

• Response:

• Responsename: <getCapacityRecordingByDateResponse>


<capacityrecording>):


capacitystart date the start date of the recording

capacityend date the end date of the recording

usercount integer the maximum count of users in this time slot

freeusercount integer the minimum count of free users in this time

slot (only for concurrent user licences)

audiencecoun

t integer

the maximum count of audience users in this

time slot (vitero audience module required)

freeaudiencec

ount integer

the minimum count of free audience users in

this time slot (vitero audience module

required)




147/206

inspireuserco

unt integer

the maximum count of inspire users in this time

slot

inspireaudienc

ecount integer

the maximum count of inspire audience users in

this time slot


<getCapacityRecordingByDateResponse


<capacityrecording>

<capacitystart>201001271800</capacitystart>

<capacityend>201001271815</capacityend>


<audiencecount>140</audiencecount>

<freeaudiencecount>20</freeaudiencecount>

</ capacityrecording >

</getCapacityRecordingByDateResponse>









148/206

4.8.7 getCapacityRecordingsByTimeSlot

• Description: Gets the capacity recordings in a specific time slot.

The information you get is the peak value in a time slot from 15

minutes.


• Request:

• Requestname:

<getCapacityRecordingsByTimeSlotRequest>


<getCapacityRecordingsByTimeSlotRequest>):



timeslotend date no

ignoreempty

entries boolean yes

If true, all recordings

where <usercount> or

<audiencecount> is 0

will be ignored. Default

is false.




server time zone.

• Sample Request:

<getCapacityRecordingsByTimeSlotRequest




<ignoreemptyentries>true</ignoreemptyentries>

</getCapacityRecordingsByTimeSlotRequest>




149/206

• Response:

• Responsename:

<getCapacityRecordingsByTimeSlotResponse>


<capacityrecording>):


capacitystart date the start date of the recording

capacityend date the end date of the recording

usercount integer the maximum count of users in this time slot

freeusercount integer the minimum count of free users in this time

slot (only for concurrent user licences)

audiencecoun

t integer

the maximum count of audience users in this

time slot (vitero audience module required)

freeaudiencec

ount integer

the minimum count of free audience users in

this time slot (vitero audience module

required)

inspireuserco

unt integer

the maximum count of inspire users in this time

slot

inspireaudienc

ecount integer

the maximum count of inspire audience users in

this time slot


<getCapacityRecordingsByTimeSlotResponse


<capacityrecording>









150/206

</capacityrecording>

<capacityrecording>






</capacityrecording>

…

</getCapacityRecordingsByTimeSlotResponse>









151/206

4.9 The session code contract

The session code contract contains functions to create session codes and

get information about them. You can use these functions by calling the

following URL: https://[hostname]/vitero/services/.

The namespace of this contract is:

http://www.vitero.de/schema/sessioncode

The contract (sessioncode.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/sessioncode.wsdl

You can append the created session codes (except VMS session code) as a

value of the URL parameter “sessionCode” or “s” to the vitero direct link

(https://[hostname]/vitero/start.htm), e.g.

https://[hostname]/vitero/start.htm?sessionCode=12345678. This Link

will start the virtual team room automatically and log in a specific user in a

specific group (related to the session code).

For vitero inspire, you can also add the code to the inspire browser link:

https://[inspire_hostname]?s=12345678.

• Optional URL Parameters:

Name Value Description

sessionCode string The session code.

login 0 or 1

If your session code does not belong to a

specific user (e.g. BOOKING) and you want to

open the dialogue for logging in as a

temporary user automatically, you can add

login=0.

customerid int

If one of your customers uses vitero custom

design, you can append the customer id to

start the custom client.

Example:

https://[hostname]/vitero/start.htm?sessionCode=12345678&login

=0&customerid=123




152/206

4.9.1 createPersonalBookingSessionCode

• Description: Creates a session code of the type

PERSONAL_BOOKING (a session code related to a specific user and

a specific booking).



• Request:

• Requestname:

<createPersonalBookingSessionCodeRequest>

• Input parameters (root-element: <sessioncode>):


userid int no > 0 The id of the user.

bookingid int no > 0 The id of the booking.

codelength int yes > 0

The character length of

the session code. Default

value is 8.

expirationda

te date yes

The date when the

session code expires. If

the value is not set or

empty, the code will not

expire.



expirationdate. Default is

the server time zone.

• Sample Request:

<createPersonalBookingSessionCodeRequest

xmlns="http://www.vitero.de/schema/sessioncode">

<sessioncode>






153/206

<expirationdate>201301010000</expirationdate>

</sessioncode>

</createPersonalBookingSessionCodeRequest>

• Response:

• Responsename:

<createPersonalBookingSessionCodeResponse>


<createPersonalBookingSessionCodeResponse>):


code string The code


<createPersonalBookingSessionCodeResponse


<code>12345678</code>

</createPersonalBookingSessionCodeResponse>

• Sample URL:

https://[hostname]/vitero/start.htm?sessionCode=12345678




• user does not exist (53)


• user not assigned to group (153)


4.9.2 createPersonalGroupSessionCode

• Description: Creates a session code of the type PERSONAL_GROUP

(a session code related to a specific user and a specific group).




154/206



• Request:

• Requestname: <createPersonalGroupSessionCodeRequest>



userid int No > 0 The id of the user.

groupid int No > 0 The id of the group.




value is 8.

allownotassi

gnedusers boolean yes

If true, the user can join

the session even if he is

not assigned to the

group. If false, you will

get the error 153 in this

case. Default value is

false.

expirationda

te date yes

The date when the




expire.





• Sample Request:

<createPersonalGroupSessionCodeRequest


<sessioncode>





155/206



</sessioncode>

</createPersonalGroupSessionCodeRequest>

• Response:

• Responsename:

<createPersonalGroupSessionCodeResponse>


<createPersonalGroupSessionCodeResponse>):




<createPersonalGroupSessionCodeResponse


<code>12345678</code>

</createPersonalGroupSessionCodeResponse>

• Sample URL:






• group does not exist (151)

• user not assigned to group (153)


4.9.3 createBookingSessionCode

• Description: Creates a session code of the type BOOKING (a

session code related to a specific booking).




156/206


for the customer, to which the group/booking belongs.

• Request:

• Requestname: <createBookingSessionCodeRequest>



bookingid int No > 0 The id of the booking.




value is 8.

role int yes > 0

the group role:

• 0 - participant

• 3 – audience

• 4 – automatic role

assignment

allownotexis

tingusers boolean yes

If true, the session code

allows users who do not

exist in the system to

enter the session.

Default value is true.

allownotassi




not assigned to the

group. Default value is

true.

• Sample Request:

<createBookingSessionCodeRequest


<sessioncode>

<bookingid>4711</ bookingid >




157/206

</sessioncode>

</ createBookingSessionCodeRequest >

• Response:

• Responsename: <createBookingSessionCodeResponse>

• Output parameters (root-element: <

createBookingSessionCodeResponse >):




<createBookingSessionCodeResponse


<code>12345678</code>

</createBookingSessionCodeResponse>

• Sample URL:






4.9.4 createVmsSessionCode

• Description: Creates a session code of the type VMS. This session

code is related to a specific user to access the Vitero Management

System without username/password authentication. You can include

every site by appending the session code as parameter to the url of

the Vitero Management System (see below). The user can open this

site in a new window or browser tab. Note that iframes are not

allowed anymore because of security reasons (X-Frame-Options are

denied).




158/206

• URL Parameters:

Name Value Description

code string The session code for the authentication that

you receive from this service.

fl 0 or 1

Indicates, if the site is frameless (only the

content without the menus and headers) or

not. It is recommended to embed the site with

fl=1.

topmargin int

If you include a site with JavaScript-Popups,

the topmargin parameter indicates the space

from the top of the page to the top of the

popup in pixels. The default value is 200px.

action reload

If you embed one of the content-sites (e.g.

the team folders), you should append

action=reload to avoid caching-problems.

Example - including the content of a group folder:

https://[hostname]/vitero/user/cms/groupfolder.htm?groupId=[gro

upid]&code=[sessioncode]&fl=1&action=reload






159/206

• Request:

• Requestname: <createVmsSessionCodeRequest> Input

parameters (root-element: <sessioncode>):


userid int No > 0 The id of the user.




value is 8.

expirationda

te date yes

The date when the




expire.





• Sample Request:

<createVmsSessionCodeRequest


<sessioncode>



</sessioncode>

</createVmsSessionCodeRequest>

• Response:

• Responsename: <createVmsSessionCodeResponse>

Output parameters (root-element:

<createVmsSessionCodeResponse>):






160/206


<createVmsSessionCodeResponse


<code>42345678</code>

</createVmsSessionCodeResponse>






4.9.5 deleteSessionCode

• Description: Deletes an existing session code.


for the customer, to which the booking or rather the group belongs.

• Request:

• Requestname: <deleteSessionCodeRequest>


<deleteSessionCodeRequest>):


code string No The code.

• Sample Request:

<deleteSessionCodeRequest


<code>12345678</code>

</deleteSessionCodeRequest>





161/206



• session code does not exist (1001)


4.9.6 getSessionCodeInformation

• Description: Returns information about a session code.


for the customer, to which the booking or rather the group belongs.

• Request:

• Requestname: <getSessionCodeInformationRequest>


<getSessionCodeInformationRequest>):


code string no The code.


The timezone used for

the output of

<expirationdate>.

Default is the timezone

of the server.

• Sample Request:

<getSessionCodeInformationRequest


<code>12345678</code>

</getSessionCodeInformationRequest >

• Response:

• Responsename: <getSessionCodeInformationResponse>




162/206

• Output parameters (root-element: <sessioncode>):


type string The type (e.g. PERSONAL_GROUP).

userid int The id of the user.

groupid int The id of the group

bookingid int The id of the booking.

expirationdate date

The date when the session code expires. If this

attribute does not exist, the session code does

not expire.

allownotexisti

ngusers

boolea

n

If true, the session code allows users who do

not exist in the system to enter the session.

allownotassig

nedusers

boolea

n

If true, the session code allows also users who

are not assigned to the group to enter the

session.


<getSessionCodeInformationResponse


<sessioncode>

<type>PERSONAL_GROUP</type>




<allownotexistingusers>false</allownotexistingusers>

<allownotassignedusers>true</allownotassignedusers>

</sessioncode>

</ getSessionCodeInformationResponse>




163/206

Possible errors:



• session code does not exist (1001)


4.9.7 getPersonalBookingSessionCodes

• Description: Returns information about non-expired session codes

which belong to a specific booking and a specific user. Expired

session codes will not be listed (in contrast to

getSessionCodeInformation).



• Request:

• Requestname: <getPersonalBookingSessionCodesRequest>


<getPersonalBookingSessionCodesRequest>):



bookingid int no > 0 The id of the booking.



the output of

<expirationdate>.


of the server.

• Sample Request:

<getPersonalBookingSessionCodesRequest







164/206

</getPersonalBookingSessionCodesRequest>

• Response:

• Responsename:

<getPersonalBookingSessionCodesResponse>




expirationdate date



not expire.


<getPersonalBookingSessionCodesResponse


<sessioncode>

<code>c81a44f68</code>


</sessioncode>

<sessioncode>

<code>85f4cc2a</code>

</sessioncode>

</getPersonalBookingSessionCodesResponse>





4.9.8 getPersonalGroupSessionCodes

• Description: Returns information about non-expired session codes

which belong to a specific group and a specific user. Expired session

codes will not be listed (in contrast to getSessionCodeInformation).




165/206



• Request:

• Requestname: <getPersonalGroupSessionCodesRequest>


<getPersonalGroupSessionCodesRequest>):



groupid int no > 0 The id of the group.



the output of

<expirationdate>.


of the server.

• Sample Request:

<getPersonalGroupSessionCodesRequest




</getPersonalGroupSessionCodesRequest>




166/206

• Response:

• Responsename:

<getPersonalGroupSessionCodesResponse>




expirationdate date



not expire.

allownotassig

nedusers

boolea

n

If true, the session code allows also users who

are not assigned to the group to enter the

session.


<getPersonalGroupSessionCodesResponse


<sessioncode>



<allownotassignedusers>true</allownotassignedusers>

</sessioncode>

<sessioncode>

<code>75c532a9</code>


<allownotassignedusers>false</allownotassignedusers>

</sessioncode>

</getPersonalGroupSessionCodesResponse>




167/206





4.9.9 getTestroomSessionCode

• Description: Returns the code with which a specific user can access

his testroom.


for one of the customers, the user is assigned to.

• Request:

• Requestname: <getTestroomSessionCodeRequest>


<getTestroomSessionCodeRequest>):



• Sample Request:

<getTestroomSessionCodeRequest



</getTestroomSessionCodeRequest>

• Response:

• Responsename: <getTestroomSessionCodeResponse>







168/206


<getTestroomSessionCodeResponse



</getTestroomSessionCodeResponse>

• Sample URL:

https://[hostname]/vitero/start.htm?sessionCode=c81a44f68





4.9.10 createAppointmentConfirmationSessionCode

• Description: Creates a session code of the type

APPOINTMENT_CONFIRMATION (a session code related to a specific

booking which allows users to register themselves).






169/206

• Request:

• Requestname:

<createAppointmentConfirmationSessionCodeRequest>




registrationd

eadline int no > 0

The time in hours before

the start of the booking

when the registration

ends.

registrationli

mit int yes > 0

The maximum count of

registrations.




value is 8.

role int yes > 0

the group role:

• 0 - participant

• 3 – audience


assignment

• Sample Request:

<createAppointmentConfirmationSessionCodeRequest


<sessioncode>


<registrationdeadline>24</registrationdeadline>

</sessioncode>

</createAppointmentConfirmationSessionCodeRequest>




170/206

• Response:

• Responsename:

<createAppointmentConfirmationSessionCodeResponse>


<createAppointmentConfirmationSessionCodeRespons

e >):




<createAppointmentConfirmationSessionCodeResponse


<code>12345678</code>

</createAppointmentConfirmationSessionCodeResponse>

• Sample URL:

https://[hostname]/vitero/registration.htm?c=12345678





• no event management module (310)

4.9.11 createWebaccessSessionCode

• Description: Creates a session code of the type WEBACCESS

(a session code related to a specific booking which allows users to

join a session via Browser or App).






171/206

• Request:

• Requestname: <createWebaccessSessionCodeRequest>




codelength int Yes > 0



value is 8.

• Sample Request:

<createWebaccessSessionCodeRequest


<sessioncode>


</sessioncode>

</createWebaccessSessionCodeRequest>

• Response:

• Responsename: <createWebaccessSessionCodeResponse>


<createWebaccessSessionCodeResponse >):


code string The code.

browserurl string The url for the browser to join the session.

appurl string The url for the app to join the session.


<createWebaccessSessionCodeResponse





172/206

<code>12345678</code>

<browserurl>http://hostname/vitero/user/webaccess/session.htm?wacode

=40123456</browserurl>

<appurl>vitero://http%3A%2F%2Fhostname%2Fvitero%2Fuser%2Fweba

ccess%2Fsession.htm%3Fwacode%3D40123456</appurl>

</createWebaccessSessionCodeResponse>





• no event management module (310)

• invalid module selection (502)

• no phone module (311)

4.9.12 createGroupSessionCode

• Description: Creates a session code of the type GROUP (a session

code related to a specific group).






173/206

• Request:

• Requestname: <createGroupSessionCodeRequest>



groupid int No > 0 The id of the group.




value is 8.

role int yes > 0

the group role:

• 0 - participant

• 3 – audience


assignment

expirationda

te date yes

The date when the




expire.





allownotexis

tingusers boolean yes

If true, the session code

allows users who do not

exist in the system to

enter the session.

Default value is true.

allownotassi




not assigned to the

group. Default value is

true.




174/206

• Sample Request:

<createGroupSessionCodeRequest


<sessioncode>


</sessioncode>

</ createGroupSessionCodeRequest >

• Response:

• Responsename: <createGroupSessionCodeResponse>

• Output parameters (root-element: <

createGroupSessionCodeResponse >):




<createGroupSessionCodeResponse


<code>21438758</code>

</createGroupSessionCodeResponse>

• Sample URL:




• group does not exist (151)





175/206

4.10 The licence contract

The licence contract contains functions to get informations about the

licenced and available vitero modules.



The namespace of this contract is: http://www.vitero.de/schema/licence

The contract (licence.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/licence.wsdl

4.10.1 getBookableModulesForGroup

• Description: Returns the bookable modules for a group in a

specific timeslot. The returned modules are at least licenced until

the end of the timeslot. Countable modules (phone hybrid, café and

rooms) are only listed, if they are not blocked by other bookings in

the specified time frame. The listed modules are not disabled in the

group configuration. Each module is unique, so if there are three

café modules available, only one is listed.



• Request:

• Requestname: <getBookableModulesForGroupRequest>


<getBookableModulesForGroupRequest>):



start date yes The start date of the time frame. If

not set, the actual date will be used.

end date yes The end date of the time frame. If

not set, the end date of the licence

will be used.

timezone timezo

ne yes

The timezone used for the input

parameters start and date. Default is

the timezone of the server.




176/206

• Sample Request:

<getBookableModulesForGroupRequest

xmlns="http://www.vitero.de/schema/licence">


<start>201308011200</start>

<end>201308011800</end>

</getBookableModulesForGroupRequest>

• Response:

• Responsename: <getBookableModulesForGroupResponse>


<modules><module>):


type string The module type, e.g. CAPTURE

roomsize int The room size. Only set if the type is ROOM.


<getBookableModulesForGroupResponse


<modules>

<module>

<type>CAPTURE</type>

</module>

<module>

<type>PHONEHYBRID</type>

</module>

<module>

<type>ROOM</type>


</module>




177/206

</modules>

</getBookableModulesForGroupResponse>


• the id is <= 0 (303)





4.10.2 getBookableRoomsForGroup

• Description: Returns the bookable room sizes for a group in a

specific timeslot. Each room size is unique, so if there are three

rooms with the size 12 available, only one is listed.



• Request:

• Requestname: <getBookableRoomsForGroupRequest>

• Input parameters: (root-element:

<getBookableRoomsForGroupRequest>):



start date yes

The start date of the time

frame. If not set, the actual

date will be used.

end date yes The end date of the time

frame. If not set, the end date

of the licence will be used.


The timezone used for the

input parameters start and

date. Default is the timezone of

the server.




178/206

• Sample Request:

<getBookableRoomsForGroupRequest



<start>201308011200</start>

<end>201308011800</end>

</getBookableRoomsForGroupRequest>

• Response:

• Responsename: <getBookableRoomsForGroupResponse>

• Output parameters (root-element: <rooms>):


roomsize int

The size of the room. There can be several

roomsize tags (one for each available room

size).

• Sample Response: In this example, you can book your group for

12 or 40 particpants.

<getBookableRoomsForGroupResponse


<rooms>



</rooms>

</getBookableRoomsForGroupResponse>


• the id is <= 0 (303)







179/206

4.10.3 groupHasBookableModule

• Description: With this method, you can check if a specific module

is bookable for a group in a time frame. To check rooms, use

<getBookableRoomsForGroupRequest>.



• Request:

• Requestname: <groupHasBookableModuleRequest>


<groupHasBookableModuleRequest>):



type string no

The type of the module.

Bookable modules:

- CAFE

- PHONEHYBRID

- CAPTURE

- PHONECAFE

Automatically booked modules:

- LANGUAGELAB

- AUDIENCE

- COOPERATION

- NEXTROOM

- WEBCAM

- MONITORING

- EXAMINATION

- PLUS

- WEBSERVICE

- RECORDING




180/206

- COOPERATIONAUDIENCE

- EVENTMANAGEMENT

start date yes The start date of the time frame. If not set,

the actual date will be used.

end date yes The end date of the time frame. If not set,

the end date of the licence will be used.


The timezone used for the input parameters

start and date. Default is the timezone of the

server.

• Sample Request:

<groupHasBookableModuleRequest



<type>CAFE</type>

<start>201308011200</start>

<end>201308011800</end>

</groupHasBookableModuleRequest>

• Response:

• Responsename: <groupHasBookableModuleResponse>


<groupHasBookableModuleRequest>):


hasmodule boolean True, if the module is bookable.


<groupHasBookableModuleResponse





181/206

<hasmodule>true</hasmodule>

</groupHasBookableModuleResponse>


• the id is <= 0 (303)




4.10.4 isPhoneAvailable

• Description: Returns information, which phone attributes are

bookable.



• Request:

• Requestname: <isPhoneAvailableRequest>


<isPhoneAvailableRequest>):



start date yes

The start date of the time

frame. If not set, the actual

date will be used.

end date yes The end date of the time

frame. If not set, the end date

of the licence will be used.



input parameters start and

date. Default is the timezone of

the server.




182/206

• Sample Request:

<isPhoneAvailableRequest



<start>201308011200</start>

<end>201308011800</end>

</isPhoneAvailableRequest>

• Response:

• Responsename: <isPhoneAvailableResponse>


<isPhoneAvailableResponse>):


phoneavailabl

e

boolea

n

True, if you can book a telephone conference

for this group in the specified time frame.

hybrid boolea

n

True: the phone hybrid module is licenced

False: the phone advanced module is licenced

(no longer available for purchase)

dialout boolea

n

Indicates if it is possible to allow dial out for the

booking.

• Sample Response: Phone advanced is licenced. The group

configuration allows telephone conferences, but not the dial out.

<isPhoneAvailableResponse


<phoneavailable>true</phoneavailable>

<hybrid>false</hybrid>

<dialout>false</dialout>

</isPhoneAvailableResponse>




183/206


• the id is <= 0 (303)




4.10.5 getModulesForCustomer

• Description: This function makes only sense if the VMS is multi-

client capable (only available, when the according additional

function is licensed)! It returns the available modules of a customer

until a specific end date. In contrast to

<getBookableModulesForGroup> the function lists every licenced

and (in proprietary mode) assigned module singulary, even if it is

blocked by existing bookings. Excluded are only modules which

expire before the end date.



• Request:

• Requestname: <getModulesForCustomerRequest>


<getModulesForCustomerRequest>):


customerid integer no > 0 The id of the customer.

end date yes The end. If not set, the end date of the

licence will be used.


The timezone used for the input

parameter end. Default is the timezone

of the server.




184/206

• Sample Request:

<getModulesForCustomerRequest



<end>201308011800</end>

</getModulesForCustomerRequest>

• Response:

• Responsename: <getModulesForCustomerResponse>


<modules><module>):


type string The module type, e.g. CAPTURE

roomsize int The room size. Only set if the type is ROOM.


<getModulesForCustomerResponse


<modules>

<module>

<type>CAFE</type>

</module>

<module>

<type>CAFE</type>

</module>

<module>

<type>ROOM</type>


</module>

<module>




185/206

<type>WEBCAM</type>

</module>

</modules>

</getModulesForCustomerResponse>


• the id is <= 0 (303)


• the customer does not exist (101)



4.10.6 getAllModules

• Description: This function makes only sense if the system is

switched to community mode (not proprietary mode) or if a

concurrent user licence is used. It returns all modules until a

specific end date. Excluded are only modules which expire before

the end date.


• Request:

• Requestname: <getAllModulesRequest>


<getAllModulesRequest>):


end date yes The end. If not set, the end

date of the licence will be used.



input parameter end. Default is

the timezone of the server.

• Sample Request:

<getAllModulesRequest xmlns="http://www.vitero.de/schema/licence">




186/206

<end>201308011800</end>

</getAllModulesRequest>

• Response:

• Responsename: <getAllModulesResponse>

• Output parameters: see

<getModulesForCustomerResponse>





4.11 The MTOM contract

The MTOM contract contains functions to upload or download files from the

Vitero Management System.



The namespace of this contract is: http://www.vitero.de/schema/mtom

The contract (mtom.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/mtom.wsdl

4.11.1 loadAvatar

• Description: Returns the avatar photo of a user as a binary file

from the server using MTOM. All MTOM-functions are using the

namespace http://www.vitero.de/schema/mtom.



• Request:

• Requestname: <loadAvatarRequest>




187/206


<loadAvatarRequest>):




The type:

0 - standard picture (default)

1 - alternative picture

size integer yes

0 <=

value

<= 2

The size:

0 - avatar image (down-scaled,

default)

1 - big image

2 - original image

• Sample Request:

<loadAvatarRequest xmlns="http://www.vitero.de/schema/mtom">


<type>0</type>

<size>2</size>

</loadAvatarRequest>

• Response:

• Responsename: <loadAvatarResponse>


<loadAvatarResponse>):


filename string the name of the file

file base64Binary the binary content




188/206


<loadAvatarResponse xmlns="http://www.vitero.de/schema/mtom">

<filename>00002256.png</filname>

<file><xop:Include

xmlns:xop="http://www.w3.org/2004/08/xop/include" href="..."/></file>

</loadAvatarResponse>






4.11.2 storeAvatar

• Description: Stores a binary file to the server as avatar image

using MTOM. All MTOM-functions are using the namespace

http://www.vitero.de/schema/mtom.



• Request:

• Requestname: <storeAvatarRequest>


<storeAvatarRequest>):




The type:

• 0 - standard

picture

(default)

• 1 - alternative




189/206

picture

filename string no not null the name of the file

file base64Binary no the binary content

• Sample Request:

<storeAvatarRequest xmlns="http://www.vitero.de/schema/mtom">



<type>0</type>

<file><xop:Include


</storeAvatarRequest>





• filesize exceeded (451)

• filetype not allowed (452)



4.11.3 loadFile

• Description: Returns a binary file from the server using MTOM. All

MTOM-functions are using the namespace




• Request:

• Requestname: <loadFileRequest>




190/206

• Input parameters (root-element: <loadFileRequest>):


nodeid long no > 0 the id of the file

• Sample Request:

<loadFileRequest xmlns="http://www.vitero.de/schema/mtom">


</loadFileRequest>

• Response:

• Responsename: <loadFileResponse>


<loadFileResponse>):


filename string the name of the

file

file base64Binary the binary content


<loadFileResponse xmlns="http://www.vitero.de/schema/mtom">


<file><xop:Include


</loadFileResponse>








191/206

4.11.4 storeFile

• Description: Stores a binary file to the server using MTOM. All

MTOM-functions are using the namespace




• Request:

• Requestname: <storeFileRequest>

• Input parameters (root-element: <storeFileRequest>):


filename string no not

null the name of the file

foldernodeid long no > 0

the id of the folder in

which the file will be

stored

file base64Binary no the binary content

• Sample Request:

<storeFileRequest xmlns="http://www.vitero.de/schema/mtom">


<foldernodeid>195</foldernodeid>

<file><xop:Include


</storeFileRequest>

• Response:

• Responsename: <storeFileResponse>


<storeFileResponse>):


nodeid long the node-id of the stored

file




192/206


<storeFileResponse xmlns="http://www.vitero.de/schema/mtom">


</storeFileResponse>






4.12 The config contract

The config contract contains functions to change the configuration. You can

use these functions by calling the following URL:


The namespace of this contract is: http://www.vitero.de/schema/config

The contract (config.wsdl) can be found on the following URL:

https://[hostname]/vitero/services/config.wsdl

The following configuration properties are available:

• Type group:

o allowTeamLeaderToAddUsers: if true, a team leader of a

group is allowed to add users to this group

o allowTeamLeaderToBookMeetings: if true, a team leader of a

group is allowed to book meetings for this group

o allowTeamLeaderToCreateUsers: if true, a team leader of a

group is allowed to create new users (which are

automatically members of this group)

o hideSlides: hide contents of the team folder from

participants and audience in the VMS.

• Type customer: no properties available yet




193/206

There are 3 validity levels for each property:

• system: Each property exists once on the system level. If the

validity level of a property is set to system, this value is relevant for

all customers/groups. All values for this property on customer or

group level are not relevant in this case.

• customer: Each property exists for each customer. If the validity

level of a property is set to customer for one specific customer,

o Type group: this value is relevant for all groups of this

customer. All values for this property on group level for this

customer are not relevant in this case.

o Type customer: each customer is configured separately.

• group (only for type group): Each property exists for each group. If

the validity level of a property is set to group for one specific group,

this value is only relevant for this group. In other words, each group

is configured separately.

4.12.1 getConfigProperty

• Description: Gets information about one specific property.


for the customer, to which the configuration belongs.

• Request:

• Requestname: <getConfigPropertyRequest>




194/206


<getConfigPropertyRequest>):


type string no group or

customer

the configuration type,

see description of this

chapter

level string no

group,

customer

or

system

the validity level, see

description of this

chapter

property string no

the name of the

property, see

description of this

chapter

groupid integer yes ➢

the id of the group,

necessary for level

group

customerid integer yes

the id of the customer,

necessary for level

customer

• Sample Request:

<getConfigPropertyRequest

xmlns="http://www.vitero.de/schema/config">

<type>group</type>

<level>customer</level>

<property>allowTeamLeaderToAddUsers</property>


</getConfigPropertyRequest>




195/206

• Response:

• Responsename: <getConfigPropertyResponse>


<getConfigPropertyResponse>):


value string the value of the property at the asked level

validvalue string the valid value of the property (can differ from

value)

validlevel string

the level which determines the validvalue (if

validlevel and the level in the request are equal,

validvalue and value are also equal)


<getConfigPropertyResponse


<value>false</value

<validvalue>true</validvalue>

<validlevel>system</validlevel>

</getConfigPropertyResponse>






4.12.2 changeConfigProperty

• Description: Changes a specific configuration property.






196/206

• Request:

• Requestname: <changeConfigPropertyRequest>


<changeConfigPropertyRequest>):



customer



chapter

level string no

group,

customer

or

system


description of this

chapter

property string no

the name of the

property, see

description of this

chapter

newvalue string no ➢ the new value of the

property



necessary for level

group



necessary for level

customer

• Sample Request:

<changeConfigPropertyRequest


<type>group</type>

<level>group</level>





197/206


<newvalue>true</newvalue>

</changeConfigPropertyRequest>

• Response:

• Responsename: <changeConfigPropertyResponse>


<changeConfigPropertyResponse>):


changed boolean True, if the value has changed. False, if the

property was already set to this value.


<changeConfigPropertyResponse


<chagned>true</changed>

</changeConfigPropertyResponse>






4.12.3 changeValidityLevel

• Description: Changes the validity level of a specific configuration

property.

• Change to system level: set overwritable to false on system

level

• Change to customer level: set overwirtable to false on

customer level and make sure, that system level is

overwritable=true




198/206

• Change to group level: set overwritable to true on customer

level and and make sure, that system level is

overwritable=true



• Request:

• Requestname: <changeValidityLevelRequest>


<changeValidityLevelRequest>):



customer



chapter

level string no

group,

customer

or

system


description of this

chapter

property string no

the name of the

property, see

description of this

chapter

overwritable boolean no ➢ see description of this

chapter



necessary for level

group



necessary for level

customer




199/206

• Sample Request:

<changeValidityLevelRequest


<type>group</type>

<level>system</level>



<overwritable>false</overwritable>

</changeValidityLevelRequest>

In this case, the allowTeamLeaderToAddUsers property on system layer is

valid for all groups.

• Response:

• Responsename: <changeValidityLevelResponse>


<changeValidityLevelResponse>):


changed boolean True, if the value has changed. False, if the

property was already set to this value.


<changeValidityLevelResponse


<chagned>true</changed>

</changeValidityLevelResponse>









200/206

5 Error Processing

If an error occures while the request is processed, the SOAP-response

contains a <SOAP-ENV:Fault> in the body-tag. There are three different

cases in which a <SOAP-ENV:Fault> is returned:

5.1 Case 1: Authentication failed

If the authentication failed, because the username or the password is

incorrect, the SOAP-message retuns a fault-string with a

WssSoapFaultException.

SOAP-Example:



<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<SOAP-ENV:Fault>

<faultcode>SOAP-ENV:Client</faultcode>

<faultstring

xml:lang="en">com.sun.xml.wss.impl.WssSoapFaultException:

Authentication of...</faultstring>

</SOAP-ENV:Fault>

</SOAP-ENV:Body>





201/206

5.2 Case 2: Validation failed

If the attributes of the request do not match with the contract, a

"Validation error" fault-string will be returned. To find out, which attribute

was incorrect, see the detail-tag.

This fault comes up if:

• the request contains an attribute does not match to the attributes in

the contract

• the attribute is in the wrong place (wrong parent element)

• a non-optional attribute is missing

• an attribute exists several

• the value of an attribute does not match the type (e.g. a character

for an integer attribute)

SOAP-Example:



<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<SOAP-ENV:Fault>


<faultstring xml:lang="en">Validation error</faultstring>

<detail>

<spring-ws:ValidationError xmlns:spring-

ws="http://springframework.org/spring-ws">

cvc-complex-type.2.4.a: Invalid content was found starting with

element 'viterouser:invalid-attribute'...

</spring-ws:ValidationError>

</detail>

</SOAP-ENV:Fault>

</SOAP-ENV:Body>





202/206

5.3 Case 3: Error

If the request is authenticated and valid, but an error occured (e.g. you try

to query a user that doesn´t exist), you get an error-code in the SOAP-

Message. To interpret that code, see the table below.

SOAP-Example:



<SOAP-ENV:Header/>

<SOAP-ENV:Body>

<SOAP-ENV:Fault>


<faultstring xml:lang="en">an error occured - see documentation

for details</faultstring>

<detail>

<error>

<request>getUserRequest</request>

<errorCode>13</errorCode>

</error>

</detail>

</SOAP-ENV:Fault>

</SOAP-ENV:Body>





203/206

5.3.1 Error codes

Error Code Error cause Example

2 unknown error an unknown error occured

3 internal error a server error occured

4 insufficient rights

you log in successfully, but the request

you sent is only accessable by a higher

role

51 another user with this name

already exists

you want to create a new user, but the

username you choose already exists

52 another user with this Email

already exists

you want to create a new user, but the

Email-Address you choose already

exists.

53 the user doesn´t exist in

the system you query for a user that doesn´t exist

54 a user must be attached to

at least one customer

you want to create a new user, but you

do not tell the system to which

customer(s) it belongs

101 the customer doesn´t exist

in the system

you query for a customer that doesn´t

exist

102 the shortname of a new

customer already exists

you try to create a new customer, but

the shortname already exists

103 the user is not attached to

the customer

you try to move a user from one

customer to another, but the user is

not attached to the source customer

151 the group doesn´t exist in

the system

you query for a group that doesn´t

exist

152 the name and customer of a

new group already exists

you try to create a new group, but the

name you choose already exists for the

customer you choose




204/206

153

the relationship between the

user and the group doesn´t

exist

you want to change the group role, but

the user isn´t participant in this group

206 invalid configuration you want to create a password link, but

thos are not allowed in the system

302 invalid list-index

you query for a user-list from 20 to

100 but there are less than 100 users

in the system

303 the value of an attribute is

not valid

you create a new user with

<password></password>

304 invalid time zone

you create a new user with

<timezone>invalidTimeZone</timezon

e>

305 invalid locale you create a new user with a locale

that doesn´t exist

306 no monitoring module the statistic contract throws this error if

there is no monitoring module licenced

307 no admin pro module

the customer contract throws this error

if there is no admin pro module

licenced

308 recording does not exist you try to query a recording that does

not exist

309 no webservice module

available

the webservice is not licensed for the

system or the customer

310 no event management

module available

the event management is not licensed

for the system or the customer

311 no phone module

audio communication via telephone is

not licensed for the system or the

customer

312 inspire not allowed inspire is not allowed for this group,

customer or system (only essentials)




205/206

313 essentials not allowed essentials is not allowed for this group,

customer or system (only inspire)

451

filesize exceeded

the file you try to upload is too large

452 filetype not allowed the file you try to upload is not allowed

(e.g. exe)

501 booking collision

you create a new booking, but the

group is already booked at this time or

there are no more free rooms available

502 invalid module selection

you create a booking with a module

that is not licenced or not available at

this time

505 booking in the past you create a booking in the past

506 booking does not exist you try to delete or query a booking

that does not exist

508 No rooms available

you try to create a booking in a

timeframe where no room is available

(e.g. because the licence is expired)

601 node not found you try to move a file to a folder that

doesn´t exist

607 treenode locked

you try to upload a file into a group

folder, but the group is locked (because

there are users in the team room)

609 cannot manipulate root

folder

you try to delete or change a folder of

the type AVATAR_ROOT_FOLDER,

GROUP_ROOT_FOLDER or

CUSTOMER_ROOT_FOLDER

703 customer expired you create a booking, but the group´s

customer licence is expired

704 available quota exhausted you want to create a booking, but the

customer´s quota is exhausted




206/206

706 quota not yet valid (706) you want to create a booking, but your

quota has a start date in the future

1001 session code does not exist you try to query a session code which

does not exist

vitero web service interface v10 · vitero web service interface v10.0 o v2009en16 vitero gmbh o...

Documents