Cisco IPICS API Reference Guide
Cisco IPICS Release 2.2
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Fax: 408 527-0883
Text Part Number: OL-18330-01
NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS MANUAL ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED
WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET FORTH IN THE INFORMATION PACKET THAT
SHIPPED WITH THE PRODUCT AND ARE INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE LICENSE
OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
The Cisco implementation of TCP header compression is an adaptation of a program developed by the University of California, Berkeley (UCB) as part of UCB’s public
domain version of the UNIX operating system. All rights reserved. Copyright © 1981, Regents of the University of California.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF THESE SUPPLIERS ARE PROVIDED “AS IS” WITH
ALL FAULTS. CISCO AND THE ABOVE-NAMED SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF
DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL, CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING,
WITHOUT LIMITATION, LOST PROFITS OR LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS MANUAL, EVEN IF CISCO
OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
CCDE, CCENT, Cisco Eos, Cisco Lumin, Cisco Nexus, Cisco StadiumVision, Cisco TelePresence, Cisco WebEx, the Cisco logo, DCE, and Welcome to the Human Network
are trademarks; Changing the Way We Work, Live, Play, and Learn and Cisco Store are service marks; and Access Registrar, Aironet, AsyncOS, Bringing the Meeting To
You, Catalyst, CCDA, CCDP, CCIE, CCIP, CCNA, CCNP, CCSP, CCVP, Cisco, the Cisco Certified Internetwork Expert logo, Cisco IOS, Cisco Press, Cisco Systems,
Cisco Systems Capital, the Cisco Systems logo, Cisco Unity, Collaboration Without Limitation, EtherFast, EtherSwitch, Event Center, Fast Step, Follow Me Browsing,
FormShare, GigaDrive, HomeLink, Internet Quotient, IOS, iPhone, iQuick Study, IronPort, the IronPort logo, LightStream, Linksys, MediaTone, MeetingPlace,
MeetingPlace Chime Sound, MGX, Networkers, Networking Academy, Network Registrar, PCNow, PIX, PowerPanels, ProConnect, ScriptShare, SenderBase, SMARTnet,
Spectrum Expert, StackWise, The Fastest Way to Increase Your Internet Quotient, TransPath, WebEx, and the WebEx logo are registered trademarks of Cisco Systems, Inc.
and/or its affiliates in the United States and certain other countries.
All other trademarks mentioned in this document or website are the property of their respective owners. The use of the word partner does not imply a partnership relationship
between Cisco and any other company. (0809R)
Cisco IPICS API Reference Guide, Cisco IPICS Release 2.2
Copyright © 2009 Cisco Systems, Inc. All rights reserved.
CONTENTS
Preface
vii
Audience
vii
Organization
vii
Obtaining Documentation, Obtaining Support, and Security Guidelines
CHAPTER
1
Overview
1-1
Executing API Requests 1-1
Executing API Request by Using a URL
Guidelines 1-1
URL Format 1-2
Examples 1-2
Executing API Requests by Using Java
CHAPTER
2
viii
API Security
1-6
API Logging
1-7
API Functions
1-1
1-3
2-1
Function Summary
2-1
API Functions 2-4
activateVtg 2-4
addChannelToVtg 2-4
addPhoneAssociatedToUser 2-5
addRadioToVtg 2-5
addUserToUserGroup 2-6
addUserToVtg 2-6
addVtgToVtg 2-6
associateChannelsToUser 2-7
associateRadiosToUser 2-7
createChannel 2-8
createUser 2-8
createUserGroup 2-9
createVtg 2-9
deactivateVtg 2-10
deleteChannel 2-10
deleteUser 2-10
Cisco IPICS API Reference Guide
OL-18330-01
iii
Contents
deleteVTG 2-10
dialAllVtgMembers 2-11
dialVtgMember 2-11
dialVtgMembers 2-12
disableChannel 2-13
disableUser 2-13
enableChannel 2-13
enableUser 2-14
executeNotificationPolicy 2-14
executePolicy 2-15
getAllChannelGroups 2-15
getAllChannels 2-15
getAllChannelsInChannelGroup 2-16
getAllPolicies 2-16
getAllRadios 2-17
getAllUserGroups 2-17
getAllUsers 2-18
getAllVtgs 2-18
getBelongingOpsViewForUser 2-19
getChannelsAssociatedToUser 2-19
getChannelStatus 2-20
getDigitIds 2-20
getPhonesAssociatedToUser 2-20
getPoliciesAssociatedToUser 2-21
getPolicyExecutionStatus 2-21
getRadiosAssociatedToUser 2-22
getUserAddress 2-22
getUserAudioStatus 2-23
getUserDialPreference 2-23
getUserGroupMembers 2-24
getUserListenerStatus 2-24
getUserNotificationPreference 2-24
getUserRoles 2-25
getUsersAssociatedToRadio 2-26
getUserStatus 2-26
getVtgParticipants 2-27
getVtgParticipantStatus 2-29
getVtgStatus 2-29
getVtgsAssociatedToUser 2-30
isActiveChannel 2-30
Cisco IPICS API Reference Guide
iv
OL-18330-01
Contents
isActiveUser 2-30
isActiveVtg 2-31
notifyAllVtgMembers 2-31
notifyVtgMember 2-31
notifyVtgMembers 2-32
removeChannelFromVtg 2-33
removePhoneAssociatedToUser 2-33
removeUserFromVtg 2-33
removeVtgFromVtg 2-34
setBelongingOpsViewForUser 2-34
setDialPreference 2-35
setDigitIds 2-35
setDigitPassword 2-35
setNotificationPreference 2-36
setUserAddress 2-36
setUserAudioStatus 2-37
setUserListenerStatus 2-37
CHAPTER
3
JiBX Mapping File
3-1
Obtaining the JiBX Mapping File
JiBX Mapping File Contents
CHAPTER
4
3-1
3-1
Web Services Description Language File
Obtaining the WSDL File
WSDL File Contents
4-1
4-1
4-1
INDEX
Cisco IPICS API Reference Guide
OL-18330-01
v
Contents
Cisco IPICS API Reference Guide
vi
OL-18330-01
Preface
This document provides the information that is required to understand and use the Cisco IP
Interoperability and Collaboration System (IPICS) application programming interface (API).
Audience
This document is intended for developers who want to use the Cisco IPICS API to control various
Cisco IPICS features and functions. It assumes that developers have knowledge or experience with
Cisco IPICS, a high-level programming language, and the following:
•
Extensible Markup Language (XML)
•
XML Schema
•
Web Services
•
Hyper Text Transport Protocol (HTTP) or Secure HTTP (HTTPS)
•
Simple Object Access Protocol (SOAP)
Organization
This document is organized as follows:
Chapter 1, “Overview”
Introduces the API, describes how to perform API requests, and
describes API security and API logging
Chapter 2, “API Functions”
Provides a summary of each API function and describes each
function in detail
Chapter 3, “JiBX Mapping File”
Shows the JiBX mapping file that define the Java clases that are
used for a response and to define which parts of an XML
response are mapped to which fields in the Java object
Chapter 4, “Web Services
Description Language File”
Shows the WSDL that the API uses
Cisco IPICS API Reference Guide
OL-18330-01
vii
Preface
Obtaining Documentation, Obtaining Support, and Security
Guidelines
For information about obtaining documentation, obtaining support, providing documentation feedback,
security guidelines, and recommended aliases and general Cisco documents, see the monthly
What’s New in Cisco Product Documentation, which also lists all new and revised Cisco technical
documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Cisco IPICS API Reference Guide
viii
OL-18330-01
CH A P T E R
1
Overview
The Cisco IP Interoperability and Collaboration System (IPICS) application programming interface
(API) is a web-services-based API that enables the management and control of various Cisco IPICS
operations through programmatic interfaces and custom applications. The API includes a set of functions
to control Cisco IPICS operations such as VTG creation, policy invocation, user management, and more.
This chapter introduces general concepts that relate to the API and explains options for executing API
requests. It includes these topics:
•
Executing API Requests, page 1-1
•
API Security, page 1-6
•
API Logging, page 1-7
Executing API Requests
To execute an API request, you send the desired API function or functions to the Cisco IPICS server.
You can execute Cisco IPICS API requests by using a URL or by using the web services with pure Java
objects. This chapter describes these approaches and provides examples. It includes these topics
•
Executing API Request by Using a URL, page 1-1
•
Executing API Requests by Using Java, page 1-3
Executing API Request by Using a URL
You can execute API requests from any browser. The following sections provide information about
executing these requests. In addition, the Web Services Description Language (WSDL) file for the
Cisco IPICS API includes helpful information. See Chapter 4, “Web Services Description Language
File.”
Guidelines
When you use the URL method to execute an API request, be aware of the following guidelines:
•
The first time that you execute a request in a browser session, the system prompts you for a user
name and password. Enter your Cisco IPICS user name and password.
•
The output format of API responses can vary depending on the browser that you are using.
Cisco IPICS API Reference Guide
OL-18330-01
1-1
Chapter 1
Overview
Executing API Requests
•
To allow error messages from the API to display in Internet Explorer, start Internet Explorer and
choose Internet Options. In the Advanced tab, check the Show friendly HTTP error messages
check box in the list of Browsing options.
•
Google Chrome removes new lines and the XML tags from API responses.
URL Format
To send an API request to the Cisco IPICS server via a URL, enter the following URL in your web
browser:
https://<Cisco_IPICS_Server>/ipics_server/services/NorthboundService/<function>
[?<parameter>=<value>][&<function>[?<parameter>=<value>]...]
In this URL:
•
Replace <Cisco_IPICS_Server> with the IP address or the host name of the Cisco IPICS server.
•
Replace <function> with the API function that you want to use.
•
Replace <parameter> with the function parameter that you want to use, if needed.
•
Replace <value> with the parameter value that you want to use, if needed.
Examples
This section provides examples of URL requests that execute various API functions. In these examples,
replace <Cisco_IPICS_Server> with the IP address or the host name of the Cisco IPICS server.
Example 1: Retrieving VTGs
To retrieve all VTGs that are configured in the Cisco IPICS server, enter the following URL in your web
browser:
https://<Cisco_IPICS_Server>/ipics_server/services/NorthboundService/getAllVtgs
Sample response:
<ns:getAllVtgsResponse>
<ns:getAllVtgsReturn>
<ns:vtgVOs>
<ns:vtgVO>
<ns:name>vtg1</ns:name>
<ns:id>260</ns:id>
</ns:vtgVO>
<ns:vtgVO>
<ns:name>vtg2</ns:name>
<ns:id>268</ns:id>
</ns:vtgVO>
</ns:vtgVOs>
</ns:getAllVtgsReturn>
</ns:getAllVtgsResponse
Example 2: Activating a VTG
To activate the VTG with the ID of 260, enter the following URL in your web browser:
https://<Cisco_IPICS_Server>/ipics_server/services/NorthboundService/activateVtg?vtgId=260
Response:
<ns:activateVtgResponse>
<ns:activateVtgReturn>true</ns:activateVtgReturn>
</ns:activateVtgResponse>
Cisco IPICS API Reference Guide
1-2
OL-18330-01
Chapter 1
Overview
Executing API Requests
Example 3: Creating a User
To create a Cisco IPICS user with the login ID test and the password abc123, enter the following URL
in your web browser:
https://<Cisco_IPICS_Server>/ipics_server/services/NorthboundService/
createUser?userLogin=test&userPassword=abc123
Sample response:
<ns:createUserResponse>
<ns:createUserReturn>6881</ns:createUserReturn>
</ns:createUserResponse>
Example 4: Forcing an Error
To cause the Cisco IPICS API to return an error message, enter the following URL in your web browser:
https://my-ipics/ipics_server/services/NorthboundService/createUser?userLogin=test
Sample response:
<faultstring>
Required element {http://com.cisco.ipics.issymo.northbound.service}userPassword defined in
the schema can not be found in the request
</faultstring>
Executing API Requests by Using Java
You can execute API requests by implementing a client application in Java with SOAP and the Axis2
and the JiBX libraries. To do so, follow these general steps:
1.
Bring the issymo-northbound-client-2.2-SNAPSHOT-jar-with-dependencies.jar file to your local
drive.
To do so, use the scp utility to download the client jar file from the /opt/cisco/ipics/examples folder
on the Cisco IPICS (replace Cisco_IPICS_Server with the IP address or the host name of the Cisco
IPICS server):
scp root@<Cisco_IPICS_Server>:/opt/cisco/ipics/examples/issymo-northbound-client-2.2SNAPSHOT-jar-with-dependencies.jar .
2.
Write an application to invoke API methods.
You may find the following resources to be helpful:
•
JiBX mapping file—Defines the Java classes that are used for a response and defines which parts of
an XML response are mapped to which fields in the Java object. The JiBX mapping file, and other
resources are included in the file named issymo-northbound-common-2.2-SNAPSHOT.jar. For more
information and the location of this file, see Chapter 3, “JiBX Mapping File.”
•
binding.xml file—Informs JiBX how to process complex object types. This file also is included in
the issymo-northbound-common-2.2-SNAPSHOT.jar file.
•
Value objects—Define the implementation of complex types. They also are included in the
issymo-northbound-common-2.2-SNAPSHOT.jar file.
•
WISDL file—Includes methods that you can invoke and the types of objects that they can return.
Some objects will be complex types. For more information, see Chapter 4, “Web Services
Description Language File.”
•
northboundservice.class—Client stub, contained in the
issymo-northbound-client-2.2-SNAPSHOT-jar-with-dependencies.jar file.
Cisco IPICS API Reference Guide
OL-18330-01
1-3
Chapter 1
Overview
Executing API Requests
Example
There are a variety of methods that you can use to access web services. The following example uses
Axis2 to build the client API request. It uses stub generation, in which a tool (WSDL2Java) generates
code from WSDL descriptions and it generates a client application that uses JiBX for binding the XML.
For additional information, see the Apache Axis2 documentation, and see Chapter 3, “JiBX Mapping
File.”
The following example relies on a reference web service client stub that ships with Cisco IPICS, called
com.cisco.ipics.issymo.northbound.client.NorthboundServiceStub. The stub is contained in the file
issymo-northbound-client-2.2-SNAPSHOT-jar-with-dependencies.jar.
This stub was generated by wsdl2java using Axis2 and JiBX. The wsdl2java utility also generated the
“value objects” which are complex types that the API uses. The file
issymo-northbound-common-2.2-SNAPSHOT.jar. includes the reference implementations of these value
objects.
import
import
import
import
import
import
import
import
import
java.rmi.RemoteException;
org.apache.axis2.AxisFault;
org.apache.axis2.client.Options;
org.apache.axis2.transport.http.HTTPConstants;
org.apache.axis2.transport.http.HttpTransportProperties;
com.cisco.ipics.issymo.northbound.client.NorthboundServiceStub;
com.cisco.ipics.issymo.northbound.client.NorthboundService;
com.cisco.ipics.issymo.northbound.service.UserContainerVO;
com.cisco.ipics.issymo.northbound.service.UserVO;
public class IpicsApiClient {
/**
* @param args The program arguments are as follows:
* 1. Hostname or IP address of your Cisco IPICS server
* 2. The Java trust store containing the Cisco IPICS server's SSL
*
certificate(s).
* 3. A Cisco IPICS user login name
* 4. A Cisco IPICS user password
*/
public static void main(String[] args) {
if(args.length!=4) {
System.err.println("ERROR: Insufficient arguments");
System.exit(1);
}
final
final
final
final
String
String
String
String
HOSTNAME
TRUSTSTORE
USERNAME
PASSWORD
=
=
=
=
args[0];
args[1];
args[2];
args[3];
try {
System.setProperty("javax.net.ssl.trustStore", TRUSTSTORE);
NorthboundService svc = initService(HOSTNAME, USERNAME, PASSWORD);
//
// Invoke the createUser API method which returns a simple int
//
try {
final String userLogin =
"testuser-"+System.currentTimeMillis();
final String userPassword = "secret";
System.out.println("Create Users:");
int newUserId = svc.createUser(userLogin, userPassword);
Cisco IPICS API Reference Guide
1-4
OL-18330-01
Chapter 1
Overview
Executing API Requests
System.out.println(" user id= " + newUserId);
} catch (RemoteException e) {
System.err.println("ERROR: "+e.getMessage());
}
System.out.println();
//
// Invoke the getAllUsers API method which returns a complex type,
// the UserContainerVO "value object".
//
try {
System.out.println("All Users:");
System.out.println("------------------------ ");
UserContainerVO userContainer = svc.getAllUsers();
if(userContainer.getUserVOs() != null) {
for (UserVO user : userContainer.getUserVOs()) {
System.out.println(user.toString());
System.out.println(" id
: "
+ user.getId());
System.out.println(" login : "
+ user.getUserLogin());
System.out.println(" name : "
+ user.getFirstName()
+ user.getLastName());
System.out.println();
}
} else {
System.out.println("No users found");
}
} catch (RemoteException e) {
System.err.println("ERROR: "+e.getMessage());
}
} catch (AxisFault ex) {
System.err.println(ex);
}
}
/**
* Get service stub for target end point URL and setup the client for
* BASIC authentication.
* @param hostname Cisco IPICS server hostname or IP address
* @param username Cisco IPICS user login name
* @param password Cisco IPICS user password
* @return An authenticated service stub, or an AxisFault exception.
* @throws AxisFault If authentication fails, or the service is
* unreachable.
*/
public static NorthboundService initService(String hostname,
String username, String password) throws AxisFault
{
NorthboundServiceStub stub;
HttpTransportProperties.Authenticator auth =
new HttpTransportProperties.Authenticator();
auth.setPreemptiveAuthentication(true);
auth.setUsername(username);
auth.setPassword(password);
final String ws_url =
"https://"+hostname+"/ipics_server/services/NorthboundService";
stub = new NorthboundServiceStub(ws_url);
Options options = stub._getServiceClient().getOptions();
options.setProperty(HTTPConstants.AUTHENTICATE, auth);
Cisco IPICS API Reference Guide
OL-18330-01
1-5
Chapter 1
Overview
API Security
return stub;
}
}
API Security
The Cisco IPICS server and the Cisco IPICS API use SSL for secure communication between the server
and clients. The server uses a X.509 certificate (also called an SSL certificate) to verify its identity when
a client attempts to connect to the server.
Be default, the Cisco IPICS server provides a self-signed certificate, which a client typically rejects. To
prevent a client from rejecting this certificate, take one of the of the actions that Table 1-1 describes.
Table 1-1
Methods for Preventing a Client from Rejecting the Cisco IPICS Server Self-Signed
Certificate
Method
Notes
Replace the Cisco IPICS server self-signed
certificate with a certificate that is signed by a
well-known certificate authority (CA), such as
VeriSign or a local CA in your organization.
For additional information, see the “Installing
Third Party Certificates on the Cisco IPICS
Server” section in Cisco IPICS Server Installation
and Upgrade Guide.
If you are using a Java client, configure the SSL Procedure:
libraries for your clients to trust the self-signed
1. Use SSH to log in to the Cisco IPICS server as
certificate by using the Java keytool to import the
the root user.
certificate into the client truststore.
2. Enter the following command:
cd /opt/cisco/ipics/tomcat/current/conf
3.
Enter the following command. Replace
<certificate_file> with the name of a file to
hold the certificate:
keytool -export -alias tomcat
-keystore tomcat.keystore
-keypass changeit -file <certificate_file>
4.
Download the self-signed certificate to the
client system.
5.
Enter the following command. Replace
<name> with a unique name for the alias,
replace <certificate_file> that you
downloaded to the client, and replace <path>
with the path to the client keystore:
keytool -import -alias <name>
-file <certificate_file> - keystore <path>
Cisco IPICS API Reference Guide
1-6
OL-18330-01
Chapter 1
Overview
API Logging
Table 1-1
Methods for Preventing a Client from Rejecting the Cisco IPICS Server Self-Signed
Certificate (continued)
Method
Notes
If you are using a client other than Java, configure You may be able to copy the self-signed certificate
the SSL libraries for your clients to trust the
to a special directory on the client system.
self-signed certificate.
See your library documentation for detailed
information.
Modify the way in which your client code
validates certificate trust chains.
Some languages provide configurable SSL files
that let you change the default certificate
validation behavior.
A client verifies its identity with a user name and password that are sent to the server by the client
application.
API Logging
The Cisco IPICS server logs all web service invocations. Entries include the date and time of the
invocation, the API function that was used, and the status of the response.
This information is maintained in the Cisco IPICS log file. For more information about the log file, see
Cisco IPICS Administration Guide.
Cisco IPICS API Reference Guide
OL-18330-01
1-7
Chapter 1
Overview
API Logging
Cisco IPICS API Reference Guide
1-8
OL-18330-01
CH A P T E R
2
API Functions
This chapter provide detailed descriptions for each function in the Cisco IPICS API. It includes these
topics:
•
Function Summary, page 2-1
•
API Functions, page 2-4
Function Summary
Table 2-1 provides a summary of the Cisco IPICS API functions. Each function is described in detail in
the section that is listed.
Table 2-1
API Function Summary
Function Name and Reference
Description
Functions for User Management
addPhoneAssociatedToUser, page 2-5
Associates a phone with a user
addUserToUserGroup, page 2-6
Adds a user to a user group
associateChannelsToUser, page 2-7
Associates one or more channels with a user
associateRadiosToUser, page 2-7
Associates one or more radios with a designated user
createUser, page 2-8
Creates a Cisco IPICS user
createUserGroup, page 2-9
Creates a user group
deleteUser, page 2-10
Deletes a Cisco IPICS user
disableUser, page 2-13
Disables a Cisco IPICS user
enableUser, page 2-14
Enables a Cisco IPICS user
isActiveUser, page 2-30
Determines if a user is active or disabled
removePhoneAssociatedToUser,
page 2-33
Disassociates a phone from a user
setBelongingOpsViewForUser,
page 2-34
Assigns an ops view to a designated user
setDialPreference, page 2-35
Adds a new dial preference for a user
setDigitIds, page 2-35
Sets digit IDs for a user
setDigitPassword, page 2-35
Sets a digit password for a user
Cisco IPICS API Reference Guide
OL-18330-01
2-1
Chapter 2
API Functions
Function Summary
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
setNotificationPreference, page 2-36
Adds a new notification preference for a user
setUserAddress, page 2-36
Adds a physical address for a user
setUserAudioStatus, page 2-37
Enables or disables the ability of a user to hear and transmit
audio on a PMC
setUserListenerStatus, page 2-37
Enables or disables the ability of a user to transmit audio
on a PMC
Functions for VTG Management
activateVtg, page 2-4
Activates a VTG (if it is not activated already)
addChannelToVtg, page 2-4
Adds a channel to an active or inactive VTG
addRadioToVtg, page 2-5
Adds a radio to an active or inactive VTG
addUserToVtg, page 2-6
Adds a user to an active or inactive VTG
addVtgToVtg, page 2-6
Add a VTG to another VTG
createVtg, page 2-9
Creates a VTG with the designated name
deactivateVtg, page 2-10
Deactivates a VTG
deleteVTG, page 2-10
Deletes a VTG
isActiveVtg, page 2-31
Determines if a VTG is active or disabled
removeChannelFromVtg, page 2-33
Removes a channel from a VTG
removeUserFromVtg, page 2-33
Removes a user from a VTG
removeVtgFromVtg, page 2-34
Removes a VTG from a VTG
Functions for Channel Management
createChannel, page 2-8
Creates a channel with the designated VTG name and short
name
deleteChannel, page 2-10
Deletes a channel
disableChannel, page 2-13
Changes a channel to DISABLED state if the current
channel state is IDLE
enableChannel, page 2-13
Changes a channel IDLE state if the current channel state
is DISABLED
isActiveChannel, page 2-30
Determines if a channel is active or disabled
Functions for Policy and Dial Function Management
dialAllVtgMembers, page 2-11
Dials out to all user members of a VTG, including members
of user groups that are part of the VTG
dialVtgMember, page 2-11
Dials out to the specified member of a VTG
dialVtgMembers, page 2-12
Dials out to a list of users or all users in a VTG
executeNotificationPolicy, page 2-14
Executes the notification policy that has the designated ID
executePolicy, page 2-15
Executes a designated policy
notifyAllVtgMembers, page 2-31
Notifies all users in a VTG, including members of user
groups in the VTG
notifyVtgMember, page 2-31
Notifies a specific member of a VTG
Cisco IPICS API Reference Guide
2-2
OL-18330-01
Chapter 2
API Functions
Function Summary
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
notifyVtgMembers, page 2-32
Notifies a list of users or all users in a VTG
Functions for Obtaining Status
getAllChannels, page 2-15
Retrieves all channels
getAllChannelGroups, page 2-15
Retrieves all channel groups
getAllChannelsInChannelGroup,
page 2-16
Retrieves all channels that are in the designated channel
group
getAllPolicies, page 2-16
Retrieves all policies.
getAllRadios, page 2-17
Retrieves all radios
getAllUsers, page 2-18
Retrieves all Cisco IPICS users
getAllUserGroups, page 2-17
Retrieves all user groups
getAllVtgs, page 2-18
Retrieves all VTGs
getBelongingOpsViewForUser,
page 2-19
Retrieves the ops view to which a designated user belongs
getChannelsAssociatedToUser,
page 2-19
Retrieves all channels that are associated with a designated
user
getChannelStatus, page 2-20
Retrieves the status of the designated channel
getDigitIds, page 2-20
Retrieves the digit IDs for a user
getPhonesAssociatedToUser, page 2-20
Retrieves all phones that are associated with a designated
user
getPoliciesAssociatedToUser, page 2-21
Retrieves all policies that are associated with a designated
user
getPolicyExecutionStatus, page 2-21
Retrieves the status of the execution of a designated policy
getRadiosAssociatedToUser, page 2-22
Return a list of radios that are associated with a designated
user
getUserAddress, page 2-22
Retrieves the physical address of a designated user
getUserAudioStatus, page 2-23
Returns a flag that indicates if the PMC of a user has audio
disabled or enabled
getUserDialPreference, page 2-23
Retrieves the dial preference that is associated with a
designated user
getUserGroupMembers, page 2-24
Retrieves all the users in a designated user group
getUserListenerStatus, page 2-24
Returns a flag that indicates whether the PMC of a user is
in listen-only mode
getUserNotificationPreference,
page 2-24
Retrieves the notification preference that is associated with
a designated user
getUserRoles, page 2-25
Retrieves the list of roles for a designated user
getUsersAssociatedToRadio, page 2-26
Return a list of users that are associated with a designated
radio
getUserStatus, page 2-26
Retrieves the active status of one or more users
getVtgParticipants, page 2-27
Retrieves all participants in a VTG
Cisco IPICS API Reference Guide
OL-18330-01
2-3
Chapter 2
API Functions
API Functions
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
getVtgParticipantStatus, page 2-29
Retrieves the status of VTG participant
getVtgStatus, page 2-29
Retrieves the ID, name, description, and status of a VTG
getVtgsAssociatedToUser, page 2-30
Retrieves all VTGs that are associated with a user
API Functions
The following sections describe each Cisco IPICS API function in detail. The function descriptions
provide the following information:
•
Function name—Name of the function
•
Description—General behavior for the function
•
Parameters—Parameters that the function requires
•
Return result—Describes the result Cisco IPICS returns for the function
•
Exception—Describes the exception that the function can throw and the situations that cause the
exception
•
Sample response—Examples of a response that the function can receive
activateVtg
Function name
activateVtg
Description
Activates a VTG (if it is not activated already).
Parameters
vtgId (int)—ID of the VTG to be activated.
Return result
True if the VTG is activated. False if the VTG is not activated.
Exception
RemoteException if a VTG with the designated ID does not exist or
if the operation fails.
Sample response
<ns:activateVtgResponse>
<ns:ActivateVtgReturn>true</ns:ActivateVtgReturn>
</ns:activateVtgResponse>
addChannelToVtg
Function name
addChannelToVtg
Description
Adds a channel to an active or inactive VTG.
Parameters
•
vtgId (int)—ID of the VTG to which the user is to be added.
•
channelId (int)—ID of the channel to be added to the designated
VTG.
Cisco IPICS API Reference Guide
2-4
OL-18330-01
Chapter 2
API Functions
API Functions
Return result
True if the channel is added to the VTG or if the channel already is a
participant in the VTG. False if the channel is not added to the VTG.
Exception
RemoteException if a VTG with the designated ID does not exist in
the system, the channel does not exist in the system, or the operation
fails.
Sample response
<ns:addChannelToVtgResponse>
<ns:addChannelToVtgReturn>true</ns:addChannelToVtgReturn>
</ns:addChannelToVtgResponse>
addPhoneAssociatedToUser
Function name
addPhoneAssociatedToUser
Description
Associates a phone with a user.
Parameters
•
userLogin (String)—Unique log in ID of the user with whom to
associate the phone.
•
dialNumber (String)—Dial number of the phone to associate with
the user.
Return result
True if the phone becomes associated with the user or if the phone
already is associated with the user. False if the phone is not associated
with the user.
Exception
RemoteException if a user with the designated ID does not exist in the
system, a phone with the designated dial number does not exist in the
system, or the operation fails.
Sample response
<ns:addPhoneAssociatedToUserResponse>
<ns:addPhoneAssociatedToUserReturn>true
</ns:addPhoneAssociatedToUserReturn>
</ns:addPhoneAssociatedToUserResponse>
addRadioToVtg
Function name
addUserToVtg
Description
Adds a radio to an active or inactive VTG.
Parameters
•
radioId (int)—ID of the radio to add.
•
vtgId (int)—ID of the VTG to which the radio is to be added.
Return result
True if the radio is added to the VTG or if the radio already is in the
VTG. False if the radio is not added to the VTG.
Exception
RemoteException if a VTG with the designated ID does not exist, the
radio does not exist in the system, or the operation fails.
Sample response
<ns:addRadioToVtgResponse>
<ns:addRadioToVtgReturn>true</ns:addRadioToVtgReturn>
</ns:addRadioToVtgResponse>
Cisco IPICS API Reference Guide
OL-18330-01
2-5
Chapter 2
API Functions
API Functions
addUserToUserGroup
Function name
addUserToUserGroup
Description
Adds a user to a user group.
Parameters
•
userLogin (String)—Unique log in ID of the user to be added to
the specified user group.
•
userGroupId (int)—ID of the user group to which the user is to
be added
Return result
True if the user is added to the user group or if the user already is in
the user group. False if the user is not added to the user group.
Exception
RemoteException if a user group with the designated ID does not
exist, the user does not exist in the system, or the operation fails.
Sample response
<ns:addUserToUserGroupResponse>
<ns:addUserToUserGroupReturn>true
</ns:addUserToUserGroupReturn>
</ns:addUserToUserGroupResponse>
Function name
addUserToVtg
Description
Adds a user to an active or inactive VTG.
addUserToVtg
Parameters
•
userLogin (String)—Unique log in ID of the user to be added to
the specified VTG.
•
vtgId (int)—ID of the VTG to which the user is to be added.
Return result
True if the user is added to the VTG or if the user already is a
participant in the VTG. False if the user is not added to the VTG.
Exception
RemoteException if a VTG with the designated ID does not exist, the
user does not exist in the system, or the operation fails.
Sample response
<ns:addUserToVtgResponse>
<ns:addUserToVtgReturn>true</ns:addUserToVtgReturn>
</ns:addUserToVtgResponse>
Function name
addVtgToVtg
Description
Adds a VTG to another or inactive VTG.
addVtgToVtg
Parameters
•
vtgIdAdd (int)—ID of the VTG to be added.
•
vtgId (int)—ID of the VTG to which the other VTG is to be
added.
Cisco IPICS API Reference Guide
2-6
OL-18330-01
Chapter 2
API Functions
API Functions
Return result
True if the designated VTG is added to the other VTG or if the
designated VTG already is in the other VTG. False if the designated
VTG is not added to the other VTG.
Exception
RemoteException if either VTG does not exist or the operation fails.
Sample response
<ns:addVtgToVtgResponse>
<ns:addVtgToVtgReturn>true</ns:addVtgToVtgReturn>
</ns:addVtgToVtgResponse>
associateChannelsToUser
Function name
associateChannelsToUser
Description
Associates one or more channels with a user.
Parameters
•
userLogin (String)—Unique log in ID of the user with whom to
associate one or more channels.
•
ChannelContainerVO—Collection of channel value objects, each
of which contains a channel ID and channel name. VO objects are
defined as:
– ChannelContainerVO
ChannelVO[] channelVOs
– ChannelVO
int id
String name
ChannelContainerVO channelContainerVO
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system, a channel with a designated ID does not exist in the
system, or the operation fails.
Sample response
<ns:associateChannelsToUserResponse>
<ns:associateChannelsToUserReturn/>
</ns:associateChannelsToUserResponse>
associateRadiosToUser
Function name
associateRadiosToUser
Description
Associates one or more radios with a user.
Cisco IPICS API Reference Guide
OL-18330-01
2-7
Chapter 2
API Functions
API Functions
Parameters
•
userLogin (String)—Unique log in ID of the user with whom to
associate one or more radios.
•
RadioContainerVO—A collection of radio value objects, each of
which contains a radio ID and radio name. VO objects are defined
as:
– RadioContainerVO
RadioVO[] radioVOs
– RadioVO
int id
String name
RadioContainerVO radioContainerVO
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system, a radio with a designated ID does not exist in the system,
or the operation fails.
Sample response
<ns:associateRadiosToUserResponse>
<ns:associateRadiosToUserReturn/>
</ns:associateRadiosToUserResponse>
createChannel
Function name
createChannel
Description
Creates a channel with the specified VTG name and short name.
Parameters
•
channelName (String)—Unique name of the channel to be
created.
•
channelShortName (String)—Unique short name of the channel
to be created.
Return result
channelId (int) if the channel is created.
Exception
RemoteException if a channel with the designated name already
exists or if the operation fails.
Sample response
<ns:createChannelResponse>
<ns:createChannelReturn>321</ns:createChannelReturn>
</ns:createChannelResponse>
Function name
createUser
Description
Creates a Cisco IPICS user
createUser
Cisco IPICS API Reference Guide
2-8
OL-18330-01
Chapter 2
API Functions
API Functions
Parameters
•
userLogin (String)—Unique log in ID of the user to be created.
•
userPassword (String)—Password of the user to be created. The
password can include letters, numbers, and special characters,
but no spaces. The system validates the password according the
parameters that are configured in Cisco IPICS Administration.
•
firstName (String)—First name of the user.
•
lastName (String)—Last name of the user
Return result
(int) ID of the user that is created.
Exception
RemoteException if a user with the designated log in ID already
exists in the system or if the operation fails.
Sample response
<ns:createUserResponse>
<ns:createUserReturn>21061</ns:createUserReturn>
</ns:createUserResponse>
createUserGroup
Function name
createUserGroup
Description
Creates a Cisco IPICS user with the specified name and description.
Parameters
•
groupName (String)—Name of the user group to be created. This
string can contain up to 32 characters, including spaces.
•
groupDescription (String)—Description of the user group to be
created. This string can contain up to 85 characters, including
spaces.
Return result
(Int) ID of the user group that is created.
Exception
Remote exception if groupName is not unique or if the operation fails.
Sample response
<ns:createUserGroupResponse>
<ns:createUserGroupReturn>5887</ns:createUserGroupReturn>
</ns:createUserGroupResponse>
Function name
createVtg
Description
Creates a VTG with the designated name.
createVtg
Parameters
•
vtgName (String)—Unique name of the VTG to be created.
•
description (String)—Description of the VTG.
Return result
vtgId (int) if the VTG is created.
Exception
RemoteException if a VTG with the designated name exists in the
system or if the operation fails.
Sample response
<ns:createVtgResponse>
<ns:createVtgReturn>452</ns:createVtgReturn>
</ns:createVtgResponse>
Cisco IPICS API Reference Guide
OL-18330-01
2-9
Chapter 2
API Functions
API Functions
deactivateVtg
Function name
deactivateVtg
Description
Deactivates a VTG.
Parameters
vtgId (int)—ID of the VTG to be activated.
Return result
True if the VTG is deactivated. False if the VTG is not deactivated.
Exception
RemoteException if a VTG with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:deactivateVtgResponse>
<ns:DeactivateVtgReturn>true</ns:DeactivateVtgReturn>
</nsdeactivateVtgResponse>
deleteChannel
Function name
deleteChannel
Description
Deletes a channel.
Parameters
channelId (int)—ID of the channel to be deleted.
Return result
True if the channel is deleted. False if the channel is not deleted.
Exception
RemoteException if a channel with the designated ID does not exist
in the system or if the operation fails.
Sample response
<ns:deleteChannelResponse>
<ns:DeleteChannelReturn>true</ns:DeleteChannelReturn>
</ns:deleteChannelResponse>
Function name
deleteUser
Description
Deletes a Cisco IPICS user.
Parameters
userId (int)—ID of the user to be deleted.
Return result
True if the user is deleted. False if the user is not deleted.
Exception
RemoteException if a user with the designated ID does not exist in the
system or if the operation fails.
Sample response
<ns:deleteUserResponse>
<ns:DeleteUserReturn>true</ns:DeleteUserReturn>
</ns:deleteUserResponse>
Function name
deleteVTG
deleteUser
deleteVTG
Cisco IPICS API Reference Guide
2-10
OL-18330-01
Chapter 2
API Functions
API Functions
Description
Deletes a VTG.
Parameters
vtgId (int)—ID of the VTG to be deleted.
Return result
True if the VTG is deleted. False if the VTG is not deleted.
Exception
RemoteException if a VTG with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:deleteVTGResponse>
<ns:DeleteVtgReturn>true</ns:DeleteVtgReturn>
</ns:deleteVTGResponse>
dialAllVtgMembers
Function name
dialAllVtgMembers
Description
Dials out to all user members of a VTG, including members of user
groups that are part of the VTG.
Parameters
•
vtgId (int)—Unique identifier of the VTG that includes the
members to be dialed.
•
trigger (String)—Name of the trigger that invokes a custom
dial-out script.
If the trigger parameter is null, the system uses its default dial-out
application.
The trigger parameter is a string in the form /<trigger_name>,
optionally followed by HTTP parameters that a custom dial-out
application requires. For example, the trigger could be
/custom_dialout?param1=value1 if an additional parameter is
required, or /custom_dialout if no additional parameters are
required.
Return result
True if the dial-out is successful. False if the dial-out is not successful.
Exception
RemoteException if the VTG with the designated ID does not exist in
the system, the VTG is not active, or the operation fails.
Sample response
<ns:dialAllVtgMembersResponse>
<ns:dialAllVtgMembersReturn>true</ns:dialAllVtgMembersRetur>
</ns:dialAllVtgMembersResponse>
dialVtgMember
Function name
dialVtgMember
Description
Dials out to the specified member of a VTG.
Cisco IPICS API Reference Guide
OL-18330-01
2-11
Chapter 2
API Functions
API Functions
Parameters
•
vtgId (int)—Unique identifier of the VTG that includes the
member to be dialed.
•
trigger (String)—Name of the trigger that invokes a custom
dial-out script.
If the trigger parameter is null, the system uses its default dial-out
application.
The trigger parameter is a string in the form /<trigger_name>,
optionally followed by HTTP parameters that a custom dial-out
application requires. For example, the trigger could be
/custom_dialout?param1=value1 if an additional parameter is
required, or /custom_dialout if no additional parameters are
required.
•
userLogin—Log in ID of the VTG member to be dialed.
Return result
True if the dial-out is successful. False if the dial-out is not
successful.
Exception
RemoteException if the VTG with the designated ID does not exist in
the system, the VTG is not active, the designated user is not a member
of the VTG, the designated user does not exist, or if the operation
fails.
Sample response
<ns:dialVtgMemberResponse>
<ns:dialVtgMemberReturn>true</ns:dialVtgMemberReturn>
</ns:dialVtgMemberResponse>
dialVtgMembers
Function name
dialVtgMembers
Description
Dials out to a list of users or all users in a VTG.
Parameters
•
vtgId (int)—Unique identifier of the VTG for which to send
invitations.
•
userContainerVO—UserVO array wrapped in a
UserContainerVO. If null, all users in the VTG are dialed. VO
objects are defined as:
– UserContainerVO
UserVO[] userVOs
– UserVO
String userLogin
String name
int id
String firstName
String lastName
If the userContainerVO is null, all users in the VTG are dialed.
Return result
None.
Cisco IPICS API Reference Guide
2-12
OL-18330-01
Chapter 2
API Functions
API Functions
Exception
RemoteException if the VTG with the designated ID does not exist in
the system, the VTG is not active, the designated user is not a member
of the VTG, the designated user does not exist, or the operation fails.
Sample response
<ns:dialVtgMembersResponse>
<ns:dialVtgMembersReturn/>
</ns:dialVtgMembersResponse>
disableChannel
Function name
disableChannel
Description
Changes a channel DISABLED state. Applies only if the current
channel state is IDLE.
Parameters
channelId (int)—Unique ID of the channel to disabled.
Return result
True if the channel is changed to DISABLED state. False if the
channel is not changed to DISABLED state.
Exception
RemoteException if the channel with the designated ID does not exist
in the system or if the operation fails.
Sample response
<ns:disableChannelResponse>
<ns:disableChannelReturn>true</ns:disableChannelReturn>
</ns:disableChannelResponse>
Function name
disableUser
Description
Disables a Cisco IPICS user.
Parameters
userLogin (String)—Unique log in ID of the user to disable.
Return result
True if the user is disabled. False if the user is not disabled.
Exception
RemoteException if the channel with the designated ID does not exist
in the system or if the operation fails.
Sample response
<ns:disableUserResponse>
<ns:disableChannelReturn>true</ns:disableChannelReturn>
</ns:disableUserResponse>
disableUser
enableChannel
Function name
enableChannel
Description
Changes a channel IDLE state. Applies only if the current channel
state is DISABLED.
Parameters
channelId (int)—Unique ID of the channel to enable.
Return result
True if the channel is changed to IDLE state. False if the channel is
not changed to IDLE state.
Cisco IPICS API Reference Guide
OL-18330-01
2-13
Chapter 2
API Functions
API Functions
Exception
RemoteException if the channel with the designated ID does not exist
in the system or if the operation fails.
Sample response
<ns:enableChannelResponse>
<ns:enableChannelReturn>true</ns:enableChannelReturn>
</ns:enableChannelResponse>
Function name
enableUser
Description
Enables a Cisco IPICS user.
Parameters
userLogin (String)—Unique log in ID of the user to enabled.
Return result
True if the user is enabled. False if the user is not enabled.
Exception
RemoteException if the user with the designated log in ID does not
exist in the system or if the operation fails.
Sample response
<ns:enableUserResponse>
<ns:enableUserReturn>true</ns:enableUserReturn>
/<ns:enableUserResponse>
enableUser
executeNotificationPolicy
Function name
executeNotificationPolicy
Description
Executes the notification policy that has the designated ID. When the
notification policy executes, the prerecorded prompt that is defined in
the Notification (Dial) action is overridden with a text-to-speech
(TTS) prompt that is generated from the designated text message.
Parameters
policyId (int)—Unique ID of the policy to execute.
msgText (String)—Text of message that the TTS function plays
recipients.
Return result
—
Exception
Remote Exception if:
Sample response
•
The policy ID does not exist in the system
•
The policy is not a General Purpose policy
•
The policy does not contain any Notification (Dial) actions
•
The TTS service is not available
•
The operation fails for any other reason
<ns:executeNotificationPolicyResponse>
<ns:executeNotificationPolicy>
<ns:setUserListenerStatusReturn/>
</ns:executeNotificationPolicy>
</ns:executeNotificationPolicyResponse>
Cisco IPICS API Reference Guide
2-14
OL-18330-01
Chapter 2
API Functions
API Functions
executePolicy
Function name
executePolicy
Description
Executes a designated policy.
Parameters
policyId (int)—Unique ID of the policy to execute.
Return result
True if the policy executes. False if the policy does not execute.
Exception
RemoteException if the policy with the designated ID does not exist
in the system or if the operation fails.
Sample response
<ns:executePolicyResponse>
<ns:executePolicyReturn>true</ns:executePolicyReturn>
</ns:executePolicyResponse>
getAllChannelGroups
Function name
getAllChannelGroups
Description
Retrieves all the channel groups.
Parameters
None.
Return result
ChannelGroupVO array wrapped in a ChannelGroupContainerVO.
Exception
RemoteException if the operation fails.
Sample response
<ns:getAllChannelGroupsResponse>
<ns:getAllChannelGroupsReturn>
<ns:channelGroupVOs>
<ns:channelGroupVO>
<ns:name>Test ChanneGroup 1</ns:name>
<ns:id>154</ns:id>
</ns:channelGroupVO>
</ns:channelGroupVOs>
</ns:getAllChannelGroupsReturn>
</ns:getAllChannelGroupsResponse>
getAllChannels
Function name
getAllChannels
Description
Retrieves all channels.
Parameters
None.
Return result
ChannelVO array wrapped in a ChannelContainerVO.
Exception
RemoteException if the operation fails.
Cisco IPICS API Reference Guide
OL-18330-01
2-15
Chapter 2
API Functions
API Functions
Sample response
<ns:getAllChannelsResponse>
<ns:getAllChannelsReturn>
<ns:channelVOs>
<ns:channelVO>
<ns:name>TestChannel1</ns:name>
<ns:id>140</ns:id>
</ns:channelVO>
<ns:channelVO>
<ns:name>TestChannel2</ns:name>
<ns:id>145</ns:id>
</ns:channelVO>
</ns:channelVOs>
</ns:getAllChannelsReturn>
</ns:getAllChannelsResponse>
getAllChannelsInChannelGroup
Function name
getAllChannelsInChannelGroup
Description
Retrieves all channels that are in the designated channel group.
Parameters
channelGroupId (int)—Unique identifier of the channel group from
which to retrieve all channels.
Return result
ChannelVO array wrapped in a ChannelContainerVO.
Exception
RemoteException if the channel group with the designated ID does
not exist in the system or if the operation fails.
Sample response
<ns:getAllChannelsInChannelGroupResponse>
<ns:getAllChannelsInChannelGroupReturn>
<ns:channelVOs>
<ns:channelVO>
<ns:name>TestChannel1</ns:name>
<ns:id>140</ns:id>
</ns:channelVO>
</ns:channelVOs>
</ns:getAllChannelsInChannelGroupReturn>
</ns:getAllChannelsInChannelGroupResponse>
getAllPolicies
Function name
getAllPolicies
Description
Retrieves all policies.
Parameters
None.
Return result
PolicyVO array wrapped in a PolicyContainerVO.
Exception
RemoteException if the operation fails.
Cisco IPICS API Reference Guide
2-16
OL-18330-01
Chapter 2
API Functions
API Functions
Sample response
<ns:getAllPoliciesResponse>
<ns:getAllPoliciesReturn>
<ns:policyVOs>
<ns:policyVO>
<ns:name>TestPolicy1</ns:name>
<ns:description>MyTestPolicy</ns:description>
<ns:id>21</ns:id>
</ns:policyVO>
/ns:policyVOs>
</ns:getAllPoliciesReturn>
</ns:getAllPoliciesResponse>
Function name
getAllRadios
Description
Retrieves all Cisco IPICS radios.
Parameters
None.
Return result
RadioVO array wrapped in a RadioContainerVO.
Exception
RemoteException if the operation fails.
Sample response
<ns:getAllRadiosResponse>
<ns:getAllRadiosReturn><ns:radioVOs>
<ns:radioVO>
<ns:name>Nextel1</ns:name>
<ns:id>5967</ns:id>
</ns:radioVO>
<ns:radioVO>
<ns:name>Tone1</ns:name>
<ns:id>6015</ns:id>
</ns:radioVO>
</ns:radioVOs>
</ns:getAllRadiosReturn>
</ns:getAllRadiosResponse>
getAllRadios
getAllUserGroups
Function name
getAllUserGroups
Description
Retrieves all user groups.
Parameters
None.
Return result
UserGroupVO array wrapped in a UserGroupContainerVO.
Exception
RemoteException if the operation fails.
Cisco IPICS API Reference Guide
OL-18330-01
2-17
Chapter 2
API Functions
API Functions
Sample response
<ns:getAllUserGroupsResponse>
<ns:getAllUserGroupsReturn>
<ns:userGroupVOs>
<ns:userGroupVO>
<ns:name>TestUserGroup1</ns:name>
<ns:id>187</ns:id>
</ns:userGroupVO>
<ns:userGroupVO>
<ns:name>TestUserGroup2</ns:name>
<ns:id>188</ns:id>
</ns:userGroupVO>
</ns:userGroupVOs>
</ns:getAllUserGroupsReturn>
</ns:getAllUserGroupsResponse>
Function name
getAllUsers
Description
Retrieves all Cisco IPICS users.
Parameters
None.
Return result
UserVO array wrapped in a UserContainerVO.
Exception
RemoteException if the operation fails.
Sample response
<ns:getAllUsersResponse>
<ns:getAllUsersReturn>
<ns:userVOs>
<ns:userVO>
<ns:userLogin>testuser1</ns:userLogin>
<ns:name>User1,Test (testuser1)</ns:name>
<ns:id>110</ns:id>
<ns:firstName>Test</ns:firstName>
<ns:lastName>User1</ns:lastName>
</ns:userVO>
<ns:userVO>
<ns:userLogin>testuser2</ns:userLogin>
<ns:name>User2,Test (testuser2)</ns:name>
<ns:id>121</ns:id>
<ns:firstName>Test</ns:firstName>
<ns:lastName>User2</ns:lastName>
</ns:userVO>
</ns:userVOs>
</ns:getAllUsersReturn>
</ns:getAllUsersResponse>
Function name
getAllVtgs
Description
Retrieves all VTGs.
Parameters
None.
Return result
VtgVO array wrapped in a VtgContainerVO.
getAllUsers
getAllVtgs
Cisco IPICS API Reference Guide
2-18
OL-18330-01
Chapter 2
API Functions
API Functions
Exception
RemoteException if the operation fails.
Sample response
</ns:getAlltgsResponse>
<ns:getAllVtgsReturn>
<ns:vtgVOs>
<ns:vtgVO>
<ns:name>TestVTG1</ns:name>
<ns:id>148</ns:id>
</ns:vtgVO>
<ns:vtgVO>
<ns:name>TestVTG2</ns:name>
<ns:id>150</ns:id>
</ns:vtgVO>
</ns:vtgVOs>
</ns:getAllVtgsReturn>
</ns:getAlltgsResponse>
getBelongingOpsViewForUser
Function name
getBelongingOpsViewForUser
Description
Retrieves the ops view to which a user belongs.
Parameters
userId (Integer)—ID of the user for whom retrieve ops views.
Return result
(Int) ID of the ops view.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getBelongingOpsViewForUserResponse>
<ns:getBelongingOpsViewForUserReturn>1
</ns:getBelongingOpsViewForUserReturn>
</ns:getBelongingOpsViewForUserResponse>
getChannelsAssociatedToUser
Function name
getChannelsAssociatedToUser
Description
Retrieves all channels that are associated with a designated user.
Parameters
userLogin (String)—Unique ID of the user for whom to retrieve
associated channels.
Return result
ChannelVO array wrapped in a ChannelContainerVO.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getChannelsAssociatedToUserResponse>
<ns:getChannelsAssociatedToUserReturn>
<ns:channelVOs>
<ns:channelVO>
<ns:name>Fire Channel 1</ns:name>
<ns:id>336</ns:id>
</ns:channelVO>
</ns:channelVOs>
</ns:getChannelsAssociatedToUserReturn>
</ns:getChannelsAssociatedToUserResponse>
Cisco IPICS API Reference Guide
OL-18330-01
2-19
Chapter 2
API Functions
API Functions
getChannelStatus
Function name
getChannelStatus
Description
Retrieves the status of the designated channel.
Parameters
channelId (int)—Unique identifier of the channel for which to
retrieve status.
Return result
Status of channel (String): disabled, idle, pending, or active.
Exception
RemoteException if the channel with the designated does not exist in
the system or if the operation fails.
Sample response
<ns:getChannelStatusResponse>
<ns:getChannelStatusReturn>idle</ns:getChannelStatusReturn>
</ns:getChannelStatusResponse>
Function name
getDigitIds
Description
Retrieves the digit IDs for a user.
Parameters
userLogin (Integer)—ID of the user for whom to retrieve digit IDs.
Return result
digitIds (int)—Digit IDs for the designated user
Exception
RemoteException if the user with the designated does not exist in the
system or if the operation fails.
Sample response
<ns:getDigitIdsResponse>
<ns:getDigitIdsReturn>2274</ns:getDigitIdsReturn>
</ns:getDigitIdsResponse>
getDigitIds
getPhonesAssociatedToUser
Function name
getPhonesAssociatedToUser
Description
Retrieves all phones that are associated with a designated user.
Parameters
userLogin (String)—Unique ID of the user for whom to retrieve
associated phones.
Return result
PhoneVO array wrapped in a PhoneContainerVO.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Cisco IPICS API Reference Guide
2-20
OL-18330-01
Chapter 2
API Functions
API Functions
Sample response
<ns:getPhonesAssociatedToUserResponse>
<ns:getPhonesAssociatedToUserReturn>
<ns:phoneVOs>
<ns: phoneVO>
<ns:name>TestPhone1</ns:name>
<ns:id>211</ns:id>
<ns:sipDn>111111111</ns: sipDn >
<ns:dialDestination>5555555555</ns: dialDestination >
</ns: phoneVO >
</ns: phoneVOs >
</ns: getPhonesAssociatedToUserReturn>
</ns:getPhonesAssociatedToUserResponse>
getPoliciesAssociatedToUser
Function name
getPoliciesAssociatedToUser
Description
Retrieves all policies that are associated with a designated user.
Parameters
userLogin (String)—Unique ID of the user for whom to retrieve
associated policies.
Return result
PolicyVO array wrapped in a PolicyContainerVO.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getPoliciesAssociatedToUserResponse>
<ns:getPoliciesAssociatedToUserReturn>
<ns:policyVOs>
<ns:policyVO>
<ns:name>TestPolicy1</ns:name>
<ns:id>21</ns:id>
</ns:policyVO>
</ns:policyVOs>
</ns:getPoliciesAssociatedToUserReturn>
</ns:getPoliciesAssociatedToUserResponse>
getPolicyExecutionStatus
Function name
getPolicyExecutionStatus
Description
Retrieves the status of the execution of a designated policy.
Parameters
policyId (int)—Unique ID of the policy for which to retrieve the
execution status.
Return result
PolicyExecutionStatusVO, which contains the date and status of the
last execution of the designated policy.
Exception
RemoteException if the policy with the designated ID does not exist
in the system or if the operation fails.
Cisco IPICS API Reference Guide
OL-18330-01
2-21
Chapter 2
API Functions
API Functions
Sample response
<ns:getPolicyExecutionStatusResponse>
<ns:getPolicyExecutionStatusReturn>
<ns:statusMessage>All actions have succeeded.</ns:
statusMessage>
<ns:executionDate>2007-08-06 11:28:05</ns:executionDate>
</ns:getPolicyExecutionStatusReturn>
</ns:getPolicyExecutionStatusResponse>
getRadiosAssociatedToUser
Function name
getRadiosAssociatedToUser
Description
Returns a list of radios that are associated with a user.
Parameters
userLogin (String)—Unique ID of the user for whom to retrieve
associated radios.
Return result
RadioVO array wrapped in a RadioContainerVO.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getRadiosAssociatedToUserResponse>
<ns:getRadiosAssociatedToUserReturn>
<ns:radioVOs>
<ns:radioVO>
<ns:name>EFJohnson1</ns:name>
<ns:id>5858</ns:id>
</ns:radioVO>
</ns:radioVOs>
</ns:getRadiosAssociatedToUserReturn>
</ns:getRadiosAssociatedToUserResponse>
getUserAddress
Function name
getUserAddress
Description
Retrieves the physical address of a user.
Parameters
userLogin (String)—Unique log in ID of the user for whom to retrieve
the address.
Return result
AddressVO
Exception
RemoteException if the user with the designated ID does not exist in
the system.
Sample response
<ns:getUserAddressResponse>
<ns:getUserAddressReturn>
<ns:country>USA</ns:country>
<ns:street>300 E Main</ns:street>
<ns:state>Michigan</ns:state>
<ns:zip>954123</ns:zip>
<ns:streetExtra>Suite 100</ns:streetExtra>
<ns:city>Lansing</ns:city>
</ns:getUserAddressReturn>
</ns:getUserAddressResponse>
Cisco IPICS API Reference Guide
2-22
OL-18330-01
Chapter 2
API Functions
API Functions
getUserAudioStatus
Function name
getUserAudioStatus
Description
Returns a flag that indicates if the PMC of a user has audio disabled
or enabled. When audio is disabled, the PMC cannot transmit or
receive audio.
Parameters
userLogin (String)—Unique log in ID of the user for whom to retrieve
the PMC audio status.
Return result
isDisabled—True if audio is disabled. False if audio is enabled.
Exception
RemoteException if the user with the designated ID does not exist in
the system.
Sample response
<ns:getUserAudioStatusResponse>
<ns: userAudioStatus> true</ns:userAudioStatus>
</ns:getUserAudioStatusResponse>
getUserDialPreference
Function name
getUserDialPreference
Description
Retrieves the dial preference that is associated with a designated user.
Parameters
userLogin (String)—Unique log in ID of the user for whom to retrieve
the dial preference.
Return result
DialAddressVO array wrapped in a DialAddressContainerVO.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getUserDialPreferenceResponse>
<ns:getUserDialPreferenceReturn>
<ns:dialAddressVOs>
<ns:dialAddressVO>
<ns:type>Business</ns:type>
<ns:dialPreferenceOrder>0</ns:dialPreferenceOrder>
<ns:dialNumber>408-555-5555</ns:dialNumber>
<ns:id>21020</ns:id>
</ns:dialAddressVO>
<ns:dialAddressVO>
<ns:type>Home</ns:type>
<ns:dialPreferenceOrder>1</ns:dialPreferenceOrder>
<ns:dialNumber>614-555-5555</ns:dialNumber>
<ns:id>21019</ns:id>
</ns:dialAddressVO>
</ns:dialAddressVOs>
</ns:getUserDialPreferenceReturn>
</ns:getUserDialPreferenceResponse>
Cisco IPICS API Reference Guide
OL-18330-01
2-23
Chapter 2
API Functions
API Functions
getUserGroupMembers
Function name
getUserGroupMembers
Description
Retrieves all the users in a designated user group.
Parameters
userGroupId (int)—Unique ID of the user group from which to
retrieve all members.
Return result
UserVO array wrapped in a UserContainerVO.
Exception
RemoteException if the user group with the designated ID does not
exist in the system or if the operation fails.
Sample response
<ns:getUserGroupMembersResponse>
<ns:getUserGroupMembersReturn>
<ns:userVOs>
<ns:userVO>
<ns:userLogin>testuser1</ns:userLogin>
<ns:name>User1,Test (testuser1)</ns:name>
<ns:id>110</ns:id>
<ns:firstName>Test</ns:firstName>
<ns:lastName>User1</ns:lastName>
</ns:userVO>
</ns:userVOs>
</ns:getUserGroupMembersReturn>
</ns:getUserGroupMembersResponse>
getUserListenerStatus
Function name
getUserListenerStatus
Description
Returns a flag that indicates whether the PMC of a user is in
listen-only mode. In this mode, the user is muted.
Parameters
userLogin (String)—Unique log in ID of the user for whom to retrieve
the PMC audio status.
Return result
ListenOnly—True if audio is muted. False if the user is not muted.
Exception
RemoteException if the user with the designated ID does not exist in
the system.
Sample response
<ns:getUserListenerStatusResponse>
<ns: userListenerStatus> true</ns:userListenerStatus>
</ns:getUserListenerStatusResponse>
getUserNotificationPreference
Function name
getUserNotificationPreference
Description
Retrieves the notification preference that is associated with a
designated user.
Parameters
userLogin (String)—Unique ID of the user for whom to retrieve the
notification preference.
Cisco IPICS API Reference Guide
2-24
OL-18330-01
Chapter 2
API Functions
API Functions
Return result
NotificationAddressVO array wrapped in a
NotificationAddressContainerVO.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getUserNotificationPreferenceResponse>
<ns:getUserNotificationPreferenceReturn>
<ns:notificationAddressVOs>
<ns:notificationAddressVO>
<ns:notificationAddress>test@cisco.com</ns:notification
Address>
<ns:type>Email</ns:type>
<ns:id>21018</ns:id>
</ns:notificationAddressVO>
<ns:notificationAddressVO>
<ns:notificationAddress>page@cisco.com</ns:notification
Address>
<ns:type>Pager</ns:type>
<ns:id>21017</ns:id>
</ns:notificationAddressVO>
</ns:notificationAddressVOs>
</ns:getUserNotificationPreferenceReturn>
</ns:getUserNotificationPreferenceResponse>
Function name
getUserRoles
Description
Retrieves the list of roles for a designated user.
Parameters
userLogin (String)—Unique ID of the user whose roles to retrieve.
Return result
UserRoleVO array wrapped in a UserRoleContainerVO.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getUserRolesResponse>
<ns:getUserRolesReturn>
<ns:userRoleVOs>
<ns:userRoleVO>
<ns:name>dispatcher</ns:name>
<ns:id>3</ns:id>
ns:displayName>Dispatcher</ns:displayName>
</ns:userRoleVO>
<ns:userRoleVO>
<ns:name>all</ns:name>
<ns:id>5</ns:id>
ns:displayName>All</ns:displayName>
</ns:userRoleVO>
<ns:userRoleVO>
<ns:name>opsadmin</ns:name>
<ns:id>6</ns:id>
<ns:displayName>Ops View Administrator</ns:displayName>
</ns:userRoleVO>
</ns:userRoleVOs>
</ns:getUserRolesReturn
</ns:getUserRolesResponse>
getUserRoles
Cisco IPICS API Reference Guide
OL-18330-01
2-25
Chapter 2
API Functions
API Functions
getUsersAssociatedToRadio
Function name
getUsersAssociatedToRadio
Description
Returns a list of users that are associated with a radio.
Parameters
radioId (String)—Unique ID of the radio for which to retrieve
associated users.
Return result
Array of User VOs wrapped in a UserContainer VO.
Exception
RemoteException if the radio with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getUsersAssociatedToRadioResponse>
<ns:getUsersAssociatedToRadioReturn>
<ns:userVOs>
<ns:userVO>
<ns:userLogin>testuser12</ns:userLogin>
<ns:name>Blow,Joe (testuser12)</ns:name>
<ns:id>5382</ns:id>
<ns:firstName>Joe</ns:firstName>
<ns:lastName>Blow</ns:lastName>
</ns:userVO>
<ns:userVO>
<ns:userLogin>testuser16</ns:userLogin>
<ns:name>Blow,Joe (testuser16)</ns:name>
<ns:id>5535</ns:id>
<ns:firstName>Joe</ns:firstName>
<ns:lastName>Blow</ns:lastName>
</ns:userVO>
</ns:userVOs>
</ns:getUsersAssociatedToRadioReturn>
</ns:getUsersAssociatedToRadioResponse>
Function name
getUserStatus
Description
Retrieves the active status of one or more users.
Parameters
userLogin (String)—Unique IDs of 1 or more users for whom to
retrieve active status.
Return result
Status (true when logged in or false when logged out) for each
designated user.
Exception
RemoteException if the designated user ID does not exist in the
system or if the operation fails.
Sample response
<ns:getUserStatusResponse>
<ns:getUserStatusReturn>
<ns:statusMessage>true.</ns:statusMessage>
</ns:getUserStatusReturn>
</ns:getUserStatusResponse>
getUserStatus
Cisco IPICS API Reference Guide
2-26
OL-18330-01
Chapter 2
API Functions
API Functions
getVtgParticipants
Function name
getVtgParticipants
Description
Retrieves all participants in a VTG.
Parameters
vtgId (int)—ID of the VTG from which to retrieve all participants.
Return result
VtgParticipant VO array wrapped in a VtgParticipantContainerVO.
Includes users, user groups, channels, channel groups, and VTGs.
Exception
RemoteException if the VTG with the designated ID does not exist in
the system or if the operation fails.
Cisco IPICS API Reference Guide
OL-18330-01
2-27
Chapter 2
API Functions
API Functions
Sample response
<ns:getVtgParticipantsResponse>
<ns:getVtgParticipantsReturn>
<ns:userGroupParticipants>
<ns:vtgParticipantVO>
<ns:participantId>118</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>user-group</ns:resourceType>
<ns:status>active</ns:status>
<ns:name>TestUserGroup2</ns:name>
<ns:id>21026</ns:id>
</ns:vtgParticipantVO>
</ns:userGroupParticipants>
ns:channelGroupParticipants>
<ns:vtgParticipantVO>
<ns:participantId>125</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>channel-group</ns:resourceType>
<ns:status>active</ns:status>
<ns:name>TestChannelGroup1</ns:name>
<ns:id>21021</ns:id>
</ns:vtgParticipantVO>
</ns:channelGroupParticipants>
<ns:vtgParticipants>
<ns:vtgParticipantVO>
<ns:participantId>928</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>vtg</ns:resourceType>
<ns:status>error</ns:status>
<ns:name>Test VTG 2</ns:name>
<ns:id>21028</ns:id>
</ns:vtgParticipantVO>
</ns:vtgParticipants>
<ns:userParticipants>
<ns:vtgParticipantVO>
<ns:participantId>953</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>user</ns:resourceType>
<ns:status>active</ns:status>
<ns:name>Test0, Some</ns:name>
<ns:id>21024</ns:id>
</ns:vtgParticipantVO>
<ns:vtgParticipantVO>
<ns:participantId>954</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>user</ns:resourceType>
<ns:status>active</ns:status>
<ns:name>Test1, Some</ns:name>
<ns:id>21025</ns:id>
</ns:vtgParticipantVO>
</ns:userParticipants>
<ns:channelParticipants>
<ns:vtgParticipantVO>
<ns:participantId>119</ns:participantId>
<ns:groupId>0</ns:groupId>
<ns:resourceType>channel</ns:resourceType>
<ns:status>error</ns:status>
<ns:name>TestChannel1</ns:name>
<ns:id>21016</ns:id>
</ns:vtgParticipantVO>
</ns:channelParticipants>
</ns:getVtgParticipantsReturn>
</ns:getVtgParticipantsResponse>
Cisco IPICS API Reference Guide
2-28
OL-18330-01
Chapter 2
API Functions
API Functions
getVtgParticipantStatus
Function name
getVtgParticipantStatus
Description
Retrieves the status of VTG participant.
Parameters
•
vtgId (int)—Unique ID of the VTG of whose participant status to
queried.
•
participantID (int)—Unique ID of the participant of whose status
to queried.
•
resourceType (String)—Participant type: user, user-group,
channel, channel-group or, vtg.
Return result
(String) Status of VTG participant (disconnected, error, pending, or
active).
Exception
RemoteException if the VTG with the designated ID does not exist in
the system or is not active, the participant with the designated ID does
not exist in the system, the resource type is invalid, or the operation
fails.
Sample response
<ns:getVtgParticipantStatusResponse>
<ns:getVtgParticipantStatusReturn>active</
<ns:getVtgParticipantStatusReturn>
</ns:getVtgParticipantStatusResponse>
Function name
getVtgStatus
Description
Retrieves the ID, name, description, and status (idle, active, pending,
or disabled) of a VTG.
Parameters
vtgId (int)—Unique identifier of the VTG for which to retrieve status.
Return result
(String) Status of the VTG (idle, pending, or active).
getVtgStatus
vtgContainerVO, which contains one vtgVO with attributes of vtgId,
vtgName, description, and status
Exception
RemoteException if the VTG with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:getVtgStatusResponse>
<ns:getVtgStatusReturn>
<ns:vtgVOs>
<ns:vtgVO>
<ns:description/>
<ns:status>idle</ns:status>
<ns:name>Fire Incident</ns:name>
<ns:id>326</ns:id>
</ns:vtgVO>
</ns:vtgVOs>
</ns:getVtgStatusReturn>
</ns:getVtgStatusResponse>
Cisco IPICS API Reference Guide
OL-18330-01
2-29
Chapter 2
API Functions
API Functions
getVtgsAssociatedToUser
Function name
getVtgsAssociatedToUser
Description
Retrieves all VTGs that are associated with a user.
Parameters
userLogin (String)—Unique log in ID of the user for whom to retrieve
associated VTGs.
Return result
VtgVO array wrapped in a VtgContainerVO.
Exception
RemoteException if the user with the designate ID does not exist in
the system or if the operation fails.
Sample response
<ns:getVtgsAssociatedToUserResponse>
<ns:getVtgsAssociatedToUserReturn>
<ns:vtgVOs>
<ns:vtgVO>
<ns:name>TestVTG1</ns:name>
<ns:id>148</ns:id>
</ns:vtgVO>
</ns:vtgVOs>
</ns:getVtgsAssociatedToUserReturn>
</ns:getVtgsAssociatedToUserResponse>
isActiveChannel
Function name
isActiveChannel
Description
Determines if a channel is active or disabled.
Parameters
channelId (int)—Unique ID of the channel to query.
Return result
True if the channel is active. False if the channel is disabled.
Exception
RemoteException if the channel with the designated ID does not exist
in the system or if the operation fails.
Sample response
<ns:isActiveChannelResponse>
<ns:isActiveChannelReturn>true</ns:isActiveChannelReturn>
</ns:isActiveChannelResponse>
Function name
isActiveUser
Description
Determines if a user is active or disabled.
Parameters
userLogin (String)—Unique log in ID of the user to query.
Return result
True if the user is active. False if the user is disabled.
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:isActiveUserResponse>
<ns:isActiveUserReturn>true</ns:isActiveUserReturn>
</ns:isActiveUserResponse>
isActiveUser
Cisco IPICS API Reference Guide
2-30
OL-18330-01
Chapter 2
API Functions
API Functions
isActiveVtg
Function name
isActiveVtg
Description
Determines if a VTG is active or disabled.
Parameters
vtgId (String)—Unique log in ID of the VTG to query.
Return result
True if the VTG is active. False if the VTG is disabled.
Exception
RemoteException if the VTG with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:isActiveVtgResponse>
<ns:isActiveVtgReturn>true</ns:isActiveVtgReturn>
</ns:isActiveVtgResponse>
notifyAllVtgMembers
Function name
notifyAllVtgMembers
Description
Notifies all users in a VTG, including members of user groups in the
VTG.
Parameters
vtgId (int)—Unique ID of the VTG for which members are to be
notified.
Return result
True if the notification is successful. False if the notification is not
successful.
Exception
RemoteException if the VTG with the designated ID does not exist in
the system, the VTG is not active or the operation fails.
Sample response
<ns:notifyAllVtgMembersResponse>
<ns:notifyAllVtgMembersReturn>true</
ns:notifyAllVtgMembersReturn>
</ns:notifyAllVtgMembersResponse>
notifyVtgMember
Function name
notifyVtgMember
Description
Notifies a specific member of a VTG.
Parameters
vtgId (int)—Unique ID of the VTG for which the member is to be
notified.
userLogin (String)—Unique log in ID of the VTG member to be
notified.
Return result
True if the notification is successful. False if the notification is not
successful.
Exception
RemoteException if the VTG with the designated ID does not exist in
the system, the VTG is not active, the user is not a participant in the
VTG, user does not exist, or if the operation fails.
Cisco IPICS API Reference Guide
OL-18330-01
2-31
Chapter 2
API Functions
API Functions
Sample response
<ns:notifyVtgMemberResponse>
<ns:notifyVtgMemberReturn>true</ns:notifyVtgMemberReturn>
</ns:notifyVtgMemberResponse>
notifyVtgMembers
Function name
notifyVtgMembers
Description
Notifies a list of users or all users in a VTG.
Parameters
•
vtgId (int)—Unique ID of the VTG for which the notification is
to be sent.
•
userContainerVO—UserVO array wrapped in a
UserContainerVO. If null, all users in the VTG are notified. VO
objects are defined as:
VO objects are defined as:
– UserContainerVO
UserVO[] userVOs
– UserVO
String userLogin
String name
int id
String firstName
String lastName
If the userContainerVO is null, all users in the VTG receive
notification.
•
subject (String)—Topic of the notification message. The subject
can contain up to 255 characters.
•
message (String)—Body of the notification message. The
message can contain up to 1,024 characters.
•
audioFile (String)—Path and file name of an audio file to include
with the notification.
Return result
None.
Exception
RemoteException if the VTG with the designated ID does not exist in
the system, the VTG is not active, the user is not a participant in the
VTG, user does not exist, or the operation fails.
Sample response
<ns:notifyVtgMembersResponse>
<ns:notifyVtgMembersReturn/>
</ns:notifyVtgMembersResponse>
Cisco IPICS API Reference Guide
2-32
OL-18330-01
Chapter 2
API Functions
API Functions
removeChannelFromVtg
Function name
removeChannelFromVtg
Description
Removes a channel from a VTG.
Parameters
•
vtgId (int)—Unique ID of the VTG from which to remove the
channel.
•
channelId (int)—Unique of the channel to be removed from the
VTG.
Return result
True if the channel is removed for the VTG. False if the channel is not
removed from the VTG.
Exception
RemoteException if a VTG with the designated ID does not exist in
the system, the designated channel does not exist in the system, or the
operation fails.
Sample response
<ns:removeChannelFromVtgResponse>
<ns:removeChannelFromVtgReturn>true</
ns:removeChannelFromVtgReturn>
</ns:removeChannelFromVtgResponse>
removePhoneAssociatedToUser
Function name
removePhoneAssociatedToUser
Description
Disassociates a phone from a user.
Parameters
•
userLogin (String)—Log in ID of the user from whom to
disassociate a phone.
•
dialNumber (String)—Dial number of the phone to disassociate
from the user.
Return result
True if disassociation succeeds or if the phone already is
disassociated from the user. False if the disassociation fails.
Exception
RemoteException if a user with the designated ID does not exist in the
system, the designated dial number does not exist in the system, or the
operation fails.
Sample response
<ns:removePhoneAssociatedToUserResponse>
<ns:removePhoneAssociatedToUserReturn>true
</ns:removePhoneAssociatedToUserReturn>
</ns:removePhoneAssociatedToUserResponse>
removeUserFromVtg
Function name
removeUserFromVtg
Description
Removes a participant from a VTG.
Cisco IPICS API Reference Guide
OL-18330-01
2-33
Chapter 2
API Functions
API Functions
Parameters
•
userLogin (String)—Unique log in ID of the user to be removed
from the VTG.
•
vtgId (int)—Unique ID of the VTG from which to remove the
user.
Return result
True if the user is removed from the VTG or is not a member of the
VTG. False if the user is not removed from the VTG.
Exception
RemoteException if a VTG with the designated ID does not exist in
the system, the user does not exist in the system, or the operation fails.
Sample response
<ns:removeUserFromVtgResponse>
<ns:removeUserFromVtgReturn>true</
ns:removeUserFromVtgReturn>
</ns:removeUserFromVtgResponse>
removeVtgFromVtg
Function name
removeVtgFromVtg
Description
Removes VTG from a VTG.
Parameters
•
vtgIdRem (String)— ID of the VTG to remove.
•
vtgId (int)—Unique ID of the VTG from which to remove the
other VTG.
Return result
True if the VTG is removed from the VTG or is not a member of the
VTG. False if the VTG is not removed from the VTG.
Exception
RemoteException if either VTG with the designated ID does not exist
in the system or the operation fails.
Sample response
<ns:removeVtgFromVtgResponse>
<ns:removeVtgFromVtgReturn>true</ns:removeVtgFromVtgReturn>
</ns:removeVtgFromVtgResponse>
setBelongingOpsViewForUser
Function name
setBelongingOpsViewForUser
Description
Assigns an ops view to a user.
Parameters
•
userLogin (String)—Log in ID of the user to whom to assign an
ops view.
•
opsViewId (int)—ID of the ops view to assign to the user.
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system, the ops view with the designated ID does not exist in the
system, or the operation fails.
Sample response
<ns:setBelongingOpsViewForUserResponse>
<ns:setBelongingOpsViewForUserReturn/>
</ns:setBelongingOpsViewForUserResponse>
Cisco IPICS API Reference Guide
2-34
OL-18330-01
Chapter 2
API Functions
API Functions
setDialPreference
Function name
setDialPreference
Description
Adds a new dial preference for a user.
Parameters
•
userLogin (String)—Unique log in ID of the user for whom to set
dial preferences.
•
dialType (String)—Dial type preference (BUSINESS,
BUSINESS2, BUSINESS3, CAR, HOME, HOME2, HOME3,
MOBILE, MOBILE2, MOBILE3, OTHER, PRIMARY,
SECONDARY).
•
dialNumber (String)—Phone number to dial.
•
dialOrder (int)—Order in which this dial type is executed if more
than one dial type is configured.
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:setDialPreferenceReturn>
<ns:prefId>7978</ns: prefId>
</ns:setDialPreferenceReturn>
Function name
setDigitIds
Description
Sets digit IDs for a user.
setDigitIds
Parameters
•
userLogin (String)—Unique log in ID of the user for whom to set
digit IDs.
•
digitIds (int)—Digit IDs for the user.
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system, invalid digit characters are entered, or the operation fails.
Sample response
<ns:setDigitIdsResponse>
<ns:setDigitIdsResponse>
<ns:setDigitIdsReturn>true</ns:seDigitIdsReturn>
<ns:setDigitIdsResponse>
</ns:setDigitIdsResponse>
setDigitPassword
Function name
setDigitPassword
Description
Sets a digit password for a user.
Cisco IPICS API Reference Guide
OL-18330-01
2-35
Chapter 2
API Functions
API Functions
Parameters
•
userLogin (String)—Unique log in ID of the user for whom to set
a digit password.
•
password (String)—Password of the user to be created. The
password can include letters, numbers, and special characters,
but no spaces. The system validates the password according the
parameters that are configured in Cisco IPICS Administration.
Return result
—
Exception
Remote Exception if the user with the designated ID does not exist in
the system, the password fails validation, or the operation fails.
Sample response
<ns:setDigitPasswordResponse>
<ns:setDigitIDsResponse>
</ns:setDigitPasswordResponse>
setNotificationPreference
Function name
setNotificationPreference
Description
Adds a new notification preference for a user.
Parameters
•
userLogin (String)—Unique log in ID of the user for whom to set
dial preferences
•
notificationType (String)—Notification type preference
(EMAIL, PAGER, SMS)
•
notificationAddress (String)—Address for the designated
notification type.
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:setNotificationPreferenceResponse>
<ns:setNotificationPreferenceReturn>
<ns:prefId>7978</ns: prefId>
</ns:seNotificationPreferenceReturn>
</ns:setNotificationPreferenceResponse>
setUserAddress
Function name
setUserAddress
Description
Adds a physical address for a user.
Cisco IPICS API Reference Guide
2-36
OL-18330-01
Chapter 2
API Functions
API Functions
Parameters
•
userLogin (String)—Unique log in ID of the user for whom to
add a physical address.
•
AddressVO—Address information. The VO object is defined as:
String street
String streetExtra
String city
String state
String zip
String country
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system or if the operation fails.
Sample response
<ns:setUserAddressResponse>
<ns:setUserAddress Return/>
</ns:setUserAddressResponse>
setUserAudioStatus
Function name
setUserAudioStatus
Description
Enables or disables the ability of a user to hear and transmit audio on
a PMC.
Note
Parameters
A user is not able to transmit audio (the user is muted) if audio
status for the user is enabled but listener status for the user is
disabled. See the “setUserListenerStatus” section on
page 2-37.
•
userLogin (String)—Unique log in ID of the user for whom to
enable or disable PMC audio.
•
audioDisabled (boolean)—If true, the audio capability is
disabled. If false, the audio capability is enabled.
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system.
Sample response
<ns:setUserAudioStatusResponse>
<ns:setUserAudioStatus>
<ns:setUserAudioStatusReturn/>
</ns:setUserAudioStatus>
</ns:setUserAudioStatusResponse>
setUserListenerStatus
Function name
setUserListenerStatus
Cisco IPICS API Reference Guide
OL-18330-01
2-37
Chapter 2
API Functions
API Functions
Description
Enables or disables the ability of a user to transmit audio on a PMC
(unmutes or mutes a user).
Note
Parameters
If the audio status for a user is disabled (see the
“setUserAudioStatus” section on page 2-37), a user cannot
transmit audio in any case.
•
userLogin (String)—Unique log in ID of the user for whom
enable or disable PMC audio.
•
mute (boolean)—If true, the user is muted. If false, the user is not
muted.
Return result
—
Exception
RemoteException if the user with the designated ID does not exist in
the system.
Sample response
<ns:setUserListenerStatusResponse>
<ns:setUserListenerStatus>
<ns:setUserListenerStatusReturn/>
</ns:setUserListenerStatus>
</ns:setUserAudioStatusResponse>
Cisco IPICS API Reference Guide
2-38
OL-18330-01
CH A P T E R
3
JiBX Mapping File
If you are using the web service with Java objects to execute Cisco IPICS API requests, JiBX parses
XML responses that a client receives from the web service and constructs Java objects. The JiBX
mapping file defines the Java classes that are used for a response and defines which parts of an XML
response are mapped to which fields in the Java object.
This chapter includes the following topics, which describe how to obtain the JiBX mapping file and show
its contents:
•
Obtaining the JiBX Mapping File, page 3-1
•
JiBX Mapping File Contents, page 3-1
Obtaining the JiBX Mapping File
The JiBX mapping file and the Java objects that the web server XML maps to are included in the file
named ssymo-northbound-common-2.2-SNAPSHOT.jar. This file is located in following folder on the
on the Cisco IPICS server:
ops/cisco/tomcat/current/webapps/ipics_server/WEB-INF/lib
JiBX Mapping File Contents
The JiBX mapping file is as follows:
<?xml version="1.0" encoding="UTF-8"?>
<binding force-classes="true"
xmlns:nbns="http://com.cisco.ipics.issymo.northbound.service" value-style="element">
<namespace uri="http://com.cisco.ipics.issymo.northbound.service" default="elements"/>
<mapping abstract="true" type-name="nbns:UserContainerVO"
class="com.cisco.ipics.issymo.northbound.service.UserContainerVO" ordered="false">
<collection name="userVOs" field="userVOs"
item-type="com.cisco.ipics.issymo.northbound.service.UserVO" usage="optional"/>
</mapping>
<mapping abstract="true" type-name="nbns:resource"
class="com.cisco.ipics.issymo.northbound.service.Resource" ordered="false">
<value name="id" field="id" usage="optional"/>
<value name="name" field="name" usage="optional"/>
</mapping>
Cisco IPICS API Reference Guide
OL-18330-01
3-1
Chapter 3
JiBX Mapping File
JiBX Mapping File Contents
<mapping name="userVO" class="com.cisco.ipics.issymo.northbound.service.UserVO"
ordered="false">
<structure map-as="nbns:resource"/>
<value name="userLogin" field="userLogin" usage="optional"/>
<value name="firstName" field="firstName" usage="optional"/>
<value name="lastName" field="lastName" usage="optional"/>
</mapping>
<mapping abstract="true" type-name="nbns:UserRoleContainerVO"
class="com.cisco.ipics.issymo.northbound.service.UserRoleContainerVO" ordered="false">
<collection name="userRoleVOs" field="userRoleVOs"
item-type="com.cisco.ipics.issymo.northbound.service.UserRoleVO" usage="optional"/>
</mapping>
<mapping name="userRoleVO"
class="com.cisco.ipics.issymo.northbound.service.UserRoleVO" ordered="false">
<structure map-as="nbns:resource"/>
<value name="displayName" field="displayName" usage="optional"/>
</mapping>
<mapping abstract="true" type-name="nbns:PolicyContainerVO"
class="com.cisco.ipics.issymo.northbound.service.PolicyContainerVO" ordered="false">
<collection name="policyVOs" field="policyVOs"
item-type="com.cisco.ipics.issymo.northbound.service.PolicyVO" usage="optional"/>
</mapping>
<mapping name="policyVO" class="com.cisco.ipics.issymo.northbound.service.PolicyVO"
ordered="false">
<structure map-as="nbns:resource"/>
<value name="description" field="description" usage="optional"/>
</mapping>
<mapping abstract="true" type-name="nbns:PhoneContainerVO"
class="com.cisco.ipics.issymo.northbound.service.PhoneContainerVO" ordered="false">
<collection name="phoneVOs" field="phoneVOs"
item-type="com.cisco.ipics.issymo.northbound.service.PhoneVO" usage="optional"/>
</mapping>
<mapping name="phoneVO" class="com.cisco.ipics.issymo.northbound.service.PhoneVO"
ordered="false">
<structure map-as="nbns:resource"/>
<value name="sipDn" field="sipDn" usage="optional"/>
<value name="dialDestination" field="dialDestination" usage="optional"/>
</mapping>
<mapping abstract="true" type-name="nbns:PolicyExecutionStatusVO"
class="com.cisco.ipics.issymo.northbound.service.PolicyExecutionStatusVO" ordered="false">
<value name="statusMessage" field="statusMessage" usage="optional"/>
<value name="executionDate" field="executionDate" usage="optional"/>
</mapping>
<mapping abstract="true" type-name="nbns:ChannelContainerVO"
class="com.cisco.ipics.issymo.northbound.service.ChannelContainerVO" ordered="false">
<collection name="channelVOs" field="channelVOs"
item-type="com.cisco.ipics.issymo.northbound.service.ChannelVO" usage="optional"/>
</mapping>
<mapping name="channelVO" class="com.cisco.ipics.issymo.northbound.service.ChannelVO"
ordered="false">
<structure map-as="nbns:resource"/>
</mapping>
<mapping abstract="true" type-name="nbns:VtgContainerVO"
class="com.cisco.ipics.issymo.northbound.service.VtgContainerVO" ordered="false">
Cisco IPICS API Reference Guide
3-2
OL-18330-01
Chapter 3
JiBX Mapping File
JiBX Mapping File Contents
<collection name="vtgVOs" field="vtgVOs"
item-type="com.cisco.ipics.issymo.northbound.service.VtgVO" usage="optional"/>
</mapping>
<mapping name="vtgVO" class="com.cisco.ipics.issymo.northbound.service.VtgVO"
ordered="false">
<structure map-as="nbns:resource"/>
</mapping>
<mapping abstract="true" type-name="nbns:ChannelGroupContainerVO"
class="com.cisco.ipics.issymo.northbound.service.ChannelGroupContainerVO" ordered="false">
<collection name="channelGroupVOs" field="channelGroupVOs"
item-type="com.cisco.ipics.issymo.northbound.service.ChannelGroupVO" usage="optional"/>
</mapping>
<mapping name="channelGroupVO"
class="com.cisco.ipics.issymo.northbound.service.ChannelGroupVO" ordered="false">
<structure map-as="nbns:resource"/>
</mapping>
<mapping abstract="true" type-name="nbns:UserGroupContainerVO"
class="com.cisco.ipics.issymo.northbound.service.UserGroupContainerVO" ordered="false">
<collection name="userGroupVOs" field="userGroupVOs"
item-type="com.cisco.ipics.issymo.northbound.service.UserGroupVO" usage="optional"/>
</mapping>
<mapping name="userGroupVO"
class="com.cisco.ipics.issymo.northbound.service.UserGroupVO" ordered="false">
<structure map-as="nbns:resource"/>
</mapping>
<mapping abstract="true" type-name="nbns:NotificationAddressContainerVO"
class="com.cisco.ipics.issymo.northbound.service.NotificationAddressContainerVO"
ordered="false">
<collection name="notificationAddressVOs" field="notificationAddressVOs"
item-type="com.cisco.ipics.issymo.northbound.service.NotificationAddressVO"
usage="optional"/>
</mapping>
<mapping name="notificationAddressVO"
class="com.cisco.ipics.issymo.northbound.service.NotificationAddressVO" ordered="false">
<value name="id" field="id" usage="optional"/>
<value name="type" field="type" usage="optional"/>
<value name="notificationAddress" field="notificationAddress" usage="optional"/>
</mapping>
<mapping abstract="true" type-name="nbns:DialAddressContainerVO"
class="com.cisco.ipics.issymo.northbound.service.DialAddressContainerVO" ordered="false" >
<collection name="dialAddressVOs" field="dialAddressVOs"
item-type="com.cisco.ipics.issymo.northbound.service.DialAddressVO" usage="optional"/>
</mapping>
<mapping name="dialAddressVO"
class="com.cisco.ipics.issymo.northbound.service.DialAddressVO" ordered="false">
<value name="id" field="id" usage="optional"/>
<value name="type" field="type" usage="optional"/>
<value name="dialNumber" field="dialNumber" usage="optional"/>
<value name="dialPreferenceOrder" field="dialPreferenceOrder" usage="optional"/>
</mapping>
<mapping abstract="true" type-name="nbns:VtgParticipantContainerVO"
class="com.cisco.ipics.issymo.northbound.service.VtgParticipantContainerVO"
ordered="false">
Cisco IPICS API Reference Guide
OL-18330-01
3-3
Chapter 3
JiBX Mapping File
JiBX Mapping File Contents
<collection name="userParticipants" field="userParticipants"
item-type="com.cisco.ipics.issymo.northbound.service.VtgParticipantVO" usage="optional"/>
<collection name="userGroupParticipants" field="userGroupParticipants"
item-type="com.cisco.ipics.issymo.northbound.service.VtgParticipantVO" usage="optional"/>
<collection name="channelParticipants" field="channelParticipants"
item-type="com.cisco.ipics.issymo.northbound.service.VtgParticipantVO" usage="optional"/>
<collection name="channelGroupParticipants" field="channelGroupParticipants"
item-type="com.cisco.ipics.issymo.northbound.service.VtgParticipantVO" usage="optional"/>
<collection name="vtgParticipants" field="vtgParticipants"
item-type="com.cisco.ipics.issymo.northbound.service.VtgParticipantVO" usage="optional"/>
</mapping>
<mapping name="vtgParticipantVO"
class="com.cisco.ipics.issymo.northbound.service.VtgParticipantVO" ordered="false">
<structure map-as="nbns:resource"/>
<value name="groupId" field="groupId" usage="optional"/>
<value name="participantId" field="participantId" usage="optional"/>
<value name="resourceType" field="resourceType" usage="optional"/>
<value name="status" field="status" usage="optional"/>
</mapping>
</binding>
Cisco IPICS API Reference Guide
3-4
OL-18330-01
CH A P T E R
4
Web Services Description Language File
The Web Services Description Language (WSDL) file for the Cisco IPICS API defines the functionality
that the API provides. It includes methods that you can invoke and the types of objects that they can
return.
This chapter includes the following topics, which describe how to obtain the WSDL file and show its
contents:
•
Obtaining the WSDL File, page 4-1
•
WSDL File Contents, page 4-1
Obtaining the WSDL File
The API WSDL file is stored on the Cisco IPICS server. To obtain the WSDL file, enter the following
URL in your web browser:
https://<Cisco_IPICS_Server>/ipics_server/services/ NorthboundService?wsdl
Replace <Cisco_IPICS_Server> with the IP address or the host name of the Cisco IPICS server.returns
the Cisco IPICS WSDL. If you are prompted for a name and password, enter your Cisco IPICS user name
and password.
WSDL File Contents
The WSDL for the Cisco IPICS API is as follows:
<wsdl:definitions xmlns:impl="http://com.cisco.ipics.issymo.northbound.service"
xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/"
xmlns:http="http://schemas.xmlsoap.org/wsdl/http/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
targetNamespace="http://com.cisco.ipics.issymo.northbound.service">
<wsdl:documentation>NorthboundService</wsdl:documentation>
<wsdl:types>
<xsd:schema xmlns="http://www.w3.org/2001/XMLSchema"
attributeFormDefault="unqualified" elementFormDefault="qualified"
targetNamespace="http://com.cisco.ipics.issymo.northbound.service">
<xsd:element name="activateVtg">
<xsd:annotation>
Cisco IPICS API Reference Guide
OL-18330-01
4-1
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:documentation>
Description: Activates a VirtualGroup (if not already
activated).
Parameters: vtgId (int) - the id of the virtual group to be
activated.
Returns: true if the virtual group activation was successful,
false if not.
Throws: RemoteException if a virtual group with the given id
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="activateVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="activateVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addChannelToVtg">
<xsd:annotation>
<xsd:documentation>
Description: Adds a channel to an active/inactive VTG.
Parameters: vtgId (int) - the id of the vtg to which the user is
to be added. channelId(int) - the id of the channel to be added
to the specified VTG.
Returns: true if the addition of the channel to the VTG was
successful or the channel is already a participant/member of the
VTG, false if not.
Throws: RemoteException if a virtual group with the given id
does not exist in the system, the channel does not exist in the
system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="channelId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Cisco IPICS API Reference Guide
4-2
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:element name="addChannelToVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="addChannelToVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addPhoneAssociatedToUser">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialNumber" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addPhoneAssociatedToUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="addPhoneAssociatedToUserReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addRadioToVtg">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="radioId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Cisco IPICS API Reference Guide
OL-18330-01
4-3
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:element name="addRadioToVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="addRadioToVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addUserToUserGroup">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userGroupId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addUserToUserGroupResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="addUserToUserGroupReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addUserToVtg">
<xsd:annotation>
<xsd:documentation>
Description: Adds a user participant to an active/inactive VTG.
Parameters: userLogin (String) - the unique login of the user to
be added to the specified VTG. vtgId (int) - the id of the vtg
to which the user is to be added.
Returns: true if the addition of the user to the VTG was
successful or the user is already a participant/member of the
VTG, false if not.
Throws: RemoteException if a virtual group with the given id
does not exist in the system, the user does not exist in the
system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="vtgId" type="int">
Cisco IPICS API Reference Guide
4-4
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addUserToVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="addUserToVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addVtgToVtg">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgIdAdd" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="addVtgToVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="addVtgToVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="associateChannelsToUser">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="channels" type="impl:ChannelContainerVO">
Cisco IPICS API Reference Guide
OL-18330-01
4-5
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="associateChannelsToUserResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="associateRadiosToUser">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="radios" type="impl:RadioContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="associateRadiosToUserResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="createChannel">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="channelName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="channelShortName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
Cisco IPICS API Reference Guide
4-6
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:element>
<xsd:element name="createChannelResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="createChannelReturn" type="int"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="createUser">
<xsd:annotation>
<xsd:documentation>
Description: Creates a user with the specified login name
Parameters: loginName (String) - the unique name of the user to
be created.
Returns: userId(int) of the created user.
Throws: RemoteException if a user with the given name already
exists in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
Create a user based on the supplied user login.
Returns an
exception if a user with this login already exists.
Return an
int as user id.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userPassword" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="firstName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="lastName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="createUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="createUserReturn" type="int"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="createUserGroup">
Cisco IPICS API Reference Guide
OL-18330-01
4-7
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="groupName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="groupDescription" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="createUserGroupResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="createUserGroupReturn" type="int"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="createVtg">
<xsd:annotation>
<xsd:documentation>
Description: Creates a VTG with the specified VTG name
Parameters: vtgName (String) - the unique name of the VTG to be
created.
Returns: vtgId(int) of the created VTG.
Throws: RemoteException if a virtual group with the given name
already exists in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="description" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="createVtgResponse">
<xsd:complexType>
<xsd:sequence>
Cisco IPICS API Reference Guide
4-8
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:element name="createVtgReturn" type="int"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="deactivateVtg">
<xsd:annotation>
<xsd:documentation>
Description: Deactivates a VirtualGroup.
Parameters: vtgId (int) - the id of the virtual group to be
activated.
Returns: true if the virtual group deactivation was successful,
false if not.
Throws: RemoteException if a virtual group with the given id
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="deactivateVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="deactivateVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="deleteChannel">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="channelId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="deleteChannelResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="deleteUser">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
Cisco IPICS API Reference Guide
OL-18330-01
4-9
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:element name="userId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="deleteUserResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="deleteVtg">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="deleteVtgResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="dialAllVtgMembers">
<xsd:annotation>
<xsd:documentation>
Description: Dials out all user members of a VTG, including
members of user groups in the VTG.
Parameters: vtgId (int) the unique identifier of the VTG whose
members are to be dialed out.
Returns: (boolean) true if the dial-out was successful, false
otherwise.
Throws: RemoteException if the VTG with the given id does not
exist in the system, if the VTG is not active or if the
operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="trigger" nillable="true" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
Cisco IPICS API Reference Guide
4-10
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="dialAllVtgMembersResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="dialAllVtgMembersReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="dialVtgMember">
<xsd:annotation>
<xsd:documentation>
Description: Dials out to the specified user member of a VTG.
Parameters: vtgId (int) the unique identifier of the VTG whose
members are to be dialed out. trigger (String) - the name of the
trigger that invokes a custom dial out script.
userLogin - the login name of the member user in the VTG to be
dialed out.
Returns: (boolean) true if the dial-out was successful, false
otherwise.
Throws: RemoteException if the VTG with the given id does not
exist in the system, if the VTG is not active, if user is not a
member of the VTG, if user does not exist or if the operation
fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="trigger" nillable="true" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="dialVtgMemberResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="dialVtgMemberReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="dialVtgMembers">
<xsd:annotation>
<xsd:documentation>
Cisco IPICS API Reference Guide
OL-18330-01
4-11
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userContainer" type="impl:UserContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="dialVtgMembersResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="disableChannel">
<xsd:annotation>
<xsd:documentation>
Description: Changes the channel state to DISABLED. Only
operates iff the current channel state is IDLE.
Parameters: channelId (int) the unique identifier of the channel
being disabled.
Returns: (boolean) true if the channel state is now DISABLED,
false otherwise.
Throws: RemoteException if the channel with the given id does
not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="channelId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="disableChannelResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="disableChannelReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="disableUser">
<xsd:annotation>
<xsd:documentation>
Description: Disables user with the given userLogin.
Parameters: userLogin (string) the unique login of the user
being disabled.
Returns: (boolean) true if the user is disabled, false
otherwise.
Cisco IPICS API Reference Guide
4-12
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="disableUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="disableUserReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="enableChannel">
<xsd:annotation>
<xsd:documentation>
Description: Changes the channel state to IDLE. Only operates
iff the current channel state is DISABLED.
Parameters: channelId (int) the unique identifier of the channel
being enabled.
Returns: (boolean) false if the channel state is still DISABLED,
true otherwise.
Throws: RemoteException if the channel with the given id does
not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="channelId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="enableChannelResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="enableChannelReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="enableUser">
<xsd:annotation>
<xsd:documentation>
Description: Enables user with the given userLogin.
Parameters: userLogin (string) the unique login of the user
being enabled.
Returns: (boolean) true if the user is enabled, false otherwise.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
Cisco IPICS API Reference Guide
OL-18330-01
4-13
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="enableUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="enableUserReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="executeNotificationPolicy">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="policyId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="msgText" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="executeNotificationPolicyResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="executePolicy">
<xsd:annotation>
<xsd:documentation>
Description: Executes the policy with the given policyId.
Parameters: policyId (int) the unique identifier of the policy
being executed.
Returns: (boolean) true if the policy was executed, false
otherwise.
Throws: RemoteException if the policy with the given policyId
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="policyId" type="int">
Cisco IPICS API Reference Guide
4-14
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="executePolicyResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="executePolicyReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllChannelGroups">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the ChannelGroups in the IPICS
System.
Parameters: None.
Returns: Array of ChannelGroupVO wrapped in a
ChannelGroupContainerVO.
Throws: RemoteException if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType/>
</xsd:element>
<xsd:element name="getAllChannelGroupsResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getAllChannelGroupsReturn"
type="impl:ChannelGroupContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllChannels">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the Channels in the IPICS System.
Parameters: None.
Returns: Array of ChannelVO wrapped in a ChannelContainerVO.
Throws: RemoteException if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType/>
</xsd:element>
<xsd:element name="getAllChannelsResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getAllChannelsReturn"
type="impl:ChannelContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllChannelsInChannelGroup">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the Channels in the given
ChannelGroup.
Parameters: channeGroupId (int) the unique identifier of the
ChannelGroup from which to retrieve all channels.
Returns: Array of ChannelVO wrapped in a ChannelContainerVO.
Cisco IPICS API Reference Guide
OL-18330-01
4-15
Chapter 4
Web Services Description Language File
WSDL File Contents
Throws: RemoteException if the ChannelGroup with the given id
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="channelGroupId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllChannelsInChannelGroupResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getAllChannelsInChannelGroupReturn"
type="impl:ChannelContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllPolicies">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the Policies in the IPPE System.
Parameters: None.
Returns: Array of PolicyVO wrapped in a PolicyContainerVO.
Throws: RemoteException if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType/>
</xsd:element>
<xsd:element name="getAllPoliciesResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getAllPoliciesReturn"
type="impl:PolicyContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllRadios">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType/>
</xsd:element>
<xsd:element name="getAllRadiosResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getAllRadiosReturn"
type="impl:RadioContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllUserGroups">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the UserGroups in the IPICS System.
Parameters: None.
Cisco IPICS API Reference Guide
4-16
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
Returns: Array of UserGroupVO wrapped in a
UserGroupContainerVO.
Throws: RemoteException if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType/>
</xsd:element>
<xsd:element name="getAllUserGroupsResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getAllUserGroupsReturn"
type="impl:UserGroupContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllUsers">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the users in the IPICS System.
Parameters: None.
Returns: Array of UserVO wrapped in a UserContainerVO.
Throws: RemoteException if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType/>
</xsd:element>
<xsd:element name="getAllUsersResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getAllUsersReturn" type="impl:UserContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getAllVtgs">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the VirtualGroups in the IPICS
System.
Parameters: None.
Returns: Array of VtgVO wrapped in a VtgContainerVO.
Throws: RemoteException if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType/>
</xsd:element>
<xsd:element name="getAllVtgsResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getAllVtgsReturn" type="impl:VtgContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getBelongingOpsViewForUser">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
Cisco IPICS API Reference Guide
OL-18330-01
4-17
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getBelongingOpsViewForUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getBelongingOpsViewForUserReturn" type="int"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getChannelsAssociatedToUser">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all channels associated to the user with
the given userLogin.
Parameters: userLogin (string) the unique login of the user.
Returns: Array of ChannelVO wrapped in a ChannelContainerVO.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getChannelsAssociatedToUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getChannelsAssociatedToUserReturn"
type="impl:ChannelContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getChannelStatus">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves the status of the channel with the given
channelId.
Parameters: channelId (int) the unique identifier of the channel
whose status is being queried.
Returns: (string) Status of channel (disabled, idle, pending or
active).
Throws: RemoteException if the channel with the given id does
not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="channelId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
Cisco IPICS API Reference Guide
4-18
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getChannelStatusResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getChannelStatusReturn" type="string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getDigitIds">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getDigitIdsResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getDigitIdsReturn" type="string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getDigitPassword">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getDigitPasswordResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getDigitPasswordReturn" type="string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getPhonesAssociatedToUser">
<xsd:annotation>
Cisco IPICS API Reference Guide
OL-18330-01
4-19
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:documentation>
Description: Retrieves all phones associated to the user with
the given userLogin.
Parameters: userLogin (string) the unique login of the user.
Returns: Array of PhoneVO wrapped in a PhoneContainerVO.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getPhonesAssociatedToUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getPhonesAssociatedToUserReturn"
type="impl:PhoneContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getPoliciesAssociatedToUser">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all Policies associated to the user with
the given userLogin.
Parameters: userLogin (string) the unique login of the user.
Returns: Array of PolicyVO wrapped in a PolicyContainerVO.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getPoliciesAssociatedToUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getPoliciesAssociatedToUserReturn"
type="impl:PolicyContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getPolicyExecutionStatus">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves the status of the execution of the policy
Cisco IPICS API Reference Guide
4-20
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
with the given policyId.
Parameters: policyId (int) the unique identifier of the policy
whose execution status is being queried.
Returns: PolicyExecutionStatusVO containing the date and status
of the last execution of the policy with the given policyId.
Throws: RemoteException if the policy with the given policyId
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="policyId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getPolicyExecutionStatusResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getPolicyExecutionStatusReturn"
type="impl:PolicyExecutionStatusVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getRadiosAssociatedToUser">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getRadiosAssociatedToUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getRadiosAssociatedToUserReturn"
type="impl:RadioContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserAddress">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
Cisco IPICS API Reference Guide
OL-18330-01
4-21
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserAddressResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUserAddressReturn" type="impl:AddressVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserAudioStatus">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserAudioStatusResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUserAudioStatusReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserDialPreference">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves the dial preference associated to the
user with the given userLogin.
Parameters: userLogin (string) the unique login of the user.
Returns: Array of DialAddressVO wrapped in
aDialAddressContainerVO.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
Cisco IPICS API Reference Guide
4-22
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:element>
<xsd:element name="getUserDialPreferenceResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUserDialPreferenceReturn"
type="impl:DialAddressContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserGroupMembers">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the users in the given UserGroup.
Parameters: userGroupId (int) the unique identifier of the
UserGroup from which to retrieve all members.
Returns: Array of UserVO wrapped in a UserContainerVO.
Throws: RemoteException if the UserGroup with the given id does
not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userGroupId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserGroupMembersResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUserGroupMembersReturn"
type="impl:UserContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserListenerStatus">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserListenerStatusResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUserListenerStatusReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
Cisco IPICS API Reference Guide
OL-18330-01
4-23
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:element>
<xsd:element name="getUserNotificationPreference">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves the notification preference associated to
the user with the given userLogin.
Parameters: userLogin (string) the unique login of the user.
Returns: Array of NotificationAddressVO wrapped in a
NotificationAddressContainerVO.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserNotificationPreferenceResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUserNotificationPreferenceReturn"
type="impl:NotificationAddressContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserRoles">
<xsd:annotation>
<xsd:documentation>
Description: Gets the list of roles for a user.
Parameters: userLogin (string) the unique login of the user
whose roles should be queried.
Returns an array of UserRoleVO wrapped in a UserRoleContainerVO.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserRolesResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUserRolesReturn"
type="impl:UserRoleContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Cisco IPICS API Reference Guide
4-24
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:element name="getUsersAssociatedToRadio">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="radioId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUsersAssociatedToRadioResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUsersAssociatedToRadioReturn"
type="impl:UserContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserStatus">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getUserStatusResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getUserStatusReturn" type="string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getVtgParticipants">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all the participants in the given VTG.
Parameters: vtgId (int) the unique identifier of the VTG from
which to retrieve all partcipants.
Returns: VtgParticipantContainerVO which consists of an array of
VtgParticipantVO for each possible type of VTG participant:
users, user groups, channels, channel groups and vtgs.
Throws: RemoteException if the VTG with the given id does not
exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
Cisco IPICS API Reference Guide
OL-18330-01
4-25
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getVtgParticipantsResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getVtgParticipantsReturn"
type="impl:VtgParticipantContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getVtgParticipantStatus">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves the status of the VTG participant.
Parameters: participantID (int) the unique identifier of the
participant of whose status is being queried. resourceType
(String) the participant's type: user, user-group, channel,
channel-group or vtg . vtgId (int) the unique identifier of the
VirtualGroup of whose participant's status is being queried.
Returns: (string) Status of VirtualGroup participant
(disconnected, error, pending or active).
Throws: RemoteException if the VirtualGroup with the given id
does not exist in the system, if it is not active, if the
participant with the given id doesn't exist in the system, if
the resource type is invalid or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="participantId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="resourceType" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getVtgParticipantStatusResponse">
Cisco IPICS API Reference Guide
4-26
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getVtgParticipantStatusReturn" type="string"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getVtgsAssociatedToUser">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves all VirtualGroups associated to the user
with the given userLogin.
Parameters: userLogin (string) the unique login of the user.
Returns: Array of VtgVO wrapped in a VtgContainerVO.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getVtgsAssociatedToUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="getVtgsAssociatedToUserReturn"
type="impl:VtgContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getVtgStatus">
<xsd:annotation>
<xsd:documentation>
Description: Retrieves the status of the VirtualGroup with the
given vtglId.
Parameters: vtgId (int) the unique identifier of the
VirtualGroup whose status is being queried.
Returns: (string) Status of VirtualGroup (idle, pending or
active).
Throws: RemoteException if the VirtualGroup with the given id
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="getVtgStatusResponse">
<xsd:complexType>
Cisco IPICS API Reference Guide
OL-18330-01
4-27
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:sequence>
<xsd:element name="getVtgStatusReturn" type="impl:VtgContainerVO"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="isActiveChannel">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="channelId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="isActiveChannelResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="isActiveChannelReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="isActiveUser">
<xsd:annotation>
<xsd:documentation>
Description: Checks whether the user is active or disabled.
Parameters: userLogin (string) the unique login of the user.
Returns: (boolean) true if User is active otherwise returns
false.
Throws: RemoteException if the user with the given userLogin
does not exist in the system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="isActiveUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="isActiveUserReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="isActiveVtg">
<xsd:annotation>
<xsd:documentation>
Cisco IPICS API Reference Guide
4-28
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="isActiveVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="isActiveVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="notifyAllVtgMembers">
<xsd:annotation>
<xsd:documentation>
Description: Notifies all user members of a VTG, including
members of user groups in the VTG.
Parameters: vtgId (int) the unique identifier of the VTG whose
members are to be notified.
Returns: (boolean) true if the notification was successful,
false otherwise.
Throws: RemoteException if the VTG with the given id does not
exist in the system, if the VTG is not active or if the
operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="notifyAllVtgMembersResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="notifyAllVtgMembersReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="notifyVtgMember">
<xsd:annotation>
<xsd:documentation>
Description: Notifies the specified user member of a VTG.
Parameters: vtgId (int) the unique identifier of the VTG whose
members are to be notified. userLogin (String) the login of the
user to be notified.
Returns: (boolean) true if the notification was successful,
false otherwise.
Throws: RemoteException if the VTG with the given id does not
Cisco IPICS API Reference Guide
OL-18330-01
4-29
Chapter 4
Web Services Description Language File
WSDL File Contents
exist in the system, if the VTG is not active, is user is not a
particpant, if user does not exist or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="notifyVtgMemberResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="notifyVtgMemberReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="notifyVtgMembers">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userContainer" type="impl:UserContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="subject" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="message" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
Cisco IPICS API Reference Guide
4-30
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:annotation>
</xsd:element>
<xsd:element name="audioFile" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="notifyVtgMembersResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="removeChannelFromVtg">
<xsd:annotation>
<xsd:documentation>
Description: Removes a channel participant from a VTG.
Parameters: vtgId (int) - the id of the vtg from which the
channel is to be removed. channelId (int) - the id of the
channel to be removed from the VTG.
Returns: true if the removal of the channel from the VTG was
successful, false if not.
Throws: RemoteException if a virtual group with the given id
does not exist in the system, the channel does not exist in the
system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="channelId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="removeChannelFromVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="removeChannelFromVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="removePhoneAssociatedToUser">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
Cisco IPICS API Reference Guide
OL-18330-01
4-31
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialNumber" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="removePhoneAssociatedToUserResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="removePhoneAssociatedToUserReturn"
type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="removeUserFromVtg">
<xsd:annotation>
<xsd:documentation>
Description: Removes a user participant/member from a VTG.
Parameters: userLogin (String) - the unique login of the user to
be removed from the specified VTG. vtgId (int) - the id of the
vtg from which the user is to be removed.
Returns: true if the removal of the user from the VTG was
successful or the user is already a participant of the VTG,
false if not.
Throws: RemoteException if a virtual group with the given id
does not exist in the system, the user does not exist in the
system or if the operation fails.
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="removeUserFromVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="removeUserFromVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
Cisco IPICS API Reference Guide
4-32
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:element>
<xsd:element name="removeVtgFromVtg">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="vtgIdRem" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="vtgId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="removeVtgFromVtgResponse">
<xsd:complexType>
<xsd:sequence>
<xsd:element name="removeVtgFromVtgReturn" type="boolean"/>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="setBelongingOpsViewForUser">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="opsViewId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="setBelongingOpsViewForUserResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="setDialPreference">
<xsd:annotation>
<xsd:documentation>
Cisco IPICS API Reference Guide
OL-18330-01
4-33
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialType" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialNumber" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialOrder" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="setDialPreferenceResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="setDigitIds">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="digitIds" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
Cisco IPICS API Reference Guide
4-34
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:element name="setDigitIdsResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="setDigitPassword">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="password" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="setDigitPasswordResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="setNotificationPreference">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="notificationType" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="notificationAddress" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="setNotificationPreferenceResponse">
Cisco IPICS API Reference Guide
OL-18330-01
4-35
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:complexType/>
</xsd:element>
<xsd:element name="setUserAddress">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="address" type="impl:AddressVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="setUserAddressResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="setUserAudioStatus">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="audioDisable" type="boolean">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="setUserAudioStatusResponse">
<xsd:complexType/>
</xsd:element>
<xsd:element name="setUserListenerStatus">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
Cisco IPICS API Reference Guide
4-36
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:complexType>
<xsd:sequence>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="mute" type="boolean">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<xsd:element name="setUserListenerStatusResponse">
<xsd:complexType/>
</xsd:element>
<xsd:complexType name="AddressVO">
<xsd:all>
<xsd:element name="street" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="streetExtra" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="city" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="state" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="zip" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="country" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
Cisco IPICS API Reference Guide
OL-18330-01
4-37
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ChannelContainerVO">
<xsd:all>
<xsd:element name="channelVOs" nillable="true"
type="impl:ArrayOfChannelVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ChannelGroupContainerVO">
<xsd:all>
<xsd:element name="channelGroupVOs" nillable="true"
type="impl:ArrayOfChannelGroupVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfChannelGroupVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="channelGroupVO" type="impl:ChannelGroupVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ChannelGroupVO">
<xsd:all>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="channelGroupContainerVO"
type="impl:ChannelGroupContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfChannelVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="channelVO" type="impl:ChannelVO"/>
Cisco IPICS API Reference Guide
4-38
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ChannelVO">
<xsd:all>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="channelContainerVO" type="impl:ChannelContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="DialAddressContainerVO">
<xsd:all>
<xsd:element name="dialAddressVOs" nillable="true"
type="impl:ArrayOfDialAddressVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfDialAddressVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="dialAddressVO" type="impl:DialAddressVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="DialAddressVO">
<xsd:all>
<xsd:element name="dialNumber" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialPreferenceOrder" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="type" type="string">
<xsd:annotation>
<xsd:documentation>
Cisco IPICS API Reference Guide
OL-18330-01
4-39
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialAddressContainerVO"
type="impl:DialAddressContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="NotificationAddressContainerVO">
<xsd:all>
<xsd:element name="notificationAddressVOs" nillable="true"
type="impl:ArrayOfNotificationAddressVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfNotificationAddressVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="notificationAddressVO" type="impl:NotificationAddressVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="NotificationAddressVO">
<xsd:all>
<xsd:element name="notificationAddress" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="type" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="notificationAddressContainerVO"
type="impl:NotificationAddressContainerVO">
Cisco IPICS API Reference Guide
4-40
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="PhoneContainerVO">
<xsd:all>
<xsd:element name="phoneVOs" nillable="true"
type="impl:ArrayOfPhoneVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfPhoneVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="phoneVO" type="impl:PhoneVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="PhoneVO">
<xsd:all>
<xsd:element name="sipDn" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="dialDestination" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="phoneContainerVO" type="impl:PhoneContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
Cisco IPICS API Reference Guide
OL-18330-01
4-41
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:complexType>
<xsd:complexType name="PolicyContainerVO">
<xsd:all>
<xsd:element name="policyVOs" nillable="true"
type="impl:ArrayOfPolicyVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="PolicyExecutionStatusVO">
<xsd:all>
<xsd:element name="statusMessage" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="executionDate" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfPolicyVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="policyVO" type="impl:PolicyVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="PolicyVO">
<xsd:all>
<xsd:element name="description" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="policyContainerVO" type="impl:PolicyContainerVO">
<xsd:annotation>
<xsd:documentation>
Cisco IPICS API Reference Guide
4-42
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="RadioContainerVO">
<xsd:all>
<xsd:element name="radioVOs" nillable="true"
type="impl:ArrayOfRadioVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfRadioVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="radioVO" type="impl:RadioVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="RadioVO">
<xsd:all>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="radioContainerVO" type="impl:RadioContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="UserContainerVO">
<xsd:all>
<xsd:element name="userVOs" nillable="true" type="impl:ArrayOfUserVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="UserGroupContainerVO">
<xsd:all>
<xsd:element name="userGroupVOs" nillable="true"
type="impl:ArrayOfUserGroupVO">
<xsd:annotation>
Cisco IPICS API Reference Guide
OL-18330-01
4-43
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfUserGroupVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="userGroupVO" type="impl:UserGroupVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="UserGroupVO">
<xsd:all>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userGroupContainerVO"
type="impl:UserGroupContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="UserRoleContainerVO">
<xsd:all>
<xsd:element name="userRoleVOs" nillable="true"
type="impl:ArrayOfUserRoleVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfUserRoleVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="userRoleVO" type="impl:UserRoleVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="UserRoleVO">
<xsd:all>
<xsd:element name="displayName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
Cisco IPICS API Reference Guide
4-44
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:annotation>
</xsd:element>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userRoleContainerVO"
type="impl:UserRoleContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfUserVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="userVO" type="impl:UserVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="UserVO">
<xsd:all>
<xsd:element name="userLogin" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="firstName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="lastName" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
Cisco IPICS API Reference Guide
OL-18330-01
4-45
Chapter 4
Web Services Description Language File
WSDL File Contents
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userContainerVO" type="impl:UserContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="VtgContainerVO">
<xsd:all>
<xsd:element name="vtgVOs" nillable="true" type="impl:ArrayOfVtgVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="VtgParticipantContainerVO">
<xsd:all>
<xsd:element name="userParticipants"
type="impl:ArrayOfVtgParticipantVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="userGroupParticipants"
type="impl:ArrayOfVtgParticipantVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="channelParticipants"
type="impl:ArrayOfVtgParticipantVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="channelGroupParticipants"
type="impl:ArrayOfVtgParticipantVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="vtgParticipants"
type="impl:ArrayOfVtgParticipantVO">
<xsd:annotation>
<xsd:documentation>
Cisco IPICS API Reference Guide
4-46
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="radioParticipants"
type="impl:ArrayOfVtgParticipantVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="VtgParticipantVO">
<xsd:all>
<xsd:element name="participantId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="resourceType" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="groupId" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="status" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
<xsd:complexType name="ArrayOfVtgParticipantVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="vtgParticipantVO" type="impl:VtgParticipantVO"/>
</xsd:sequence>
Cisco IPICS API Reference Guide
OL-18330-01
4-47
Chapter 4
Web Services Description Language File
WSDL File Contents
</xsd:complexType>
<xsd:complexType name="ArrayOfVtgVO">
<xsd:sequence>
<xsd:element form="qualified" maxOccurs="unbounded" minOccurs="0"
name="vtgVO" type="impl:VtgVO"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="VtgVO">
<xsd:all>
<xsd:element name="description" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="status" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="name" type="string">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="id" type="int">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="vtgContainerVO" type="impl:VtgContainerVO">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
</xsd:complexType>
</xsd:schema>
</wsdl:types>
<wsdl:message name="addPhoneAssociatedToUser3Request">
<wsdl:part name="part1" element="impl:addPhoneAssociatedToUser"/>
</wsdl:message>
<wsdl:message name="addPhoneAssociatedToUser3Response">
<wsdl:part name="part1" element="impl:addPhoneAssociatedToUserResponse"/>
</wsdl:message>
<wsdl:message name="getRadiosAssociatedToUser43Request">
<wsdl:part name="part1" element="impl:getRadiosAssociatedToUser"/>
</wsdl:message>
<wsdl:message name="getRadiosAssociatedToUser43Response">
<wsdl:part name="part1" element="impl:getRadiosAssociatedToUserResponse"/>
</wsdl:message>
<wsdl:message name="getAllVtgs34Request">
<wsdl:part name="part1" element="impl:getAllVtgs"/>
</wsdl:message>
<wsdl:message name="getAllVtgs34Response">
Cisco IPICS API Reference Guide
4-48
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:part name="part1" element="impl:getAllVtgsResponse"/>
</wsdl:message>
<wsdl:message name="getUserAudioStatus45Request">
<wsdl:part name="part1" element="impl:getUserAudioStatus"/>
</wsdl:message>
<wsdl:message name="getUserAudioStatus45Response">
<wsdl:part name="part1" element="impl:getUserAudioStatusResponse"/>
</wsdl:message>
<wsdl:message name="addVtgToVtg7Request">
<wsdl:part name="part1" element="impl:addVtgToVtg"/>
</wsdl:message>
<wsdl:message name="addVtgToVtg7Response">
<wsdl:part name="part1" element="impl:addVtgToVtgResponse"/>
</wsdl:message>
<wsdl:message name="setDigitPassword70Request">
<wsdl:part name="part1" element="impl:setDigitPassword"/>
</wsdl:message>
<wsdl:message name="setDigitPassword70Response">
<wsdl:part name="part1" element="impl:setDigitPasswordResponse"/>
</wsdl:message>
<wsdl:message name="associateRadiosToUser9Request">
<wsdl:part name="part1" element="impl:associateRadiosToUser"/>
</wsdl:message>
<wsdl:message name="associateRadiosToUser9Response">
<wsdl:part name="part1" element="impl:associateRadiosToUserResponse"/>
</wsdl:message>
<wsdl:message name="getUserStatus52Request">
<wsdl:part name="part1" element="impl:getUserStatus"/>
</wsdl:message>
<wsdl:message name="getUserStatus52Response">
<wsdl:part name="part1" element="impl:getUserStatusResponse"/>
</wsdl:message>
<wsdl:message name="deleteUser16Request">
<wsdl:part name="part1" element="impl:deleteUser"/>
</wsdl:message>
<wsdl:message name="deleteUser16Response">
<wsdl:part name="part1" element="impl:deleteUserResponse"/>
</wsdl:message>
<wsdl:message name="getUserRoles50Request">
<wsdl:part name="part1" element="impl:getUserRoles"/>
</wsdl:message>
<wsdl:message name="getUserRoles50Response">
<wsdl:part name="part1" element="impl:getUserRolesResponse"/>
</wsdl:message>
<wsdl:message name="removeUserFromVtg65Request">
<wsdl:part name="part1" element="impl:removeUserFromVtg"/>
</wsdl:message>
<wsdl:message name="removeUserFromVtg65Response">
<wsdl:part name="part1" element="impl:removeUserFromVtgResponse"/>
</wsdl:message>
<wsdl:message name="notifyAllVtgMembers60Request">
<wsdl:part name="part1" element="impl:notifyAllVtgMembers"/>
</wsdl:message>
<wsdl:message name="notifyAllVtgMembers60Response">
<wsdl:part name="part1" element="impl:notifyAllVtgMembersResponse"/>
</wsdl:message>
<wsdl:message name="getChannelsAssociatedToUser36Request">
<wsdl:part name="part1" element="impl:getChannelsAssociatedToUser"/>
</wsdl:message>
<wsdl:message name="getChannelsAssociatedToUser36Response">
<wsdl:part name="part1" element="impl:getChannelsAssociatedToUserResponse"/>
</wsdl:message>
<wsdl:message name="deleteVtg17Request">
<wsdl:part name="part1" element="impl:deleteVtg"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-49
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:message>
<wsdl:message name="deleteVtg17Response">
<wsdl:part name="part1" element="impl:deleteVtgResponse"/>
</wsdl:message>
<wsdl:message name="notifyVtgMembers62Request">
<wsdl:part name="part1" element="impl:notifyVtgMembers"/>
</wsdl:message>
<wsdl:message name="notifyVtgMembers62Response">
<wsdl:part name="part1" element="impl:notifyVtgMembersResponse"/>
</wsdl:message>
<wsdl:message name="addRadioToVtg4Request">
<wsdl:part name="part1" element="impl:addRadioToVtg"/>
</wsdl:message>
<wsdl:message name="addRadioToVtg4Response">
<wsdl:part name="part1" element="impl:addRadioToVtgResponse"/>
</wsdl:message>
<wsdl:message name="getAllChannels28Request">
<wsdl:part name="part1" element="impl:getAllChannels"/>
</wsdl:message>
<wsdl:message name="getAllChannels28Response">
<wsdl:part name="part1" element="impl:getAllChannelsResponse"/>
</wsdl:message>
<wsdl:message name="getAllChannelGroups27Request">
<wsdl:part name="part1" element="impl:getAllChannelGroups"/>
</wsdl:message>
<wsdl:message name="getAllChannelGroups27Response">
<wsdl:part name="part1" element="impl:getAllChannelGroupsResponse"/>
</wsdl:message>
<wsdl:message name="getAllUserGroups32Request">
<wsdl:part name="part1" element="impl:getAllUserGroups"/>
</wsdl:message>
<wsdl:message name="getAllUserGroups32Response">
<wsdl:part name="part1" element="impl:getAllUserGroupsResponse"/>
</wsdl:message>
<wsdl:message name="setDigitIds69Request">
<wsdl:part name="part1" element="impl:setDigitIds"/>
</wsdl:message>
<wsdl:message name="setDigitIds69Response">
<wsdl:part name="part1" element="impl:setDigitIdsResponse"/>
</wsdl:message>
<wsdl:message name="getUserNotificationPreference49Request">
<wsdl:part name="part1" element="impl:getUserNotificationPreference"/>
</wsdl:message>
<wsdl:message name="getUserNotificationPreference49Response">
<wsdl:part name="part1" element="impl:getUserNotificationPreferenceResponse"/>
</wsdl:message>
<wsdl:message name="removeVtgFromVtg66Request">
<wsdl:part name="part1" element="impl:removeVtgFromVtg"/>
</wsdl:message>
<wsdl:message name="removeVtgFromVtg66Response">
<wsdl:part name="part1" element="impl:removeVtgFromVtgResponse"/>
</wsdl:message>
<wsdl:message name="getUserListenerStatus48Request">
<wsdl:part name="part1" element="impl:getUserListenerStatus"/>
</wsdl:message>
<wsdl:message name="getUserListenerStatus48Response">
<wsdl:part name="part1" element="impl:getUserListenerStatusResponse"/>
</wsdl:message>
<wsdl:message name="getUserGroupMembers47Request">
<wsdl:part name="part1" element="impl:getUserGroupMembers"/>
</wsdl:message>
<wsdl:message name="getUserGroupMembers47Response">
<wsdl:part name="part1" element="impl:getUserGroupMembersResponse"/>
</wsdl:message>
Cisco IPICS API Reference Guide
4-50
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:message name="activateVtg1Request">
<wsdl:part name="part1" element="impl:activateVtg"/>
</wsdl:message>
<wsdl:message name="activateVtg1Response">
<wsdl:part name="part1" element="impl:activateVtgResponse"/>
</wsdl:message>
<wsdl:message name="getAllRadios31Request">
<wsdl:part name="part1" element="impl:getAllRadios"/>
</wsdl:message>
<wsdl:message name="getAllRadios31Response">
<wsdl:part name="part1" element="impl:getAllRadiosResponse"/>
</wsdl:message>
<wsdl:message name="getPoliciesAssociatedToUser41Request">
<wsdl:part name="part1" element="impl:getPoliciesAssociatedToUser"/>
</wsdl:message>
<wsdl:message name="getPoliciesAssociatedToUser41Response">
<wsdl:part name="part1" element="impl:getPoliciesAssociatedToUserResponse"/>
</wsdl:message>
<wsdl:message name="disableChannel21Request">
<wsdl:part name="part1" element="impl:disableChannel"/>
</wsdl:message>
<wsdl:message name="disableChannel21Response">
<wsdl:part name="part1" element="impl:disableChannelResponse"/>
</wsdl:message>
<wsdl:message name="getUsersAssociatedToRadio51Request">
<wsdl:part name="part1" element="impl:getUsersAssociatedToRadio"/>
</wsdl:message>
<wsdl:message name="getUsersAssociatedToRadio51Response">
<wsdl:part name="part1" element="impl:getUsersAssociatedToRadioResponse"/>
</wsdl:message>
<wsdl:message name="isActiveUser58Request">
<wsdl:part name="part1" element="impl:isActiveUser"/>
</wsdl:message>
<wsdl:message name="isActiveUser58Response">
<wsdl:part name="part1" element="impl:isActiveUserResponse"/>
</wsdl:message>
<wsdl:message name="dialAllVtgMembers18Request">
<wsdl:part name="part1" element="impl:dialAllVtgMembers"/>
</wsdl:message>
<wsdl:message name="dialAllVtgMembers18Response">
<wsdl:part name="part1" element="impl:dialAllVtgMembersResponse"/>
</wsdl:message>
<wsdl:message name="getPhonesAssociatedToUser40Request">
<wsdl:part name="part1" element="impl:getPhonesAssociatedToUser"/>
</wsdl:message>
<wsdl:message name="getPhonesAssociatedToUser40Response">
<wsdl:part name="part1" element="impl:getPhonesAssociatedToUserResponse"/>
</wsdl:message>
<wsdl:message name="getVtgStatus56Request">
<wsdl:part name="part1" element="impl:getVtgStatus"/>
</wsdl:message>
<wsdl:message name="getVtgStatus56Response">
<wsdl:part name="part1" element="impl:getVtgStatusResponse"/>
</wsdl:message>
<wsdl:message name="addChannelToVtg2Request">
<wsdl:part name="part1" element="impl:addChannelToVtg"/>
</wsdl:message>
<wsdl:message name="addChannelToVtg2Response">
<wsdl:part name="part1" element="impl:addChannelToVtgResponse"/>
</wsdl:message>
<wsdl:message name="getPolicyExecutionStatus42Request">
<wsdl:part name="part1" element="impl:getPolicyExecutionStatus"/>
</wsdl:message>
<wsdl:message name="getPolicyExecutionStatus42Response">
Cisco IPICS API Reference Guide
OL-18330-01
4-51
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:part name="part1" element="impl:getPolicyExecutionStatusResponse"/>
</wsdl:message>
<wsdl:message name="setUserListenerStatus74Request">
<wsdl:part name="part1" element="impl:setUserListenerStatus"/>
</wsdl:message>
<wsdl:message name="setUserListenerStatus74Response">
<wsdl:part name="part1" element="impl:setUserListenerStatusResponse"/>
</wsdl:message>
<wsdl:message name="isActiveVtg59Request">
<wsdl:part name="part1" element="impl:isActiveVtg"/>
</wsdl:message>
<wsdl:message name="isActiveVtg59Response">
<wsdl:part name="part1" element="impl:isActiveVtgResponse"/>
</wsdl:message>
<wsdl:message name="setUserAudioStatus73Request">
<wsdl:part name="part1" element="impl:setUserAudioStatus"/>
</wsdl:message>
<wsdl:message name="setUserAudioStatus73Response">
<wsdl:part name="part1" element="impl:setUserAudioStatusResponse"/>
</wsdl:message>
<wsdl:message name="createUserGroup12Request">
<wsdl:part name="part1" element="impl:createUserGroup"/>
</wsdl:message>
<wsdl:message name="createUserGroup12Response">
<wsdl:part name="part1" element="impl:createUserGroupResponse"/>
</wsdl:message>
<wsdl:message name="enableChannel23Request">
<wsdl:part name="part1" element="impl:enableChannel"/>
</wsdl:message>
<wsdl:message name="enableChannel23Response">
<wsdl:part name="part1" element="impl:enableChannelResponse"/>
</wsdl:message>
<wsdl:message name="enableUser24Request">
<wsdl:part name="part1" element="impl:enableUser"/>
</wsdl:message>
<wsdl:message name="enableUser24Response">
<wsdl:part name="part1" element="impl:enableUserResponse"/>
</wsdl:message>
<wsdl:message name="deactivateVtg14Request">
<wsdl:part name="part1" element="impl:deactivateVtg"/>
</wsdl:message>
<wsdl:message name="deactivateVtg14Response">
<wsdl:part name="part1" element="impl:deactivateVtgResponse"/>
</wsdl:message>
<wsdl:message name="getVtgParticipantStatus54Request">
<wsdl:part name="part1" element="impl:getVtgParticipantStatus"/>
</wsdl:message>
<wsdl:message name="getVtgParticipantStatus54Response">
<wsdl:part name="part1" element="impl:getVtgParticipantStatusResponse"/>
</wsdl:message>
<wsdl:message name="getBelongingOpsViewForUser35Request">
<wsdl:part name="part1" element="impl:getBelongingOpsViewForUser"/>
</wsdl:message>
<wsdl:message name="getBelongingOpsViewForUser35Response">
<wsdl:part name="part1" element="impl:getBelongingOpsViewForUserResponse"/>
</wsdl:message>
<wsdl:message name="getChannelStatus37Request">
<wsdl:part name="part1" element="impl:getChannelStatus"/>
</wsdl:message>
<wsdl:message name="getChannelStatus37Response">
<wsdl:part name="part1" element="impl:getChannelStatusResponse"/>
</wsdl:message>
<wsdl:message name="removePhoneAssociatedToUser64Request">
<wsdl:part name="part1" element="impl:removePhoneAssociatedToUser"/>
Cisco IPICS API Reference Guide
4-52
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:message>
<wsdl:message name="removePhoneAssociatedToUser64Response">
<wsdl:part name="part1" element="impl:removePhoneAssociatedToUserResponse"/>
</wsdl:message>
<wsdl:message name="addUserToUserGroup5Request">
<wsdl:part name="part1" element="impl:addUserToUserGroup"/>
</wsdl:message>
<wsdl:message name="addUserToUserGroup5Response">
<wsdl:part name="part1" element="impl:addUserToUserGroupResponse"/>
</wsdl:message>
<wsdl:message name="getUserDialPreference46Request">
<wsdl:part name="part1" element="impl:getUserDialPreference"/>
</wsdl:message>
<wsdl:message name="getUserDialPreference46Response">
<wsdl:part name="part1" element="impl:getUserDialPreferenceResponse"/>
</wsdl:message>
<wsdl:message name="associateChannelsToUser8Request">
<wsdl:part name="part1" element="impl:associateChannelsToUser"/>
</wsdl:message>
<wsdl:message name="associateChannelsToUser8Response">
<wsdl:part name="part1" element="impl:associateChannelsToUserResponse"/>
</wsdl:message>
<wsdl:message name="setUserAddress72Request">
<wsdl:part name="part1" element="impl:setUserAddress"/>
</wsdl:message>
<wsdl:message name="setUserAddress72Response">
<wsdl:part name="part1" element="impl:setUserAddressResponse"/>
</wsdl:message>
<wsdl:message name="getUserAddress44Request">
<wsdl:part name="part1" element="impl:getUserAddress"/>
</wsdl:message>
<wsdl:message name="getUserAddress44Response">
<wsdl:part name="part1" element="impl:getUserAddressResponse"/>
</wsdl:message>
<wsdl:message name="getAllPolicies30Request">
<wsdl:part name="part1" element="impl:getAllPolicies"/>
</wsdl:message>
<wsdl:message name="getAllPolicies30Response">
<wsdl:part name="part1" element="impl:getAllPoliciesResponse"/>
</wsdl:message>
<wsdl:message name="executePolicy26Request">
<wsdl:part name="part1" element="impl:executePolicy"/>
</wsdl:message>
<wsdl:message name="executePolicy26Response">
<wsdl:part name="part1" element="impl:executePolicyResponse"/>
</wsdl:message>
<wsdl:message name="setDialPreference68Request">
<wsdl:part name="part1" element="impl:setDialPreference"/>
</wsdl:message>
<wsdl:message name="setDialPreference68Response">
<wsdl:part name="part1" element="impl:setDialPreferenceResponse"/>
</wsdl:message>
<wsdl:message name="getVtgsAssociatedToUser55Request">
<wsdl:part name="part1" element="impl:getVtgsAssociatedToUser"/>
</wsdl:message>
<wsdl:message name="getVtgsAssociatedToUser55Response">
<wsdl:part name="part1" element="impl:getVtgsAssociatedToUserResponse"/>
</wsdl:message>
<wsdl:message name="addUserToVtg6Request">
<wsdl:part name="part1" element="impl:addUserToVtg"/>
</wsdl:message>
<wsdl:message name="addUserToVtg6Response">
<wsdl:part name="part1" element="impl:addUserToVtgResponse"/>
</wsdl:message>
Cisco IPICS API Reference Guide
OL-18330-01
4-53
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:message name="getAllUsers33Request">
<wsdl:part name="part1" element="impl:getAllUsers"/>
</wsdl:message>
<wsdl:message name="getAllUsers33Response">
<wsdl:part name="part1" element="impl:getAllUsersResponse"/>
</wsdl:message>
<wsdl:message name="getVtgParticipants53Request">
<wsdl:part name="part1" element="impl:getVtgParticipants"/>
</wsdl:message>
<wsdl:message name="getVtgParticipants53Response">
<wsdl:part name="part1" element="impl:getVtgParticipantsResponse"/>
</wsdl:message>
<wsdl:message name="createVtg13Request">
<wsdl:part name="part1" element="impl:createVtg"/>
</wsdl:message>
<wsdl:message name="createVtg13Response">
<wsdl:part name="part1" element="impl:createVtgResponse"/>
</wsdl:message>
<wsdl:message name="notifyVtgMember61Request">
<wsdl:part name="part1" element="impl:notifyVtgMember"/>
</wsdl:message>
<wsdl:message name="notifyVtgMember61Response">
<wsdl:part name="part1" element="impl:notifyVtgMemberResponse"/>
</wsdl:message>
<wsdl:message name="dialVtgMember19Request">
<wsdl:part name="part1" element="impl:dialVtgMember"/>
</wsdl:message>
<wsdl:message name="dialVtgMember19Response">
<wsdl:part name="part1" element="impl:dialVtgMemberResponse"/>
</wsdl:message>
<wsdl:message name="dialVtgMembers20Request">
<wsdl:part name="part1" element="impl:dialVtgMembers"/>
</wsdl:message>
<wsdl:message name="dialVtgMembers20Response">
<wsdl:part name="part1" element="impl:dialVtgMembersResponse"/>
</wsdl:message>
<wsdl:message name="isActiveChannel57Request">
<wsdl:part name="part1" element="impl:isActiveChannel"/>
</wsdl:message>
<wsdl:message name="isActiveChannel57Response">
<wsdl:part name="part1" element="impl:isActiveChannelResponse"/>
</wsdl:message>
<wsdl:message name="removeChannelFromVtg63Request">
<wsdl:part name="part1" element="impl:removeChannelFromVtg"/>
</wsdl:message>
<wsdl:message name="removeChannelFromVtg63Response">
<wsdl:part name="part1" element="impl:removeChannelFromVtgResponse"/>
</wsdl:message>
<wsdl:message name="deleteChannel15Request">
<wsdl:part name="part1" element="impl:deleteChannel"/>
</wsdl:message>
<wsdl:message name="deleteChannel15Response">
<wsdl:part name="part1" element="impl:deleteChannelResponse"/>
</wsdl:message>
<wsdl:message name="createChannel10Request">
<wsdl:part name="part1" element="impl:createChannel"/>
</wsdl:message>
<wsdl:message name="createChannel10Response">
<wsdl:part name="part1" element="impl:createChannelResponse"/>
</wsdl:message>
<wsdl:message name="getAllChannelsInChannelGroup29Request">
<wsdl:part name="part1" element="impl:getAllChannelsInChannelGroup"/>
</wsdl:message>
<wsdl:message name="getAllChannelsInChannelGroup29Response">
Cisco IPICS API Reference Guide
4-54
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:part name="part1" element="impl:getAllChannelsInChannelGroupResponse"/>
</wsdl:message>
<wsdl:message name="getDigitIds38Request">
<wsdl:part name="part1" element="impl:getDigitIds"/>
</wsdl:message>
<wsdl:message name="getDigitIds38Response">
<wsdl:part name="part1" element="impl:getDigitIdsResponse"/>
</wsdl:message>
<wsdl:message name="setNotificationPreference71Request">
<wsdl:part name="part1" element="impl:setNotificationPreference"/>
</wsdl:message>
<wsdl:message name="setNotificationPreference71Response">
<wsdl:part name="part1" element="impl:setNotificationPreferenceResponse"/>
</wsdl:message>
<wsdl:message name="setBelongingOpsViewForUser67Request">
<wsdl:part name="part1" element="impl:setBelongingOpsViewForUser"/>
</wsdl:message>
<wsdl:message name="setBelongingOpsViewForUser67Response">
<wsdl:part name="part1" element="impl:setBelongingOpsViewForUserResponse"/>
</wsdl:message>
<wsdl:message name="executeNotificationPolicy25Request">
<wsdl:part name="part1" element="impl:executeNotificationPolicy"/>
</wsdl:message>
<wsdl:message name="executeNotificationPolicy25Response">
<wsdl:part name="part1" element="impl:executeNotificationPolicyResponse"/>
</wsdl:message>
<wsdl:message name="disableUser22Request">
<wsdl:part name="part1" element="impl:disableUser"/>
</wsdl:message>
<wsdl:message name="disableUser22Response">
<wsdl:part name="part1" element="impl:disableUserResponse"/>
</wsdl:message>
<wsdl:message name="createUser11Request">
<wsdl:part name="part1" element="impl:createUser"/>
</wsdl:message>
<wsdl:message name="createUser11Response">
<wsdl:part name="part1" element="impl:createUserResponse"/>
</wsdl:message>
<wsdl:message name="getDigitPassword39Request">
<wsdl:part name="part1" element="impl:getDigitPassword"/>
</wsdl:message>
<wsdl:message name="getDigitPassword39Response">
<wsdl:part name="part1" element="impl:getDigitPasswordResponse"/>
</wsdl:message>
<wsdl:portType name="NorthboundServicePortType">
<wsdl:operation name="addPhoneAssociatedToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addPhoneAssociatedToUser3Request" wsaw:Action="addPhoneAssociatedToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addPhoneAssociatedToUser3Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ad
dPhoneAssociatedToUser3Response"/>
</wsdl:operation>
<wsdl:operation name="getRadiosAssociatedToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getRadiosAssociatedToUser43Request"
wsaw:Action="getRadiosAssociatedToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getRadiosAssociatedToUser43Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tRadiosAssociatedToUser43Response"/>
</wsdl:operation>
<wsdl:operation name="getAllVtgs">
Cisco IPICS API Reference Guide
OL-18330-01
4-55
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllVtgs34Request" wsaw:Action="getAllVtgs"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllVtgs34Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tAllVtgs34Response"/>
</wsdl:operation>
<wsdl:operation name="getUserAudioStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserAudioStatus45Request" wsaw:Action="getUserAudioStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserAudioStatus45Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUserAudioStatus45Response"/>
</wsdl:operation>
<wsdl:operation name="addVtgToVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addVtgToVtg7Request" wsaw:Action="addVtgToVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addVtgToVtg7Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ad
dVtgToVtg7Response"/>
</wsdl:operation>
<wsdl:operation name="setDigitPassword">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setDigitPassword70Request" wsaw:Action="setDigitPassword"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setDigitPassword70Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/se
tDigitPassword70Response"/>
</wsdl:operation>
<wsdl:operation name="associateRadiosToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:associateRadiosToUser9Request" wsaw:Action="associateRadiosToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:associateRadiosToUser9Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/as
sociateRadiosToUser9Response"/>
</wsdl:operation>
<wsdl:operation name="getUserStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserStatus52Request" wsaw:Action="getUserStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserStatus52Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUserStatus52Response"/>
</wsdl:operation>
<wsdl:operation name="deleteUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:deleteUser16Request" wsaw:Action="deleteUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:deleteUser16Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/de
leteUser16Response"/>
</wsdl:operation>
<wsdl:operation name="getUserRoles">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserRoles50Request" wsaw:Action="getUserRoles"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserRoles50Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUserRoles50Response"/>
</wsdl:operation>
<wsdl:operation name="removeUserFromVtg">
Cisco IPICS API Reference Guide
4-56
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:removeUserFromVtg65Request" wsaw:Action="removeUserFromVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:removeUserFromVtg65Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/re
moveUserFromVtg65Response"/>
</wsdl:operation>
<wsdl:operation name="notifyAllVtgMembers">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:notifyAllVtgMembers60Request" wsaw:Action="notifyAllVtgMembers"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:notifyAllVtgMembers60Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/no
tifyAllVtgMembers60Response"/>
</wsdl:operation>
<wsdl:operation name="getChannelsAssociatedToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getChannelsAssociatedToUser36Request"
wsaw:Action="getChannelsAssociatedToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getChannelsAssociatedToUser36Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tChannelsAssociatedToUser36Response"/>
</wsdl:operation>
<wsdl:operation name="deleteVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:deleteVtg17Request" wsaw:Action="deleteVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:deleteVtg17Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/de
leteVtg17Response"/>
</wsdl:operation>
<wsdl:operation name="notifyVtgMembers">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:notifyVtgMembers62Request" wsaw:Action="notifyVtgMembers"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:notifyVtgMembers62Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/no
tifyVtgMembers62Response"/>
</wsdl:operation>
<wsdl:operation name="addRadioToVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addRadioToVtg4Request" wsaw:Action="addRadioToVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addRadioToVtg4Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ad
dRadioToVtg4Response"/>
</wsdl:operation>
<wsdl:operation name="getAllChannels">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllChannels28Request" wsaw:Action="getAllChannels"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllChannels28Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tAllChannels28Response"/>
</wsdl:operation>
<wsdl:operation name="getAllChannelGroups">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllChannelGroups27Request" wsaw:Action="getAllChannelGroups"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllChannelGroups27Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tAllChannelGroups27Response"/>
</wsdl:operation>
Cisco IPICS API Reference Guide
OL-18330-01
4-57
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:operation name="getAllUserGroups">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllUserGroups32Request" wsaw:Action="getAllUserGroups"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllUserGroups32Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tAllUserGroups32Response"/>
</wsdl:operation>
<wsdl:operation name="setDigitIds">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setDigitIds69Request" wsaw:Action="setDigitIds"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setDigitIds69Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/se
tDigitIds69Response"/>
</wsdl:operation>
<wsdl:operation name="getUserNotificationPreference">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserNotificationPreference49Request"
wsaw:Action="getUserNotificationPreference"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserNotificationPreference49Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUserNotificationPreference49Response"/>
</wsdl:operation>
<wsdl:operation name="removeVtgFromVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:removeVtgFromVtg66Request" wsaw:Action="removeVtgFromVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:removeVtgFromVtg66Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/re
moveVtgFromVtg66Response"/>
</wsdl:operation>
<wsdl:operation name="getUserListenerStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserListenerStatus48Request" wsaw:Action="getUserListenerStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserListenerStatus48Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUserListenerStatus48Response"/>
</wsdl:operation>
<wsdl:operation name="getUserGroupMembers">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserGroupMembers47Request" wsaw:Action="getUserGroupMembers"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserGroupMembers47Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUserGroupMembers47Response"/>
</wsdl:operation>
<wsdl:operation name="activateVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:activateVtg1Request" wsaw:Action="activateVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:activateVtg1Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ac
tivateVtg1Response"/>
</wsdl:operation>
<wsdl:operation name="getAllRadios">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllRadios31Request" wsaw:Action="getAllRadios"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllRadios31Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tAllRadios31Response"/>
Cisco IPICS API Reference Guide
4-58
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:operation>
<wsdl:operation name="getPoliciesAssociatedToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getPoliciesAssociatedToUser41Request"
wsaw:Action="getPoliciesAssociatedToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getPoliciesAssociatedToUser41Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tPoliciesAssociatedToUser41Response"/>
</wsdl:operation>
<wsdl:operation name="disableChannel">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:disableChannel21Request" wsaw:Action="disableChannel"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:disableChannel21Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/di
sableChannel21Response"/>
</wsdl:operation>
<wsdl:operation name="getUsersAssociatedToRadio">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUsersAssociatedToRadio51Request"
wsaw:Action="getUsersAssociatedToRadio"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUsersAssociatedToRadio51Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUsersAssociatedToRadio51Response"/>
</wsdl:operation>
<wsdl:operation name="isActiveUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:isActiveUser58Request" wsaw:Action="isActiveUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:isActiveUser58Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/is
ActiveUser58Response"/>
</wsdl:operation>
<wsdl:operation name="dialAllVtgMembers">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:dialAllVtgMembers18Request" wsaw:Action="dialAllVtgMembers"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:dialAllVtgMembers18Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/di
alAllVtgMembers18Response"/>
</wsdl:operation>
<wsdl:operation name="getPhonesAssociatedToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getPhonesAssociatedToUser40Request"
wsaw:Action="getPhonesAssociatedToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getPhonesAssociatedToUser40Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tPhonesAssociatedToUser40Response"/>
</wsdl:operation>
<wsdl:operation name="getVtgStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getVtgStatus56Request" wsaw:Action="getVtgStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getVtgStatus56Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tVtgStatus56Response"/>
</wsdl:operation>
<wsdl:operation name="addChannelToVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addChannelToVtg2Request" wsaw:Action="addChannelToVtg"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-59
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addChannelToVtg2Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ad
dChannelToVtg2Response"/>
</wsdl:operation>
<wsdl:operation name="getPolicyExecutionStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getPolicyExecutionStatus42Request" wsaw:Action="getPolicyExecutionStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getPolicyExecutionStatus42Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tPolicyExecutionStatus42Response"/>
</wsdl:operation>
<wsdl:operation name="setUserListenerStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setUserListenerStatus74Request" wsaw:Action="setUserListenerStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setUserListenerStatus74Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/se
tUserListenerStatus74Response"/>
</wsdl:operation>
<wsdl:operation name="isActiveVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:isActiveVtg59Request" wsaw:Action="isActiveVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:isActiveVtg59Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/is
ActiveVtg59Response"/>
</wsdl:operation>
<wsdl:operation name="setUserAudioStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setUserAudioStatus73Request" wsaw:Action="setUserAudioStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setUserAudioStatus73Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/se
tUserAudioStatus73Response"/>
</wsdl:operation>
<wsdl:operation name="createUserGroup">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:createUserGroup12Request" wsaw:Action="createUserGroup"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:createUserGroup12Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/cr
eateUserGroup12Response"/>
</wsdl:operation>
<wsdl:operation name="enableChannel">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:enableChannel23Request" wsaw:Action="enableChannel"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:enableChannel23Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/en
ableChannel23Response"/>
</wsdl:operation>
<wsdl:operation name="enableUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:enableUser24Request" wsaw:Action="enableUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:enableUser24Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/en
ableUser24Response"/>
</wsdl:operation>
<wsdl:operation name="deactivateVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:deactivateVtg14Request" wsaw:Action="deactivateVtg"/>
Cisco IPICS API Reference Guide
4-60
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:deactivateVtg14Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/de
activateVtg14Response"/>
</wsdl:operation>
<wsdl:operation name="getVtgParticipantStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getVtgParticipantStatus54Request" wsaw:Action="getVtgParticipantStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getVtgParticipantStatus54Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tVtgParticipantStatus54Response"/>
</wsdl:operation>
<wsdl:operation name="getBelongingOpsViewForUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getBelongingOpsViewForUser35Request"
wsaw:Action="getBelongingOpsViewForUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getBelongingOpsViewForUser35Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tBelongingOpsViewForUser35Response"/>
</wsdl:operation>
<wsdl:operation name="getChannelStatus">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getChannelStatus37Request" wsaw:Action="getChannelStatus"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getChannelStatus37Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tChannelStatus37Response"/>
</wsdl:operation>
<wsdl:operation name="removePhoneAssociatedToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:removePhoneAssociatedToUser64Request"
wsaw:Action="removePhoneAssociatedToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:removePhoneAssociatedToUser64Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/re
movePhoneAssociatedToUser64Response"/>
</wsdl:operation>
<wsdl:operation name="addUserToUserGroup">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addUserToUserGroup5Request" wsaw:Action="addUserToUserGroup"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addUserToUserGroup5Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ad
dUserToUserGroup5Response"/>
</wsdl:operation>
<wsdl:operation name="getUserDialPreference">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserDialPreference46Request" wsaw:Action="getUserDialPreference"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserDialPreference46Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUserDialPreference46Response"/>
</wsdl:operation>
<wsdl:operation name="associateChannelsToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:associateChannelsToUser8Request" wsaw:Action="associateChannelsToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:associateChannelsToUser8Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/as
sociateChannelsToUser8Response"/>
</wsdl:operation>
<wsdl:operation name="setUserAddress">
Cisco IPICS API Reference Guide
OL-18330-01
4-61
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setUserAddress72Request" wsaw:Action="setUserAddress"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setUserAddress72Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/se
tUserAddress72Response"/>
</wsdl:operation>
<wsdl:operation name="getUserAddress">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserAddress44Request" wsaw:Action="getUserAddress"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getUserAddress44Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tUserAddress44Response"/>
</wsdl:operation>
<wsdl:operation name="getAllPolicies">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllPolicies30Request" wsaw:Action="getAllPolicies"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllPolicies30Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tAllPolicies30Response"/>
</wsdl:operation>
<wsdl:operation name="executePolicy">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:executePolicy26Request" wsaw:Action="executePolicy"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:executePolicy26Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ex
ecutePolicy26Response"/>
</wsdl:operation>
<wsdl:operation name="setDialPreference">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setDialPreference68Request" wsaw:Action="setDialPreference"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setDialPreference68Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/se
tDialPreference68Response"/>
</wsdl:operation>
<wsdl:operation name="getVtgsAssociatedToUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getVtgsAssociatedToUser55Request" wsaw:Action="getVtgsAssociatedToUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getVtgsAssociatedToUser55Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tVtgsAssociatedToUser55Response"/>
</wsdl:operation>
<wsdl:operation name="addUserToVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addUserToVtg6Request" wsaw:Action="addUserToVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:addUserToVtg6Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ad
dUserToVtg6Response"/>
</wsdl:operation>
<wsdl:operation name="getAllUsers">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllUsers33Request" wsaw:Action="getAllUsers"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllUsers33Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tAllUsers33Response"/>
</wsdl:operation>
<wsdl:operation name="getVtgParticipants">
Cisco IPICS API Reference Guide
4-62
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getVtgParticipants53Request" wsaw:Action="getVtgParticipants"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getVtgParticipants53Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tVtgParticipants53Response"/>
</wsdl:operation>
<wsdl:operation name="createVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:createVtg13Request" wsaw:Action="createVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:createVtg13Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/cr
eateVtg13Response"/>
</wsdl:operation>
<wsdl:operation name="notifyVtgMember">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:notifyVtgMember61Request" wsaw:Action="notifyVtgMember"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:notifyVtgMember61Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/no
tifyVtgMember61Response"/>
</wsdl:operation>
<wsdl:operation name="dialVtgMember">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:dialVtgMember19Request" wsaw:Action="dialVtgMember"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:dialVtgMember19Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/di
alVtgMember19Response"/>
</wsdl:operation>
<wsdl:operation name="dialVtgMembers">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:dialVtgMembers20Request" wsaw:Action="dialVtgMembers"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:dialVtgMembers20Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/di
alVtgMembers20Response"/>
</wsdl:operation>
<wsdl:operation name="isActiveChannel">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:isActiveChannel57Request" wsaw:Action="isActiveChannel"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:isActiveChannel57Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/is
ActiveChannel57Response"/>
</wsdl:operation>
<wsdl:operation name="removeChannelFromVtg">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:removeChannelFromVtg63Request" wsaw:Action="removeChannelFromVtg"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:removeChannelFromVtg63Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/re
moveChannelFromVtg63Response"/>
</wsdl:operation>
<wsdl:operation name="deleteChannel">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:deleteChannel15Request" wsaw:Action="deleteChannel"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:deleteChannel15Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/de
leteChannel15Response"/>
</wsdl:operation>
<wsdl:operation name="createChannel">
Cisco IPICS API Reference Guide
OL-18330-01
4-63
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:createChannel10Request" wsaw:Action="createChannel"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:createChannel10Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/cr
eateChannel10Response"/>
</wsdl:operation>
<wsdl:operation name="getAllChannelsInChannelGroup">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllChannelsInChannelGroup29Request"
wsaw:Action="getAllChannelsInChannelGroup"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getAllChannelsInChannelGroup29Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tAllChannelsInChannelGroup29Response"/>
</wsdl:operation>
<wsdl:operation name="getDigitIds">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getDigitIds38Request" wsaw:Action="getDigitIds"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getDigitIds38Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tDigitIds38Response"/>
</wsdl:operation>
<wsdl:operation name="setNotificationPreference">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setNotificationPreference71Request"
wsaw:Action="setNotificationPreference"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setNotificationPreference71Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/se
tNotificationPreference71Response"/>
</wsdl:operation>
<wsdl:operation name="setBelongingOpsViewForUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setBelongingOpsViewForUser67Request"
wsaw:Action="setBelongingOpsViewForUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:setBelongingOpsViewForUser67Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/se
tBelongingOpsViewForUser67Response"/>
</wsdl:operation>
<wsdl:operation name="executeNotificationPolicy">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:executeNotificationPolicy25Request"
wsaw:Action="executeNotificationPolicy"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:executeNotificationPolicy25Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ex
ecuteNotificationPolicy25Response"/>
</wsdl:operation>
<wsdl:operation name="disableUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:disableUser22Request" wsaw:Action="disableUser"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:disableUser22Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/di
sableUser22Response"/>
</wsdl:operation>
<wsdl:operation name="createUser">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:createUser11Request" wsaw:Action="createUser"/>
Cisco IPICS API Reference Guide
4-64
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:createUser11Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/cr
eateUser11Response"/>
</wsdl:operation>
<wsdl:operation name="getDigitPassword">
<wsdl:input xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getDigitPassword39Request" wsaw:Action="getDigitPassword"/>
<wsdl:output xmlns:wsaw="http://www.w3.org/2006/05/addressing/wsdl"
message="impl:getDigitPassword39Response"
wsaw:Action="http://com.cisco.ipics.issymo.northbound.service/NorthboundServicePortType/ge
tDigitPassword39Response"/>
</wsdl:operation>
</wsdl:portType>
<wsdl:binding name="NorthboundServiceSOAP11Binding"
type="impl:NorthboundServicePortType">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
<wsdl:operation name="addPhoneAssociatedToUser">
<soap:operation soapAction="addPhoneAssociatedToUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getRadiosAssociatedToUser">
<soap:operation soapAction="getRadiosAssociatedToUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllVtgs">
<soap:operation soapAction="getAllVtgs" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserAudioStatus">
<soap:operation soapAction="getUserAudioStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addVtgToVtg">
<soap:operation soapAction="addVtgToVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDigitPassword">
<soap:operation soapAction="setDigitPassword" style="document"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-65
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="associateRadiosToUser">
<soap:operation soapAction="associateRadiosToUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserStatus">
<soap:operation soapAction="getUserStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteUser">
<soap:operation soapAction="deleteUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserRoles">
<soap:operation soapAction="getUserRoles" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeUserFromVtg">
<soap:operation soapAction="removeUserFromVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyAllVtgMembers">
<soap:operation soapAction="notifyAllVtgMembers" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getChannelsAssociatedToUser">
<soap:operation soapAction="getChannelsAssociatedToUser" style="document"/>
<wsdl:input>
Cisco IPICS API Reference Guide
4-66
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteVtg">
<soap:operation soapAction="deleteVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyVtgMembers">
<soap:operation soapAction="notifyVtgMembers" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addRadioToVtg">
<soap:operation soapAction="addRadioToVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllChannels">
<soap:operation soapAction="getAllChannels" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllChannelGroups">
<soap:operation soapAction="getAllChannelGroups" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllUserGroups">
<soap:operation soapAction="getAllUserGroups" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDigitIds">
<soap:operation soapAction="setDigitIds" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-67
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserNotificationPreference">
<soap:operation soapAction="getUserNotificationPreference" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeVtgFromVtg">
<soap:operation soapAction="removeVtgFromVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserListenerStatus">
<soap:operation soapAction="getUserListenerStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserGroupMembers">
<soap:operation soapAction="getUserGroupMembers" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="activateVtg">
<soap:operation soapAction="activateVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllRadios">
<soap:operation soapAction="getAllRadios" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getPoliciesAssociatedToUser">
<soap:operation soapAction="getPoliciesAssociatedToUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
Cisco IPICS API Reference Guide
4-68
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="disableChannel">
<soap:operation soapAction="disableChannel" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUsersAssociatedToRadio">
<soap:operation soapAction="getUsersAssociatedToRadio" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveUser">
<soap:operation soapAction="isActiveUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialAllVtgMembers">
<soap:operation soapAction="dialAllVtgMembers" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getPhonesAssociatedToUser">
<soap:operation soapAction="getPhonesAssociatedToUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgStatus">
<soap:operation soapAction="getVtgStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addChannelToVtg">
<soap:operation soapAction="addChannelToVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
Cisco IPICS API Reference Guide
OL-18330-01
4-69
Chapter 4
Web Services Description Language File
WSDL File Contents
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getPolicyExecutionStatus">
<soap:operation soapAction="getPolicyExecutionStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserListenerStatus">
<soap:operation soapAction="setUserListenerStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveVtg">
<soap:operation soapAction="isActiveVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserAudioStatus">
<soap:operation soapAction="setUserAudioStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createUserGroup">
<soap:operation soapAction="createUserGroup" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="enableChannel">
<soap:operation soapAction="enableChannel" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="enableUser">
<soap:operation soapAction="enableUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
Cisco IPICS API Reference Guide
4-70
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deactivateVtg">
<soap:operation soapAction="deactivateVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgParticipantStatus">
<soap:operation soapAction="getVtgParticipantStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getBelongingOpsViewForUser">
<soap:operation soapAction="getBelongingOpsViewForUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getChannelStatus">
<soap:operation soapAction="getChannelStatus" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removePhoneAssociatedToUser">
<soap:operation soapAction="removePhoneAssociatedToUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addUserToUserGroup">
<soap:operation soapAction="addUserToUserGroup" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserDialPreference">
<soap:operation soapAction="getUserDialPreference" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
Cisco IPICS API Reference Guide
OL-18330-01
4-71
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:operation>
<wsdl:operation name="associateChannelsToUser">
<soap:operation soapAction="associateChannelsToUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserAddress">
<soap:operation soapAction="setUserAddress" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserAddress">
<soap:operation soapAction="getUserAddress" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllPolicies">
<soap:operation soapAction="getAllPolicies" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="executePolicy">
<soap:operation soapAction="executePolicy" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDialPreference">
<soap:operation soapAction="setDialPreference" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgsAssociatedToUser">
<soap:operation soapAction="getVtgsAssociatedToUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
Cisco IPICS API Reference Guide
4-72
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:operation name="addUserToVtg">
<soap:operation soapAction="addUserToVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllUsers">
<soap:operation soapAction="getAllUsers" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgParticipants">
<soap:operation soapAction="getVtgParticipants" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createVtg">
<soap:operation soapAction="createVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyVtgMember">
<soap:operation soapAction="notifyVtgMember" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialVtgMember">
<soap:operation soapAction="dialVtgMember" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialVtgMembers">
<soap:operation soapAction="dialVtgMembers" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveChannel">
Cisco IPICS API Reference Guide
OL-18330-01
4-73
Chapter 4
Web Services Description Language File
WSDL File Contents
<soap:operation soapAction="isActiveChannel" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeChannelFromVtg">
<soap:operation soapAction="removeChannelFromVtg" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteChannel">
<soap:operation soapAction="deleteChannel" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createChannel">
<soap:operation soapAction="createChannel" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllChannelsInChannelGroup">
<soap:operation soapAction="getAllChannelsInChannelGroup" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getDigitIds">
<soap:operation soapAction="getDigitIds" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setNotificationPreference">
<soap:operation soapAction="setNotificationPreference" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setBelongingOpsViewForUser">
<soap:operation soapAction="setBelongingOpsViewForUser" style="document"/>
Cisco IPICS API Reference Guide
4-74
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="executeNotificationPolicy">
<soap:operation soapAction="executeNotificationPolicy" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="disableUser">
<soap:operation soapAction="disableUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createUser">
<soap:operation soapAction="createUser" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getDigitPassword">
<soap:operation soapAction="getDigitPassword" style="document"/>
<wsdl:input>
<soap:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:binding name="NorthboundServiceSOAP12Binding"
type="impl:NorthboundServicePortType">
<soap12:binding transport="http://schemas.xmlsoap.org/soap/http"
style="document"/>
<wsdl:operation name="addPhoneAssociatedToUser">
<soap12:operation soapAction="addPhoneAssociatedToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getRadiosAssociatedToUser">
<soap12:operation soapAction="getRadiosAssociatedToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-75
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllVtgs">
<soap12:operation soapAction="getAllVtgs" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserAudioStatus">
<soap12:operation soapAction="getUserAudioStatus" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addVtgToVtg">
<soap12:operation soapAction="addVtgToVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDigitPassword">
<soap12:operation soapAction="setDigitPassword" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="associateRadiosToUser">
<soap12:operation soapAction="associateRadiosToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserStatus">
<soap12:operation soapAction="getUserStatus" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteUser">
<soap12:operation soapAction="deleteUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
Cisco IPICS API Reference Guide
4-76
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:operation>
<wsdl:operation name="getUserRoles">
<soap12:operation soapAction="getUserRoles" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeUserFromVtg">
<soap12:operation soapAction="removeUserFromVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyAllVtgMembers">
<soap12:operation soapAction="notifyAllVtgMembers" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getChannelsAssociatedToUser">
<soap12:operation soapAction="getChannelsAssociatedToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteVtg">
<soap12:operation soapAction="deleteVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyVtgMembers">
<soap12:operation soapAction="notifyVtgMembers" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addRadioToVtg">
<soap12:operation soapAction="addRadioToVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
Cisco IPICS API Reference Guide
OL-18330-01
4-77
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:operation name="getAllChannels">
<soap12:operation soapAction="getAllChannels" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllChannelGroups">
<soap12:operation soapAction="getAllChannelGroups" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllUserGroups">
<soap12:operation soapAction="getAllUserGroups" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDigitIds">
<soap12:operation soapAction="setDigitIds" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserNotificationPreference">
<soap12:operation soapAction="getUserNotificationPreference"
style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeVtgFromVtg">
<soap12:operation soapAction="removeVtgFromVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserListenerStatus">
<soap12:operation soapAction="getUserListenerStatus" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
Cisco IPICS API Reference Guide
4-78
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:operation name="getUserGroupMembers">
<soap12:operation soapAction="getUserGroupMembers" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="activateVtg">
<soap12:operation soapAction="activateVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllRadios">
<soap12:operation soapAction="getAllRadios" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getPoliciesAssociatedToUser">
<soap12:operation soapAction="getPoliciesAssociatedToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="disableChannel">
<soap12:operation soapAction="disableChannel" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUsersAssociatedToRadio">
<soap12:operation soapAction="getUsersAssociatedToRadio" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveUser">
<soap12:operation soapAction="isActiveUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialAllVtgMembers">
Cisco IPICS API Reference Guide
OL-18330-01
4-79
Chapter 4
Web Services Description Language File
WSDL File Contents
<soap12:operation soapAction="dialAllVtgMembers" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getPhonesAssociatedToUser">
<soap12:operation soapAction="getPhonesAssociatedToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgStatus">
<soap12:operation soapAction="getVtgStatus" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addChannelToVtg">
<soap12:operation soapAction="addChannelToVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getPolicyExecutionStatus">
<soap12:operation soapAction="getPolicyExecutionStatus" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserListenerStatus">
<soap12:operation soapAction="setUserListenerStatus" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveVtg">
<soap12:operation soapAction="isActiveVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserAudioStatus">
<soap12:operation soapAction="setUserAudioStatus" style="document"/>
Cisco IPICS API Reference Guide
4-80
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createUserGroup">
<soap12:operation soapAction="createUserGroup" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="enableChannel">
<soap12:operation soapAction="enableChannel" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="enableUser">
<soap12:operation soapAction="enableUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deactivateVtg">
<soap12:operation soapAction="deactivateVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgParticipantStatus">
<soap12:operation soapAction="getVtgParticipantStatus" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getBelongingOpsViewForUser">
<soap12:operation soapAction="getBelongingOpsViewForUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getChannelStatus">
<soap12:operation soapAction="getChannelStatus" style="document"/>
<wsdl:input>
Cisco IPICS API Reference Guide
OL-18330-01
4-81
Chapter 4
Web Services Description Language File
WSDL File Contents
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removePhoneAssociatedToUser">
<soap12:operation soapAction="removePhoneAssociatedToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addUserToUserGroup">
<soap12:operation soapAction="addUserToUserGroup" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserDialPreference">
<soap12:operation soapAction="getUserDialPreference" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="associateChannelsToUser">
<soap12:operation soapAction="associateChannelsToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserAddress">
<soap12:operation soapAction="setUserAddress" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserAddress">
<soap12:operation soapAction="getUserAddress" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllPolicies">
<soap12:operation soapAction="getAllPolicies" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
Cisco IPICS API Reference Guide
4-82
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="executePolicy">
<soap12:operation soapAction="executePolicy" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDialPreference">
<soap12:operation soapAction="setDialPreference" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgsAssociatedToUser">
<soap12:operation soapAction="getVtgsAssociatedToUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addUserToVtg">
<soap12:operation soapAction="addUserToVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllUsers">
<soap12:operation soapAction="getAllUsers" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgParticipants">
<soap12:operation soapAction="getVtgParticipants" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createVtg">
<soap12:operation soapAction="createVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
Cisco IPICS API Reference Guide
OL-18330-01
4-83
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyVtgMember">
<soap12:operation soapAction="notifyVtgMember" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialVtgMember">
<soap12:operation soapAction="dialVtgMember" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialVtgMembers">
<soap12:operation soapAction="dialVtgMembers" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveChannel">
<soap12:operation soapAction="isActiveChannel" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeChannelFromVtg">
<soap12:operation soapAction="removeChannelFromVtg" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteChannel">
<soap12:operation soapAction="deleteChannel" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createChannel">
<soap12:operation soapAction="createChannel" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
Cisco IPICS API Reference Guide
4-84
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllChannelsInChannelGroup">
<soap12:operation soapAction="getAllChannelsInChannelGroup" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getDigitIds">
<soap12:operation soapAction="getDigitIds" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setNotificationPreference">
<soap12:operation soapAction="setNotificationPreference" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setBelongingOpsViewForUser">
<soap12:operation soapAction="setBelongingOpsViewForUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="executeNotificationPolicy">
<soap12:operation soapAction="executeNotificationPolicy" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="disableUser">
<soap12:operation soapAction="disableUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createUser">
<soap12:operation soapAction="createUser" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-85
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getDigitPassword">
<soap12:operation soapAction="getDigitPassword" style="document"/>
<wsdl:input>
<soap12:body use="literal"/>
</wsdl:input>
<wsdl:output>
<soap12:body use="literal"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:binding name="NorthboundServiceHttpBinding"
type="impl:NorthboundServicePortType">
<http:binding verb="POST"/>
<wsdl:operation name="addPhoneAssociatedToUser">
<http:operation location="addPhoneAssociatedToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getRadiosAssociatedToUser">
<http:operation location="getRadiosAssociatedToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllVtgs">
<http:operation location="getAllVtgs"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserAudioStatus">
<http:operation location="getUserAudioStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addVtgToVtg">
<http:operation location="addVtgToVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDigitPassword">
<http:operation location="setDigitPassword"/>
<wsdl:input>
<mime:content type="text/xml"/>
Cisco IPICS API Reference Guide
4-86
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="associateRadiosToUser">
<http:operation location="associateRadiosToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserStatus">
<http:operation location="getUserStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteUser">
<http:operation location="deleteUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserRoles">
<http:operation location="getUserRoles"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeUserFromVtg">
<http:operation location="removeUserFromVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyAllVtgMembers">
<http:operation location="notifyAllVtgMembers"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getChannelsAssociatedToUser">
<http:operation location="getChannelsAssociatedToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
Cisco IPICS API Reference Guide
OL-18330-01
4-87
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteVtg">
<http:operation location="deleteVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyVtgMembers">
<http:operation location="notifyVtgMembers"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addRadioToVtg">
<http:operation location="addRadioToVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllChannels">
<http:operation location="getAllChannels"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllChannelGroups">
<http:operation location="getAllChannelGroups"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllUserGroups">
<http:operation location="getAllUserGroups"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDigitIds">
<http:operation location="setDigitIds"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
Cisco IPICS API Reference Guide
4-88
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserNotificationPreference">
<http:operation location="getUserNotificationPreference"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeVtgFromVtg">
<http:operation location="removeVtgFromVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserListenerStatus">
<http:operation location="getUserListenerStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserGroupMembers">
<http:operation location="getUserGroupMembers"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="activateVtg">
<http:operation location="activateVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllRadios">
<http:operation location="getAllRadios"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getPoliciesAssociatedToUser">
<http:operation location="getPoliciesAssociatedToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-89
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="disableChannel">
<http:operation location="disableChannel"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUsersAssociatedToRadio">
<http:operation location="getUsersAssociatedToRadio"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveUser">
<http:operation location="isActiveUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialAllVtgMembers">
<http:operation location="dialAllVtgMembers"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getPhonesAssociatedToUser">
<http:operation location="getPhonesAssociatedToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgStatus">
<http:operation location="getVtgStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addChannelToVtg">
<http:operation location="addChannelToVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
Cisco IPICS API Reference Guide
4-90
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:operation>
<wsdl:operation name="getPolicyExecutionStatus">
<http:operation location="getPolicyExecutionStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserListenerStatus">
<http:operation location="setUserListenerStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveVtg">
<http:operation location="isActiveVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserAudioStatus">
<http:operation location="setUserAudioStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createUserGroup">
<http:operation location="createUserGroup"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="enableChannel">
<http:operation location="enableChannel"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="enableUser">
<http:operation location="enableUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
Cisco IPICS API Reference Guide
OL-18330-01
4-91
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:operation name="deactivateVtg">
<http:operation location="deactivateVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgParticipantStatus">
<http:operation location="getVtgParticipantStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getBelongingOpsViewForUser">
<http:operation location="getBelongingOpsViewForUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getChannelStatus">
<http:operation location="getChannelStatus"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removePhoneAssociatedToUser">
<http:operation location="removePhoneAssociatedToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addUserToUserGroup">
<http:operation location="addUserToUserGroup"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserDialPreference">
<http:operation location="getUserDialPreference"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="associateChannelsToUser">
Cisco IPICS API Reference Guide
4-92
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<http:operation location="associateChannelsToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setUserAddress">
<http:operation location="setUserAddress"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getUserAddress">
<http:operation location="getUserAddress"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllPolicies">
<http:operation location="getAllPolicies"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="executePolicy">
<http:operation location="executePolicy"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setDialPreference">
<http:operation location="setDialPreference"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgsAssociatedToUser">
<http:operation location="getVtgsAssociatedToUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="addUserToVtg">
<http:operation location="addUserToVtg"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-93
Chapter 4
Web Services Description Language File
WSDL File Contents
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllUsers">
<http:operation location="getAllUsers"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getVtgParticipants">
<http:operation location="getVtgParticipants"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createVtg">
<http:operation location="createVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="notifyVtgMember">
<http:operation location="notifyVtgMember"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialVtgMember">
<http:operation location="dialVtgMember"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="dialVtgMembers">
<http:operation location="dialVtgMembers"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="isActiveChannel">
<http:operation location="isActiveChannel"/>
<wsdl:input>
Cisco IPICS API Reference Guide
4-94
OL-18330-01
Chapter 4
Web Services Description Language File
WSDL File Contents
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="removeChannelFromVtg">
<http:operation location="removeChannelFromVtg"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="deleteChannel">
<http:operation location="deleteChannel"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createChannel">
<http:operation location="createChannel"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getAllChannelsInChannelGroup">
<http:operation location="getAllChannelsInChannelGroup"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getDigitIds">
<http:operation location="getDigitIds"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setNotificationPreference">
<http:operation location="setNotificationPreference"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="setBelongingOpsViewForUser">
<http:operation location="setBelongingOpsViewForUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
Cisco IPICS API Reference Guide
OL-18330-01
4-95
Chapter 4
Web Services Description Language File
WSDL File Contents
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="executeNotificationPolicy">
<http:operation location="executeNotificationPolicy"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="disableUser">
<http:operation location="disableUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="createUser">
<http:operation location="createUser"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
<wsdl:operation name="getDigitPassword">
<http:operation location="getDigitPassword"/>
<wsdl:input>
<mime:content type="text/xml"/>
</wsdl:input>
<wsdl:output>
<mime:content type="text/xml"/>
</wsdl:output>
</wsdl:operation>
</wsdl:binding>
<wsdl:service name="NorthboundService">
<wsdl:port name="NorthboundServiceSOAP11port_http"
binding="impl:NorthboundServiceSOAP11Binding">
<soap:address
location="http://10.10.90.122:8080/ipics_server/services/NorthboundService"/>
</wsdl:port>
<wsdl:port name="NorthboundServiceSOAP12port_http"
binding="impl:NorthboundServiceSOAP12Binding">
<soap12:address
location="http://10.10.90.122:8080/ipics_server/services/NorthboundService"/>
</wsdl:port>
<wsdl:port name="NorthboundServiceHttpport"
binding="impl:NorthboundServiceHttpBinding">
<http:address
location="http://10.10.90.122:8080/ipics_server/services/NorthboundService"/>
</wsdl:port>
</wsdl:service>
</wsdl:definitions>
Cisco IPICS API Reference Guide
4-96
OL-18330-01
INDEX
URL format for
A
1-2
application programming interface
activateVtg function
activating, VTG
2-4
See API
2-4
associateChannelsToUser function
addChannelToVtg function
2-4, 2-5
adding
associateRadiosToUser function
2-7
2-7
audio
channel to VTG
radio to VTG
2-4
2-5
user to user group
user to VTG
2-6
disabling on PMC
2-37, 2-38
enabling on PMC
2-37, 2-38
authentication
1-6
2-6
VTG to VTG
2-6
addRadioToVtg function
addUserToUserGroup function
addUserToVtg function
addVtgToVtg function
B
2-5
2-6
binding.xml file
1-3
2-6
2-6
C
API
authentication
description
1-6
channel
1-1
active
function
2-30
adding to VTG
2-4
list, See function
associating with user
overview
2-4
creating
2-8
summary
2-1
deleting
2-10
disabled
2-30
JiBX mapping file
3-1
logging
1-7
disabling
2-13
security
1-6
enabling
2-13
WDSL
4-1
removing from VTG
API requests
1-1
all
1-2, 1-4
URL
log in
1-1
2-15
all in channel group
executing
JAVA
2-33
retrieving
browser guidelines
examples
2-7
2-16
channel associated with user
1-3
1-1
status
2-19
2-20
channel group, retrieving
all
2-15
Cisco IPICS API Reference Guide
OL-18330-01
IN-1
Index
all channels in
disabling
2-16
Cisco IPICS application programming interface
channel
See API
client stub
user
2-13
1-3
createChannel function
createUser function
createVtg function
2-8
E
2-8, 2-9
2-9
enableChannel function
creating
enableUser function
channel
user
2-13
2-8
VTG
2-14
enabling
2-8
channel
user group
2-13
2-9
user
2-9
2-13
2-14
executeNotificationPolicy function
executePolicy function
2-15
executing notification policy
D
executing policy
deactivateVtg function
deactivating, VTG
2-10
2-10
deleteVTG function
2-10
function
activateVtg
deleting
2-10
addRadioToVtg
2-10
2-11
2-11
addVtgToVtg
2-6
2-6
2-6
associateChannelsToUser
2-11
associateRadiosToUser
2-11, 2-12
createChannel
dial preferences
createUser
retrieving for user
2-23
2-35
dialVtgMember function
2-11
dialVtgMembers function
2-12
digit IDs
retrieving
setting
2-5
addUserToVtg
dialing, VTG members
setting
2-4, 2-5
addUserToUserGroup
dialAllVtgMembers function
one
2-4
addChannelToVtg
VTG
all
2-15
F
2-10
deleteUser function
user
2-20
createVtg
2-35
disableChannel function
2-13
2-7
2-8, 2-9
2-9
deactivateVtg
2-10
deleteChannel
2-10
deleteUser
2-10
deleteVTG
2-10
dialVtgMember
digit password, setting
2-7
2-8
dialAllVtgMembers
2-35
disableUser function
2-14
2-10
deleteChannel function
channel
2-14
dialVtgMembers
disableChannel
2-11
2-11
2-12
2-13
2-13
Cisco IPICS API Reference Guide
IN-2
OL-18330-01
Index
disableUser
enableChannel
enableUser
removeChannelFromVtg
2-13
removePhoneAssociatedToUser
2-13
removeUserFromVtg
2-14
executeNotificationPolicy
executePolicy
setDialPreference
2-15
setDigitIds
2-15
getAllChannelsInChannelGroup
getAllRadios
getAllUsers
getAllVtgs
setUserAddress
2-19
getChannelStatus
2-20
2-37
2-20
getAllChannels function
2-20
getPoliciesAssociatedToUser
getPolicyExecutionStatus
2-21
2-21
getRadiosAssociatedToUser
getUserAddress
2-22
getUserDialPreference
getUserGroupMembers
getUserListenerStatus
2-24
2-24
2-24
2-25
2-26
2-26
getVtgParticipants
2-18
getBelongingOpsViewForUser function
2-19
getChannelsAssociatedToUser function
2-19
getDigitIds function
2-20
2-20
2-29
2-30
2-29
getUserAddress function
getUserAudioStatus function
2-21
getUserListenerStatus function
2-31
2-23
2-24
2-24
getUserNotificationPreference function
notifyAllVtgMembers
2-31
2-31, 2-32
getUserRoles function
2-22
2-23
getUserGroupMembers function
2-30
2-21
2-22
getUserDialPreference function
2-30
2-20
getPoliciesAssociatedToUser function
getRadiosAssociatedToUser function
getVtgsAssociatedToUser
notifyVtgMember
2-18
getPolicyExecutionStatus function
2-27
getVtgParticipantStatus
isActiveChannel
2-17
getPhonesAssociatedToUser function
getUsersAssociatedToRadio
getUserStatus
2-17
getChannelStatus function
getUserNotificationPreference
2-16
2-16
getAllUserGroups function
getAllVtgs function
2-23
2-15
getAllPolicies function
getAllUsers function
2-23
2-15
getAllChannelsInChannelGroup function
getAllRadios function
2-22
getUserAudioStatus
getUserRoles
G
getAllChannelGroups function
getPhonesAssociatedToUser
isActiveVtg
2-37
2-18
getChannelsAssociatedToUser
isActiveUser
2-36
2-36
setUserListenerStatus
2-18
2-19
getVtgStatus
2-35
setUserAudioStatus
2-17
getBelongingOpsViewForUser
getDigitIds
2-35
setNotificationPreference
2-17
2-34
2-35
setDigitPassword
2-16
2-16
getAllUserGroups
2-34
setBelongingOpsViewForUser
getAllChannelGroups
getAllPolicies
2-33
2-33
removeVtgFromVtg
2-14
2-15
getAllChannels
2-33
2-24
2-25
getUsersAssociatedToRadio function
2-26
Cisco IPICS API Reference Guide
OL-18330-01
IN-3
Index
getUserStatus function
all
2-26
getVtgParticipants function
one
2-27
getVtgParticipantStatus function
2-29
getVtgsAssociatedToUser function
getVtgStatus function
2-31
2-30
2-31, 2-32
notification policy, executing
notifyAllVtgMembers function
notifyVtgMember function
2-29
I
2-14
2-31
2-31, 2-32
O
isActiveChannel function
isActiveUser function
2-30
ops view
assigning to user
2-30
isActiveVtg function
retrieving
2-31
J
P
JiBX mapping file
phone
2-34
2-19
contents
3-1
disassociating from user
location
3-1
retrieving
obtaining
3-1
overview
1-3, 3-1
2-33
2-20
PMC
disabling audio
2-37, 2-38
enabling audio
2-37, 2-38
policy
L
executing
log, of API invocations
2-15
execution status
1-7
retrieving
2-21
2-16, 2-21
M
R
members
of VTG, dialing
radio
2-11
of VTG, dialing one
2-11, 2-12
adding to VTG
2-5
associating with user
retrieving
N
2-22
retrieving, all
northboundservice.class
1-3
2-7
2-17
users associated with
2-26
removeChannelFromVtg function
notification
removePhoneAssociatedToUser function
preferences
retrieving
setting
2-33
2-24
2-36
removeUserFromVtg function
removeVtgFromVtg function
2-33
2-33
2-34
VTG users
Cisco IPICS API Reference Guide
IN-4
OL-18330-01
Index
retrieving
setUserAddress function
channel
2-36
setUserAudioStatus function
all
setUserListenerStatus function
2-15
all in channel group
channel groups
channel status
2-19
U
2-15
2-20
dial preferences
URL, for API functions
2-23
1-2
user
digit IDs
2-20
active
ops view
2-19
adding physical address
phones associated with user
2-20
policies associated with user
2-21
adding to VTG
2-21
radios associated with user
user group members
user groups, all
2-22
2-24
creating
2-8
deleting
2-10
dial preferences
2-17
digit IDs
2-25
2-6
disabled
2-18
disabling
2-24
users associated with radio
user status
2-7
2-23, 2-35
2-35
2-30
2-13
disassociating phone from
2-26
enabling
2-26
muting
VTG
2-18
2-38
2-30
names of participants
2-27
2-29
assigning
2-34
retrieving
2-19
phones associated with
status of participants
2-29
removing from VTG
S
retrieving, all
roles of
1-6
setBelongingOpsViewForUser function
setDialPreference function
2-34
status of
unmuting
2-35
2-22, 2-26
2-33
2-25
2-26
2-38
2-30
user group
2-35
setNotificationPreference function
2-21
2-18
VTGs associated with
2-35
setDigitPassword function
2-20
policies associated with
radios associated with
setDigitIds function
2-24, 2-36
ops view
associated with user
status
2-33
2-14
notification preferences
all
2-7
2-20, 2-35
digit password
notification preferences
security
2-6
associating radio with
users
all
2-36
associating channel with
2-17
user roles
2-30
adding to user group
2-16
policy execution status
radios
2-37
2-16
channel associated with user
policy
2-37
2-36
adding user to
2-6
Cisco IPICS API Reference Guide
OL-18330-01
IN-5
Index
creating
removing from VTG
2-9
retrieving
retrieving
all
all
2-17
members
in 2-27
status 2-29
2-26
status
V
2-29
retrieving all
value objects
2-30
participants
2-25
user status, retrieving
2-18
associated with user
2-24
user roles, retrieving
2-34
status
1-3
2-18
2-29
virtual talk group
See VTG
W
VTG
activating
active
Web Services Description Language (WSDL) file
2-4
2-31
adding channel to
2-4
adding radio to
2-5
adding to VTG
2-6
adding user to
4-1
location
4-1
obtaining
4-1
overview
1-3, 4-1
2-6
adding VTG to
all
contents
2-6
2-18
associated with user
creating
2-30
2-9
deactivating
deleting
2-10
2-11
dialing all members
2-11
dialing one member
2-11
disabled
2-31
invitation
2-12
notifying
all users
2-31
one user
2-31, 2-32
participant
names
2-27
status
2-29
removing
channel
user
2-33
2-33
VTG
2-34
Cisco IPICS API Reference Guide
IN-6
OL-18330-01