ilinc 10 Web Services

Transcription

1 ilinc 10 Web Services Version 1.8 ilinc is a trademark of ilinc Communications, Inc.. All rights reserved. Page 1 of 103

2 Table of Contents Table of Contents... 2 SOAP Web Service Introduction... 4 Web Service Methods... 6 AddUserBasic... 6 EditUserBasic... 8 AddUserAuthorityLevel RemoveUserAuthorityLevel AddUser (combination request) GetLoginURL GetDivisionID GetAuthorityLevelID GetLanguageID GetUserID GetUserBasic ConvertGuestToUser ChangeUserStatus AuthenticateUser AddDivision EditDivision ChangeDivisionStatus AddGroup RemoveGroup GetGroupID AddGroupMember RemoveGroupMember AddActivityBasic EditActivityBasic EditActivitySchedule EditActivityInSession EditActivityToolOption (deprecated in ilinc 9) EditActivityCommunication (deprecated in ilinc 9) RegisterAllUsers UnregisterAllUsers AddActivityAttendee RemoveActivityAttendee AddActivity (combination request) GetActivityID GetActivityFieldID GetActivityFieldProperties EditActivityFieldValue GetActivityBasic GetActivitySchedule GetActivityInSession GetActivityCommunication (deprecated in ilinc 9) GetActivityAttendees ChangeActivityStatus UserCanCopy AddContent EditContent GetContent Page 2 of 103

3 GetContentID GetContentInstanceID AddActivityContentInstance RemoveActivityContentInstance GetJoinURL GetJoinHTML GetJoinNowURL/GetJoinNowHTML GetUploadUserPictureURL GetSessionData GetUserRegistration GetUserGreenMeter GetClientGreenMeter ConvertTimeZone Acceptable TimeZone Values EncryptText Changes in ilinc 10 Methods New Methods Page 3 of 103

4 SOAP Web Service Introduction The ilinc web service is implemented according to the SOAP methodology. It implements method calls for adding and editing ilinc users and activities and their associated settings. Production WSDL: Beta WSDL: Introduction The SOAP web service implements methods for each of the listed API requests. All input and output parameters are supported and any restrictions for those parameters still apply. Every SOAP request must include an Authorization element including the following parameters: APIVersion, ClientID, AuthorizedUserName and AuthorizedPassword. These correspond to the version, ClientID, UserName and Password parameters of the ilinc:authorization element in the XML API. All XML API parameters, whether implemented as attributes or child elements, are implemented as child elements within the parameters element for requests and within the return element for responses. For example, compare the following XML API request and response to the SOAP equivalents: Sample SOAP Request: <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap= xmlns:xsi= xmlns:xsd= xmlns:soapenc= xmlns:tns="urn:ilincapi"> <soap:body soap:encodingstyle=" <tns:getuserbasic> <Authorization xsi:type="tns:authorizationtype"> <tns:apiversion xsi:type="xsd:string">10.0</tns:apiversion> <tns:clientid xsi:type="xsd:string">client-id</tns:clientid> <tns:authorizedusername xsi:type="xsd:string">user-name</tns:authorizedusername> <tns:authorizedpassword xsi:type="xsd:string">password</tns:authorizedpassword> </Authorization> <parameters xsi:type="tns:getuserbasictype"> <tns:reference xsi:type="xsd:string">reference</tns:reference> <tns:userid xsi:type="xsd:positiveinteger">user-id</tns:userid> </parameters> </tns:getuserbasic> </soap:body> </soap:envelope> Sample SOAP Response: <?xml version="1.0" encoding="utf-8"?> Page 4 of 103

5 <soap:envelope xmlns:xsi=" xmlns:soapenc=" xmlns:xsd=" soap:encodingstyle=" xmlns:soap=" <soap:body> <GetUserBasicResponse xmlns="urn:ilincapi"> <return> <Reference xsi:type="xsd:int">reference</reference> <ErrorID xsi:type="xsd:int">error-id</errorid> <ErrorStr xsi:type="xsd:string">error-str</errorstr> <FirstName xsi:type="xsd:string">first-name</firstname> <TimeZone xsi:type="xsd:string">time-zone</timezone> <LanguageID xsi:type="xsd:int">language-id</languageid> <Status xsi:type="xsd:string">status</status> < Address xsi:type="xsd:string"> -address</ address> <UserType xsi:type="xsd:string">user-type</usertype> <UserName xsi:type="xsd:string">user-name</username> <LastName xsi:type="xsd:string">last-name</lastname> <DivisionID xsi:type="xsd:int">division-id</divisionid> <ModeratorCode xsi:type="xsd:string">moderator-code</moderatorcode> <PhoneNumber xsi:type="xsd:string">phone-number</phonenumber> <AlternateDialIn xsi:type="xsd:string">alternate-dial-in</alternatedialin> <PrimaryDialIn xsi:type="xsd:string">primary-dial-in</primarydialin> <Passcode xsi:type="xsd:string">passcode</passcode> </return> </GetUserBasicResponse> </soap:body> </soap:envelope> Sample Java Code AuthorizationType auth = new AuthorizationType(); auth.apiversion = "10.0"; auth.clientid = BigInteger.valueOf(13135); auth.authorizedusername = "administrator"; auth.authorizedpassword = "soap4ilinc"; GetUserBasicType testuser = new GetUserBasicType(); testuser.reference = "001"; testuser.userid = BigInteger.valueOf(154791); GetUserBasicResponseType testuserresp = service.getuserbasic(auth, testuser); Page 5 of 103

6 Web Service Methods AddUserBasic This request will add a new user to the ilinc system. The request should be formed as follows: <ilinc:adduserbasic Reference="reference"> <UserType>user-type</UserType> <UserName>user-name</UserName> <FirstName>first-name</FirstName> <LastName>last-name</LastName> <Password>password</Password> < Address> -address</ Address> <TimeZone>time-zone</TimeZone> <LanguageID>language-id</LanguageID> <PhoneNumber>phone-number</PhoneNumber> <PrimaryDialIn>primary-dial-in</PrimaryDialIn> <AlternateDialIn>alternate-dial-in</AlternateDialIn> <ModeratorCode>moderator-code</ModeratorCode> <Passcode>passcode</Passcode> <MuteOnEntry>mute-on-entry</MuteOnEntry> <DivisionID>division-id</DivisionID> <CeilingDivisionID>ceiling-division-id</CeilingDivisionID> </ilinc:adduserbasic> When adding a Guest, only UserType set to guest, FirstName, LastName, and Address are required. All other user parameters, if included, are ignored when adding a guest. When adding a User, a guest found with the same Address will be converted from Guest to User. MuteOnEntry is applicable only if your ilinc site has an integrated audio bridge specified. DivisionID and CeilingDivisionID do not have to be included if the site has only one division. All users will be assigned an AuthorityLevel of Standard User For all new Users or Guests a personal PIN shall be automatically assigned if the site is set up to use ilinc Bridge C. Page 6 of 103

7 UserType (x) user or guest - only required if specifically adding a guest. Defaults to user if not specified. UserName (x) All chars except space and % \ < > 64 chars UserName must be unique in the ilinc system. Not necessary to include if auto-generated UserName is desired, in which case the UserName is returned in the AddUserBasicResponse. FirstName x All chars 40 chars LastName x All chars 40 chars Password x A-Z a-z _ Must be 4 to Address x Standard address format. If an address is not desired or not available, supply an address of noone@[domain].com (i.e. noone@ilinc.com). Address must be unique in the ilinc system. TimeZone TimeZone from the list of acceptable TimeZone values. If a TimeZone is not specified, the site s time zone will be assigned to the user. 14 chars 64 chars LanguageID LanguageID of an existing language in the ilinc system. If blank or not included, defaults to site s default language. PhoneNumber ( ). and space 20 chars Passcode All chars 16 chars MuteOnEntry yes or no - only applicable if your ilinc site has an integrated audio bridge specified DivisionID DivisionID of an existing division in the ilinc system. If blank or not included, defaults to administrator s division. CeilingDivisio nid DivisionID of an existing division in the ilinc system. Must be same as DivisionID above or a direct ancestor of that DivisionID. If blank or not included, defaults to DivisionID above. Page 7 of 103

8 <?xml version= 1.0?> <ilinc:response version="10.0" xmlns:ilinc= > <ilinc:adduserbasicresponse Reference= reference > <UserID>user-id</UserID> <EncryptedUserID>encrypted-user-id</EncryptedUserID> </ilinc:adduserbasicresponse> EditUserBasic This request will edit the basic parameters of an existing user in the ilinc system. The request should be formed as follows: <?xml version= 1.0?> <ilinc:request version="10.0" xmlns:ilinc= > <ilinc:edituserbasic UserID= user-id Reference= reference > <UserName>user-name</UserName> <FirstName>first-name</FirstName> <LastName>last-name</LastName> <Password>password</Password> < Address> -address</ Address> <TimeZone>time-zone</TimeZone> <LanguageID>language-id</LanguageID> <PhoneNumber>phone-number</PhoneNumber> <PrimaryDialIn>primary-dial-in</PrimaryDialIn> <AlternateDialIn>alternate-dial-in</AlternateDialIn> <ModeratorCode>moderator-code</ModeratorCode> <Passcode>passcode</Passcode> <MuteOnEntry>mute-on-entry</MuteOnEntry> <DivisionID>division-id</DivisionID> <CeilingDivisionID>ceiling-division-id</CeilingDivisionID> </ilinc:edituserbasic> A Guest user s FirstName, LastName and Address can be modified by specifying the Guest s ID for the UserID value. The UserID passed to EditUserBasic must be the one that was returned from a previous call to AddUser or GetUserID. Only those parameters that are included in the <ilinc:edituserbasic> section will be modified. You may omit values you do not wish to change. MuteOnEntry is applicable only if your ilinc site has an integrated audio bridge specified. Refer to the table below for required parameters, as well as other restrictions: UserID x UserID of an existing user or guest in the ilinc system Page 8 of 103

9 UserName All chars except space and % \. < > 25 chars UserName must be unique in the ilinc system. FirstName All chars 40 chars LastName All chars 40 chars Password A-Z a-z _ Must be 4 to 14 chars Address Standard address format. If an 64 chars address is not desired or not available, supply an address of noone@[domain].com (i.e. noone@ilinc.com). Address must be unique in the ilinc system. TimeZone TimeZone from the list of acceptable TimeZone values. LanguageID LanguageID of an existing language in the ilinc system. PhoneNumber ( ). and space 20 chars Passcode All chars 16 chars MuteOnEntry yes or no - only applicable if your ilinc site has an integrated audio bridge specified DivisionID DivisionID of an existing division in CeilingDivisio nid the ilinc system. DivisionID of an existing division in the ilinc system. Must be same as DivisionID above or a direct ancestor of that DivisionID. <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:edituserbasicresponse Reference="reference"> </ilinc:edituserbasicresponse> Page 9 of 103

10 AddUserAuthorityLevel This request will assign an existing authority level to an existing user in the ilinc system. Multiple <ilinc:adduserauthoritylevel> sections may be included in the request. The request should be formed as follows: <ilinc:adduserauthoritylevel UserID="user-ID" AuthorityLevelID="authority-level-id" Reference="reference" /> <ilinc:adduserauthoritylevel UserID="user-ID" AuthorityLevelID="authority-level-id" Reference="reference" /> The UserID passed to AddUserAuthorityLevel must be the one that was returned from a previous call to AddUser or GetUserID. The AuthorityLevelID passed to AddUserAuthorityLevel must be one that is in the ilinc system, or one that was returned from a previous call to GetAuthorityLevelID. UserID x UserID of an existing user in the ilinc system AuthorityLevel ID x AuthorityLevelID of an existing authority level in the ilinc system <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:adduserauthoritylevelresponse Reference="reference"> </ilinc:adduserauthoritylevelresponse> <ilinc:adduserauthoritylevelresponse Reference="reference"> </ilinc:adduserauthoritylevelresponse> RemoveUserAuthorityLevel This request will remove an existing authority level from an existing user in the ilinc system. Multiple <ilinc:removeuserauthoritylevel> sections may be included in the request. The request should be formed as follows: Page 10 of 103

11 <ilinc:removeuserauthoritylevel UserID="user-ID" AuthorityLevelID="authority-level-id" Reference="reference" /> <ilinc:removeuserauthoritylevel UserID="user-ID" AuthorityLevelID="authority-level-id" Reference="reference" /> The UserID passed to RemoveUserAuthorityLevel must be the one that was returned from a previous call to AddUser or GetUserID. The AuthorityLevelID passed to RemoveUserAuthorityLevel must be one that is in the ilinc system, or one that was returned from a previous call to GetAuthorityLevelID. UserID x UserID of an existing user in the ilinc system AuthorityLevel ID x AuthorityLevelID of an existing authority level in the ilinc system <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:removeuserauthoritylevelresponse Reference="reference"> </ilinc:removeuserauthoritylevelresponse> <ilinc:removeuserauthoritylevelresponse Reference="reference"> </ilinc:removeuserauthoritylevelresponse> AddUser (combination request) This request will add a new user to the ilinc system. The request should be formed as follows: <ilinc:adduser Reference="reference"> <ilinc:adduserbasic Reference="reference"> <UserType>user-type</UserType> <UserName>user-name</UserName> <FirstName>first-name</FirstName> <LastName>last-name</LastName> <Password>password</Password> Page 11 of 103

12 < Address> -address</ Address> <TimeZone>time-zone</TimeZone> <LanguageID>language-id</LanguageID> <PhoneNumber>phone-number</PhoneNumber> <PrimaryDialIn>primary-dial-in</PrimaryDialIn> <AlternateDialIn>alternate-dial-in</AlternateDialIn> <ModeratorCode>moderator-code</ModeratorCode> <Passcode>passcode</Passcode> <MuteOnEntry>mute-on-entry</MuteOnEntry> <DivisionID>division-id</DivisionID> <CeilingDivisionID>ceiling-divisionid</CeilingDivisionID> </ilinc:adduserbasic> <ilinc:adduserauthoritylevel AuthorityLevelID="authority-level-id" Reference="reference" /> <ilinc:adduserauthoritylevel AuthorityLevelID="authority-level-id" Reference="reference" /> <ilinc:adduserauthoritylevel AuthorityLevelID="authority-level-id" Reference="reference" /> </ilinc:adduser> The AddUser request is a combination request made up of an AddUserBasic request, along with optional AddUserAuthorityLevel requests. Notice that the AddUserAuthorityLevel calls in this AddUser combination request do not require UserID parameters like a stand-alone AddUserAuthorityLevel calls. It is referred to as a combination request because the UserID returned in the AddUserBasicResponse is automatically passed along to the AddUserAuthorityLevel calls. Thus, you can create a new user and assign authority levels to that user all in the same document, without knowing the new user s UserID. <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:adduserresponse Reference="reference"> <ilinc:adduserbasicresponse Reference="reference"> <UserID>user-id</UserID> <EncryptedUserID>encrypted-user-id</EncryptedUserID> </ilinc:adduserbasicresponse> <ilinc:adduserauthoritylevelresponse Reference="reference"> </ilinc:adduserauthoritylevelresponse> <ilinc:adduserauthoritylevelresponse Reference="reference"> </ilinc:adduserauthoritylevelresponse> <ilinc:adduserauthoritylevelresponse Reference="reference"> </ilinc:adduserauthoritylevelresponse> </ilinc:adduserresponse> Page 12 of 103

13 <UserID> and <EncryptedUserID> tags will only be present if the user was successfully added. The user ID returned should be used for future references to this user through the API. GetLoginURL The request will return a URL to automatically log in a user for the specified UserID. The request should be formed as follows: <?xml version="1.0" encoding="utf-8"?> <soap:envelope Envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" xmlns:tns="urn:ilincapi"> <soap:body> <tns:getloginurl> <Authorization> <tns:apiversion>10.0</tns:apiversion> <tns:clientid>client-id</tns:clientid> <tns:authorizedusername> authorized-user-name </tns:authorizedusername> <tns:authorizedpassword> authorized-password </tns:authorizedpassword> </Authorization> <parameters> <tns:reference>reference</tns:reference> <tns:userid>user-id</tns:userid> </parameters> </tns:getloginurl> </soap:body> </soap:envelope> UserID x UserID of an existing user in the ilinc system n/a The Login URL is time stamped and expires one hour from the creation of the URL. The response will contain the following information: Response LoginURL Description The log in URL for the specified user Possible error responses: Error Code New? Error String -101 N All required inputs were not received -103 N UserID does not exist, does not belong to this client site or is invalid in this instance <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:soapenc=" Page 13 of 103

14 xmlns:xsd=" soap:encodingstyle=" xmlns:soap=" <soap:body> <GetLoginURL xmlns="urn:ilincapi"> <return> <Reference xsi:type="xsd:string">reference</reference> <ErrorID xsi:type="xsd:int">error-id</errorid> <ErrorStr xsi:type="xsd:string" /> <LoginURL xsi:type=" xsd:anyuri">login-url</loginurl> </return> </GetLoginURL> </soap:body> </soap:envelope> GetDivisionID This request will return an existing division ID from the ilinc system. The request should be formed as follows: <ilinc:getdivisionid DivisionTitle="division-title" Reference="reference" /> The division title passed to GetDivisionID must be one that is in the ilinc system or one that was used in a previous call to AddDivision. DivisionTi x DivisionTitle of an existing division in the tle ilinc system <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:getdivisionidresponse Reference="reference"> <DivisionID>division-id</DivisionID> </ilinc:getdivisionidresponse> GetAuthorityLevelID This request will return an existing authority level ID from the ilinc system. The request should be formed as follows: Page 14 of 103

15 <ilinc:getauthoritylevelid AuthorityLevelName="authority-levelname" Reference="reference" /> The authority level name passed to GetAuthorityLevelID must be one that is in the ilinc system. AuthorityLevelName x AuthorityLevelName of an existing authority level in the ilinc system <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:getauthoritylevelidresponse Reference="reference"> <AuthorityLevelID>authority-level-id</AuthorityLevelID> </ilinc:getauthoritylevelidresponse> GetLanguageID This request will return an existing language ID from the ilinc system. The request should be formed as follows: <ilinc:getlanguageid Reference="reference"> <LanguageName><![CDATA[language-name]]></LanguageName> </ilinc:getlanguageid> The language name passed to GetLanguageID must be one that is in the ilinc system. LanguageName x LanguageName of an existing language in the ilinc system Page 15 of 103

16 <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:getlanguageidresponse Reference="reference"> <LanguageID>language-id</LanguageID> </ilinc:getlanguageidresponse> GetUserID This request will return an existing user ID from the ilinc system. The request should be formed as follows: <ilinc:getuserid UserName="user-name" Reference="reference" /> The user name passed to GetUserID must be one that was used in a previous call to AddUserBasic or EditUserBasic. UserName x UserName of an existing user in the ilinc system An alternate way of retrieving a user's or guest's ID is to provide the user s or guest's address. The request should be formed as follows: <ilinc:getuserid Address=" -address" Reference="reference" /> The address passed to GetUserID should belong to a user or guest in the ilinc system. Addres x Address of an existing user or guest s in the ilinc system A final way (although not as precise as the methods mentioned above) of retrieving a user's or guest's ID, is to provide the user s or guest's first name and last name. Both must be included. The request should be formed as follows: Page 16 of 103

17 <ilinc:getuserid FirstName="first-name" LastName="last-name" Reference="reference" /> The first name and last name passed to GetUserID should belong to a user or guest in the ilinc system. FirstName x FirstName of an existing user or guest in the ilinc system LastName x LastName of an the same existing user or guest in the ilinc system In all cases, the ilinc response will be as follows: <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:getuseridresponse Reference="reference"> <UserID>user-id</UserID> <EncryptedUserID>encrypted-user-id</EncryptedUserID> </ilinc:getuseridresponse> If more than one user or guest matches the information provided, a pipe (" ") delimited list of matching user or guest IDs will be returned for the UserID value. GetUserBasic This request will retrieve the basic properties of an existing user or guest in the ilinc system. The request should be formed as follows: <ilinc:getuserbasic UserID="user-id" Reference="reference" /> The UserID passed to GetUserBasic must be one that was returned from a previous call to AddUser or GetUserID. UserID x UserID of an existing user or guest in the Page 17 of 103

18 ilinc system <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:getuserbasicresponse Reference="reference"> <UserType>user-type</UserType> <UserName>user-name</UserName> <FirstName>first-name</FirstName> <LastName>last-name</LastName> < Address> -address</ Address> <TimeZone>time-zone</TimeZone> <LanguageID>language-id</LanguageID> <PhoneNumber>phone-number</PhoneNumber> <PrimaryDialIn>primary-dial-in</PrimaryDialIn> <AlternateDialIn>alternate-dial-in</AlternateDialIn> <ModeratorCode>moderator-code</ModeratorCode> <Passcode>passcode</Passcode> <PersonalPIN>personalPIN</PersonalPIN> <MuteOnEntry>mute-on-entry</MuteOnEntry> <DivisionID>division-id</DivisionID> <CeilingDivisionID>ceiling-division-id</CeilingDivisionID> <Status>status</Status> </ilinc:getuserbasicresponse> Refer to the Legal Values/Characters descriptions for AddUserBasic or EditUserBasic for values and formats to expect in the response. For instance, the TimeZone will be one from the list of acceptable TimeZone values. MuteOnEntry is returned only if your ilinc site has an integrated audio bridge specified. If the UserID specified belongs to a guest, only the information applicable to a guest (UserType, FirstName, LastName and Address) will be returned in GetUserBasicResponse. ConvertGuestToUser This request will convert an existing guest to a user and update the basic parameters of that user in the ilinc system. The request should be formed as follows: <?xml version= 1.0?> <ilinc:request version="10.0" xmlns:ilinc= > <ilinc:convertguesttouser UserID= user-id Reference= reference > <UserName>user-name</UserName> <FirstName>first-name</FirstName> <LastName>last-name</LastName> Page 18 of 103

19 <Password>password</Password> < Address> -address</ Address> <TimeZone>time-zone</TimeZone> <LanguageID>language-id</LanguageID> <PhoneNumber>phone-number</PhoneNumber> <PrimaryDialIn>primary-dial-in</PrimaryDialIn> <AlternateDialIn>alternate-dial-in</AlternateDialIn> <ModeratorCode>moderator-code</ModeratorCode> <Passcode>passcode</Passcode> <MuteOnEntry>mute-on-entry</MuteOnEntry> <DivisionID>division-id</DivisionID> <CeilingDivisionID>ceiling-division-id</CeilingDivisionID> </ilinc:convertguesttouser> The UserID passed to ConvertGuestToUser must be the one that was returned from a previous call to AddUser or GetUserID and must be for an existing user of UserType guest. Only those parameters that are included in the <ilinc:converttoguestuser> section will be modified. You may omit values you do not wish to change. MuteOnEntry is applicable only if your ilinc site has an integrated audio bridge specified. Refer to the table below for required parameters, as well as other restrictions: UserID x UserID of an existing guest in the ilinc system UserName x All chars except space and % \. < > 25 chars UserName must be unique in the ilinc system. FirstName All chars 40 chars LastName All chars 40 chars Password x A-Z a-z _ Must be 4 to 14 chars Address Standard address format. If an 64 chars address is not desired or not available, supply an address of noone@[domain].com (i.e. noone@ilinc.com). Address must be unique in the ilinc system. TimeZone TimeZone from the list of acceptable TimeZone values. LanguageID LanguageID of an existing language in the ilinc system. PhoneNumber ( ). and space 20 chars PrimaryDialIn ( ). and space 20 chars AlternateDialI n ( ). and space 20 chars ModeratorCode All chars 16 chars Passcode All chars 16 chars MuteOnEntry yes or no - only applicable if your ilinc site has an integrated audio bridge specified Page 19 of 103

20 DivisionID CeilingDivisio nid DivisionID of an existing division in the ilinc system. DivisionID of an existing division in the ilinc system. Must be same as DivisionID above or a direct ancestor of that DivisionID. <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:convertguesttouserresponse Reference="reference"> </ilinc:convertguesttouserresponse> ChangeUserStatus This request will change the status of an existing user or guest from the ilinc system. Multiple <ilinc:changeuserstatus> sections may be included in the request. The request should be formed as follows: <ilinc:changeuserstatus UserID="user-ID" Status="status" Reference="reference" /> <ilinc:changeuserstatus UserID="user-ID" Status="status" Reference="reference" /> The UserID passed to ChangeUserStatus must be the one that was returned from a previous call to AddUser or GetUserID. UserID x UserID of an existing user or guest in the ilinc system Status x active, inactive or delete <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:changeuserstatusresponse Reference="reference"> </ilinc:changeuserstatusresponse> <ilinc:changeuserstatusresponse Reference="reference"> Page 20 of 103

21 </ilinc:changeuserstatusresponse> AuthenticateUser This request will authenticate a user by determining if an active user with the specified user ID or user name and password exists in the ilinc system. The request should be formed as follows: <ilinc:authenticateuser Reference="reference"> <UserName>user-name</UserName> <Password>password</Password> </ilinc:authenticateuser> The user name passed to AuthenticateUser must be one that was used in a previous call to AddUserBasic or EditUserBasic. UserName x UserName of an existing active user in the ilinc system Password x Password of the same user An alternate way of authenticating a user is to provide the user s ID. The request should be formed as follows: <ilinc:authenticateuser Reference="reference"> <UserID>user-id</UserID> <Password>password</Password> </ilinc:authenticateuser> The user ID passed to AuthenticateUser should belong to an active user in the ilinc system. UserID x UserID of an existing active user in the ilinc system Password x Password of the same user In both cases, the ilinc response will be as follows: Page 21 of 103

22 <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:authenticateuserresponse Reference="reference"> </ilinc:authenticateuserresponse> AddDivision This request will allow third-party system to modify the ilinc system and create divisions. The request should be formed as follows: <?xml version="1.0" encoding="utf-8"?> <soap:envelope Envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" xmlns:tns="urn:ilincapi"> <soap:body> <tns:adddivision> <Authorization> <tns:apiversion>10.0</tns:apiversion> <tns:clientid>client-id</tns:clientid> <tns:authorizedusername>authorized-username</tns:authorizedusername> <tns:authorizedpassword>authorizedpassword</tns:authorizedpassword> </Authorization> <parameters> <tns:reference>reference</tns:reference> <tns:divisiontitle>division-title</tns:divisiontitle> <tns:parentdivisionid>parent-division-id</tns:parentdivisionid> <tns:description>description</tns:description> </parameters> </tns:adddivision> </soap:body> </soap:envelope> The request will create a division using the following request parameters: DivisionTitle x All chars 255 chars Description All chars 1,000 chars ParentDivisionID The DivisionID or EncryptedDivisionID of the parent division <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:soapenc=" xmlns:xsd=" soap:encodingstyle=" xmlns:soap=" Page 22 of 103

23 <soap:body> <AddDivisionResponse xmlns="urn:ilincapi"> <return> <Reference xsi:type="xsd:string">reference</reference> <ErrorID xsi:type="xsd:int">error-id</errorid> <ErrorStr xsi:type="xsd:string" /> <DivisionID xsi:type="xsd:int">division-id</divisionid> <EncryptedDivisionID xsi:type="xsd:int">encrypted-divisionid</encrypteddivisionid> </return> </AddDivisionResponse> </soap:body> </soap:envelope> The request returns the following response information: Response Description DivisionID The DivisionID of the newly created group EncryptedDivisionID The encrypted version of the DivisionID of the newly created group Possible error responses: Error Code New? Error String -101 N All required inputs were not received -105 N DivisionID does not exist or does not belong to this client site -422 N Description cannot be more than 1000 characters -437 Y DivisionTitle cannot be more than 255 characters EditDivision This request will edit the basic parameters of an existing division in the ilinc system. The request should be formed as follows: <?xml version= 1.0?> <ilinc:request version="10.0" xmlns:ilinc= > <ilinc:editdivision> <Reference>reference</Reference> <DivisionID>division-id</DivisionID> <DivisionTitle>division-title</DivisionTitle> <Description>description</Description> <ParentDivisionID>parent-division-id</ParentDivisionID> </ilinc:editdivision> The request will edit a division using the following request parameters: DivisionID X The DivisionID or EncryptedDivisionID of the division DivisionTitle All chars 255 chars Page 23 of 103

24 Description All chars 1,000 chars ParentDivisionID The DivisionID or EncryptedDivisionID of the parent division <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:soapenc=" xmlns:xsd=" soap:encodingstyle=" xmlns:soap=" <soap:body> <EditDivisionResponse xmlns="urn:ilincapi"> <return> <Reference xsi:type="xsd:string">reference</reference> <ErrorID xsi:type="xsd:int">error-id</errorid> <ErrorStr xsi:type="xsd:string" /> </return> </EditDivisionResponse> </soap:body> </soap:envelope> Possible error responses: Error Code New? Error String -101 N All required inputs were not received -105 N DivisionID does not exist or does not belong to this client site -422 N Description cannot be more than 1000 characters -437 Y DivisionTitle cannot be more than 255 characters ChangeDivisionStatus This request will change the status of an existing division in the ilinc system. The request should be formed as follows: <?xml version= 1.0?> <ilinc:request version="10.0" xmlns:ilinc= > <ilinc:changedivisionstatus <Reference>reference</Reference> <DivisionID>division-id</DivisionID> <Status>status</Status> </ilinc:changedivisionstatus> The request will edit a division using the following request parameters: DivisionID X The DivisionID or Page 24 of 103

25 EncryptedDivisionID of the division Status X Can set Division Status to Delete <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:soapenc=" xmlns:xsd=" soap:encodingstyle=" xmlns:soap=" <soap:body> <EditDivisionResponse xmlns="urn:ilincapi"> <return> <Reference xsi:type="xsd:string">reference</reference> <ErrorID xsi:type="xsd:int">error-id</errorid> <ErrorStr xsi:type="xsd:string" /> </return> </EditDivisionResponse> </soap:body> </soap:envelope> Possible error responses: Error Code New? Error String -101 N All required inputs were not received -105 N DivisionID does not exist or does not belong to this client site -438 Y Status can only be delete AddGroup This request will allow third-party system to modify the ilinc system and create user groups. The request should be formed as follows: <?xml version="1.0" encoding="utf-8"?> <soap:envelope Envelope xmlns:soap=" xmlns:xsi=" xmlns:xsd=" xmlns:tns="urn:ilincapi"> <soap:body> <tns:addgroup> <Authorization> <tns:apiversion>10.0</tns:apiversion> <tns:clientid>client-id</tns:clientid> <tns:authorizedusername> authorized-user-name </tns:authorizedusername> <tns:authorizedpassword> authorized-password </tns:authorizedpassword> </Authorization> <parameters> <tns:reference>reference</tns:reference> <tns:groupname>group-name</tns:groupname> <tns:description>description</tns:description> </parameters> Page 25 of 103

26 </tns:addgroup> </soap:body> </soap:envelope> The request will create a user group using the following request parameters: GroupName x All chars 255 chars Description All chars 1,000 chars <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:soapenc=" xmlns:xsd=" soap:encodingstyle=" xmlns:soap=" <soap:body> <AddGroupResponse xmlns="urn:ilincapi"> <return> <Reference xsi:type="xsd:string">reference</reference> <ErrorID xsi:type="xsd:int">error-id</errorid> <ErrorStr xsi:type="xsd:string" /> <GroupID xsi:type="xsd:int">group-id</groupid> <EncryptedGroupID xsi:type="xsd:int"> encrypted-group-id </EncryptedGroupID> </return> </AddGroupResponse> </soap:body> </soap:envelope> The request returns the following response information: Response Description GroupID The GroupID of the newly created group EncryptedGroupID The encrypted version of the GroupID of the newly created group Possible error responses: Error Code New? Error String -101 N All required inputs were not received -421 Y GroupName cannot be more than 255 characters -422 N Description cannot be more than 1000 characters RemoveGroup This request will allow third-party system to modify the ilinc system and delete user groups. The request should be formed as follows: <?xml version="1.0" encoding="utf-8"?> <soap:envelope Envelope xmlns:soap=" xmlns:xsi=" Page 26 of 103

27 xmlns:xsd=" xmlns:tns="urn:ilincapi"> <soap:body> <tns:removegroup> <Authorization> <tns:apiversion>10.0</tns:apiversion> <tns:clientid>client-id</tns:clientid> <tns:authorizedusername> authorized-user-name </tns:authorizedusername> <tns:authorizedpassword> authorized-password </tns:authorizedpassword> </Authorization> <parameters> <tns:reference>reference</tns:reference> <tns:groupid>group-id</tns:groupid> </parameters> </tns:removegroup> </soap:body> </soap:envelope> The request will set the status of a user group to deleted using the following required parameters: GroupID x GroupID of an existing user group in the ilinc system n/a The request returns the standard ErrorID and ErrorStr responses. Possible error responses: Error Code New? Error String -101 N All required inputs were not received <?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:xsi=" xmlns:soapenc=" xmlns:xsd=" soap:encodingstyle=" xmlns:soap=" <soap:body> <RemoveGroupResponse xmlns="urn:ilincapi"> <return> <Reference xsi:type="xsd:string">reference</reference> <ErrorID xsi:type="xsd:int">error-id</errorid> <ErrorStr xsi:type="xsd:string"/> </return> </RemoveGroupResponse> </soap:body> </soap:envelope> Page 27 of 103

28 GetGroupID This request will return an existing group ID from the ilinc system. The request should be formed as follows: <ilinc:getgroupid GroupName="group-name" Reference="reference" /> The GroupName passed to GetGroupID must be one from an existing group in the ilinc system. GroupName x GroupName of an existing group in the ilinc system <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:getgroupidresponse Reference="reference"> <GroupID>group-ID</GroupID> </ilinc:getgroupidresponse> If more than one group has the specified GroupName, the GroupID returned will be multiple group IDs separated by pipes: <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:getgroupidresponse Reference="reference"> <GroupID>group-id-1 group-id-2...</groupid> </ilinc:getgroupidresponse> AddGroupMember This request will add an existing user or group to an existing group in the ilinc system. Adding a group to a group allows for nested groups. Multiple <ilinc:addgroupmember> sections may be included in the request. The request should be formed as follows: Page 28 of 103

29 <ilinc:addgroupmember GroupID="group-id" MemberID="member-id" IsGroup="is-group" Reference="reference" /> <ilinc:addgroupmember GroupID="group-id" MemberID="member-id" IsGroup="is-group" Reference="reference" /> <ilinc:addgroupmember GroupID="group-id" MemberID="member-id" IsGroup="is-group" Reference="reference" /> The GroupID passed to AddGroupMember is the group to which members will be added, and must be one that was returned from a previous call to GetGroupID. If a user is being added to the group, then the MemberID must be one that was returned from a previous call to AddUser or GetUserID. If another group is being added to the group, then the MemberID must be one that was returned from a previous call to GetGroupID. GroupID x GroupID of an existing group in the ilinc system MemberID x ID of an existing user or group in the ilinc system to be added to GroupID IsGroup yes or no is MemberID a GroupID? <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:addgroupmemberresponse Reference="reference"> </ilinc:addgroupmemberresponse> <ilinc:addgroupmemberresponse Reference="reference"> </ilinc:addgroupmemberresponse> <ilinc:addgroupmemberresponse Reference="reference"> </ilinc:addgroupmemberresponse> RemoveGroupMember This request will remove a user or group from a group in the ilinc system. Multiple <ilinc:removegroupmember> sections may be included in the request. The request should be formed as follows: Page 29 of 103

30 <ilinc:removegroupmember GroupID="group-id" MemberID="member-id" IsGroup="is-group" Reference="reference" /> <ilinc:removegroupmember GroupID="group-id" MemberID="member-id" IsGroup="is-group" Reference="reference" /> <ilinc:removegroupmember GroupID="group-id" MemberID="member-id" IsGroup="is-group" Reference="reference" /> The GroupID passed to RemoveGroupMember is the group from which members will be removed, and must be one that was returned from a previous call to GetGroupID. If a user is being removed from the group, then the MemberID must be one that was returned from a previous call to GetUserID. If another group is being removed from the group, then the MemberID must be one that was returned from a previous call to GetGroupID. IsGroup should be set to no if the MemberID is a user ID, and set to yes if the MemberID is a group ID. If IsGroup is not passed to RemoveGroupMember, it is assumed the MemberID is a user ID. GroupID x GroupID of an existing group in the ilinc system MemberID x ID of an existing user or group in the ilinc system to be added to GroupID IsGroup yes or no is MemberID a GroupID? <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:removegroupmemberresponse Reference="reference"> </ilinc:removegroupmemberresponse> <ilinc:removegroupmemberresponsereference="reference"> </ilinc:removegroupmemberresponse> AddActivityBasic This request will add a new activity to the ilinc system. The request should be formed as follows: <ilinc:addactivitybasic Reference="reference"> <ActivityType>activity-type</ActivityType> <Title>activity-title</Title> Page 30 of 103

31 <Description>description</Description> <OwnerID>owner-id</OwnerID> <LeaderID>leader-id</LeaderID> <TeleconferenceType>teleconference-type</TeleconferenceType> <PrimaryDialIn>primary-dial-in</PrimaryDialIn> <AlternateDialIn>alternate-dial-in</AlternateDialIn> <ModeratorCode>moderator-code</ModeratorCode> <Passcode>passcode</Passcode> <MuteOnEntry>mute-on-entry</MuteOnEntry> <MaxScore>max-score</MaxScore> <MasteryScore>mastery-score</MasteryScore> <ControlledBy>controlled-by</ControlledBy> <Password>password</Password> <JoinMessage>join-message</JoinMessage> <AESEncryption>aes-encryption</AESEncryption> <AnonymousType>anonymous-type</AnonymousType> <AttendeePublicChat>attendee-publicchat</AttendeePublicChat> <AttendeePrivateChat>attendee-privatechat</AttendeePrivateChat> <AttendeeLimit>attendee-limit</AttendeeLimit> <WaitingList>waiting-list</WaitingList> <AudioQuality>audio-quality</AudioQuality> <VideoQuality>video-quality</VideoQuality> <VideoSize>video-size</VideoSize> <AutoAdjustVideo>auto-adjust-video</AutoAdjustVideo> <ActivityIDToCopy>activity_id_to_copy</ActivityIDToCopy> </ilinc:addactivitybasic> MaxScore and MasteryScore are applicable only for an ActivityType of class. ControlledBy is applicable only for an ActivityType of meeting. AttendeePublicChat and AttendeePublicChat are applicable for an ActivityType of meeting, class or conference. WaitingList is applicable only for an ActivityType of support. If an OwnerID and LeaderID are specified, they must each be the UserID of an existing user in the ilinc system. If an OwnerID is not specified, the UserID of the administrative user in the section will be assigned as the owner. If a LeaderID is not specified, the OwnerID will be assigned as the leader. TeleconferenceType should be set to none if a teleconference will not be used with the activity. A TeleconferenceType of unique is applicable only when your ilinc site has an integrated audio bridge specified. A setting of unique will generate a unique ModeratorCode and Passcode for the activity. A TeleconferenceType of leader will automatically assign the leader s PrimaryDialIn, AlternateDialIn, ModeratorCode and Passcode to the activity. The leader s MuteOnEntry setting will also be applied if your ilinc site has an integrated audio bridge specified. A TeleconferenceType should be used to specify a PrimaryDialIn, AlternateDialIn, ModeratorCode and Passcode that do not belong to the leader and that are not automatically-generated unique PINs to use with an integrated audio bridge. MuteOnEntry is applicable for a TeleconferenceType of unique or leader only if your ilinc site has an integrated audio bridge specified. It is only necessary to specify a PrimaryDialIn, ModeratorCode and Passcode if TeleconferenceType is set to other. PrimaryDialIn, ModeratorCode and Passcode are not necessary if TeleconferenceType is set to none, unique or leader. If TeleconferenceType is unique or dialout and audio provider for the site is ilinc Bridge C, a new Audio Set Page 31 of 103

32 (primary dial-in, alternate dial-in, moderator code and Passcode) will be generated. If TeleconferenceType is not specified, it will assume the value specified in your defaults for the given activity type. ActivityIDToCopy can be used to create a new activity by copying the settings of an existing activity in the ilinc system. When passing ActivityIDToCopy, only OwnerID is required. Passing any other parameters when using ActivityIDToCopy will override the settings from the source activity. The UserCanCopy request can be used before issuing an AddActivityBasic request with the ActivityIDToCopy parameter to check whether a user has copy permissions for the activity. Refer to the table below for required parameters, as well as other restrictions: ActivityType x class, meeting, conference or support Title x All chars except < > 1000 chars Description All chars 2000 chars OwnerID UserID of an existing user in the ilinc system LeaderID UserID of an existing user in the ilinc system TeleconferenceTyp none, unique (only available if your e ilinc site has an integrated audio bridge specified), leader, other or dialout Passcode All chars 16 chars BridgeEntryType none, tones, or namerecord BridgeExitType none, tones, or namerecord MuteOnEntry yes or no - only applicable if TeleconferenceType is set to unique, or leader if your ilinc site has an integrated audio bridge specified MaxScore Integer greater than or equal to 0 - only available if ActivityType is set to class MasteryScore Integer greater than or equal to 0 and less than or equal to MaxScore - only available if ActivityType is set to class ControlledBy leader, anyone or restrictedleader - only available if ActivityType is set to meeting Password All chars 32 chars JoinMessage All chars 127 chars AESEncryption on or off AnonymousType full, partial or off AttendeePublicCha on or off - not available if t ActivityType is set to support AttendeePrivateCh on or off - not available if at ActivityType is set to support Page 32 of 103

33 AttendeeLimit Integer greater than or equal to 0 WaitingList on or off - only available if ActivityType is set to support (deprecated in v9) RemoteControl HideDesktop Wallpaper (all one word) AudioQuality VideoQuality VideoSize AutoAdjustVideo ActivityIDToCopy (deprecated in v9) on or off - only available if ActivityType is set to support off low (8 kbps) medium (15 kbps) high (24 kbps) off, low, medium or high - see VideoQuality/ VideoSize bandwidth chart below small, medium or large - only available if VideoQuality is set to low, medium or high yes or no - only available if VideoQuality is set to low, medium or high ActivityID of an existing activity in the ilinc system The following table provides the bandwidth usage for the combined VideoQuality and VideoSize settings. VideoQuality and VideoSize bandwidth (maximum) chart: VideoQuality VideoSize small medium large off n/a n/a n/a low 8 kbps n/a n/a medium 48 kbps 128 kbps 256 kbps high 48 kbps 128 kbps 512 kbps Note: For backwards compatibility, the v8.6 parameters for VideoQuality: low, mediumlow, mediumhigh and high are still supported. Using either mediumhigh or high will result in the same VideoSize and VideoQuality settings in ilinc 9. For this reason it is recommended that only mediumhigh be used, as the ilinc 9 method will return mediumhigh for both mediumhigh and high settings. <ilinc:response version="10.0" xmlns:ilinc=" <ilinc:addactivitybasicresponse Reference="reference"> <ActivityID>activity-id</ActivityID> <EncryptedActivityID>encrypted-activityid</EncryptedActivityID> </ilinc:addactivitybasicresponse> Page 33 of 103

34 Error Code New? Error String -377 Y Bridge Entry and Exit types can only be none, tones, or namerecord -378 Y Bridge Entry and Exit types can only be none or tones for Dial Out Teleconference EditActivityBasic This request will edit the basic parameters of an existing activity in the ilinc system. The request should be formed as follows: <ilinc:editactivitybasic ActivityID="activity-id" Reference="reference"> <Title>activity-title</Title> <Description>description</Description> <OwnerID>owner-id</OwnerID> <LeaderID>leader-id</LeaderID> <TeleconferenceType>teleconference-type</TeleconferenceType> <PrimaryDialIn>primary-dial-in</PrimaryDialIn> <AlternateDialIn>alternate-dial-in</AlternateDialIn> <ModeratorCode>moderator-code</ModeratorCode> <Passcode>passcode</Passcode> <MuteOnEntry>mute-on-entry</MuteOnEntry> <MaxScore>max-score</MaxScore> <MasteryScore>mastery-score</MasteryScore> <ControlledBy>controlled-by</ControlledBy> <Password>password</Password> <JoinMessage>join-message</JoinMessage> <AESEncryption>aes-encryption</AESEncryption> <AnonymousType>anonymous-type</AnonymousType> <AttendeePublicChat>attendee-publicchat</AttendeePublicChat> <AttendeePrivateChat>attendee-privatechat</AttendeePrivateChat> <AttendeeLimit>attendee-limit</AttendeeLimit> <WaitingList>waiting-list</WaitingList> <AudioQuality>audio-quality</AudioQuality> <VideoQuality>video-quality</VideoQuality> <VideoSize>video-size</VideoSize> <AutoAdjustVideo>auto-adjust-video</AutoAdjustVideo> </ilinc:editactivitybasic> The ActivityID passed to EditActivityBasic must be one that was returned from a previous call to AddActivityBasic or GetActivityID. Only those parameters that are included in the <ilinc:editactivitybasic> section will be modified. You may omit values you do not wish to change. The ActivityType cannot be edited once an activity is created. MaxScore and MasteryScore are applicable only for an Page 34 of 103