Cisco IPICS API Reference Guide
Cisco IPICS Release 4.0
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-21552-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.
Cisco and the Cisco Logo are trademarks of Cisco Systems, Inc. and/or its affiliates in the U.S. and other countries. A listing of Cisco's trademarks can be found at
www.cisco.com/go/trademarks. Third party trademarks mentioned 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. (1005R)
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
Copyright © 2011 Cisco Systems, Inc. All rights reserved.
CONTENTS
Preface
xi
Audience
xi
Organization
xi
Obtaining Documentation, Obtaining Support, and Security Guidelines
CHAPTER
1
Overview of Web Services API
1-1
Generating a Web Services Client Stub 1-1
Obtaining and Configuring the Eclipse IDE 1-2
Generating a Client Stub on a Developer Workstation
Creating and Executing API Client Code
API Client Code Example
CHAPTER
2
API Security
1-7
API Logging
1-8
Web Services API Functions
Function Guidelines
Function Summary
xii
1-2
1-3
1-4
2-1
2-1
2-2
Function Descriptions 2-8
activateIncident 2-8
activateIncidentVtg 2-9
activateVtg 2-9
addChannelToVtg 2-10
addJournalToIncident 2-11
addParticipantsToVtg 2-11
addPhotoToIncident 2-12
addRadioToVtg 2-13
addResourcesToVtg 2-13
addUserToUserGroup 2-14
addUserToVtg 2-14
addVideoToIncident 2-15
addVtgParticipants 2-16
addVtgToVtg 2-17
associateChannelsToUser 2-17
associatePhonesToUser 2-18
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
iii
Contents
associateRadiosToUser 2-18
associateResourcesToIncident 2-19
createChannel 2-20
createIncident 2-21
createPhoto 2-21
createUser 2-22
createUserGroup 2-23
createVideo 2-23
createVtg 2-24
deactivateIncident 2-26
deactivateIncidentVtg 2-26
deactivateVtg 2-27
deletePmcProfile 2-28
deleteResources 2-28
dialAllIncidentVtgMembers 2-29
dialAllVtgMembers 2-30
dialIncidentVtgMember 2-31
dialVtgMember 2-32
disableChannel 2-33
disableUser 2-34
enableChannel 2-35
enableUser 2-35
endSession 2-36
executeNotificationPolicy 2-36
executePolicy 2-37
findChannelGroups 2-38
findChannels 2-38
findIncidents 2-39
findPhotos 2-40
findRadios 2-41
findUserGroups 2-41
findUsers 2-42
findVideos 2-43
findVtgs 2-44
getAllChannelGroups 2-44
getAllChannels 2-45
getAllChannelsInChannelGroup 2-45
getAllIncidents 2-46
getAllIncidentsWithIVtgStatus 2-47
getAllPhotos 2-47
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
iv
OL-21552-01
Contents
getAllPolicies 2-48
getAllRadios 2-48
getAllUserGroups 2-49
getAllUsers 2-50
getAllVideos 2-50
getAllVtgs 2-51
getBelongingOpsViewForUser 2-51
getChannel 2-52
getChannelDetails 2-53
getChannelGroupsForVtg 2-53
getChannelsAssociatedToUser 2-54
getChannelsForIncident 2-55
getChannelsForVtg 2-55
getChannelStatus 2-56
getDigitId 2-56
getDigitPassword 2-57
getIncident 2-58
getIncidentDetails 2-58
getIncidentParticipants 2-59
getIncidentsForUser 2-59
getIncidentVtg 2-60
getIncidentVtgOptions 2-61
getIncidentVtgUserOptions 2-61
getIpicsVersion 2-62
getJournal 2-63
getJournalDetails 2-63
getJournalsForIncident 2-64
getPhonesAssociatedToUser 2-64
getPhoto 2-65
getPhotoDetails 2-66
getPhotosForIncident 2-66
getPmcProfile 2-67
getPoliciesAssociatedToUser 2-67
getPolicy 2-68
getPolicyDetails 2-69
getPolicyExecutionStatus 2-69
getPolicyExecutionStatusDetails 2-70
getRadiosAssociatedToUser 2-71
getRadiosForIncident 2-71
getRadiosForVtg 2-72
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
v
Contents
getUser 2-72
getUserAddress 2-73
getUserAudioStatus 2-74
getUserDetails 2-74
getUserDialPreference 2-75
getUserDirectory 2-75
getUserGroup 2-76
getUserGroupMembers 2-77
getUserGroupsForVtg 2-77
getUserId 2-78
getUserListenerStatus 2-78
getUserNotificationPreference 2-79
getUserRoles 2-80
getUsersAssociatedToRadio 2-81
getUsersForIncident 2-81
getUsersForVtg 2-82
getUserStatus 2-83
getVideo 2-83
getVideoDetails 2-84
getVideosForIncident 2-84
getVtgDetails 2-85
getVtgOptions 2-86
getVtgParticipants 2-86
getVtgParticipantStatus 2-87
getVtgsAssociatedToUser 2-88
getVtgsForIncident 2-89
getVtgsForVtg 2-89
getVtgStatus 2-90
getVtgUserOptions 2-91
isActiveChannel 2-91
isActiveIncidentVtg 2-92
isActiveUser 2-93
isActiveVtg 2-93
notifyAllIncidentVtgMembers 2-94
notifyAllVtgMembers 2-94
notifyIncidentVtgMember 2-95
notifyVtgMember 2-96
removeChannelFromVtg 2-96
removePhoneAssociatedToUser 2-97
removeRadioFromVtg 2-98
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
vi
OL-21552-01
Contents
removeResourceFromIncident 2-98
removeUserFromVtg 2-99
removeVtgFromVtg 2-100
removeVtgParticipants 2-100
savePmcProfile 2-101
setBelongingOpsViewForUser 2-102
setDialPreference 2-102
setDigitId 2-103
setDigitPassword 2-104
setIncidentVtgOptions 2-105
setIncidentVtgUserOptions 2-106
setNotificationPreference 2-107
setUserAddress 2-107
setUserAudioStatus 2-108
setUserListenerStatus 2-109
setVtgOptions 2-109
setVtgUserOptions 2-110
startSession 2-111
updateIncident 2-112
updatePhoto 2-113
updateUserGroup 2-113
updateVideo 2-114
updateVirtualTalkGroup 2-114
CHAPTER
3
Value Objects
3-1
Value Objects Overview
3-1
Value Objects Descriptions 3-4
AddressVO 3-4
BooleanVO 3-4
ChannelContainerVO 3-5
ChannelDetailVO 3-5
ChannelGroupContainerVO 3-7
ChannelGroupVO 3-7
ChannelVO 3-7
ClientDescriptorVO 3-8
DialAddressContainerVO 3-8
DialAddressVO 3-9
ErrorVO 3-9
IncidentContainerVO 3-10
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
vii
Contents
IncidentDetailsVO 3-10
IncidentParticipantContainerVO 3-11
IncidentParticipantVO 3-11
IncidentVO 3-12
IncidentVtgOptionsVO 3-12
IncidentVtgUserOptionsVO 3-13
IntegerVO 3-13
JournalContainerVO 3-14
JournalDetailsContainerVO 3-14
JournalDetailsVO 3-14
JournalVO 3-15
NotificationAddressContainerVO 3-16
NotificationAddressVO 3-16
PaginationContextVO 3-16
PhoneContainerVO 3-17
PhoneVO 3-17
PhotoContainerVO 3-18
PhotoDetailsVO 3-18
PhotoVO 3-19
PolicyActionVO 3-20
PolicyContainerVO 3-21
PolicyDetailsVO 3-21
PolicyExecutionStatusContainerVO 3-22
PolicyExecutionStatusVO 3-22
PolicyTriggerVO 3-22
PolicyVO 3-23
RadioContainerVO 3-23
RadioDetailsVO 3-23
RadioVO 3-24
ResourceContainerVO 3-24
ResourceVO 3-25
SessionVO 3-25
StringVO 3-25
UserContainerVO 3-26
UserDetailsVO 3-26
UserGroupContainerVO 3-27
UserGroupDetailsVO 3-27
UserGroupVO 3-27
UserRoleContainerVO 3-28
UserRoleVO 3-28
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
viii
OL-21552-01
Contents
UserVO 3-28
VideoContainerVO 3-29
VideoDetailsVO 3-29
VideoVO 3-31
VtgContainerVO 3-32
VtgDetailContainerVO 3-32
VtgDetailVO 3-32
VtgOptionsVO 3-33
VtgParticipantContainerVO 3-34
VtgParticipantVO 3-34
VtgUserOptionsVO 3-35
VtgVO 3-36
CHAPTER
4
REST API Function
4-1
REST Function Description 4-1
Function URL 4-1
Function Parameters 4-2
Return Result 4-4
REST Examples 4-4
Example 1: Uploading a Video File 4-4
Example 2: Uploading a Video File with Debug Output
Example 3: Uploading a Photograph URL 4-5
Example 4: Uploading Journal Text 4-6
4-5
INDEX
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
ix
Contents
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
x
OL-21552-01
Preface
This document provides the information that is required to understand and use the Cisco IP
Interoperability and Collaboration System (IPICS) release 4.0(x) 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
•
REST web standards
•
Eclipse integrated development environment (IDE)
•
Hyper Text Transport Protocol (HTTP) or Secure HTTP (HTTPS)
•
Simple Object Access Protocol (SOAP)
Organization
This document is organized as follows:
Chapter 1, “Overview of Web
Services API”
Introduces the web services API, describes how to perform API
requests, and describes API security and API logging
Chapter 2, “Web Services API
Functions”
Provides a summary of each Cisco IPICS web services API
function and describes each function in detail
Chapter 3, “Value Objects”
Provides detailed descriptions of each value object that is used
by the Cisco IPICS web services API functions
Chapter 4, “REST API Function”
Describes the Cisco IPICS API uploadData function, which is
a REST function that uploads a resource (photo, video, journal)
to the Cisco IPICS server and associates the resource with an
incident
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
xi
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, Cisco IPICS Release 4.0
xii
OL-21552-01
CH A P T E R
1
Overview of Web Services API
The Cisco IP Interoperability and Collaboration System (IPICS) 4.0(x) application programming
interface (API) provides 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 web services API. It also explains how to
generate a client stub by using the Eclipse integrated development environment (IDE), and explains
options for executing API requests.
This chapter includes these topics:
•
Generating a Web Services Client Stub, page 1-1
•
Creating and Executing API Client Code, page 1-3
•
API Client Code Example, page 1-4
•
API Security, page 1-7
•
API Logging, page 1-8
Generating a Web Services Client Stub
Before using the Cisco IPICS API, you must generate a client stub on the PC that is to be used for the
API development (the developer workstation).
You can use a variety of tools to generate a client stub. The following sections describe how to generate
the stub by using the Eclipse IDE.
•
Obtaining and Configuring the Eclipse IDE, page 1-2
•
Generating a Client Stub on a Developer Workstation, page 1-2
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
1-1
Chapter 1
Overview of Web Services API
Generating a Web Services Client Stub
Obtaining and Configuring the Eclipse IDE
Before you generate a web services client stub for the Cisco IPICS API, follow these steps to obtain and
configure the Eclipse IDE:
Step 1
On the developer workstation, download the Eclipse IDE for Java Developers package from the Galileo
(v 3.5.2) release of the Eclipse open-source IDE.
This IDE is available from the Eclipse website.
Step 2
On the developer workstation, download and extract Axis2 version 1.3 from the Apache website
Step 3
Take these actions to configure Axis2 runtime in the Eclipse IDE:
a.
Launch the Eclipse IDE.
b.
Choose Windows > Preferences.
c.
In the Preferences window. expand Web Services.
d.
Click Axis2 Preferences.
e.
Click Browse and, in the Browse to a Folder window, click the folder in which you extracted Axis2.
f.
Click OK.
g.
Click OK to exit the Preference window.
Generating a Client Stub on a Developer Workstation
The following procedure describes how to use the Eclipse IDE to generate a client stub on a developer
workstation. Before you perform this procedure, configure the Eclipse IDE on the developer workstation
as described in the “Obtaining and Configuring the Eclipse IDE” section on page 1-2.
Procedure
Step 1
Launch the Eclipse IDE and take these actions:
a.
Choose File > New > Other... > Web Services > Web ServiceClient.
b.
Click Next.
The Web Services Client window appears.
Step 2
In the Web Services Client window, take these actions:
a.
In the service definition field, enter the following URL, where cisco_IPICS_server is the host name
or IP address of your server:
http://cisco_IPICS_server/ipics_server/services/IpicsWebService?wsdl
b.
Make sure that the Client type field displays Java Proxy.
c.
Click the Server: Tomcat version Server hyperlink.
The Client Environment Configuration window appears.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
1-2
OL-21552-01
Chapter 1
Overview of Web Services API
Creating and Executing API Client Code
Step 3
Step 4
In the Client Environment Configuration window, take these actions:
a.
In the Server area, choose the server type that Eclipse uses when generating the stub (by default, the
server type is Tomcat vX.X Server.
b.
Click OK.
In the Web Services Client window, take these actions, click the Web service runtime: Apache Axis
hyperlink.
The Client Environment Configuration window appears.
Step 5
In the Client Environment Configuration window, take these actions:
a.
Click Apache Axis2 in the Web service runtime area.
b.
Click OK.
Step 6
In the Web Services Client window, take these actions, click the Client project hyperlink.
Step 7
In the Specify Client Project Settings window, take these actions:
a.
In the Client project field, enter a name for the client project.
b.
Make sure that the Client Project field displays Dynamic Web Project.
c.
Click OK.
d.
Click Next.
The Web Service Client window appears.
Step 8
In the Web Service Client window, click Finish.
The client stub is generated in a folder with the name that you specified in the Specify Client Project
Settings window.
Creating and Executing API Client Code
Each API service function requires a valid session ID to access the API functions. To start a new web
services session, the client code must call the startSession function and provide the login name and
password that are used to authenticate the user who executes the API code. After authentication
completes, the startSession method returns a unique SessionId value, which should be used when
executing subsequent API methods in a web service session. To end a session, the API client code must
call the endSession function, which invalidates the current SessionId and is important for security.
For additional information about using the API, see the “Function Guidelines” section on page 2-1.
After you create API client code, follow these steps to execute it:
Procedure
Step 1
Launch the Eclipse IDE and take these actions:
a.
Click the name of the client file in the left panel of the window.
b.
Choose Run > Run Configurations....
The Run Configurations window appears.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
1-3
Chapter 1
Overview of Web Services API
API Client Code Example
Step 2
In the Run Configurations window, take these actions:
a.
Right-click Java Application in the left panel of the window.
b.
Choose New.
c.
Click Run.
API Client Code Example
The following is an example of Cisco API client code. In this example:
•
The location of the keystore is specified. The keystore contains the SSL certificate that the Cisco
IPICS server uses to verify its identity when a client attempts to connect to the server, and the URL
for the web service endpoint.
•
The startSession function is executed. This function returns a unique sessionId, which is needed to
execute other web service functions.
•
The getIpicsVersion is executed. This function returns the Cisco IPICS version that is running on
the Cisco IPICS sever.
•
These VTG functions are executed:
– createVtg—Create a new VTG on the Cisco IPICS server and returns the ID of the VTG,
activates VTG and returns list of all VTG's present in the system respectively.
– activateVTG—Activates the newly-created VTG.
– getAllVtgs—Retrieves a list of all VTGs that are present in Cisco IPICS.
•
The endSession function is executed. This function terminate the web service session. A terminated
session cannot be used again.
package com.example;
import java.rmi.RemoteException;
import com.example.IpicsWebServiceStub.*;
public class IpicsWebServiceTestClient {
// The web service stub
private static IpicsWebServiceStub ws = null;
//
// Modify the following parameters as needed for your environment
//
// Update with your server's address.
// Note: The use of HTTPS/SSL is optional, but highly recommended.
private static final String WEB_SERVICE_ENDPOINT_URL =
"https://<my_server_address>/ipics_server/services/IpicsWebService";
// If you use SSL to connect to the server, update with the location
// of your trusted SSL certificate key store (sometimes also called
// a "trust store").
private static final String KEY_STORE_FILE =
"c:\\client_truststore.jks";
// Choose the client type: IDC or IPHONE
// Affects how clients show up in the Active Users page found in the
// Cisco IPICS Administration Console.
private static final String CLIENT_TYPE = "IDC";
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
1-4
OL-21552-01
Chapter 1
Overview of Web Services API
API Client Code Example
// Update with the IPICS user login used to connect to the server.
// Use of the default "ipics" user account is not recommended, but
// shown here for simplicity.
private static final String USER_LOGIN = "ipics";
// Update with the corresponding IPICS user password.
private static final String USER_PASSWORD = "secret";
public static void main(String[] args) {
String sessionId = null;
try {
// Note: Use Java keytool to import the server's SSL certificate
// into KEY_STORE_FILE before running this client application,
// otherwise your SSL connection will fail.
System.setProperty("javax.net.ssl.trustStore", KEY_STORE_FILE);
// Create web service stub object using end-point URL
ws = new IpicsWebServiceStub(WEB_SERVICE_ENDPOINT_URL);
sessionId = testStartSession();
System.out.println("Session ID : " + sessionId);
testGetIpicsVersion(sessionId);
int vtgId = testCreateVtg(sessionId);
testActivateVTG(sessionId, vtgId);
testGetAllVtgs(sessionId);
testEndSession(sessionId);
} catch (Exception e) {
e.printStackTrace();
}
}
private static String testStartSession() throws Exception {
ClientDescriptorVO cd = new ClientDescriptorVO();
cd.setClientType(CLIENT_TYPE);
StartSession params = new StartSession();
params.setClientDescriptor(cd);
params.setUserLogin(USER_LOGIN);
params.setPass(USER_PASSWORD);
SessionVO result = ws.startSession(params).get_return();
if (result.getErrorVO() != null) {
System.out.println(result.getErrorVO().getErrorMessages());
return null;
}
String sessionId = result.getSessionId();
return sessionId;
}
private static String testGetIpicsVersion(String sessionId)
throws RemoteException {
System.out.println("\n----------- GetIpicsVersion ----------- ");
GetIpicsVersion params = new GetIpicsVersion();
params.setSessionId(sessionId);
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
1-5
Chapter 1
Overview of Web Services API
API Client Code Example
StringVO result = ws.getIpicsVersion(params).get_return();
if (result.getErrorVO() == null) {
System.out.println("\nIPICS Version: " + result.getValue());
return result.getValue();
} else {
System.out.println("\nIPICS Version: "
+ result.getErrorVO().getErrorMessages());
return null;
}
}
private static int testCreateVtg(String sessionId) {
System.out.println("\n----------- Create VTG ----------- ");
CreateVtg params = new CreateVtg();
params.setSessionId(sessionId);
params.setVtgName("vtg1");
params.setDescription("Test VTG 1");
IntegerVO result = new IntegerVO();
try {
result = ws.createVtg(params).get_return();
} catch (RemoteException e) {
e.printStackTrace();
}
if (result.getErrorVO() != null) {
System.out.println(result.getErrorVO().getErrorMessages());
return 0;
}
System.out.println("\n VTG Id : " + result.getValue());
return result.getValue();
}
private static void testActivateVTG(String sessionId, int vtgId)
throws Exception {
System.out.println("\n----------- Activate VTG ----------- ");
ActivateVtg params = new ActivateVtg();
params.setSessionId(sessionId);
params.setVtgId(vtgId);
BooleanVO result = ws.activateVtg(params).get_return();
if (result.getErrorVO() != null) {
System.out.println(result.getErrorVO().getErrorMessages());
return;
}
System.out.println("\n Return Value : " + result.getValue());
}
private static VtgContainerVO testGetAllVtgs(String sessionId)
throws Exception
{
System.out.println("\n----------- Get All VTGs ----------- ");
PaginationContextVO pc = new PaginationContextVO();
pc.setPageNumber(1);
pc.setPageRecords(100);
pc.setTotalRecords(100);
GetAllVtgs params = new GetAllVtgs();
params.setSessionId(sessionId);
params.setPc(pc);
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
1-6
OL-21552-01
Chapter 1
Overview of Web Services API
API Security
VtgContainerVO result =
ws.getAllVtgs(params).get_return();
if (result.getErrorVO() != null) {
System.out.println(result.getErrorVO().getErrorMessages());
return null;
}
System.out.println("VTG container length : "
+ result.getVtgVOs().length);
System.out.println("VTG Total Records : "
+ result.getPaginationContextVO().getTotalRecords());
System.out.println("VTG Total Pages : "
+ result.getPaginationContextVO().getTotalPages());
return result;
}
private static void testEndSession(String sessionId) throws Exception {
System.out.println("\n----------- End Session ------------ ");
EndSession params = new EndSession();
params.setSessionId(sessionId);
ws.endSession(params);
System.out.println("Session ID deleted successfully.");
}
}
API Security
The Cisco IPICS server and the Cisco IPICS API use SSL for secure communication between the server
and client systems. 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.
By 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
Remarks
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.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
1-7
Chapter 1
Overview of Web Services API
API Logging
Table 1-1
Methods for Preventing a Client from Rejecting the Cisco IPICS Server Self-Signed
Certificate (continued)
Method
Remarks
When 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/security
3.
Download the self-signed certificate named
server.cert.pem to the client system.
4.
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
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, Cisco IPICS Release 4.0
1-8
OL-21552-01
CH A P T E R
2
Web Services API Functions
This chapter describes the Cisco web services API functions. It provides general information and
detailed descriptions for each function, and a summary of the functions, arranged by category.
This chapter includes these topics:
•
Function Guidelines, page 2-1
•
Function Summary, page 2-2.
•
Function Descriptions, page 2-8
Function Guidelines
When you use the Cisco web service API functions as documented in this chapter, be aware of the
following:
•
In general, the API functions consider only items (users, channels, photographs, radios, videos, or
VTGs), that are associated with the Cisco IPICS ops view of the user who is logged in to
Cisco IPICS web services and executes the function. If you belong to the Cisco IPICS system ops
view, the API functions consider all ops views
In particular, be aware that the find and get functions retrieve only items that are associated with
your ops view. For example, if you execute a function that retrieves all incidents or VTGs, only
incidents or VTGs that are associated with your ops view are retrieved.
•
You must have a specific Cisco IPICS role to use some functions. If you execute a function when
you do not have a valid role to do so, the function returns an ErrorVO.
•
Functions that make changes to an active VTG may cause Cisco IPICS to reprogram the RMS, which
can consume significant system resources for a long time. If you use these functions, it is a best
practice to make all VTG changes in as few web service calls as possible, or to execute these
functions at off-peak hours.
•
The function descriptions refer to various value objects (VOs). For more detailed information, see
Chapter 3, “Value Objects.”
•
Many functions require at least one identifier (ID) to indicate the item that the function is to affect.
For example, a function might require the ID of an incident (incidentId), user (userID), or VTG
(vtgId). You can obtain these IDs by using various “get” functions. See the function descriptions to
determine the function that returns the information that you need.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-1
Chapter 2
Web Services API Functions
Function Summary
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
addUserToUserGroup, page 2-14
Adds a user to a user group
associateChannelsToUser, page 2-17
Associates one or more channels with a user
associatePhonesToUser, page 2-18
Associates one or more phones with a user
associateRadiosToUser, page 2-18
Associates one or more radios with a designated user
createUser, page 2-22
Creates a Cisco IPICS user
createUserGroup, page 2-23
Creates a user group
deletePmcProfile, page 2-28
Deletes IDC profile information for the designated user
disableUser, page 2-34
Disables a Cisco IPICS user
enableUser, page 2-35
Enables a Cisco IPICS user
isActiveUser, page 2-93
Determines if a user is active or disabled
removePhoneAssociatedToUser,
page 2-97
Disassociates a phone from a user
savePmcProfile, page 2-101
Saves IDC profile information for the designated user
setBelongingOpsViewForUser,
page 2-102
Assigns an ops view to a designated user
setDialPreference, page 2-102
Adds a new dial preference for a user
setDigitId, page 2-103
Sets digit IDs for a user
setDigitPassword, page 2-104
Sets a digit password for a user
setNotificationPreference, page 2-107
Adds a new notification preference for a user
setUserAddress, page 2-107
Adds a physical address for a user
setUserAudioStatus, page 2-108
Enables or disables the ability of a user to hear and transmit
audio on a PMC
setUserListenerStatus, page 2-109
Enables or disables the ability of a user to transmit audio
on a PMC
updateUserGroup, page 2-113
Modifies various attributes of a user group
Functions for VTG Management
activateVtg, page 2-9
Activates a VTG (if it is not activated already)
addChannelToVtg, page 2-10
Adds a channel to an active or inactive VTG
addRadioToVtg, page 2-13
Adds a radio to an active or inactive VTG
addParticipantsToVtg, page 2-11
Adds any combination of resources (channel, radio, user,
and VTG) to a VTG
addResourcesToVtg, page 2-13
Adds one or more resources of the same type (users,
channels, radios, or VTGs) to a VTG
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-2
OL-21552-01
Chapter 2
Web Services API Functions
Function Summary
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
addUserToVtg, page 2-14
Adds a user to an active or inactive VTG
addVtgParticipants, page 2-16
Adds any combination of resources (channels, radios,
users, and VTGs) to a VTG
addVtgToVtg, page 2-17
Add a VTG to another VTG
createVtg, page 2-24
Creates a VTG with the designated name
deactivateVtg, page 2-27
Deactivates a VTG
isActiveVtg, page 2-93
Determines if a VTG is active or disabled
removeChannelFromVtg, page 2-96
Removes a channel from a VTG
removeUserFromVtg, page 2-99
Removes a user from a VTG
removeRadioFromVtg, page 2-98
Removes a radio from a VTG.
removeVtgFromVtg, page 2-100
Removes a VTG from a VTG
setVtgOptions, page 2-109
Sets various options for a VTG
setVtgUserOptions, page 2-110
Sets various options for a designated user in a VTG
updateVirtualTalkGroup, page 2-114
Modifies various attributes of a video
Functions for Incident Management
activateIncident, page 2-8
Activates an incident (if it is not activated already)
activateIncidentVtg, page 2-9
Creates and activates an incident VTG for a designated
incident
addJournalToIncident, page 2-11
Creates a journal entry and associates it with an incident
addPhotoToIncident, page 2-12
Adds the URL of a photograph to an incident and
associates the photograph with the incident
addVideoToIncident, page 2-15
Creates the URL of a video to an incident and associates
the video with the incident
associateResourcesToIncident, page 2-19 Associates one or more resources of the same type (users,
channels, photographs, radios, videos, or VTGs) with an
incident.
createIncident, page 2-21
Creates an incident
createPhoto, page 2-21
Adds the URL of a photograph to Cisco IPICS
createVideo, page 2-23
Adds the URL of a video to Cisco IPICS
deactivateIncident, page 2-26
Deactivates an incident
deactivateIncidentVtg, page 2-26
Deactivates an incident VTG
isActiveIncidentVtg, page 2-92
Determines if an incident VTG in a designated incident is
active or inactive
removeResourceFromIncident, page 2-98 Disassociates one or more resource from an incident
removeVtgParticipants, page 2-100
Removes one or more participants from a VTG
setIncidentVtgOptions, page 2-105
Sets various options for an incident VTG
setIncidentVtgUserOptions, page 2-106
Sets various options for a designated user in an incident
VTG
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-3
Chapter 2
Web Services API Functions
Function Summary
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
updateIncident, page 2-112
Modifies various attributes of an incident
updatePhoto, page 2-113
Modifies various attributes of a photograph
updateVideo, page 2-114
Modifies various attributes of a video
Functions for Channel Management
createChannel, page 2-20
Creates a channel
disableChannel, page 2-33
Changes a channel to DISABLED state if the current
channel state is IDLE
enableChannel, page 2-35
Changes a channel IDLE state if the current channel state
is DISABLED
isActiveChannel, page 2-91
Determines if a channel is active or disabled
Functions for Policy and Dial Function Management
dialAllIncidentVtgMembers, page 2-29
Dials out to all user who are members of an incident VTG
dialAllVtgMembers, page 2-30
Dials out to all users who are members of a VTG, including
members of user groups that are part of the VTG
dialIncidentVtgMember, page 2-31
Dials out to the specified member of an incident VTG
dialVtgMember, page 2-32
Dials out to the specified member of a VTG
executeNotificationPolicy, page 2-36
Executes the notification policy that has the designated ID
executePolicy, page 2-37
Executes a designated policy
notifyAllIncidentVtgMembers, page 2-94 Sends a notification to each user in the incident VTG of the
designated incident
notifyAllVtgMembers, page 2-94
Sends a notification to each user in the incident VTG of the
designated incident
notifyIncidentVtgMember, page 2-95
Notifies a designated member of an incident VTG
notifyVtgMember, page 2-96
Notifies a specific member of a VTG
Functions for Obtaining Information
findChannelGroups, page 2-38
Retrieves each channel group with a name that matches a
designated search criterion
findChannels, page 2-38
Retrieves each channel with a name that matches a
designated search criterion
findIncidents, page 2-39
Retrieves each incident with a name that matches a
designated search criterion
findPhotos, page 2-40
Retrieves each photograph with a name that matches a
designated search criterion
findRadios, page 2-41
Retrieves each radio with a name that matches a designated
search criterion
findUserGroups, page 2-41
Retrieves each user group with a name that matches a
designated search criterion
findUsers, page 2-42
Retrieves each user with a user name that matches a
designated search criterion
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-4
OL-21552-01
Chapter 2
Web Services API Functions
Function Summary
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
findVideos, page 2-43
Retrieves each video with a name that matches a designated
search criterion
findVtgs, page 2-44
Retrieves each VTG with a name that matches a designated
search criterion
getAllChannels, page 2-45
Retrieves all channels that are associated with your
Cisco IPICS ops view
getAllChannelGroups, page 2-44
Retrieves all channel groups that are associated with your
Cisco IPICS ops view
getAllChannelsInChannelGroup,
page 2-45
Retrieves all channels that are in the designated channel
group
getAllIncidents, page 2-46
Retrieves all incidents that are associated with your
Cisco IPICS ops view
getAllIncidentsWithIVtgStatus,
page 2-47
Retrieves all incidents that are associated with your
Cisco IPICS ops view and the status of each incident VTG
that is associated with an incident
getAllPhotos, page 2-47
Retrieves all photographs that are associated with your
Cisco IPICS ops view
getAllPolicies, page 2-48
Retrieves all policies that are associated with your
Cisco IPICS ops view
getAllRadios, page 2-48
Retrieves all radios that are associated with your
Cisco IPICS ops view
getAllUserGroups, page 2-49
Retrieves all user groups that are associated with your
Cisco IPICS ops view
getAllUsers, page 2-50
Retrieves all Cisco IPICS users that are associated with
your Cisco IPICS ops view
getAllVideos, page 2-50
Retrieves all videos that are associated with your
Cisco IPICS ops view
getAllVtgs, page 2-51
Retrieves all VTGs that are associated with your Cisco
IPICS ops view
getBelongingOpsViewForUser,
page 2-51
Retrieves the ops view to which a designated user belongs
getChannel, page 2-52
Retrieves summary information about a designated channel
getChannelDetails, page 2-53
Retrieves detailed information about a designated channel
getChannelGroupsForVtg, page 2-53
Retrieves a list of channel groups s that are associated with
a designated VTG.
getChannelsAssociatedToUser,
page 2-54
Retrieves all channels that are associated with a user
getChannelsForIncident, page 2-55
Retrieves a list of channels that are associated with an
incident
getChannelsForVtg, page 2-55
Retrieves a list of channels that are associated with a VTG
getDigitId, page 2-56
Retrieves the digit ID for a user
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-5
Chapter 2
Web Services API Functions
Function Summary
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
getDigitPassword, page 2-57
Retrieves the digit password for a user
getIncident, page 2-58
Retrieves summary information about a designated
incident
getIncidentDetails, page 2-58
Retrieves detailed information about a designated incident
getIncidentParticipants, page 2-59
Retrieves all resources (channels, journals, radios,
photographs, users, videos, and VTGs) that are associated
with an incident.
getIncidentsForUser, page 2-59
Retrieves a list of all incidents that are associated with a
designated user.
getIncidentVtg, page 2-60
Retrieves information about the incident VTG that is
associated with a designated incident
getIncidentVtgOptions, page 2-61
Retrieves VTG options for the incident VTG that is
associated with a designated incident
getIncidentVtgUserOptions, page 2-61
Retrieves incident VTG options for an incident VTG user.
getIpicsVersion, page 2-62
Retrieves the version of Cisco IPICS that is running on
active Cisco IPICS server
getJournal, page 2-63
Retrieves summary information about a designated journal
getJournalDetails, page 2-63
Retrieves summary information about a designated journal
getJournalsForIncident, page 2-64
Retrieves all journals for a designated incident
getPhonesAssociatedToUser, page 2-64
Retrieves all phones that are associated with a designated
user
getPhoto, page 2-65
Retrieves summary information about a photograph
getPhotoDetails, page 2-66
Retrieves detailed information about a photograph
getPhotosForIncident, page 2-66
Retrieves a list of photographs that are associated with a
designated incident.
getPmcProfile, page 2-67
Retrieves IDC profile information for the designated user
getPoliciesAssociatedToUser, page 2-67
Retrieves all policies that are associated with a designated
user
getPolicy, page 2-68
Retrieves summary information about a policy
getPolicyDetails, page 2-69
Retrieves detailed information about a policy
getPolicyExecutionStatus, page 2-69
Retrieves the status of the execution of a designated policy
getPolicyExecutionStatusDetails,
page 2-70
Retrieves detailed status information about the execution
of each policy that is associated with a designated user
getRadiosAssociatedToUser, page 2-71
Retrieves a list of radios that are associated with a
designated user
getRadiosForIncident, page 2-71
Retrieves a list of radios that are associated with a
designated incident.
getRadiosForVtg, page 2-72
Retrieves a list of radios that are associated with a
designated VTG.
getUser, page 2-72
Retrieves summary information about the designated user
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-6
OL-21552-01
Chapter 2
Web Services API Functions
Function Summary
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
getUserAddress, page 2-73
Retrieves the physical address of a designated user
getUserAudioStatus, page 2-74
Retrieves a flag that indicates if the PMC of a user has
audio disabled or enabled
getUserDetails, page 2-74
Retrieves detailed information about a designated user
getUserDialPreference, page 2-75
Retrieves the dial preference that is associated with a
designated user
getUserDirectory, page 2-75
Retrieves the users for whom a direct connect number is
assigned in the designated serial radio descriptor file
getUserGroup, page 2-76
Retrieves summary information about the designated user
group
getUserGroupMembers, page 2-77
Retrieves all the users in a designated user group
getUserGroupsForVtg, page 2-77
Retrieves user groups that are associated with a designated
VTG
getUserId, page 2-78
Retrieves the system-generated user ID for the designated
user
getUserListenerStatus, page 2-78
Retrieves a flag that indicates whether the PMC of a user is
in listen-only mode
getUserNotificationPreference,
page 2-79
Retrieves the notification preference that is associated with
a designated user
getUserRoles, page 2-80
Retrieves the list of roles for a designated user
getUsersAssociatedToRadio, page 2-81
Return a list of users that are associated with a designated
radio
getUsersForIncident, page 2-81
Retrieves a list of users that are associated with a
designated incident
getUsersForVtg, page 2-82
Retrieves a list of users that are associated with a
designated VTG
getUserStatus, page 2-83
Retrieves the active status of one or more users
getVideo, page 2-83
Retrieves summary information about the designated video
getVideoDetails, page 2-84
Retrieves detailed information about the designated video
getVideosForIncident, page 2-84
Retrieves a list of videos that are associated with a
designated incident
getVtgDetails, page 2-85
Retrieves detailed information about the designated VTG
getVtgOptions, page 2-86
Retrieves information about the status of a variety of
options for a VTG
getVtgParticipants, page 2-86
Retrieves all participants in a VTG
getVtgParticipantStatus, page 2-87
Retrieves the status of VTG participant
getVtgsAssociatedToUser, page 2-88
Retrieves all VTGs that are associated with a user
getVtgsForIncident, page 2-89
Retrieves a list of VTGs that are associated with a
designated incident
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-7
Chapter 2
Web Services API Functions
Function Descriptions
Table 2-1
API Function Summary (continued)
Function Name and Reference
Description
getVtgsForVtg, page 2-89
Retrieves a list of VTGs that are associated with a
designated VTG.
getVtgStatus, page 2-90
Retrieves the ID, name, description, and status of a VTG
getVtgUserOptions, page 2-91
Retrieves the settings of the latch, listen only, and rxmute
VTG options settings for a designated VTG and user
Functions for General Operations
deleteResources, page 2-28
Deletes designated resources
endSession, page 2-36
Ends a web services session
startSession, page 2-111
Starts a web services session
Function Descriptions
The following sections describe each Cisco IPICS API function in detail. The function descriptions
provide the following information:
Note
•
Function name—Name of the function.
•
Description—General behavior for the function.
•
Role—Cisco IPICS role that you must have to use the function. If you execute a function when you
do not have a valid role to do so, the function returns an ErrorVO. At a minimum, everyone who uses
Cisco IPICS has the User role, so functions for which the Role is identified as “User” are available
to all Cisco IPICS users.
•
Parameters—Parameters that the function requires.
•
Return result—Describes the result that Cisco IPICS returns for the function.
•
Sample response—Example of a response that the function can receive.
The “Function Guidelines” section on page 2-1 provides important information that relates to many of
the functions that the following sections describe.
activateIncident
Function name
activateIncident
Description
Activates an incident (if it is not activated already).
Role
Dispatcher
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident to be activated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-8
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Return result
IntegerVO that contains 1 if the designated incident is activated or 0
if it is not activated.
The IntegerVO also contains an ErrorVO, which is empty if the
incident is activated, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="activateIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
activateIncidentVtg
Function name
activateIncidentVtg
Description
Creates and activates an incident VTG for a designated incident.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident for which to activate the
incident VTG.
BooleanVO that contains true if the incident VTG is created and
activated, or false if the incident VTG is not created and activated.
The BooleanVO also contains an ErrorVO, which is empty if the
incident VTG is created and activated, or contains an explanation if
an exception occurs when the function executes.
Sample response
<xs:element name="activateIncidentVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
activateVtg
Description
Activates a VTG (if it is not activated already).
activateVtg
Role
•
IDC patch—User (with advanced IDC permissions)
•
VTG—Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-9
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to be activated.
BooleanVO that contains true if the VTG is activated, or false if the
VTG is not activated.
The BooleanVO also contains an ErrorVO, which is empty if the VTG
is activated, or contains an explanation if an exception occurs when
the function executes.
Sample response
<xs:element name="activateVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
addChannelToVtg
Function name
addChannelToVtg
Description
Adds a channel to an active or inactive VTG.
Role
Parameters
Return result
•
IDC patch—User (with advanced IDC permissions)
•
VTG—Dispatcher
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
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.
BooleanVO that contains true if the channel is added to the VTG, or
false if the channel is not added to the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the
channel is added, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="addChannelToVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-10
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
addJournalToIncident
Function name
addJournalToIncident
Description
Creates a journal entry and associates it with an incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)— ID of the incident to which the journal entry is
to be added.
•
journalVO (JournalDetailsVO)—Journal to add.
IntegerVO that contains the ID of the new journal if the journal is
created and associated with the designated incident, or 0 if the journal
is not created and associated with the designated incident.
The IntegerVO also contains an ErrorVO, which is empty if the
journal is created and added, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="addJournalToIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
addParticipantsToVtg
Function name
addParticipantsToVtg
Description
Adds any combination of resources to a VTG. Resources can be
channels, radios, users, and VTGs. This function provides the same
functionality as the addVtgParticipants function, with the addition of
the ability to add a description for each resource.
Role
Dispatcher
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to which the list of resources is to be
added.
•
vtgParticipants (VtgParticipantVO[])—Array of resources to be
added to the VTG.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-11
Chapter 2
Web Services API Functions
Function Descriptions
Return result
BooleanVO that contains true if the resources are added to the VTG,
or false if the resources are not added to the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the
resources are added, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="addParticipantsToVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
addPhotoToIncident
Function name
addPhotoToIncident
Description
Adds the URL of a photograph to an incident and associates the
photograph with the incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident to which the photograph is to
be added.
•
photo (PhotoDetailsVO)—Information about the photograph
URL to add to the incident.
•
autoDelete (boolean)—If true, the Cisco IPICS database record
for the photograph and the photograph file (if the file exists on the
Cisco IPICS server) are deleted automatically when all incidents
with which the photograph are associated are deleted. If false, the
Cisco IPICS database record for the photograph and the
photograph file are never deleted automatically.
IntegerVO that contains the ID the record of the photograph if the
photograph is associated with an incident, or 0 if an error occurs.
The IntegerVO also contains an ErrorVO, which is empty if the
photograph is associated, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="addPhotoToIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-12
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
addRadioToVtg
Function name
addRadioToVtg
Description
Adds a radio to an active or inactive VTG.
Role
Parameters
Return result
•
IDC patch—User (with advanced IDC permissions)
•
VTG—Dispatcher
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to which the radio is to be added.
•
radioId (int)—ID of the radio to add.
BooleanVO that contains true if the radio is added to the VTG, or
false if the radio is not added to the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the radio
is added, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="addRadioToVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
addResourcesToVtg
Function name
addResourcesToVtg
Description
Adds one or more resources of the same type to a VTG. Resources can
be users, channels, radios, or VTGs.
Role
Dispatcher
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to which the list of resources is to be
added.
•
resourceIds (int[])—Array of IDs of each resource to add to the
VTG.
•
resourceType (String)—Type of resource to add (user, channel,
radio, or VTG).
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-13
Chapter 2
Web Services API Functions
Function Descriptions
Return result
BooleanVO that contains true if the resources are added to the VTG,
or false the resources are not added to the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the
resources are added, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="addResourcesToVtgResponse">
<xs:complexType>
<xs:sequence>
<xxs:element minOccurs="0"
name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
addUserToUserGroup
Function name
addUserToUserGroup
Description
Adds a user to a user group.
Role
Operator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user to be
added to the specified user group. This parameter must be entered
in all lower case.
•
userGroupId (int)—ID of the user group to which the user is to
be added.
BooleanVO that contains true if the user is added to the user group,
or false if the user is not added to the user group.
The BooleanVO also contains an ErrorVO, which is empty if the user
is added, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="addUserToUserGroupResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
addUserToVtg
addUserToVtg
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-14
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Description
Role
Parameters
Return result
Adds a user to an active or inactive VTG.
•
IDC patch—User (with advanced IDC permissions)
•
VTG—Dispatcher
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to which the user is to be added.
•
userLogin (String)—Cisco IPICS user name of the user to be
added to the specified VTG. This parameter must be entered in
all lower case.
BooleanVO that contains true if the user is added to the VTG, or false
if the user is not added to the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the user
added, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="addUserToVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
addVideoToIncident
Function name
addVideoToIncident
Description
Creates the URL of a video to an incident and associates the video
with the incident.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident to which the video is to be
added.
•
video (VideoDetailsVO)—Information about the video URL to
add to the incident.
•
autoDelete (boolean)—If true, the Cisco IPICS database record
for the video and the video file (if the file exists on the Cisco
IPICS server) are deleted automatically when all incidents with
which the video are associated are deleted. If false, the Cisco
IPICS database record for the video and the video file are never
deleted automatically.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-15
Chapter 2
Web Services API Functions
Function Descriptions
Return result
IntegerVO that contains the ID the record of the photograph if the
video is associated with an incident, or 0 if an error occurs.
The IntegerVO also contains an ErrorVO, which is empty if the video
is associated, or contains an explanation if an exception occurs when
the function executes.
Sample response
<xs:element name="addVideoToIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
addVtgParticipants
Function name
addVtgParticipants
Description
Adds any combination of resources to a VTG. Resources include
channels, radios, users, and VTGs. This function provides the same
functionality as the addParticipantsToVtg function, but does not
include the ability to add a description for each resource.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to which the participants are to be
added.
•
parts (ResourceContainerVO)—VO that contains the list of
participants to add to the VTG.
IntegerVO that contains the number of resources that are added to the
VTG.
The IntegerVO also contains an ErrorVO, which is empty if all
designated resources are added, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="addVtgParticipantsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-16
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
addVtgToVtg
Function name
addVtgToVtg
Description
Adds a VTG to another active or inactive VTG.
Role
Parameters
Return result
•
IDC patch—User (with advanced IDC permissions)
•
VTG—Dispatcher
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgIdAdd (int)—ID of the VTG to be added.
•
vtgId (int)—ID of the VTG to which the other VTG is to be
added.
BooleanVO that contains true if the VTG is added to the VTG, or
false if the VTG is not added to the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the VTG
is added, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="addVtgToVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
associateChannelsToUser
Function name
associateChannelsToUser
Description
Associates one or more channels with a user.
Role
Operator
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user with
whom to associate one or more channels. This parameter must be
entered in all lower case.
•
channels (ChannelContainerVO)—Collection of channel value
objects, each of which contains a channel ID and channel name.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-17
Chapter 2
Web Services API Functions
Function Descriptions
Return result
BooleanVO that contains true if the channel is associated with the
user, or false if the channel is not associated with the user.
The BooleanVO also contains an ErrorVO, which is empty if the
channel is associated, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="associateChannelsToUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
associatePhonesToUser
Function name
associatePhonesToUser
Description
Associates one or more phones with a user.
Role
Operator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user with
whom to associate one more phones. This parameter must be
entered in all lower case.
•
dialNumbers (String[])—Dial number of each phone to associate
with the user.
BooleanVO that contains true if the phone is associated with the user,
or false if the phone is not associated with the user.
The BooleanVO also contains an ErrorVO, which is empty if the
phone is associated, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="associatePhonesToUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
associateRadiosToUser
Function name
associateRadiosToUser
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-18
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Description
Associates one or more radios with a user.
Role
Operator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user with
whom to associate one or more radios. This parameter must be
entered in all lower case.
•
radios (RadioContainerVO)—A collection of radio value objects,
each of which contains a radio ID and radio name.
BooleanVO that contains true if the radio is associated with the user,
or false if the radio is not associated with the user.
The BooleanVO also contains an ErrorVO, which is empty if the radio
is associated, or contains an explanation if an exception occurs when
the function executes.
Sample response
<xs:element name="associateRadiosToUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
associateResourcesToIncident
Function name
associateResourcesToIncident
Description
Associates one or more resources of the same type with an incident.
Resources can be users, channels, photographs, radios, videos, or
VTGs.
Role
•
To associate a channel—Administrator or Dispatcher
•
To associate a photograph—User
•
To associate a radio—Administrator or Dispatcher
•
To associate a user—Dispatcher or Operator
•
To associate a video—User
•
To associate a VTG—Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-19
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that is to include the
resource.
•
resourceType—Type of resource (user, channel, photograph,
radio, video, or VTG).
•
resourceIds (int[])—IDs of the resources to add to the incident.
IntegerVO that contains a value that indicates how many resources
have been associated with the incident.
The IntegerVO also contains an ErrorVO, which is empty if all
designated resources are associated, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="associateResourcesToIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
createChannel
Function name
createChannel
Description
Creates a channel with the specified name and short name.
Role
Administrator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelName (String)—Unique name of the channel to be
created. The name can include up to 20 characters and spaces.
The following characters are not allowed: ! @ $ % ^ & * + = [ ]
\;{}|“<>?~‘
•
channelShortName (String)—Unique short name of the channel
to be created. The name can include up to 5 alphanumeric
characters and spaces. The following characters are not allowed:
!@$%^&*+=[]\;{}|“<>?~‘
IntegerVO that contains the ID of the channel, if the channel is
created.
The IntegerVO also contains an ErrorVO, which is empty if the
channel is created, or contains an explanation if an exception occurs
when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-20
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="createChannelResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
createIncident
Function name
createIncident
Description
Creates an incident that is in the active state.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incident (IncidentDetailsVO)—Information about the incident to
be created.
IntegerVO that contains the ID of the of the incident, if the incident
is created.
The IntegerVO also contains an ErrorVO, which is empty if the
incident is created, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="createIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
createPhoto
Description
Adds the URL of a photograph to Cisco IPICS. The URL can be used
to associate the photograph with an incident later.
Role
User
createPhoto
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-21
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
photo (PhotoDetailsVO)—URL of a photograph to add to Cisco
IPICS.
•
autoDelete—If true, the Cisco IPICS database record for the
photograph and the photograph file (if the file exists on the Cisco
IPICS server) are deleted automatically when all incidents with
which the photograph are associated are deleted. If false, the
Cisco IPICS database record for the photograph and the
photograph file are never deleted automatically.
IntegerVO that contains the ID of the of the photograph, if the
photograph is created.
The IntegerVO also contains an ErrorVO, which is empty if the
photograph is created, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="createPhotoResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
createUser
Description
Creates a Cisco IPICS user
Role
Operator
createUser
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user to be
created. This parameter must be entered in all lower case.
•
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
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-22
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Return result
IntegerVO that contains the ID of the of the user, if the user is created.
The IntegerVO also contains an ErrorVO, which is empty if the user
is created, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="createUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
createUserGroup
Function name
createUserGroup
Description
Creates a Cisco IPICS user group with the specified name and
description.
Role
Operator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
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.
IntegerVO that contains the ID of the of the user group, if the user
group is created.
The IntegerVO also contains an ErrorVO, which is empty if the user
group is created, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="createUserGroupResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
createVideo
createVideo
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-23
Chapter 2
Web Services API Functions
Function Descriptions
Description
Adds the URL of a video to Cisco IPICS. The URL can be used to
associate the video with an incident later.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
video (VideoDetailsVO)—URL of a video to add to Cisco IPICS.
•
autoDelete—If true, the Cisco IPICS database record for the
video and the video file (if the file exists on the Cisco IPICS
server) are deleted automatically when all incidents with which
the video are associated are deleted. If false, the Cisco IPICS
database record for the video and the video file are never deleted
automatically.
IntegerVO that contains the ID of the of the video, if the video is
created.
The IntegerVO also contains an ErrorVO, which is empty if the video
is created, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="createVideoResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
createVtg
createVtg
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-24
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Description
Creates a VTG with the designated name.
The VTG can be either a regular VTG or a patch VTG. A regular
VTG, which also can be created through the Cisco IPICS
Administration Console or the VTG tab in the IDC, remains in the
system and can be activated and deactivated as needed. A patch VTG,
which you create in the IDC by using the Patch button in the Dial Pad
and Channel Patch Area or the Patch button in the PTT and Patch
Controls Area, is a temporary VTG that is deleted when the patch is
removed.
The following guidelines apply when the createVtg function is used
to create a patch VTG:
•
Advanced IDC Permissions must be configured in the
Cisco IPICS Administration Console for the user who is creating
the patch.
•
The name of the patch VTG can contain a maximum of 40
characters and must be named patchnumber.user, where
– number is a unique numerical sequence
– user is the Cisco IPICS user name of the user who is created
the patch
Role
Parameters
Return result
•
A user can have 1 patch VTG in effect at a time.
•
When this function executes, the API program calls createVtg(),
followed by addParticipantsToVtg(), followed by activateVtg().
•
When the client (program) unpatches, it calls deactivateVtg(),
followed by deleteResources(session, int[] { vtgid }, VTG, true).
•
When the client shuts down or logs out, the unpatch occurs
automatically.
•
IDC patch—User (with advanced IDC permission)
•
VTG—Dispatcher
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgName (String)—Name of the VTG to be created.
•
description (String)—Description of the VTG.
IntegerVO that contains the ID of the of the VTG, if the VTG is
created.
The IntegerVO also contains an ErrorVO, which is empty if the VTG
is created, or contains an explanation if an exception occurs when the
function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-25
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="createVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
deactivateIncident
Function name
deactivateIncident
Description
Deactivates an Incident. This action changes the incident state from
Active to Inactive, deactivates its incident VTG if it is activated, and
releases the incident VTG resources.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident to deactivate.
IntegerVO that contains 1 if the incident is deactivated, or 0 if the
incident is not deactivated.
The IntegerVO also contains an ErrorVO, which is empty if the
incident is deactivated, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="deactivateIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
deactivateIncidentVtg
Function name
deactivateIncidentVtg
Description
Deactivates an incident VTG.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-26
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that includes the incident
VTG to deactivate.
BooleanVO that contains true if the incident VTG is deactivated, or
false if the incident VTG is not deactivated.
The BooleanVO also contains an ErrorVO, which is empty if the
incident VTG is deactivated, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="deactivateIncidentVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
deactivateVtg
Description
Deactivates a VTG.
deactivateVtg
Role
Parameters
Return result
•
IDC patch—User (with advanced IDC permissions)
•
VTG—Dispatcher
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to deactivate.
BooleanVO that contains true if the VTG is deactivated, or false if
the VTG is not deactivated.
The BooleanVO also contains also contains an ErrorVO, which is
empty if the VTG is deactivated, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="deactivateVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-27
Chapter 2
Web Services API Functions
Function Descriptions
deletePmcProfile
Function name
deletePmcProfile
Description
Deletes Cisco IPICS Dispatch Console (IDC) profile information for
the designated user. The system uses profile information to cause an
IDC to appear and function in the same way for a user regardless of
the PC on which the user runs the IDC.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
id (int)—ID of the user whose profile is to be deleted.
IntegerVO that contains 1 if the IDC profile information is deleted, or
0 if the IDC profile information is not deleted.
The IntegerVO also contains also contains an ErrorVO, which is
empty if the IDC profile information is deleted, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="deletePmcProfileResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
deleteResources
Function name
deleteResources
Description
Deletes one or more resources of the same type from Cisco IPICS.
Resources can be users, channels, photographs, radios, videos, or
VTGs.
Role
•
To delete a channel or radio—Administrator
•
To delete a photograph or video—User
•
To delete a user—Operator
•
To delete a VTG—Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-28
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
resourceIds (int[])—ID of the resource to delete. If you specify
more than one resourceId parameter, each must be the same type.
•
resourceType (String)—Type of resource to delete (user, channel,
photograph, radio, video, or VTG).
•
autoDeleteReferences (boolean)—If true, the Cisco IPICS
database records for the resources and the resource files (if the
files exists for photographs or videos on the Cisco IPICS server)
are deleted automatically when all incidents and VTGs with
which the resources are associated are deleted. If false, the Cisco
IPICS database record for the resources and the resource files are
never deleted automatically.
BooleanVO that contains true if some or all of the designated
resources are deleted, or false if none of the resources are deleted.
The BooleanVO also contains an ErrorVO, which is empty if all
designated resources are deleted, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="deleteResourcesResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
dialAllIncidentVtgMembers
Function name
dialAllIncidentVtgMembers
Description
Dials out to all user users who are members of an incident VTG.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-29
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that includes the incident
VTG whose members you want to dial.
•
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> and
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
BooleanVO that contains true if the dial out is successful to all
members of the incident VTG, or false if the dial out is not successful
to all members of the incident VTG.
The BooleanVO also contains an ErrorVO, which is empty if the dial
out is successful to all members of the incident VTG, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="dialAllIncidentVtgMembersResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
dialAllVtgMembers
Function name
dialAllVtgMembers
Description
Dials out to all user who are members of a VTG, including members
of user groups that are part of the VTG.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-30
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services session.
•
vtgId (int)—ID 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
BooleanVO that contains true if the dial out is successful to all
members of the VTG, or false if the dial out is not successful to all
members of the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the dial
out is successful to all members of the VTG, or contains an explanation
if an exception occurs when the function executes.
Sample response
<xs:element name="dialAllVtgMembersResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
dialIncidentVtgMember
Function name
dialIncidentVtgMember
Description
Dials out to the specified member of an incident VTG.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-31
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that includes the incident
VTG with the member to dial.
•
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
userLogin (String)—Cisco IPICS user name of the incident VTG
member to be dialed. This parameter must be entered in all lower
case.
BooleanVO that contains true if the dial out is successful to the
incident VTG member, or false if the dial out is not successful to the
incident VTG member.
The BooleanVO also contains an ErrorVO, which is empty if the dial
out is successful to the incident VTG member, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="dialIncidentVtgMemberResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
dialVtgMember
Function name
dialVtgMember
Description
Dials out to the specified member of a VTG.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-32
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG that includes the member to dial.
•
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
userLogin—Cisco IPICS user name of the VTG member to be
dialed. This parameter must be entered in all lower case.
BooleanVO that contains true if the dial out is successful to the VTG
member, or false if the dial out is not successful to the VTG member.
The BooleanVO also contains an ErrorVO, which is empty if the dial
out is successful to the VTG member, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="dialVtgMemberResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
disableChannel
Function name
disableChannel
Description
Changes a channel to DISABLED state. Applies only if the current
channel state is IDLE.
Role
Administrator
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelId (int)—ID of the channel to disable.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-33
Chapter 2
Web Services API Functions
Function Descriptions
Return result
BooleanVO that contains true if the channel is disabled, or false if the
channel is not disabled.
The BooleanVO also contains an ErrorVO, which is empty if the
channel is disabled, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="disableChannelResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
disableUser
Description
Changes a user to the Disabled state in Cisco IPICS. If you execute
this function for a user who is logged in to the Cisco IPICS
Administration Console the user is logged out automatically when
trying to perform an activity. If you execute this function for a user
who is logged in to the IDC, the user is logged out automatically the
next time that the IDC polls the IPICS server.
Role
Operator
disableUser
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user to
disable. This parameter must be entered in all lower case.
BooleanVO that contains true if the user is disabled, or false if the
user is not disabled.
The BooleanVO also contains an ErrorVO, which is empty if the user
is disabled, or contains an explanation if an exception occurs when
the function executes.
Sample response
<xs:element name="disableUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-34
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
enableChannel
Function name
enableChannel
Description
Changes a channel IDLE state. Applies only if the current channel
state is DISABLED.
Role
Administrator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelId (int)—ID of the channel to enable.
BooleanVO that contains true if the channel is enabled, or false if the
channel is not enabled.
The BooleanVO also contains an ErrorVO, which is empty if the
channel is enabled, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="enableChannelResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
enableUser
Description
Changes a user to the Enabled state in Cisco IPICS.
Role
Operator
enableUser
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user to
enabled. This parameter must be entered in all lower case.
BooleanVO that contains true if the user is enabled, or false if the
user is not enabled.
The BooleanVO also contains an ErrorVO, which is empty if the user
is enabled, or contains an explanation if an exception occurs when the
function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-35
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="enableUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
endSession
Description
Ends a designated web services session. A user with the Cisco IPICS
Administrator role or the All role can end any session. Users with
other Cisco IPICS roles can end only sessions that belong to them.
Role
—
endSession
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
BooleanVO that contains true if the session is ended, or false if the
session is not ended.
The BooleanVO also contains an ErrorVO, which is empty if the
session is ended, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="endSessionResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
executeNotificationPolicy
Function name
executeNotificationPolicy
Description
Executes a designated notification policy. 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.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-36
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
policyId (int)—ID of the policy to execute.
•
msgText (String)—Text of message that the TTS function to play
to recipients.
BooleanVO that contains true if the notification is executed, or false
if the notification is not executed.
The BooleanVO also contains an ErrorVO, which is empty if the
notification is executed, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="executeNotificationPolicyResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
executePolicy
Function name
executePolicy
Description
Executes a designated policy.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
policyId (int)—ID of the policy to execute.
BooleanVO that contains true if the policy is executed, or false if the
policy is not executed.
The BooleanVO also contains an ErrorVO, which is empty if the
policy is executed, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="executePolicyResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-37
Chapter 2
Web Services API Functions
Function Descriptions
findChannelGroups
Function name
findChannelGroups
Description
Retrieves each channel group with a name that matches a designated
search criterion.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelGroupVO (ChannelGroupVO)—Search criterion for the
name to retrieve. The search criterion can be the complete name,
or the beginning character or characters of the name. The name is
sensitive and the percent character (%) can be used as a wildcard
to match any character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channel groups are returned
and these results are not paginated.
ChannelGroupContainerVO that contains channel groups that match
the search criterion.
The ChannelGroupContainerVO also contains an ErrorVO, which is
empty if one or more channel groups are retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="findChannelGroupsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelGroupContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
findChannels
Description
Retrieves each channel with a name that matches a designated search
criterion.
Role
User
findChannels
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-38
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channel (ChannelVO)—Search criterion for the name to retrieve.
The search criterion can be the complete name, or the beginning
character or characters of the name. The name is sensitive and the
percent character (%) can be used as a wildcard to match any
character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channels are returned and these
results are not paginated.
ChannelContainerVO that contains channels that match the search
criterion.
The ChannelContainerVO also contains an ErrorVO, which is empty
if one or more channels are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="findChannelsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
findIncidents
Description
Retrieves each incident with a name that matches a designated search
criterion.
Role
User
findIncidents
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incident (IncidentDetailsVO)—Search criterion for the name to
retrieve. The search criterion can be the complete name, or the
beginning character or characters of the name. The name is
sensitive and the percent character (%) can be used as a wildcard
to match any character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all incidents are returned and these
results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-39
Chapter 2
Web Services API Functions
Function Descriptions
Return result
IncidentContainerVO that contain incidents that match the search
criterion.
The IncidentContainerVO also contains an ErrorVO, which is empty
if one or more incidents are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="findIncidentsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
findPhotos
Description
Retrieves each photograph with a name that matches a designated
search criterion.
Role
User
findPhotos
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
photo (PhotoDetailsVO)—Search criterion for the name to
retrieve. The search criterion can be the complete name, or the
beginning character or characters of the name. The name is
sensitive and the percent character (%) can be used as a wildcard
to match any character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all photographs are returned and
these results are not paginated.
PhotoContainerVO that contains an array of photographs that match
the search criterion.
The PhotoContainerVO also contains an ErrorVO, which is empty if
one or more photographs are retrieved, or contains an explanation if
an exception occurs when the function executes.
Sample response
<xs:element name="findPhotosResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PhotoContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-40
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
findRadios
Function name
findRadios
Description
Retrieves each radio with a name that matches a designated search
criterion.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
radio (RadioDetailsVO)—Search criterion for the name to
retrieve. The search criterion can be the complete name, or the
beginning character or characters of the name. The name is
sensitive and the percent character (%) can be used as a wildcard
to match any character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all radios are returned and these
results are not paginated.
RadioContainerVO that contains an array of radios that match the
search criterion.
The RadioContainerVO also contains an ErrorVO, which is empty if
one or more radios are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="findRadiosResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:RadioContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
findUserGroups
Function name
findUserGroups
Description
Retrieves each user group with a name that matches a designated
search criterion.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-41
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
group (UserGroupDetailsVO)—Search criterion for the name to
retrieve. The search criterion can be the complete name, or the
beginning character or characters of the name. The name is
sensitive and the percent character (%) can be used as a wildcard
to match any character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all user groups are returned and
these results are not paginated.
UserGroupContainerVO that contains an array of user groups that
match the search criterion.
The UserGroupContainerVO also contains an ErrorVO, which is
empty if one or more user groups are retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="findUserGroupsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserGroupContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
findUsers
Description
Retrieves each user with a user name that matches a designated search
criterion.
Role
User
findUsers
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
user (UserDetailsVO)—Search criterion for the name to retrieve.
The search criterion can be the complete name, or the beginning
character or characters of the name. The name is sensitive and the
percent character (%) can be used as a wildcard to match any
character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all users are returned and these
results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-42
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Return result
UserContainerVO that contains an array of users that match the
search criterion.
The UserContainerVO also contains an ErrorVO, which is empty if
one or more users are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="findUsersResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
findVidoes
Description
Retrieves each video that matches a designated search criterion.
Role
User
findVideos
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
video VideoDetailsVO—Search criterion for the name to
retrieve. The search criterion can be the complete name, or the
beginning character or characters of the name. The name is
sensitive and the percent character (%) can be used as a wildcard
to match any character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all videos are returned and these
results are not paginated.
VideoContainerVO that contains an array of videos that match the
search criterion.
The VideoContainerVO also contains an ErrorVO, which is empty if
one or more videos are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="findVideosResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VideoContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-43
Chapter 2
Web Services API Functions
Function Descriptions
findVtgs
Function name
findVtgs
Description
Retrieves VTGs with a name that matches a designated search
criterion.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtg (VtgVO)—Search criterion for the name to retrieve. The
search criterion can be the complete name, or the beginning
character or characters of the name. The name is sensitive and the
percent character (%) can be used as a wildcard to match any
character.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all VTGs are returned and these
results are not paginated.
VtgContainerVO that contains an array of VtgVOs that match the
search criterion.
The VtgContainerVO also contains an ErrorVO, which is empty if
one or more VTGs are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="findVtgsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getAllChannelGroups
Function name
getAllChannelGroups
Description
Retrieves all channel groups that are associated with your
Cisco IPICS ops view.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channel groups are returned
and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-44
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Return result
ChannelGroupContainerVO that contains an array of
ChannelGroupVO value objects.
The ChannelGroupContainerVO also contains an ErrorVO, which is
empty if all channel groups are retrieved, or contains an explanation
if an exception occurs when the function executes.
Sample response
<xs:element name="getAllChannelsInChannelGroupResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelGroupContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getAllChannels
Function name
getAllChannels
Description
Retrieves all channels.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channels are returned and these
results are not paginated.
ChannelContainerVO that contains an array of ChannelVO value
objects.
The ChannelContainerVO also contains an ErrorVO, which is empty
if all channels are retrieved, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="getAllChannelsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getAllChannelsInChannelGroup
Function name
getAllChannelsInChannelGroup
Description
Retrieves all channels that are in the designated channel group.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-45
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelGroupId (int)—ID of the channel group from which to
retrieve all channels.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channels in the designated
channel group are returned and these results are not paginated.
ChannelContainerVO that contains an array of ChannelVO value
objects for all channels in the channel group.
The ChannelContainerVO also contains an ErrorVO, which is empty
if all channels in the channel group are retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getAllChannelsInChannelGroupResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getAllIncidents
Function name
getAllIncidents
Description
Retrieves all incidents that are associated your Cisco IPICS ops view.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all incidents are returned and these
results are not paginated.
ChannelContainerVO that contains an array of IncidentVO value
objects.
The ChannelContainerVO also contains an ErrorVO, which is empty
if all incidents are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getAllIncidentsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-46
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
getAllIncidentsWithIVtgStatus
Function name
getAllIncidentsWithIVtgStatus
Description
Retrieves all incidents that are associated with your Cisco IPICS ops
view and the status of each incident VTG that is associated with an
incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all incidents are returned and these
results are not paginated.
IncidentContainerVO containing that contains an array of IncidentVO
value objects.
The ChannelContainerVO also contains an ErrorVO, which is empty
if the function executes properly, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getAllIncidentsWithIVtgStatusResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getAllPhotos
Description
Retrieves all photographs that are associated with your Cisco IPICS
ops view.
Role
User
getAllPhotos
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all photographs are returned and
these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-47
Chapter 2
Web Services API Functions
Function Descriptions
Return result
PhotoContainerVO that contains an array of PhotoVO value objects.
The PhotoContainerVO also contains an ErrorVO, which is empty if
all photographs are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getAllPhotosResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PhotoContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getAllPolicies
Function name
getAllPolicies
Description
Retrieves all policies that are associated with your Cisco IPICS ops
view.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all policies are returned and these
results are not paginated.
PolicyContainerVO that contains an array of PolicyVO value objects.
The PolicyContainerVO also contains an ErrorVO, which is empty if
all policies are retrieved, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="getAllPoliciesResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PolicyContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getAllRadios
Description
Retrieves all radios that are associated with your Cisco IPICS ops
view.
Role
User
getAllRadios
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-48
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all radios are returned and these
results are not paginated.
RadioContainerVO that contains an array of RadioVO value objects.
The RadioContainerVO also contains an ErrorVO, which is empty if
all radios are retrieved, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="getAllRadiosResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:RadioContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getAllUserGroups
Function name
getAllUserGroups
Description
Retrieves all user groups that are associated with your Cisco IPICS
ops view.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all user groups are returned and
these results are not paginated.
UserGroupContainerVO that contains an array of UserGroupVO
value objects.
The UserGroupContainerVO also contains an ErrorVO, which is
empty if all user groups are retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getAllUserGroupsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserGroupContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-49
Chapter 2
Web Services API Functions
Function Descriptions
getAllUsers
Function name
getAllUsers
Description
Retrieves all Cisco IPICS users that are associated with your Cisco
IPICS ops view.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all users are returned and these
results are not paginated.
UserContainerVO that contains an array of UserVO value objects
The UserContainerVO also contains an ErrorVO, which is empty if all
users are retrieved, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="getAllUsersResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getAllVideos
Description
Retrieves all videos that are associated with your Cisco IPICS ops
view.
Role
User
getAllVideos
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all videos are returned and these
results are not paginated.
VideoContainerVO that contains an array of VideoVO value objects.
The VideoContainerVO also contains an ErrorVO, which is empty if
all videos are retrieved, or contains an explanation if an exception
occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-50
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="getAllVideosResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VideoContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getAllVtgs
Description
Retrieves all VTGs that are associated with your Cisco IPICS ops
view.
Role
User
getAllVtgs
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all VTGs are returned and these
results are not paginated.
VtgContainerVO that contains an array of VtgVO value objects.
The VtgContainerVO also contains an ErrorVO, which is empty if all
VTGs are retrieved, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="getAllVtgsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getBelongingOpsViewForUser
Function name
getBelongingOpsViewForUser
Description
Retrieves the ops view to which a user belongs.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-51
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user whose
ops view you want to retrieve. This parameter must be entered in
all lower case.
IntegerVO that contains the ops view of the designated user.
The IntegerVO also contains an ErrorVO, which is empty if the ops
view is retrieved, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="getBelongingOpsViewForUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getChannel
Description
Retrieves summary information about a designated channel.
Role
User
getChannel
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelId (int)—ID of the channel for which to retrieve
information.
ChannelVO that contains summary information about the designated
channel.
The ChannelVO also contains an ErrorVO, which is empty if
summary information about the channel is retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getChannelResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-52
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
getChannelDetails
Function name
getChannelDetails
Description
Retrieves detailed information about a designated channel.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelId (int)—ID of the channel for which to retrieve detailed
information.
ChannelDetailVO that contains detailed information about the
designated channel.
The ChannelDetailVO also contains an ErrorVO, which is empty if
detailed information about the channel is retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getChannelDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelDetailVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getChannelGroupsForVtg
Function name
getChannelGroupsForVtg
Description
Retrieves channel groups that are associated with a designated VTG.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG for which to retrieve associated
channel groups.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channel groups are returned
and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-53
Chapter 2
Web Services API Functions
Function Descriptions
Return result
ChannelGroupContainerVO that contains an array of
ChannelGroupVO value objects for all channel groups that are
associated with the VTG.
The ChannelGroupContainerVO also contains an ErrorVO, which is
empty if all channels that are associated with the VTG are retrieved,
or contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getChannelGroupsForVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgParticipantContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getChannelsAssociatedToUser
Function name
getChannelsAssociatedToUser
Description
Retrieves all channels that are associated with a designated user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve associated channels. This parameter must be entered
in all lower case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channels that are associated
with the designated user are returned and these results are not
paginated.
ChannelContainerVO that contains an array of ChannelVO value
objects for all channels that are associated with the user.
The ChannelContainerVO also contains an ErrorVO, which is empty
if all channels that are associated with the user are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getChannelsAssociatedToUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-54
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
getChannelsForIncident
Function name
getChannelsForIncident
Description
Retrieves a list of channels that are associated with a designated
incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident for which to retrieve
associated channels.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channels that are associated
with the incident are returned and these results are not paginated.
ChannelContainerVO that contains an array of ChannelVO value
objects for all channels that are associated with the incident.
The ChannelContainerVO also contains an ErrorVO, which is empty
if all channels that are associated with the incident are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getChannlesForIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:ChannelContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getChannelsForVtg
Function name
getChannelsForVtg
Description
Retrieves a list of channels that are associated with a designated VTG.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG for which to retrieve associated
channels.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all channels that are associated
with the VTG are returned and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-55
Chapter 2
Web Services API Functions
Function Descriptions
Return result
ChannelContainerVO that contains an array of ChannelVO value
objects for all channels that are associated with the designated VTG.
The ChannelContainerVO also contains an ErrorVO, which is empty
if all channels that are associated with the VTG are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getChannelsForVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgParticipantContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getChannelStatus
Function name
getChannelStatus
Description
Retrieves the status of the designated channel.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelId (int)—ID of the channel for which to retrieve status.
StringVO that contains the status of the designated channel.
The StringVO also contains an ErrorVO, which is empty if the status
of the channel is retrieved, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="getChannelStatusResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getDigitId
Description
Retrieves the digit ID for a user.
Role
User
getDigitId
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-56
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve the digit ID. This parameter must be entered in all
lower case.
StringVO that contains the digit ID of the user.
The StringVO also contains an ErrorVO, which is empty if the digit
ID is retrieved, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="getDigitIdResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getDigitPassword
Function name
getDigitPassword
Description
Retrieves the digit password for a user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve the digit password. This parameter must be entered in
all lower case.
StringVO that contains the digit password the user.
The StringVO also contains an ErrorVO, which is empty if the
password is retrieved, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="getDigitPasswordResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-57
Chapter 2
Web Services API Functions
Function Descriptions
getIncident
Function name
getIncident
Description
Retrieves summary information about a designated incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident for which to retrieve
summary information.
IncidentVO that contains summary information about the incident.
The IncidentVO also contains an ErrorVO, which is empty if
summary information about the incident is retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getIncidentDetails
Function name
getIncidentDetails
Description
Retrieves detailed information about a designated incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident for which to retrieve
summary information.
IncidentVO that contains detailed information about the incident.
The IncidentVO also contains an ErrorVO, which is empty if detailed
information about the incident is retrieved, or contains an explanation
if an exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-58
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="getIncidentDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentDetailsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getIncidentParticipants
Function name
getIncidentParticipants
Description
Retrieves all resources that are associated with an incident. Resources
include channels, journals, radios, photographs, users, videos, and
VTGs.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (String)—ID of the incident for which to retrieve
resources (channels, journals, radios, photographs, users, videos,
and VTGs).
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all incident resources are returned
and these results are not paginated.
IncidentParticipantContainerVO that contains an array of
IncidentParticipantVO value objects for each resource that is
associated with the incident.
The IncidentParticipantContainerVO also contains an ErrorVO,
which is empty if all resources that are associated with the incident
are retrieved, or contains an explanation if an exception occurs when
the function executes.
Sample response
<xs:element name="getIncidentParticipantsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentParticipantContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getIncidentsForUser
Function name
getIncidentsForUser
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-59
Chapter 2
Web Services API Functions
Function Descriptions
Description
Retrieves a list of all incidents that are associated with a designated
user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userId (int)—System-generated ID of the user for whom to
retrieve associated incidents.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all incidents that are associated
with the user are returned and these results are not paginated.
IncidentContainerVO that contains an array of IncidentVO value
objects for each incident that is associated with the user.
The IncidentContainerVO also contains an ErrorVO, which is empty
if all incidents that are associated with the user are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getIncidentsForUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getIncidentVtg
Function name
getIncidentVtg
Description
Retrieves information about the incident VTG that is associated with
a designated incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident for which to retrieve the
incident VTG information.
VtgDetailVO that contains information about the incident VTG.
The VtgDetailVO also contains an ErrorVO, which is empty if
information about the incident VTG is retrieved, or contains an
explanation if an exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-60
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="getIncidentVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgDetailVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getIncidentVtgOptions
Function name
getIncidentVtgOptions
Description
Retrieves VTG options for the incident VTG that is associated with a
designated incident. Options include the allow VAD, latch, listen
only, region ID, and RX mute settings.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident from which to retrieve the
incident VTG options.
IncidentVtgOptionsVO that contains VTG options for the incident
VTG.
The IncidentVtgOptionsVO also contains an ErrorVO, which is
empty if VTG options for the incident VTG are retrieved, or contains
an explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getIncidentVtgOptionsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentVtgOptionsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getIncidentVtgUserOptions
Function name
getIncidentVtgUserOptions
Description
Retrieves incident VTG options for an incident VTG user. Options
include latch, listen only, and RX mute.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-61
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident from which to retrieve the
incident VTG user options.
•
userId (int)—System-generated ID of the user for whom to
retrieve options.
IncidentVtgUserOptionsVO that contains incident VTG user options.
The IncidentVtgUserOptionsVO also contains an ErrorVO, which is
empty if incident VTG options for the incident VTG are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getIncidentVtgUserOptionsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IncidentVtgUserOptionsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getIpicsVersion
Function name
getIpicsVersion
Description
Retrieves the version of Cisco IPICS that is running on the active
Cisco IPICS server.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
StringVO that contains the version of Cisco IPICS that is running on
the active Cisco IPICS server.
The StringVO also contains an ErrorVO, which is empty if the version
of Cisco IPICS is retrieved, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="getIpicsVersionResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-62
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
getJournal
Function name
getJournal
Description
Retrieves summary information about a designated journal.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
journalId (int)—ID of the journal for which to retrieve summary
information.
JournalVO that contains summary information about the journal.
The JournalVO also contains an ErrorVO, which is empty if summary
information about the journal is retrieved, or contains an explanation
if an exception occurs when the function executes.
Sample response
<xs:element name="getJournalResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:JournalVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getJournalDetails
Function name
getJournalDetails
Description
Retrieves detailed information about a designated journal.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
journalId (int)—ID of the journal for which to retrieve detailed
information.
JournalDetailsVO that contains detailed information about the
journal.
The JournalDetailsVO also contains an ErrorVO, which is empty if
detailed information about the journal is retrieved, or contains an
explanation if an exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-63
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="getJournalDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:JournalDetailsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getJournalsForIncident
Function name
getJournalsForIncident
Description
Retrieves all journals for a designated incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident for which to retrieve journals.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all journals that are associated
with the incident are returned and these results are not paginated.
JournalContainerVO that contains an array of JournalVO value
objects for all journals that are associated with the incident.
The JournalContainerVO also contains an ErrorVO, which is empty if
all journals that are associated with the incident are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getJournalsForIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:JournalContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getPhonesAssociatedToUser
Function name
getPhonesAssociatedToUser
Description
Retrieves all phones that are associated with a designated user.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-64
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve associated phones. This parameter must be entered in
all lower case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all phones that are associated with
the user are returned and these results are not paginated.
PhoneContainerVO that contains an array of PhoneVO value objects
for all phones that are associated with the user.
The PhoneContainerVO also contains an ErrorVO, which is empty if
all phones that are associated with the user are retrieved, or contains
an explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getPhonesAssociatedToUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PhoneContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getPhoto
Description
Retrieves summary information about a photograph.
Role
User
getPhoto
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
photoId (int)—ID of the photograph for which to retrieve
summary information.
PhotoVO that contains summary information about the photograph.
The PhotoVO also contains an ErrorVO, which is empty if summary
information about the photograph is retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getPhotoResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PhotoVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-65
Chapter 2
Web Services API Functions
Function Descriptions
getPhotoDetails
Function name
getPhotoDetails
Description
Retrieves detailed information about a photograph.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
photoId (int)—ID of the photograph for which to retrieve detailed
information.
PhotoDetailsVO that contains detailed information about the
photograph.
The PhotoDetailsVO also contains an ErrorVO, which is empty if
detailed information about the photograph is retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getPhotoDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PhotoDetailsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getPhotosForIncident
Function name
getPhotosForIncident
Description
Retrieves a list of photographs that are associated with a designated
incident.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident for which to retrieve
associated photos.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all photographs that are associated
with the incident are returned and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-66
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Return result
PhotoContainerVO that contains an array of PhotoVO value objects
for all photographs that are associated with the incident.
The PhotoContainerVO also contains an ErrorVO, which is empty if
all photographs that are associated with the incident are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getPhotosForIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PhotoContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getPmcProfile
Function name
getPmcProfile
Description
Retrieves IDC profile information for the designated user. The system
uses profile information to cause an IDC to appear and function in the
same way for a user regardless of the PC on which the user runs the
IDC.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
id (int)—System-generated ID of the user for whom to retrieve
IDC profile information.
StringVO that contains IDC profile information.
The StringVO also contains an ErrorVO, which is empty if IDC
profile information is retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getPmcProfileResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getPoliciesAssociatedToUser
Function name
getPoliciesAssociatedToUser
Description
Retrieves all policies that are associated with a designated user.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-67
Chapter 2
Web Services API Functions
Function Descriptions
Role
Parameters
Return result
User
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)— Cisco IPICS user name of the user for
whom to retrieve associated policies. This parameter must be
entered in all lower case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all policies that are associated
with the user are returned and these results are not paginated.
PolicyContainerVO that contains an array of PolicyVO value objects
for all policies that are associated with the user.
The PolicyContainerVO also contains an ErrorVO, which is empty if
all policies that are associated with the user are retrieved, or contains
an explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getPoliciesAssociatedToUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PolicyContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getPolicy
Description
Retrieves summary information about a policy.
Role
User
getPolicy
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
policyId (int)—ID of the policy for which to retrieve summary
information.
PolicyVO that contains summary information about the policy.
The PolicyVO also contains an ErrorVO, which is empty if summary
information about the policy is retrieved, or contains an explanation
if an exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-68
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="getPolicyResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PolicyVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getPolicyDetails
Function name
getPolicyDetails
Description
Retrieves detailed information about a policy.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
policyId (int)—ID of the policy for which to retrieve detailed
information.
PolicyDetailsVO that contains detailed information about the policy.
The PolicyDetailsVO also contains an ErrorVO, which is empty if
detailed information about the policy is retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getPolicyDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PolicyDetailsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getPolicyExecutionStatus
Function name
getPolicyExecutionStatus
Description
Retrieves summary status information about a the last execution of a
policy.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
policyId (int)—ID of the policy for which to retrieve a status
summary of the execution.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-69
Chapter 2
Web Services API Functions
Function Descriptions
Return result
PolicyExecutionStatusVO that contains summary information about
of the last execution of the designated policy.
The PolicyExecutionStatusVO also contains an ErrorVO, which is
empty if summary information is retrieved, or contains an explanation
if an exception occurs when the function executes.
Sample response
<xs:element name="getPolicyExecutionStatusResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PolicyExecutionStatusVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getPolicyExecutionStatusDetails
Function name
getPolicyExecutionStatusDetails
Description
Retrieves detailed status information about the execution of each
policy that is associated with a designated user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve detailed information about of the last execution of
associated policies. This parameter must be entered in all lower
case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, the execution status of all policies
that are associated with the user are returned and these results are
not paginated.
PolicyExecutionStatusContainerVO that contains an array of
PolicyExecutionStatusVO value objects that provide detailed
information about the execution of a policy and its action.
The PolicyExecutionStatusContainerVO also contains an ErrorVO,
which is empty if detailed information is retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getPolicyExecutionStatusDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:PolicyExecutionStatusContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-70
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
getRadiosAssociatedToUser
Function name
getRadiosAssociatedToUser
Description
Retrieves a list of radios that are associated with a designated user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve associated radios. This parameter must be entered in
all lower case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all radios that are associated with
the user are returned and these results are not paginated.
RadioContainerVO that contains an array of RadioVO value objects
for all radios that are associated with the user.
The RadioContainerVO also contains an ErrorVO, which is empty if
all radios that are associated with the user are retrieved, or contains
an explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getRadiosAssociatedToUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:RadioContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getRadiosForIncident
Function name
getRadiosForIncident
Description
Retrieves a list of radios that are associated with a designated
incident.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (String)—ID of the incident for which to retrieve
associated radios.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all radios that are associated with
the incident are returned and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-71
Chapter 2
Web Services API Functions
Function Descriptions
Return result
RadioContainerVO that contains an array of RadioVO value objects
for all radios that are associated with the incident.
The RadioContainerVO also contains an ErrorVO, which is empty if
all radios that are associated with the incident are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getRadiosForIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:RadioContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getRadiosForVtg
Function name
getRadiosForVtg
Description
Retrieves a list of radios that are associated with a designated VTG.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG for which to retrieve associated
radios.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all radios that are associated with
the VTG are returned and these results are not paginated.
RadioContainerVO that contains an array of RadioVO value objects
for all radios that are associated with the designated VTG.
The RadioContainerVO also contains an ErrorVO, which is empty if
all radios that are associated with the VTG are retrieved, or contains
an explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getRadiosForVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgParticipantContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getUser
getUser
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-72
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Description
Retrieves summary information about the designated user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userId (int)—System-generated ID of the user for whom to
retrieve summary information.
UserVO that contains summary information about the user.
The UserVO also contains an ErrorVO, which is empty if summary
information about the user is retrieved, or contains an explanation if
an exception occurs when the function executes.
Sample response
<xs:element name="getUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUserAddress
Function name
getUserAddress
Description
Retrieves the physical address of a designated user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve the address. This parameter must be entered in all
lower case.
AddressVO that contains address information of the user.
The AddressVO also contains an ErrorVO, which is empty if address
information of the user is retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getUserAddressResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:AddressVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-73
Chapter 2
Web Services API Functions
Function Descriptions
getUserAudioStatus
Function name
getUserAudioStatus
Description
Retrieves a flag that indicates if the IDC of a user has audio disabled
or enabled. When audio is disabled, the IDC cannot transmit or
receive audio.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve the IDC audio status. This parameter must be entered
in all lower case.
BooleanVO that contains true if IDC audio is disabled for the user, or
false if IDC audio is not disabled for the user.
The BooleanVO also contains an ErrorVO, which is empty if IDC
audio is disabled for the user, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getUserAudioStatusResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUserDetails
Function name
getUserDetails
Description
Retrieves detailed information about a designated user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userId (int)—System-generated ID of the user for whom to
retrieve detailed information.
UserDetailsVO that contains detailed information about the user.
The UserDetailsVO also contains an ErrorVO, which is empty if
detailed information about the user is retrieved, or contains an
explanation if an exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-74
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="getUserDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserDetailsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUserDialPreference
Function name
getUserDialPreference
Description
Retrieves the dial preferences that are associated with a designated
user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve the dial preference. This parameter must be entered in
all lower case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all dial preferences for the user are
returned and these results are not paginated.
DialAddressContainerVO that contains an array of DialAddressVO
value objects for all dial preferences that are associated with the user.
The DialAddressContainerVO also contains an ErrorVO, which is
empty if dial preferences are retrieved, or contains an explanation if
an exception occurs when the function executes.
Sample response
<xs:element name="getUserDialPreferenceResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:DialAddressContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUserDirectory
Function name
getUserDirectory
Description
Retrieves the users for whom a direct connect number is assigned in
the designated serial radio descriptor file.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-75
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
descriptorId (String)—ID of the radio descriptor file from which
to retrieve users for whom a direct connect number is assigned.
StringVO that contains, in an XML string, the users for whom a direct
connect number is assigned in the designated serial radio descriptor
file.
The StringVO also contains an ErrorVO, which is empty if the users
are retrieved, or contains an explanation if an exception occurs when
the function executes.
Sample response
<xs:element name="getUserDirectoryResponse">
<xs:complexType>
<xs:sequence>
<xs:element minOccurs="0"
name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getUserGroup
Description
Retrieves summary information about the designated user group.
Role
User
getUserGroup
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
groupId (int)—ID of the user group for which to retrieve
summary information.
UserGroupVO that contains summary information about the
designated user group.
The UserGroupVO also contains an ErrorVO, which is empty if
summary information is retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getUserGroupResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserGroupVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-76
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
getUserGroupMembers
Function name
getUserGroupMembers
Description
Retrieves all the users in a designated user group.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userGroupId (int)—ID of the group user for which to retrieve all
members.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all members in the user group are
returned and these results are not paginated.
UserContainerVO that contains an array of UserVO value objects for
all members of the user group.
The UserContainerVO also contains an ErrorVO, which is empty if all
members of the user group are retrieved, or contains an explanation if
an exception occurs when the function executes.
Sample response
<xs:element name="getUserGroupMembersResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUserGroupsForVtg
Function name
getUserGroupsForVtg
Description
Retrieves user groups that are associated with the designated VTG.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (String)—ID of the VTG for which to retrieve associated
user groups.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all users groups that are associated
with the VTG are returned and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-77
Chapter 2
Web Services API Functions
Function Descriptions
Return result
VtgParticipantContainerVO that contains an array of
VtgParticipantVO value objects for all user groups that are associated
with the VTG.
The VtgParticipantContainerVO also contains an ErrorVO, which is
empty if all user groups that are associated with the VTG are
retrieved, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="getUserGroupsForVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgParticipantContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getUserId
Description
Retrieves the system-generated user ID for the designated user.
Role
User
getUserId
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for which
to retrieve the system-generated user ID. This parameter must be
entered in all lower case.
IntegerVO that contains system-generated user ID for the designated
user.
The VtgParticipantContainerVO also contains an ErrorVO, which is
empty if the user ID is retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getUserIdResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUserListenerStatus
Function name
getUserListenerStatus
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-78
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Description
Retrieves a flag that indicates whether the IDC of a user is in
listen-only mode. In this mode, the user is muted.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve the IDC audio status. This parameter must be entered
in all lower case.
BooleanVO that contains true if the IDC is in listen-only mode
(muted), or false if the IDC is not in listen-only mode.
The BooleanVO also contains an ErrorVO, which is empty if the
mode is returned, or contains an explanation if an exception occurs
when the function executes
Sample response
<xs:element name="getUserListenerStatusResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUserNotificationPreference
Function name
getUserNotificationPreference
Description
Retrieves the notification preferences that is associated with a
designated user.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve the notification preference. This parameter must be
entered in all lower case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all dial preferences for the user are
returned and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-79
Chapter 2
Web Services API Functions
Function Descriptions
Return result
NotificationAddressContainerVO that contains an array of
NotificationAddressVO value objects for all notification preferences
that are associated with the user.
The NotificationAddressContainerVO also contains an ErrorVO,
which is empty if all notification preferences that are associated with
the user are retrieved, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="getUserNotificationPreferenceResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:NotificationAddressContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getUserRoles
Description
Retrieves the list of roles for a designated user.
Role
User
getUserRoles
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user whose
roles to retrieve. This parameter must be entered in all lower case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. For this function, you should always pass
null.
UserRoleContainerVO that contains an array of UserRoleVO value
objects for all roles that are assigned to the user.
The UserRoleContainerVO also contains an ErrorVO, which is empty
if all roles that are assigned to the user are retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getUserRolesResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserRoleContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-80
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
getUsersAssociatedToRadio
Function name
getUsersAssociatedToRadio
Description
Retrieves a list of users that are associated with a radio.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
radioId (String)—ID of the radio for which to retrieve associated
users.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all users that are associated with
the radio are returned and these results are not paginated.
UserContainerVO that contains an array of UserVO value objects for
all users that are associated with the designated radio.
The UserContainerVO also contains an ErrorVO, which is empty if all
users that are associated with the radio are retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getUsersAssociatedToRadioResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUsersForIncident
Function name
getUsersForIncident
Description
Retrieves a list of users that are associated with a designated incident.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (String)—ID of the incident for which to retrieve
associated users.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all users that are associated with
the incident are returned and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-81
Chapter 2
Web Services API Functions
Function Descriptions
Return result
UserContainerVO that contains an array of UserVO value objects for
all users that are associated with the incident.
The UserContainerVO also contains an ErrorVO, which is empty if all
users that are associated with the incident are retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getUsersForIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:UserContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getUsersForVtg
Function name
getUsersForVtg
Description
Retrieves a list of users that are associated with a designated VTG.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgtId (String)—ID of the VTG for which to retrieve associated
VTGs.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all users that are associated with
the VTG are returned and these results are not paginated.
VtgParticipantContainerVO that contains an array of
VtgParticipantVO value objects for all users that are associated with
the VTG.
The VtgParticipantContainerVO also contains an ErrorVO, which is
empty if all users that are associated with the VTG are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name=" getUsersForVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgParticipantContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-82
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
getUserStatus
Function name
getUserStatus
Description
Retrieves the Cisco IPICS status of the designated user. The status can
be enabled or disabled. A user with the disabled status cannot log in
to Cisco IPCS.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of each user for
whom to retrieve active status. This parameter must be entered in
all lower case.
StringVO that contains enabled or disabled, which indicates the
Cisco IPICS status of designated user.
The StringVO also contains an ErrorVO, which is empty if the status
is retrieved, or contains an explanation if an exception occurs when
the function executes.
Sample response
<xs:element name="getUserStatusResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getVideo
Description
Retrieves summary information about the designated video.
Role
User
getVideo
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
videoId (int)—ID of the video for which to retrieve summary
information.
VideoVO that contains summary information about the designated
video.
The VideoVO also contains an ErrorVO, which is empty if summary
information about the video is retrieved, or contains an explanation if
an exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-83
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
xs:element name="getVideoResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VideoVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getVideoDetails
Function name
getVideoDetails
Description
Retrieves detailed information about the designated video.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
videoId (int)—ID of the video for which to retrieve detailed
information.
VideoDetailsVO that contains detailed information for the designated
video.
The VideoVO also contains an ErrorVO, which is empty if detailed
information about the video is retrieved, or contains an explanation if
an exception occurs when the function executes.
Sample response
<xs:element name="getVideoDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VideoDetailsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getVideosForIncident
Function name
getVideosForIncident
Description
Retrieves a list of videos that are associated with a designated
incident.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-84
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int) —ID of the incident for which to retrieve
associated videos.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all videos that are associated with
the VTG are returned and these results are not paginated.
VideoContainerVO that contains an array of VideoVO value objects
for all videos that are associated with the designated incident.
The VideoContainerVO also contains an ErrorVO, which is empty if
all videos that are associated with the incident are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getVideosForIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VideoContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getVtgDetails
Description
Retrieves detailed information about the designated VTG.
Role
User
getVtgDetails
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG for which to retrieve detailed
information.
VtgDetailVO that contains detailed information about the designated
VTG.
The VtgDetailVO also contains an ErrorVO, which is empty if
detailed information about the VTG is retrieved, or contains an
explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getVtgDetailsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgDetailVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-85
Chapter 2
Web Services API Functions
Function Descriptions
getVtgOptions
Function name
getVtgOptions
Description
Retrieves information about the status of a variety of options for a
VTG.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG for which to retrieve option status
information.
VtgOptionsVO that contains information about the status of a variety
of options for the designated VTG.
The VtgOptionsVO also contains an ErrorVO, which is empty if VTG
options are retrieved, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="getVtgOptionsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgOptionsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getVtgParticipants
Function name
getVtgParticipants
Description
Retrieves all participants in a designated VTG. Participants include
channels, channel groups, radios, users, user groups, and VTGs.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG from which to retrieve all participants
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all participants in the VTG are
returned and these results are not paginated.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-86
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Return result
VtgParticipantContainerVO that contains an array of
VtgParticipantVO value objects for all participants (channels,
channel groups, radios, users, user groups, and VTGs) that are in the
designated VTG.
The VtgParticipantContainerVO also contains an ErrorVO, which is
empty if all participants that are in the VTG are retrieved, or contains
an explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getVtgParticipantsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgParticipantContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getVtgParticipantStatus
Function name
getVtgParticipantStatus
Description
Retrieves the status of a VTG participant. The participant can be a
user, user group, channel, channel group, or VTG. Status can be
disconnected, error, pending, or active.
Role
User
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG that contains the participant for
which the status is to be retrieved.
•
participantID (int)—ID of the participant whose status is be
retrieved.
•
resourceType (String)—Participant type: user, user-group,
channel, channel-group, vtg, or radio.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-87
Chapter 2
Web Services API Functions
Function Descriptions
Return result
StringVO that contains the status of the designated VTG participant.
Status can be any of the following:
•
active—Participant is associated with the VTG.
•
pending—Participant is in the process of becoming associated
with the VTG.
•
error—Participant could not be associated with the VTG. (This
situation typically occurs if there are insufficient system
resources.)
•
disconnected—The participant could not be connected to the
RMS or could not be configured on the RMS.
The StringVO also contains an ErrorVO, which is empty if the status
of the VTG participant is retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getVtgParticipantStatusResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getVtgsAssociatedToUser
Function name
getVtgsAssociatedToUser
Description
Retrieves all VTGs that are associated with a user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to retrieve associated VTGs. This parameter must be entered in
all lower case.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all VTGs that are associated with
the user are returned and these results are not paginated.
VtgContainerVO that contains an array VtgVO value objects for all
VTGs that are associated with the designated user.
The VtgContainerVO also contains an ErrorVO, which is empty if all
VTGs that are associated with the user are retrieved, or contains an
explanation if an exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-88
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="getVtgsAssociatedToUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getVtgsForIncident
Function name
getVtgsForIncident
Description
Retrieves a list of VTGs that are associated with a designated
incident.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (String)—ID of the incident for which to retrieve
associated VTGs.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all VTGs that are associated with
the incident are returned and these results are not paginated.
VtgContainerVO that contains an array of VtgVO value objects for all
VTGs that are associated with the designated incident.
The VtgContainerVO also contains an ErrorVO, which is empty if all
VTGs that are associated with the incident are retrieved, or contains
an explanation if an exception occurs when the function executes.
Sample response
<xs:element name="getVtgsForIncidentResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getVtgsForVtg
Description
Retrieves a list of VTGs that are associated with a designated VTG.
Role
User
getVtgsForVtg
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-89
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgtId (String)—ID of the VTG for which to retrieve associated
VTGs.
•
pc (PaginationContextVO)—Specifies format and limits of the
output of this function. If null, all VTGs that are associated with
the VTG are returned and these results are not paginated.
VtgParticipantContainerVO that contains an array of
VtgParticipantVO value objects for all VTGs that are associated with
the designated VTG.
The VtgParticipantContainerVO also contains an ErrorVO, which is
empty if all VTGs that are associated with the VTG are retrieved, or
contains an explanation if an exception occurs when the function
executes.
Sample response
<xs:element name="getVtgsForVtgResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgParticipantContainerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
getVtgStatus
Description
Retrieves the ID, name, description, and status (active, idle, or
pending) of a VTG. “Pending” indicates a VTG that is in transition
from active to idle state or from idle to active state.
Role
User
getVtgStatus
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG for which to retrieve information.
StringVO that contains information for the designated VTG.
The StringVO also contains an ErrorVO, which is empty if status
information is retrieved, or contains an explanation if an exception
occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-90
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="getVtgStatusResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:StringVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
getVtgUserOptions
Function name
getVtgUserOptions
Description
Retrieves the settings of the latch, listen only, and rxmute VTG
options settings for a designated VTG and user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG that includes the user for whom to
retrieve option settings.
•
userId (int)—System-generated ID of the user users for whom to
retrieve VTG option settings.
VtgUserOptionsVO that contains the latch, listen only, and rxmute
information for the designated user in the designated VTG.
The VtgUserOptionsVO also contains an ErrorVO, which is empty if
option information is retrieved, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="getVtgUserOptionsResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:VtgUserOptionsVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
isActiveChannel
Function name
isActiveChannel
Description
Determines if a channel is active or disabled.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-91
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
channelId (int)—ID of the channel to query.
BooleanVO that contains true if the channel is active, or false if the
channel is disabled.
The BooleanVO also contains an ErrorVO, which is empty if the
function returns a value, or contains explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="isActiveChannelResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
isActiveIncidentVtg
Function name
isActiveIncidentVtg
Description
Determines if an incident VTG in a designated incident is active or
inactive.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that includes the incident
VTG for which to determine status.
BooleanVO that contains true if the incident VTG is active, or false
if the incident VTG is inactive.
The BooleanVO also contains an ErrorVO, which is empty if the
function returns a value, or contains explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="isActiveIncidentVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-92
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
isActiveUser
Function name
isActiveUser
Description
Determines if a user is active or disabled.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user to query.
This parameter must be entered in all lower case.
BooleanVO that contains true if the user is active, or false if the user
is disabled.
The BooleanVO also contains an ErrorVO, which is empty if the
function returns a value, or contains explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="isActiveUserResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
isActiveVtg
Description
Determines if a VTG is active or inactive.
Role
User
isActiveVtg
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to query.
BooleanVO that contains true if the VTG is active, or false if the
VTG is inactive.
The BooleanVO also contains an ErrorVO, which is empty if the
function returns a value, or contains explanation if an exception
occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-93
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="isActiveVtgResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
notifyAllIncidentVtgMembers
Function name
notifyAllIncidentVtgMembers
Description
Sends a notification to each user in the incident VTG of the
designated incident. The notification method that the system uses for
a user is configured in the communications preferences for that user
in the Cisco IPICS Administration Console or by the
setNotificationPreferences API function.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that includes the incident
VTG whose members are to be notified.
BooleanVO that contains true if all members of the incident VTG in
the designed incident are notified, or false if not all members are
notified.
The BooleanVO also contains an ErrorVO, which is empty if all
members of the incident VTG are notified, or contains an explanation
if an exception occurs when the function executes.
Sample response
<xs:element name="notifyAllIncidentVtgMembersResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
notifyAllVtgMembers
Function name
notifyAllVtgMembers
Description
Sends a notification to each user in the designated VTG, including
members of user groups in the VTG. The notification method that the
system uses for a user is configured in the communications
preferences for that user in the Cisco IPICS Administration Console
or by the setNotificationPreferences API function.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-94
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Role
Parameters
Return result
Dispatcher
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG that includes members to be notified.
BooleanVO that contains true if all members of the VTG are notified,
or false if not all members are notified.
The BooleanVO also contains an ErrorVO, which is empty if all
members of the VTG are notified, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name=" notifyAllVtgMembersResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
notifyIncidentVtgMember
Function name
notifyIncidentVtgMember
Description
Notifies a designated member of an incident VTG. The notification
method is based on notification options as configured for the user in
the Cisco IPICS Administration Console.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that includes the incident
VTG with the member is to be notified.
•
userLogin (String)—Cisco IPICS user name of the incident VTG
member to be notified. This parameter must be entered in all
lower case.
BooleanVO that contains true if the designated incident VTG
member is notified, or false if the designated incident VTG member
is not notified.
The BooleanVO also contains an ErrorVO, which is empty if the
incident VTG member is notified, or contains an explanation if an
exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-95
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="notifyIncidentVtgMemberResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
notifyVtgMember
Function name
notifyVtgMember
Description
Notifies a designated member of a VTG. The notification method that
the system uses for a user is configured in the communications
preferences for that user in the Cisco IPICS Administration Console
or by the setNotificationPreferences API function.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG that includes the member is to be
notified.
•
userLogin (String)—Cisco IPICS user name of the VTG member
to be notified. This parameter must be entered in all lower case.
BooleanVO that contains true if the designated VTG member is
notified, or false if the designated VTG member is not notified.
The BooleanVO also contains an ErrorVO, which is empty if the VTG
member is notified, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="notifyVtgMemberResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
removeChannelFromVtg
Function name
removeChannelFromVtg
Description
Removes a channel from a VTG.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-96
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG from which to remove the channel.
•
channelId (int)—Unique of the channel to be removed from the
VTG.
BooleanVO that contains true if the channel is removed from the
VTG, or false if the channel is not removed from the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the
channel is removed from the VTG, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="removeChannelFromVtgResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
removePhoneAssociatedToUser
Function name
removePhoneAssociatedToUser
Description
Disassociates a phone from a user.
Role
Operator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user from
whom to disassociate a phone. This parameter must be entered in
all lower case.
•
dialNumber (String)—Dial number of the phone to disassociate
from the user.
BooleanVO that contains true if the phone is disassociated from the
user, or false if the phone is not disassociated from the user.
The BooleanVO also contains an ErrorVO, which is empty if the
phone is disassociated from the user, or contains an explanation if an
exception occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-97
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="removePhoneAssociatedToUserResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
removeRadioFromVtg
Function name
removeRadioFromVtg
Description
Removes a radio from a VTG.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG from which to remove the radio.
•
radioId (int)—ID of the radio to be removed from the VTG.
BooleanVO that contains true if the radio is removed from the VTG,
or false if the radio is not removed from the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the radio
is removed from the VTG, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="removeRadioFromVtgResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
removeResourceFromIncident
Function name
removeResourceFromIncident
Description
Disassociates one or more resource from an incident.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-98
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident from which to remove the
resource.
•
resourceIds (int[])—IDs of the resources to remove.
•
resourceType (String)—The type of resource to remove from the
incident: User, Video, Photo, Channel, Radio, or Vtg.
IntegerVO that contains the number of resource that were removed
from the incident.
The IntegerVO also contains an ErrorVO, which is empty if the
function executes properly, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="removeResourceFromIncidentResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
removeUserFromVtg
Function name
removeUserFromVtg
Description
Removes a user from a VTG.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user to be
removed from the VTG. This parameter must be entered in all
lower case.
•
vtgId (int)—ID of the VTG from which to remove the user.
BooleanVO that contains true if the user is removed from the VTG,
or false if the user is not removed from the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the user
is removed from the VTG, or contains an explanation if an exception
occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-99
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="removeUserFromVtgResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
removeVtgFromVtg
Function name
removeVtgFromVtg
Description
Removes a VTG from a VTG.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgIdRem (int)— ID of the VTG to remove.
•
vtgId (int)—ID of the VTG from which to remove the other VTG.
BooleanVO that contains true if the VTG is removed from the VTG,
or false if the VTG is not removed from the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the VTG
is removed from the VTG, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="removeVtgFromVtgResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
removeVtgParticipants
Function name
removeVtgParticipants
Description
Removes one or more participants from a VTG.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-100
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG from which to remove participants.
•
parts (ResourceContainerVO)—The array of participants to be
removed from VTG.
BooleanVO that contains true if the participants are removed from
the VTG, or false if the participants are not removed from the VTG.
The BooleanVO also contains an ErrorVO, which is empty if the
function executes properly, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="removeVtgParticipantsResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
savePmcProfile
Function name
savePmcProfile
Description
Saves IDC profile information for the designated user. The system
uses profile information to cause an IDC to appear and function in the
same way for a user regardless of the PC on which the user runs the
IDC.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
id (int)—System-generated ID of the user for whom to retrieve
IDC profile information
•
xmlString (String)—IDC profile information for the designated
user.
IntegerVO that contains 1 if the IDC profile is saved, or 0 if it is not.
The IntegerVO also contains an ErrorVO, which is empty if the IDC
profile is saved, or contains an explanation if an exception occurs
when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-101
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="savePmcProfileResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setBelongingOpsViewForUser
Function name
setBelongingOpsViewForUser
Description
Assigns an ops view to a user.
Role
Operator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS use name of the user to whom
to assign an ops view. This parameter must be entered in all lower
case.
•
opsViewId (int)—ID of the ops view to assign to the user.
BooleanVO that contains true if the ops view is assigned to the user,
or false if is not.
The BooleanVO also contains an ErrorVO, which is empty if the ops
view is assigned, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="setBelongingOpsViewForUserResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setDialPreference
Function name
setDialPreference
Description
Adds a new dial preference for a user.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-102
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to set dial preferences. This parameter must be entered in all
lower case.
•
dialType (String)—Label for the dial number (BUSINESS,
BUSINESS2, BUSINESS3, CAR, HOME, HOME2, HOME3,
MOBILE, MOBILE2, MOBILE3, OTHER, PRIMARY,
SECONDARY).
•
dialNumber (String)—Phone number to dial.
•
dialOrder (int)—Order in which the system dials phone numbers
is if more than one dial number is configured.
BooleanVO that contains true if the dial preference is added for the
user, or false if the dial preference is not added.
The BooleanVO also contains an ErrorVO, which is empty if the dial
preference is added, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="setDialPreferenceResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
setDigitId
Description
Sets digit ID for a user. A digit ID is a numeric ID that a user enters
when accessing the Cisco IPICS service from a Cisco Unified IP
Phone or when accessing the Cisco IPICS telephony user interface.
Role
User
setDigitId
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to set digit IDs. This parameter must be entered in all lower case.
•
digitId (String)—Digit ID for the user. Valid characters are
numerals 0 through 9.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-103
Chapter 2
Web Services API Functions
Function Descriptions
Return result
BooleanVO that contains true if the digit ID is set for the user, or
false if the digit ID is not set for the user.
The BooleanVO also contains an ErrorVO, which is empty if the digit
ID is set, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="setDigitIdResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setDigitPassword
Function name
setDigitPassword
Description
Sets a digit password for a user. A digit password is a password that
a user enters when accessing the Cisco IPICS service from a
Cisco Unified IP Phone or PIN that the user enters when accessing the
Cisco IPICS telephony user interface.
You specify requirements for passwords, including length and
character requirements, in the Administration > Options
window in the Cisco IPICS Administration Console.
Note
Role
Parameters
Return result
User
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to set a digit password. This parameter must be entered in all
lower case.
•
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.
BooleanVO that contains true if the digit password is set for the user,
or false if the digit password is no set for the user.
The BooleanVO also contains an ErrorVO, which is empty if the digit
password is set, or contains an explanation if an exception occurs
when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-104
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="setDigitPasswordResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setIncidentVtgOptions
Function name
setIncidentVtgOptions
Description
Sets various options for an incident VTG.
Role
Dispatcher
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that contains the incident
VTG for which to set options.
•
latch (boolean):
– true—Enables the latch function for the incident VTG
– false—Disables the latch function
•
listenOnly (boolean):
– true—Enables listen only mode for the incident VTG
– false—Disables listen only mode
•
rxMute (String):
– all—When PTT is engaged, RX (receive transmission) is
muted on all voice resources
– this—When PTT is engaged, RX is muted on this incident
VTG
– none—When PTT is engaged, no voice resources are muted
•
allowVad (boolean):
– true—Enables the VAD function for the incident VTG
– false—Disables the VAD function
•
Return result
pmcRegionId (int)—Indicates the preferred region in which the
IDC displays the incident VTG.
BooleanVO that contains true if all designated incident VTG options
are set, or false if not all options are not set.
The BooleanVO also contains an ErrorVO, which is empty if the
function executes properly, or contains an explanation if an exception
occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-105
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="setIncidentVtgOptionsResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setIncidentVtgUserOptions
Function name
setIncidentVtgUserOptions
Description
Sets various options for a designated user in an incident VTG.
Role
Dispatcher
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incidentId (int)—ID of the incident that contains the incident
VTG for which to set options.
•
userId (int)—System-generated ID of the user for whom to set
incident VTG options
•
latch (boolean)—Enables or disables the latch function for the
designated user in the designated incident VTG as follows:
– true—Enables the latch function
– false—Disables the latch function
•
listenOnly (boolean)—Enables or disables listen only mode for
the designated user in the designated incident VTG as follows:
– true—Enables listen only mode
– false—Disables listen only mode
•
rxMute (boolean):
– true—Prevents the designated user from listening or
speaking in the designated incident VTG
– false—Allows the designated user to listen or speak in the
designated incident VTG
Return result
BooleanVO that contains true if the incident VTG options are set for
the user, or false incident VTG options are not set.
The BooleanVO also contains an ErrorVO, which is empty if the
function executes properly, or contains an explanation if an exception
occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-106
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="setIncidentVtgUserOptionsResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setNotificationPreference
Function name
setNotificationPreference
Description
Adds a new notification preference for a user.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to set notification preferences. This parameter must be entered in
all lower case.
•
notificationType (String)—Notification type preference
(EMAIL, PAGER, SMS)
•
notificationAddress (String)—Address for the designated
notification type.
BooleanVO that contains true if the notification preference is added
for the user, or false if the notification preference is not added for the
user.
The BooleanVO also contains an ErrorVO, which is empty if the
notification preference is added, or contains an explanation if an
exception occurs when the function executes.
Sample response
<xs:element name="setNotificationPreferenceResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setUserAddress
Function name
setUserAddress
Description
Adds a physical address for a user.
Role
User
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-107
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to add a physical address. This parameter must be entered in all
lower case.
•
address (AddressVO)—Address information.
BooleanVO that contains true if the address is added for the user, or
false if the address is not added for the user.
The BooleanVO also contains an ErrorVO, which is empty if the
address is added, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="setUserAddressResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setUserAudioStatus
Function name
setUserAudioStatus
Description
Enables or disables the ability of a user to hear and transmit audio on
an IDC.
Note
Role
Parameters
Return result
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-109.
Operator
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
to enable or disable IDC audio. This parameter must be entered
in all lower case.
•
audioDisabled (boolean)—If true, the audio capability is
disabled. If false, the audio capability is enabled.
BooleanVO that contains true if the audio status is updated for the
user, or false if the audio status is not updated for the user.
The BooleanVO also contains an ErrorVO, which is empty if the
audio status is updated, or contains an explanation if an exception
occurs when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-108
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="setUserAudioStatusResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setUserListenerStatus
Function name
setUserListenerStatus
Description
Enables or disables the ability of a user to transmit audio on an IDC
(unmutes or mutes a user).
Note
Role
Parameters
Return result
If the audio status for a user is disabled (see the
“setUserAudioStatus” section on page 2-108), a user cannot
transmit audio in any case.
Operator
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
userLogin (String)—Cisco IPICS user name of the user for whom
enable or disable IDC audio. This parameter must be entered in
all lower case.
•
mute (boolean)—If true, the user is muted. If false, the user is
not muted.
BooleanVO that contains true if the audio status is updated for the
user, or false if the audio status is not updated for the user.
The BooleanVO also contains an ErrorVO, which is empty if the
audio status is updated, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="setUserListenerStatusResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
setVtgOptions
Description
Sets various options for a VTG.
setVtgOptions
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-109
Chapter 2
Web Services API Functions
Function Descriptions
Role
Parameters
Dispatcher
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG for which to set options.
•
latch (boolean):
– true—Enables the latch function for the VTG
– false—Disables the latch function
•
listenOnly (boolean):
– true—Enables listen only mode for the VTG
– false—Disables listen only mode
•
rxMute (String):
– all—When PTT is engaged, RX (receive transmission) is
muted on all voice resources
– this—When PTT is engaged, RX is muted on this incident
VTG
– none—When PTT is engaged, no voice resources are muted
•
allowVad (boolean):
– true—Enables the VAD function for the incident VTG
– false—Disables the VAD function
•
Return result
pmcRegionId (int)—Indicates the preferred region in which the
IDC displays the VTG.
BooleanVO that contains true if the VTG options are set, or false if
the VTG options are not set.
The BooleanVO also contains an ErrorVO, which is empty if the
function executes properly, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="setVtgOptionsResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
setVtgUserOptions
Function name
setVtgUserOptions
Description
Sets various options for a designated user in a VTG.
Role
Dispatcher
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-110
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG for which to set options for a user.
•
userId (int)—System-generated ID of the user for whom to set
incident VTG options
•
latch (boolean):
– true—Enables the latch function for the VTG
– false—Disables the latch function
•
listenOnly (boolean):
– true—Enables listen only mode for the VTG
– false—Disables listen only mode
•
rxMute (boolean):
– true—Prevents the designated user from listening or
speaking in the designated incident VTG
– false—Allows the designated user to listen or speak in the
designated incident VTG
Return result
BooleanVO that contains true if the VTG options are set for the user,
or false if the VTG options are not set.
The BooleanVO also contains an ErrorVO, which is empty if the VTG
options are set, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="setVtgUserOptionsResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
startSession
Description
Logs into the IPICS web service, authenticates that the user has a
valid IPICS user account, starts a session, and returns a unique
session ID (sessionId), which must be used for subsequent web
service calls. Logging into the IPICS web service does not consume
a Cisco IPICS license.
Role
—
startSession
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-111
Chapter 2
Web Services API Functions
Function Descriptions
Parameters
Return result
•
userLogin (String)—Cisco IPICS user name of the user who is
executing the API client code.
•
password (String)—Cisco IPICS user password of the user who
is executing the API client code. This parameter is case sensitive.
•
clientDescriptorVO (ClientDescriptorVO)—Type of client that is
connecting to the web service.
SessionVO that contains the session ID.
The SessionVO also contains an ErrorVO, which is empty if the
session starts, or contains an explanation if an exception occurs when
the function executes.
Sample response
<xs:element name="startSessionResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:SessionVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
updateIncident
Function name
updateIncident
Description
Modifies various attributes of an incident.
Role
Dispatcher
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
incident (IncidentDetailsVO)—Incident attributes to update.
IntegerVO that contains 1 if the incident is updated, or 0 if the
incident is not updated.
The IntegerVO also contains an ErrorVO, which is empty if the
incident is updated, or contains an explanation if an exception occurs
when the function executes.
Sample response
<xs:element name="updateIncidentResponse">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-112
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
updatePhoto
Function name
updatePhoto
Description
Modifies various attributes of a photograph.
Role
User
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
photo (PhotoDetailsVO)—Photograph attributes.
IntegerVO that contains 1 if the photograph is updated, or 0 if the
photograph is not updated.
The IntegerVO also contains an ErrorVO, which is empty if the
photograph is updated, or contains an explanation if an exception
occurs when the function executes.
Sample response
<xs:element name="updatePhotoResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
updateUserGroup
Function name
updateUserGroup
Description
Modifies various attributes of a user group.
Role
Operator
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
group (UserGroupDetailsVO)—User group attributes.
BooleanVO that contains true if the user group is updated, or false if
the user group is not updated.
The IntegerVO also contains an ErrorVO, which is empty if the user
group is updated, or contains an explanation if an exception occurs
when the function executes.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-113
Chapter 2
Web Services API Functions
Function Descriptions
Sample response
<xs:element name="updateUserGroupResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:BooleanVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Function name
updateVideo
Description
Modifies various attributes of a video.
Role
User
updateVideo
Parameters
Return result
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
video (VideoDetailsVO)—Video attributes.
IntegerVO that contains 1 if the video is updated, or 0 if the video is
not updated.
The IntegerVO also contains an ErrorVO, which is empty if the video
is updated, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="updateVideoResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
updateVirtualTalkGroup
Function name
updateVirtualTalkGroup
Description
Modifies various attributes of a VTG.
Role
Dispatcher
Parameters
•
sessionId (String)—Unique session ID. This ID is generated and
returned when you use the startSession function to log in to Cisco
IPICS web services and is used for the entire web services
session.
•
vtgId (int)—ID of the VTG to modify.
•
vtgName (String)—Name to set for the VTG.
•
vtgDescription (String)—Description to set for the VTG.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-114
OL-21552-01
Chapter 2
Web Services API Functions
Function Descriptions
Return result
IntegerVO that contains 1 if the VTG is updated, or 0 if the VTG is
not updated.
The IntegerVO also contains an ErrorVO, which is empty if the VTG
is updated, or contains an explanation if an exception occurs when the
function executes.
Sample response
<xs:element name="updateVirtualTalkGroupResponse>">
<xs:complexType>
<xs:sequence>
<xs:element name="return" nillable="true"
type="ns1:IntegerVO"/>
</xs:sequence>
</xs:complexType>
</xs:element>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
2-115
Chapter 2
Web Services API Functions
Function Descriptions
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
2-116
OL-21552-01
CH A P T E R
3
Value Objects
This chapter provide detailed descriptions of each value object (VO) that is used by the Cisco IPICS web
services API functions. It includes these topics:
•
Value Objects Overview, page 3-1
•
Value Objects Descriptions, page 3-4
Value Objects Overview
The Cisco IPICS web services API functions that are explained in Chapter 2, “Web Services API
Functions,” use value objects to describe characteristics of various items and to store information. In
addition, some value objects contain other value objects.
Table 3-1 provides a summary of the Cisco IPICS web services API VOs. Each VO is described in detail
in the section that is referenced.
Table 3-1
API Value Object Summary
Value Name and Reference
Description
AddressVO, page 3-4
Contains information about the address of a user
BooleanVO, page 3-4
Contains a boolean value that a function returns
ChannelContainerVO, page 3-5
Contains an array of summary information about 1 or more
channels
ChannelDetailVO, page 3-5
Contains detailed information about a channel
ChannelGroupContainerVO, page 3-7
Contains an array of summary information about 1 or more
channel groups
ChannelGroupVO, page 3-7
Contains summary information about a channel group
ChannelVO, page 3-7
Contains summary information about a channel
ClientDescriptorVO, page 3-8
Contains information about the type of client that connects
to a web services session
DialAddressContainerVO, page 3-8
Contains an array of information about 1 or more dial
preferences
DialAddressVO, page 3-9
Contains summary information about a dial number
ErrorVO, page 3-9
Contains an error code and error message, if returned by a
function
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-1
Chapter 3
Value Objects
Value Objects Overview
Table 3-1
API Value Object Summary (continued)
Value Name and Reference
Description
IncidentContainerVO, page 3-10
Contains an array of summary information about 1 or more
incidents
IncidentDetailsVO, page 3-10
Contains detailed information about an incident
IncidentParticipantContainerVO,
page 3-11
Contains an array of information about 1 or more incident
participants
IncidentParticipantVO, page 3-11
Contains summary information about an incident
participant
IncidentVO, page 3-12
Contains summary information about an incident
IncidentVtgOptionsVO, page 3-12
Contains summary information about an incident VTG
IncidentVtgUserOptionsVO, page 3-13
Contains summary information about a user in an incident
VTG
IntegerVO, page 3-13
Contains an integer value
JournalContainerVO, page 3-14
Contains an array of summary information about 1 or more
journals
JournalDetailsContainerVO, page 3-14
Contains an array of detailed information about 1 or more
journals
JournalDetailsVO, page 3-14
Contains detailed information about a journal
JournalVO, page 3-15
Contains summary information about a journal
NotificationAddressContainerVO,
page 3-16
Contains an array of information about 1 or more
notification addresses
NotificationAddressVO, page 3-16
Contains information about a notification address
PaginationContextVO, page 3-16
Contains attributes that designate the format and limits of
the output of a function
PhoneContainerVO, page 3-17
Contains an array of information about 1 or more direct
dial phones
PhoneVO, page 3-17
Contains summary information about a direct dial phone
PhotoContainerVO, page 3-18
Contains an array of information about 1 or more
photographs
PhotoDetailsVO, page 3-18
Contains detailed information about a photograph that has
been added to Cisco IPICS
PhotoVO, page 3-19
Contains summary information about a photograph that has
been added to Cisco IPICS
PolicyActionVO, page 3-20
Contains information about a policy action
PolicyContainerVO, page 3-21
Contains an array of information about 1 or more policies
PolicyDetailsVO, page 3-21
Contains detailed information about a policy
PolicyExecutionStatusContainerVO,
page 3-22
Contains an array of information about the execution of 1
or more policies
PolicyExecutionStatusVO, page 3-22
Contains information about the execution of a policy
PolicyTriggerVO, page 3-22
Contains information about a policy trigger
PolicyVO, page 3-23
Contains summary information about a policy
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-2
OL-21552-01
Chapter 3
Value Objects
Value Objects Overview
Table 3-1
API Value Object Summary (continued)
Value Name and Reference
Description
RadioContainerVO, page 3-23
Contains an array of information about 1 or more radios
RadioDetailsVO, page 3-23
Contains detailed information about a radio
RadioVO, page 3-24
Contains summary information about a radio
ResourceContainerVO, page 3-24
Contains an array of information about 1 or more resources
ResourceVO, page 3-25
Contains information about a resource
SessionVO, page 3-25
Contains a web services session ID
StringVO, page 3-25
Contains a string
UserContainerVO, page 3-26
Contains an array of information about 1 or more users
UserDetailsVO, page 3-26
Contains detailed information about a user
UserGroupContainerVO, page 3-27
Contains an array of information about 1 or more user
groups
UserGroupDetailsVO, page 3-27
Contains detailed information about a user group
UserGroupVO, page 3-27
Contains summary information about a user group
UserRoleContainerVO, page 3-28
Contains an array of information about 1 or more Cisco
IPICS user roles
UserRoleVO, page 3-28
Contains information about a Cisco IPICS user role
UserVO, page 3-28
Contains summary information about a user
VideoContainerVO, page 3-29
Contains an array of information about 1 or more videos
VideoDetailsVO, page 3-29
Contains detailed information about a video that has been
added to Cisco IPICS
VideoVO, page 3-31
Contains summary information about a video that has been
added to Cisco IPICS
VtgContainerVO, page 3-32
Contains an array of summary information about 1 or more
VTGs
VtgDetailContainerVO, page 3-32
Contains an array of detailed information about 1 or more
VTGs
VtgDetailVO, page 3-32
Contains detailed information about a VTG
VtgOptionsVO, page 3-33
Contains information about options that are configured for
a VTG
VtgParticipantContainerVO, page 3-34
Contains an array of information about participants in a
VTG
VtgParticipantVO, page 3-34
Contains information about a VTG participant
VtgUserOptionsVO, page 3-35
Contains information about user options that are
configured for a VTG
VtgVO, page 3-36
Contains summary information about a VTG
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-3
Chapter 3
Value Objects
Value Objects Descriptions
Value Objects Descriptions
The following sections describe each Cisco IPICS API VO in detail. The tables in these sections provide
this information:
•
Attribute name—Name of a VO attribute
•
Type—Type of VO attribute
•
Description—Description of the VO attribute
AddressVO
The AddressVO value object contains information about the address of a Cisco IPICS user.
Table 3-2 describes the attributes of this value object.
Table 3-2
AddressVO Attributes
Attribute Name
Type
Description
city
String
Contains the name of the address city.
country
String
Contains the name of the address country.
elevation
float
Not used.
elevationUnits
String
Not used.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the address.
Cisco IPICS generates this ID when you add the
address to Cisco IPICS.
latitude
float
Not used.
longitude
float
Not used.
state
String
Contains the name of the address state.
street
String
Contains the name of the address street.
streetExtra
String
Store addition information related to street, such
as an apartment number.
zip
String
Contains the address ZIP code.
BooleanVO
The BooleanVO value object contains a boolean value that a function returns.
Table 3-3 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-4
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-3
BooleanVO Attributes
Attribute Name
Type
Description
value
boolean
Contains the boolean value that a function returns
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
ChannelContainerVO
The ChannelContainerVO value object contains an array of summary information about one or more
channels.
Table 3-4 describes the attributes of this value object.
Table 3-4
ChannelContainerVO Attributes
Attribute Name
Type
Description
channelVOs
ChannelVO[]
Contains an array of ChannelVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
ChannelDetailVO
The ChannelDetailVO value object contains detailed information about a channel.
Table 3-5 describes the attributes of this value object.
Table 3-5
ChannelDetailVO Attributes
Attribute Name
Type
Description
codec
String
Contains codec information about the channel.
colorization
String
Contains the color of the channel that appears in
the IDC.
conType
String
Contains the channel connection type.
Desc
String
Contains a description of the channel.
dialedNumber
String
Not used.
disable
boolean
Indicates whether a channel is disabled (true) or
enabled (false).
duplex
String
Indicates whether channel is full duplex or half
duplex.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the channel. Cisco
IPICS generated this ID when the channel was
created in Cisco IPICS.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-5
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-5
ChannelDetailVO Attributes (continued)
Attribute Name
Type
Description
latchable
boolean
Indicates whether the channel is latchable (true
means yes and false means no).
lmrg_delay_time
int
Designates the number of milliseconds that the
LMR gateway delays audio from the channel
before sending it to the radio. Valid values are 0
through 1500.
lmrg_hangover_time
int
Designates the number of milliseconds that the
LMR gateway maintains the radio transmitting
after the LMR gateway receives the last audio
packet from a transmission from the channel.
Valid values are 0 through 1500.
maxVoiceStreams
int
Not used.
mcastAddr
String
Contains the multicast address of the channel.
name
String
Contains the name of the channel.
port
int
Contains the port number that the channel uses.
ptttimeout
int
Not used.
region
String
Contains the preferred region in which the IDC
displays the incident.
rfc2198_pt
int
Not used.
rfc2833event_pt
int
Sends the designated DTMF tones on the channel.
rfc2833tone_pt
int
Sends the designated single-frequency tones on
the channel.
rxmute
String
Indicates whether audio to or from the channel is
muted when the PTT button is pressed in the IDC
or on an IP phone. Valid values are:
•
all-When PTT is engaged, RX (receive
transmission) is muted on all voice resources
•
this-When PTT is engaged, RX is muted on
this channel
•
none-When PTT is engaged, no voice
resources are muted
secure
boolean
Indicates whether the channel is secure (true
means yes and false means no).
sipPort
int
Not used.
sipProxyIp
String
Not used.
txmute
boolean
Indicates whether the channel is configured as
listen only (true means yes and false means no).
vad
boolean
Indicates whether VAD1 is enabled for the channel
(true means yes and false means no).
1. VAD = voice activity detection
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-6
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
ChannelGroupContainerVO
The ChannelGroupContainerVO value object contains an array of summary information about one or
more channel groups
Table 3-6 describes the attributes of this value object.
Table 3-6
ChannelGroupContainerVO Attributes
Attribute Name
Type
Description
channelGroupVOs
ChannelGroupVO[]
Contains an array of ChannelGroupVO value
objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
ChannelGroupVO
The ChannelGroupVO value object contains summary information about a channel group.
Table 3-7 describes the attributes of this value object.
Table 3-7
ChannelGroupVO Attributes
Attribute Name
Type
Description
Description
String
Contains a description of the channel group.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the channel group.
Cisco IPICS generated this ID when the channel
group was created in Cisco IPICS.
Name
String
Contains the name of the channel group, or the
name to find when using a Find function.
ChannelVO
The ChannelVO value object contains summary information about a channel.
Table 3-8 describes the attributes of this value object.
Table 3-8
ChannelVO Attributes
Attribute Name
Type
Description
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
id
int
Contains the unique ID of the channel. Cisco
IPICS generated this ID when the channel was
created in Cisco IPICS.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-7
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-8
ChannelVO Attributes (continued)
Attribute Name
Type
Description
isSecure
boolean
Indicates whether the channel is designated as
secure (true means yes and false means no).
name
String
Contains the name of the channel
ClientDescriptorVO
The ClientDescriptorVO value object contains information about the type of client that connects to a web
services session.
Table 3-9 describes the attributes of this value object.
Table 3-9
ClientDescriptorVO Attributes
Attribute Name
Type
Description
clientId
String
Contains the ID of the client
clientType
String
Contains the type of client (for example, IDC or
iPhone)
cpuMhz
float
Not used
hwVersion
String
Not used
ipicsVersion
String
Contains Cisco IPICS version that is running on
the server that the client connects to
manufacturer
String
Not used
model
String
Not used
osVersion
String
Not used
preferredLanguage
String
Not used
ramFree
long
Not used
ramTotal
long
Not used
screenHeight
int
Not used
screenWidth
int
Not used
storeFree
long
Not used
storeTotal
long
Not used
supportedVideoFormats String
Not used
DialAddressContainerVO
The DialAddressContainerVO value object contains an array of information about one or more dial
preferences.
Table 3-10 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-8
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-10
DialAddressContainerVO Attributes
Attribute Name
Type
Description
dialAddressVOs
DialAddressVO[]
Contains an array of DialAddressVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
DialAddressVO
The DialAddressVO value object contains summary information about a dial number.
Table 3-11 describes the attributes of this value object.
Table 3-11
DialAddressVO Attributes
Attribute Name
Type
Description
dialNumber
String
Contains dial number, which is the phone number
that the policy engine uses when dialing out.
dialPreferenceOrder
int
Contains the order of telephone numbers at which
Cisco IPICS contacts a user when a
user-associated policy executes or when a
dispatcher initiates a dial out to invite a user to
join an active VTG.
errorVO
ErroVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the dial address. Cisco
IPICS generated this ID when the dial address was
created in Cisco IPICS.
type
String
Contains type of dial number.
ErrorVO
The ErrorVO value object contains an error code and message, if a function returns an error.
Table 3-12 describes the attributes of this value object.
Table 3-12
ErrorVO Attributes
Attribute Name
Type
Description
errorCode
String
Contains an error code
errorMessage
String
Contains an error message that a function returns
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-9
Chapter 3
Value Objects
Value Objects Descriptions
IncidentContainerVO
The ncidentContainerVO value object contains an array of summary information about one or more
incidents.
Table 3-13 describes the attributes of this value object.
Table 3-13
ncidentContainerVO Attributes
Attribute Name
Type
Description
incidentVOs
IncidentVO[]
Contains an array of IncidentVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
IncidentDetailsVO
The IncidentDetailsVO value object contains detailed information about an incident.
Table 3-14 describes the attributes of this value object.
Table 3-14
IncidentDetailsVO Attributes
Attribute Name
Type
Description
address
AddressVO
Contains the physical address where the incident
is taking place.
commanderId
int
Not used.
createDate
Date
Contains the date and time at which the incident
was created.
description
String
Contains a description of the incident.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the incident. Cisco
IPICS generated this ID when the incident was
created.
incidentVtgId
int
Contains the ID of the incident VTG that is
associated with the incident, if an associated
incident VTG exists.
name
String
Contains the full the name of the incident.
opsviewId
int
Contains the ID of the ops view to which the
incident belongs.
ownerId
int
Contains the ID of the user who created the
incident. Cisco IPICS generated this ID when the
user was created in Cisco IPICS.
pmcRegionId
int
Contains the preferred region in which the ICD
displays the incident.
priority
short
Not used.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-10
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-14
IncidentDetailsVO Attributes (continued)
Attribute Name
Type
Description
resourceType
String
Not used.
shortName
String
Not used.
startDate
Date
Contains the date and time at which the incident
was activated.
state
String
Indicates the state of the incident (Active or
Inactive).
stopDate
Date
Contains the date and time at which the incident
was deactivated.
IncidentParticipantContainerVO
The IncidentParticipantContainerVO value object contains an array of information about one or more
resources in an incident. Resources are users, channels, photographs, radios, videos, or VTGs.
Table 3-15 describes the attributes of this value object.
Table 3-15
IncidentParticipantContainerVO Attributes
Attribute Name
Type
Description
incidentParticipantVOs
incidentParticipantVO
Contains an array of IncidentParticiapntVO value
objects
ErrorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
IncidentParticipantVO
The IncidentParticipantVO value object contains summary information about a resource in an incident.
A resource is user, channel, photograph, radio, video, or VTG.
Table 3-16 describes the attributes of this value object.
Table 3-16
IncidentParticipantVO Attributes
Attribute Name
Type
Description
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the incident participant.
Cisco IPICS generated this ID when the incident
participant was added.
name
String
Contains the name of the incident participant.
participantType
String
Contains the type of the incident resource.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-11
Chapter 3
Value Objects
Value Objects Descriptions
IncidentVO
The IncidentVO value object contains summary information about an incident.
Table 3-17 describes the attributes of this value object.
Table 3-17
IncidentVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the incident.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the incident. Cisco
IPICS generated this ID when the incident was
created.
incidentVtgId
int
Contains the ID of the incident VTG that is
associated with the incident, if an associated
incident VTG exists.
incidentVtgStatus
String
Status of the incident VTG that is associated with
the incident.
name
String
Contains the name of the incident.
ownerId
int
Contains the Cisco IPICS ID of the user who
created the incident.
pmcRegionId
int
Contains the preferred region in which the ICD
displays the incident.
resourceType
String
Not used.
shortName
String
Not used.
state
String
Indicates the state of the incident (Active or
Inactive).
IncidentVtgOptionsVO
The IncidentVtgOptionsVO value object contains summary information about an incident VTG,
Table 3-18 describes the attributes of this value object.
Table 3-18
IncidentVtgOptionsVO Attributes
Attribute Name
Type
Description
errorVO
ErroVO
Contains an error code and message, if an
exception occurs during function execution.
latch
boolean
Indicates whether the incident VTG is latchable
(true means yes and false means no).
listenOnly
boolean
Indicates whether incident VTG is configured as
listen only (true means yes and false means no).
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-12
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-18
IncidentVtgOptionsVO Attributes (continued)
Attribute Name
Type
Description
rxMute
String
Indicates whether audio to or from the incident
VTG is muted when the PTT button is pressed in
the IDC or on an IP phone. Valid values are:
•
all-When PTT is engaged, RX (receive
transmission) is muted on all voice resources
•
this-When PTT is engaged, RX is muted on
this incident VTG
•
none-When PTT is engaged, no voice
resources are muted
allowVad
boolean
Indicates whether VAD1 is enabled for the incident
VTG (true means yes and false means no).
pmcRegionId
int
Contains the preferred region in which the ICD
displays the VTG.
1. VAD = voice activity detection
IncidentVtgUserOptionsVO
The IncidentVtgUserOptionsVO value object contains summary information about an incident VTG
user.
Table 3-19 describes the attributes of this value object.
Table 3-19
IncidentVtgUserOptionsVO Attributes
Attribute Name
Type
Description
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
latch
boolean
Indicates whether the incident VTG is latchable
(true means yes and false means no)
listenOnly
boolean
Indicates whether incident VTG is configured as
listen only (true means yes and false means no).
rxMute
boolean
Indicates whether audio to or from the incident
VTG is muted when the PTT button is pressed in
the IDC or on an IP phone (true means yes and
false means no).
IntegerVO
The IntegerVO value object contains an integer value that a function returns
Table 3-20 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-13
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-20
IntegerVO Attributes
Attribute Name
Type
Description
value
int
Contains an integer value that a function returns
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
JournalContainerVO
The JournalContainerVO value object contains an array of summary information about one or more
journals.
Table 3-21 describes the attributes of this value object.
Table 3-21
JournalContainerVO Attributes
Attribute Name
Type
Description
journalVOs
JournalVO[]
Contains an array of JournalVO value objects
ErrorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
JournalDetailsContainerVO
The JournalDetailsContainerVO value object contains an array of detailed information about one or
more journals
Table 3-22 describes the attributes of this value object.
Table 3-22
JournalDetailsContainerVO Attributes
Attribute Name
Type
Description
journals
JournalDetailsVO[]
Contains an array of JournalDetailsVO value
objects
ErrorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
JournalDetailsVO
The JournalDetailsVO value object contains detailed information about a journal.
Table 3-23 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-14
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-23
JournalDetailsVO Attributes
Attribute Name
Type
Description
address
AddressVO
Not used.
created
Date
Contains the date and time at which the journal
was created.
description
String
Not used.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the journal. Cisco IPICS
generated this ID when the journal was created.
language
String
Contains the language of the journal text.
message
String
Contains the journal text.
name
String
Not used.
opsViewId
int
Contains the ID of the ops view that is associated
with the user who created the journal entry.
owner
UserVO
Not used.
ownerId
int
Contains the Cisco IPICS ID of the user who
created the journal.
resourceType
String
Not used.
url
String
Not used.
JournalVO
The JournalVO value object contains summary information about a journal.
Table 3-24 describes the attributes of this value object.
Table 3-24
JournalVO Attributes
Attribute Name
Type
Description
created
Date
Contains the date and time at which the journal
was created.
description
String
Not used.
errorVO
ErroVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the journal. Cisco IPICS
generated this ID when the journal was created.
message
String
Contains the journal text.
name
String
Not used.
owner
UserVO
Not used.
ownerId
int
Contains the Cisco IPICS ID of the user who
created the journal.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-15
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-24
JournalVO Attributes (continued)
Attribute Name
Type
Description
resourceType
String
Not used.
title
String
Not used.
url
String
Not used.
NotificationAddressContainerVO
The NotificationAddressContainerVO value object Contains an array of information about one or more
notification addresses.
Table 3-25 describes the attributes of this value object.
Table 3-25
NotificationAddressContainerVO Attributes
Attribute Name
Type
Description
notificationAddressVOs NotificationAddressVO[] Contains an array of NotificationAddressVO
value objects
ErrorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
NotificationAddressVO
The NotificationAddressVO value object contains information about a notification address.
Table 3-26 describes the attributes of this value object.
Table 3-26
NotificationAddressVO Attributes
Attribute Name
Type
Description
errorVO
ErroVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the notification address.
Cisco IPICS generated this ID when the
notification address was added in Cisco IPICS.
notificationAddress
String
Contains the e-mail address, pager number, of
phone number of the device that is to receive the
notification.
type
String
Contains the type of notification (email, pager, or
sms).
PaginationContextVO
The PaginationContextVO value object contains attributes that designate the format and limits of the
output of a function.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-16
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-27 describes the attributes of this value object.
Table 3-27
PaginationContextVO Attributes
Attribute Name
Type
Description
pageNumber
int
Contains the page number of the display
pageRecords
int
Contains the number of records to be displayed per
page
totalPages
int
Contains the total number of pages to include in
the display output
totalRecords
int
Contains the total number of records that the
request returns.
PhoneContainerVO
The PhoneContainerVO value object contains an array of information about one or more direct dial
phones.
Table 3-28 describes the attributes of this value object.
Table 3-28
PhoneContainerVO Attributes
Attribute Name
Type
Description
phoneVOs
PhoneVO[]
Contains an array of PhoneVO value objects
ErrorVO
ErroVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
PhoneVO
The PhoneVO value object contains summary information about a direct dial phone.
Table 3-29 describes the attributes of this value object.
Table 3-29
PhoneVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the phone number (for
example, business or home).
dialDestination
String
Contains the number to dial for the phone.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the phone, which
Cisco IPICS generates when you add the phone to
Cisco IPICS.
name
String
Contains the direct dial phone label.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-17
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-29
PhoneVO Attributes (continued)
Attribute Name
Type
Description
ownerId
int
Contains Cisco IPICS ID of the user who created
the phone.
sipdn
String
Contains the unique ID of the phone, which
Cisco IPICS generates when you add the phone to
Cisco IPICS.
PhotoContainerVO
The PhotoContainerVO value object Contains an array of information about one or more photographs.
Table 3-28 describes the attributes of this value object.
Table 3-30
PhoneContainerVO Attributes
Attribute Name
Type
Description
photoVOs
PhotoVO[]
Contains an array of PhotoVO value objects
ErrorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
PhotoDetailsVO
The PhotoDetailsVO value object contains detailed information about a photograph that has been added
to Cisco IPICS.
Table 3-31 describes the attributes of this value object.
Table 3-31
PhotoDetailsVO Attributes
Attribute Name
Type
Description
address
AddressVO
Contains information about the physical address
where the photograph was taken.
autoDelete
boolean
If true, the Cisco IPICS database record for the
photograph and the photograph file (if the file
exists on the Cisco IPICS server) are deleted
automatically when all incidents with which the
photograph are associated are deleted. If false, the
Cisco IPICS database record for the photograph
and the photograph file are never deleted
automatically.
colorDepth
short
Contains color depth information about the
photograph.
created
Date
Contains the date and time at which the
photograph was added to IPICS.
description
String
Contains a description of the photograph.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-18
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-31
PhotoDetailsVO Attributes (continued)
Attribute Name
Type
Description
dimension
String
Not used.
direction
String
Not used.
encoding
String
Not used.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
height
int
Not used.
id
int
Contains the unique ID of the photograph. Cisco
IPICS generated this ID when the photograph was
added in Cisco IPICS.
name
String
Not used.
opsViewId
int
Contains the ops view with which the photograph
is associated.
owner
UserVO
Not used.
ownerId
int
Contains the unique ID of the user who added the
photograph. Cisco IPICS generated this ID when
the user was added in Cisco IPICS.
palette
String
Not used.
resourceType
String
Not used.
spectrum
String
Not used.
title
String
Contains a brief title, or name, of the photograph.
url
String
Contains the URL of the photograph.
width
int
Not used.
PhotoVO
The PhotoVO value object contains summary information about a photograph that has been added to
Cisco IPICS.
Table 3-32 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-19
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-32
PhotoVO Attributes
Attribute Name
Type
Description
autoDelete
boolean
If true, the Cisco IPICS database record for the
photograph and the photograph file (if the file
exists on the Cisco IPICS server) are deleted
automatically when all incidents with which the
photograph are associated are deleted. If false, the
Cisco IPICS database record for the photograph
and the photograph file are never deleted
automatically.
created
Date
Contains the date and time at which the
photograph was created.
description
String
Contains a description of the photograph.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the photograph. Cisco
IPICS generated this ID when the photograph was
added in Cisco IPICS.
name
String
Not used.
opsViewId
int
Contains the ops view with which the photograph
is associated.
owner
UserVO
Not used.
ownerId
int
Contains the unique ID of the user who added the
photograph. Cisco IPICS generated this ID when
the user was added in Cisco IPICS.
resourceType
String
Not used
title
String
Contains a brief title, or name, of the photograph.
url
String
Contains the URL of the photograph.
PolicyActionVO
The PolicyActionVO value object Contains information about a policy action.
Table 3-33 describes the attributes of this value object.
Table 3-33
PolicyActionVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the policy action.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the policy action. Cisco
IPICS generated this ID when the policy action
was created in Cisco IPICS.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-20
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-33
PolicyActionVO Attributes (continued)
Attribute Name
Type
Description
message
String
Contains the text of the message that a policy
notification action sends
name
String
Contains the name of the policy.
startTime
String
Contains the configured start date and time for the
policy.
status
String
Contains the status of the policy, such as such as
Successful, Executing, or Failed.
type
String
Contains policy action type.
PolicyContainerVO
The PolicyContainerVO value object contains an array of information about 1 or more policies.
Table 3-34 describes the attributes of this value object.
Table 3-34
PolicyContainerVO Attributes
Attribute Name
Type
Description
policyVOs
PolicyVO[]
Contains an array of PolicyVO value objects
ErrorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
PolicyDetailsVO
The PolicyDetailsVO value object contains detailed information about a policy.
Table 3-35 describes the attributes of this value object.
Table 3-35
PolicyDetailsVO Attributes
Attribute Name
Type
Description
actions
PolicyActionVO[]
Contains an array of PolicyActionVO value
objects.
description
String
Contains a description of the policy.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the policy. Cisco IPICS
generated this ID when the policy was created in
Cisco IPICS.
name
String
Contains the name of policy.
triggers
PolicyTriggerVO[]
Contains an array of PolicyTriggerVO value
objects.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-21
Chapter 3
Value Objects
Value Objects Descriptions
PolicyExecutionStatusContainerVO
The PolicyExecutionStatusContainerVO value object contains an array of information about the
execution of one or more policies.
Table 3-36 describes the attributes of this value object.
Table 3-36
PolicyExecutionStatusContainerVO Attributes
Attribute Name
Type
Description
policyExecutionStatusVO
s
policyExecutionStatusVO[
]
Contains an array of
PolicyExecutionStatusVO value objects
ErrorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
PolicyExecutionStatusVO
The PolicyExecutionStatusVO value object contains information about the execution of a policy.
Table 3-37 describes the attributes of this value object.
Table 3-37
PolicyExecutionStatusVO Attributes
Attribute Name
Type
Description
actions
PolicyActionVO[]
Contains and array of PolicyActionVO value
objects.
description
String
Contains a description of the policy.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
executionDate
String
Contains the date and time at which the policy last
executed
executionStatus
String
Contains latest execution status of the policy, such
as Successful, Executing, or Failed.
id
int
Contains the unique ID of the policy, which
Cisco IPICS generates when you add the policy to
Cisco IPICS.
name
String
Contains the name of the policy.
statusMessage
String
Contains information about the execution of the
policy.
PolicyTriggerVO
The PolicyTriggerVO value object contains detailed about a policy trigger.
Table 3-38 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-22
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-38
PolicyTriggerVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the policy trigger.
errorVO
ErroVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the policy trigger,
which Cisco IPICS generates when you add the
policy trigger to Cisco IPICS.
name
String
Contains the name of the policy trigger.
PolicyVO
The PolicyVO value object contains summary information about a policy.
Table 3-39 describes the attributes of this value object.
Table 3-39
PolicyVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the policy.
errorVO
ErroVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the policy, which
Cisco IPICS generates when you add the policy to
Cisco IPICS.
name
String
Contains the name of the policy.
RadioContainerVO
TheRadioContainerVO value object contains an array of information about one or more radios.
Table 3-40 describes the attributes of this value object.
Table 3-40
TheRadioContai Attributes
Attribute Name
Type
Description
radioVOs
RadioVO[]
Contains an array of RadioVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
RadioDetailsVO
The RadioDetailsVO value object contains detailed information about a radio.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-23
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-41 describes the attributes of this value object.
Table 3-41
RadioDetailsVO Attributes
Attribute Name
Type
Description
control
String
Contains control type of the radio (serial or tone).
description
String
Contains a description of the radio.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the radio, which
Cisco IPICS generates when you add the radio to
Cisco IPICS.
location
int
Contains the location that was configured for the
radio when the radio was added to Cisco IPICS.
name
String
Contains the name of the radio.
type
String
Indicates the type of the radio (Nextel or EFJ).
RadioVO
The RadioVO value object contains summary information about a radio.
Table 3-42 describes the attributes of this value object.
Table 3-42
RadioVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the radio.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the radio, which
Cisco IPICS generates when you add the radio to
Cisco IPICS.
locationId
int
Contains Cisco IPICS location of the radio.
name
String
Contains the name of the radio.
radioControlType
String
Contains control type of the radio (serial or tone).
pooledResourceInd
boolean
Indicates whether radio is pooled resource (true
means yes and false means no).
ResourceContainerVO
The ResourceContainerVO value object contains an array of information about one or more resources
(channels, radios, users, and VTGs).
Table 3-43 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-24
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-43
ResourceContainerVO Attributes
Attribute Name
Type
Description
resources
ResourceVO[]
Contains an array of ResourceVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
ResourceVO
The ResourceVO value object contains information about a resource (channel, radio, user, or VTG).
Table 3-44 describes the attributes of this value object.
Table 3-44
ResourceVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the resource.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the resource, which
Cisco IPICS generates when you add the resource
to Cisco IPICS.
name
String
Contains the name of the resource.
resourceType
String
Contains the type of the resource.
SessionVO
The SessionVO value object contains a web services session ID.
Table 3-45 describes the attributes of this value object.
Table 3-45
SessionVO Attributes
Attribute Name
Type
Description
sessionId
String
Contains the ID of the current web services
session
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
StringVO
The StringVO value object stores a string that a function returns.
Table 3-46 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-25
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-46
StringVO Attributes
Attribute Name
Type
Description
value
String
Contains the string that a function returns
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
UserContainerVO
The UserContainerVO value object contains an array of information about 1 or more users.
Table 3-47 describes the attributes of this value object.
Table 3-47
UserContainerVO Attributes
Attribute Name
Type
Description
userVOs
UserVO[]
Contains an array of UserVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
UserDetailsVO
The UserDetailsVO value object contains detailed information about a user.
Table 3-48 describes the attributes of this value object.
Table 3-48
UserDetailsVO Attributes
Attribute Name
Type
Description
allowUnsecurePatch
Boolean
If true, the user can combine secure and unsecure
channels in a patch. If false, the user can use only
non-secure channels in a patch.
description
String
Contains a description of the user.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
firstName
String
Contains the first name of the user.
id
int
Contains the unique ID of the use, which
Cisco IPICS generates when you add the user to
Cisco IPICS.
lastName
String
Contains the last name of the user.
name
String
Contains the name of the user to be displayed in
the Cisco IPICS Administration Console.
roles
String[]
Contains an array Cisco IPICS roles that are
associated with the user.
userLogin
String
Contains the Cisco IPICS user name of the user.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-26
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
UserGroupContainerVO
The UserGroupContainerVO value object contains an array of information about one or more user
groups.
Table 3-49 describes the attributes of this value object.
Table 3-49
UserGroupContainerVO Attributes
Attribute Name
Type
Description
userGroupVOs
UserGtoupVO[]
Contains an array of UserGroupVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
UserGroupDetailsVO
The UserGroupDetailsVO value object contains detailed information about a user group.
Table 3-50 describes the attributes of this value object.
Table 3-50
UserGroupDetailsVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of user group.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the user group, which
Cisco IPICS generates when you add the user
group to Cisco IPICS.
name
String
Contains the name of the user group.
users
UserVO[]
Contains an array of UserVO value objects.
UserGroupVO
The UserGroupVO value object contains summary information about a user group.
Table 3-51 describes the attributes of this value object.
Table 3-51
UserGroupVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the user group.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-27
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-51
UserGroupVO Attributes (continued)
Attribute Name
Type
Description
id
int
Contains the unique ID of the user group, which
Cisco IPICS generates when you add the user
group to Cisco IPICS.
name
String
Contains the name of the user group.
UserRoleContainerVO
The UserRoleContainerVO value object contains an array of information about one or more Cisco IPICS
user roles.
Table 3-52 describes the attributes of this value object.
Table 3-52
UserRoleContainerVO Attributes
Attribute Name
Type
Description
userRoleVOs
UserRoleVO[]
Contains an array of UserRoleVO value objects.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
UserRoleVO
The UserRoleVO value object contains information about a Cisco IPICS user role.
Table 3-53 describes the attributes of this value object.
Table 3-53
UserRoleVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the user role.
displayName
String
Contains name of the role as it appears in the
Cisco IPICS Administration Console GUI.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the user role, which
Cisco IPICS generates when you add the user role
to Cisco IPICS.
name
String
Contains the names of the user role.
UserVO
The UserVO value object contains summary information about a user.
Table 3-54 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-28
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-54
UserVO Attributes
Attribute Name
Type
Description
description
String
Contains a description of the user.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
firstName
String
Contains the first name of the user.
id
int
Contains the unique ID of the user, which
Cisco IPICS generates when you add the user to
Cisco IPICS.
lastName
String
Contains the last name of the user.
name
String
Contains complete name of the user.
userLogin
String
Contains the Cisco IPICS user name of the user.
VideoContainerVO
The VideoContainerVO value object contains an array of information about one or more videos.
Table 3-55 describes the attributes of this value object.
Table 3-55
VideoContainerVO Attributes
Attribute Name
Type
Description
videoVOs
VideoVO[]
Contains and array of VideoVO value objects
errorVO
ErroVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
VideoDetailsVO
The VideoDetailsVO value object contains detailed information about a video that has been added to
Cisco IPICS.
Table 3-56 describes the attributes of this value object.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-29
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-56
VideoDetailsVO Attributes
Attribute Name
Type
Description
address
AddressVO
Contains the physical address where the
photograph was taken.
autoDelete
boolean
If true, the Cisco IPICS database record for the
video and the video file (if the file exists on the
Cisco IPICS server) are deleted automatically
when all incidents with which the video are
associated are deleted. If false, the Cisco IPICS
database record for the video and the video file are
never deleted automatically.
cameraModel
String
Not used.
cameraSrcType
String
Not used.
cameraUrl
String
Not used.
colorDepth
int
Not used.
created
Date
Contains the date and time at which the video was
added to Cisco IPICS.
description
String
Contains a description of the video.
dimension
String
Not used.
direction
String
Not used.
encoding
String
Not used.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
has Audio
boolean
Indicates whether video includes audio (true
means yes and false means no).
hasPtz
boolean
Not used.
iconUrl
String
Not used.
id
int
Contains the unique ID of the video, which
Cisco IPICS generates when you add the video to
Cisco IPICS
isFixedLocation
boolean
Not used.
language
String
Not used.
name
String
Not used.
opsViewId
int
Contains the ID of the ops view that is associated
with the video.
owner
UserVO
Not used.
ownerId
int
Contains the unique ID of the user who added the
video. Cisco IPICS generated this ID when the
user was added in Cisco IPICS.
palette
String
Not used.
rate
int
Not used.
rateUnits
String
Not used.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-30
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-56
VideoDetailsVO Attributes (continued)
Attribute Name
Type
Description
resourceType
String
Not used.
spectrum
String
Not used.
title
String
Contains a brief title, or name, of the video.
url
String
Contains the URL of the video.
videoType
String
Not used.
videoUrl
String
Not used.
vsomUrl
String
Not used.
VideoVO
The VideoVO value object contains summary information about a video that has been added to Cisco
IPICS.
Table 3-57 describes the attributes of this value object.
Table 3-57
VideoVO Attributes
Attribute Name
Type
Description
autoDelete
boolean
If true, the Cisco IPICS database record for the
video and the video file (if the file exists on the
Cisco IPICS server) are deleted automatically
when all incidents with which the video are
associated are deleted. If false, the Cisco IPICS
database record for the video and the video file are
never deleted automatically.
cameraModel
String
Not used.
cameraSrcType
String
Not used.
cameraUrl
String
Not used.
created
date
Contains the date and time at which the video was
added to Cisco IPICS
description
String
Contains a description of the video.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
hasPtz
boolean
Not used.
iconUrl
String
Not used.
id
int
Contains the unique ID of the video, which
Cisco IPICS generates when you add the video to
Cisco IPICS
name
String
Not used.
opsViewId
int
Contains the ID of the ops view that is associated
with the video.
owner
UserVO
Not used.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-31
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-57
VideoVO Attributes (continued)
Attribute Name
Type
Description
ownerId
int
Contains the unique ID of the user who added the
video. Cisco IPICS generated this ID when the
user was added in Cisco IPICS.
resourceType
String
Not used.
title
String
Contains a brief title, or name, of the video
url
String
Contains the URL of the video.
videoType
String
Not used.
videoUrl
String
Not used.
vsomUrl
String
Not used.
VtgContainerVO
The VtgContainerVO value object contains an array of summary information about one or more VTGs.
Table 3-58 describes the attributes of this value object.
Table 3-58
VtgContainerVO Attributes
Attribute Name
Type
Description
vtgVOs
VtgVO[]
Contains an array of VtgVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
VtgDetailContainerVO
The VtgDetailContainerVO value object contains an array of detailed information about one or more
VTGs.
Table 3-59 describes the attributes of this value object.
Table 3-59
VtgDetailContainerVO Attributes
Attribute Name
Type
Description
vtgDetails
VtgDetailVO[]
Contains an array of VtgDetailVO value objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
VtgDetailVO
The VtgDetailVO value object contains detailed information about a VTG.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-32
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-60 describes the attributes of this value object.
Table 3-60
VtgDetailVO Attributes
Attribute Name
Type
Description
defaultVtgId
int
Not used.
description
String
Contains a description of the VTG.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the VTG. Cisco IPICS
generates this ID when you add the VTG to Cisco
IPICS.
mcastaddr
String
Contains the multicast address that is assigned to
the VTG.
name
String
Contains name of the VTG.
port
int
Contains multicast address port number that is
assigned to the VTG.
status
String
Contains the current status of the VTG (such as
active, inactive, pending)
vtgId
int
Contains the unique ID of the VTG. Cisco IPICS
generates this ID when you add the VTG to Cisco
IPICS.
VtgOptionsVO
The VtgOptionsVO value object contains information about options that are configured for a VTG.
Table 3-61 describes the attributes of this value object.
Table 3-61
VtgOptionsVO Attributes
Attribute Name
Type
Description
allowVad
boolean
Indicates whether VAD1 is enabled for the VTG
(true means yes and false means no).
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
latch
boolean
Indicates whether the VTG is latchable (true
means yes and false means no).
listenOnly
boolean
Indicates whether the VTG is listen only mode
(true means yes and false means no).
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-33
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-61
VtgOptionsVO Attributes (continued)
Attribute Name
Type
Description
pmcRegionId
int
Contains the preferred region in which the ICD
displays the VTG.
rxMute
String
Indicates whether audio to or from the VTG is
muted when the PTT button is pressed in the IDC
or on an IP phone. Valid values are:
•
all—When PTT is engaged, RX (receive
transmission) is muted on all voice resources
•
this—When PTT is engaged, RX is muted on
this incident VTG
•
none—When PTT is engaged, no voice
resources are muted
1. VAD = voice activity detection
VtgParticipantContainerVO
The VtgParticipantContainerVO value object contains an array of detailed information about VTG
participants (channels, channel groups, radios, users, user groups, and VTGs).
Table 3-62 describes the attributes of this value object.
Table 3-62
VtgParticipantContainerVO Attributes
Attribute Name
Type
Description
channelGroupParticipant
s
VtgParticipantVO[]
Contains an array of VtgParticipantVO value
objects
channelParticipants
VtgParticipantVO[]
Contains an array of VtgParticipantVO value
objects
radioParticipants
VtgParticipantVO[]
Contains an array of VtgParticipantVO value
objects
userGroupParticipants
VtgParticipantVO[]
Contains an array of VtgParticipantVO value
objects
userParticipants
VtgParticipantVO[]
Contains an array of VtgParticipantVO value
objects
vtgParticipants
VtgParticipantVO[]
Contains an array of VtgParticipantVO value
objects
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution
paginationContext
PaginationContextVO
Contains pagination information
VtgParticipantVO
The VtgParticipantVO value object contains information about a VTG participant (channel, channel
group, radio, user, user group, or VTG).
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-34
OL-21552-01
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-63 describes the attributes of this value object.
Table 3-63
VtgParticipantVO Attributes
Attribute Name
Type
Description
allocationStatus
String
Contains the status of the allocation of the
participant to the VTG.
allocationStatusMessage String
Contains a message that relates to the allocation
status.
description
String
Contains a description of the VTG participant.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
groupId
int
Not used.
id
int
Contains the unique ID of the association between
the participant and the VTG. Cisco IPICS
generates this ID when the VTG is activated.
name
String
Contains the name of the VTG participant.
participantId
int
Contains the unique ID of the participant that is
associated with the VTG. Cisco IPICS generated
this ID when the participant was created in Cisco
IPICS.
resourceType
String
Contains type of vtg participant (channel / radio).
status
String
Contains status of vtg participant.
userLogin
String
Contains the Cisco IPICS user name of a user
participant.
isSecure
boolean
Indicates whether the channel is designated as
secure (true means yes and false means no).
VtgUserOptionsVO
The VtgUserOptionsVO value object contains information about user options that are configured for a
VTG.
Table 3-64 describes the attributes of this value object.
Table 3-64
VtgUserOptionsVO Attributes
Attribute Name
Type
Description
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
latch
boolean
Indicates whether the latch function is configured
for use by the VTG user (true means yes and false
means no).
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
3-35
Chapter 3
Value Objects
Value Objects Descriptions
Table 3-64
VtgUserOptionsVO Attributes (continued)
Attribute Name
Type
Description
listenOnly
boolean
Indicates whether listen only mode is configured
for the VTG user (true means yes and false means
no).
rxMute
boolean
Indicates whether audio to or from the incident
VTG is muted when the PTT button is pressed in
the IDC or on an IP phone. Valid values are:
•
all—When PTT is engaged, RX (receive
transmission) is muted on all voice resources
•
this—When PTT is engaged, RX is muted on
this incident VTG
•
none—When PTT is engaged, no voice
resources are muted
VtgVO
The VtgVO value object contains summary information about a VTG.
Table 3-65 describes the attributes of this value object.
Table 3-65
VtgVO Attributes
Attribute Name
Type
Description
description
String
Contains description of the VTG.
errorVO
ErrorVO
Contains an error code and message, if an
exception occurs during function execution.
id
int
Contains the unique ID of the VTG. Cisco IPICS
generates this ID when you add the VTG to Cisco
IPICS.
name
String
Contains the name of the VTG.
status
String
Contains the current status of VTG (such as
active, inactive, pending).
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
3-36
OL-21552-01
CH A P T E R
4
REST API Function
This chapter describes the Cisco IPICS API uploadData function, which is a REST function that uploads
a resource (photograph, video, or journal) to the Cisco IPICS server and associates it with an incident.
This chapter includes these topics:
•
REST Function Description, page 4-1
•
REST Examples, page 4-4
REST Function Description
The uploadData function uploads a resource (photograph, video, or journal) to the Cisco IPICS server
and associates the resource with a designated incident. The resource can be uploaded as a URL or a file
(for a photograph or video) or text (for a journal).
This function must be invoked through an HTTP library. You can use a library of your choice.
Before you call this function, you must use the Cisco IPICS API startSession function to start a web
services session. When you are finished uploading resources, use the endSession function to end the web
services session. For information about these functions, see the “startSession” section on page 2-111 and
the “endSession” section on page 2-36.
You can view or download the XML schema for the uploadData function from the following URL.
Replace servername with the fully-qualified host name of the Cisco IPICS server if you are using DNS
in your deployment, or the IP address of the Cisco IPICS serve, if you are not using DNS.
https://servername/documents/schema1.xsd
Function URL
The URL for the uploadData function is as follows:
https://servername/ipics_server/handsetservice/incident/incidentId/uploaddata
where:
•
servername—Fully-qualified host name of the Cisco IPICS server if you are using DNS in your
deployment, or IP address of the Cisco IPICS server if you are not using DNS.
•
incidentId—Identifier of the incident with which to associate the resource that you are uploading.
You can use the Cisco IPICS API getIncident or the getIncidentDetails function to determine this
identifier. For more information, see the “getIncident” section on page 2-58 or the
“getIncidentDetails” section on page 2-58.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
4-1
Chapter 4
REST API Function
REST Function Description
Function Parameters
Table 4-1 describes the HTTP library parameters for the uploadData function.
Table 4-1
HTTP Library Parameters for the uploadData Function
Parameter
Type
Description
autoDelete
Request header or
parameter of
boolean type
Designates whether the system deletes the Cisco IPICS
database record for the uploaded resource and the resource
file (if the file exists on the Cisco IPICS server)
automatically when all incidents with which the resource is
associated are deleted.
Valid values are:
•
true—The database record and the resource file (if it
exists) are deleted automatically
•
false—The database record and the resource file (if it
exists) are never deleted automatically
This parameter is optional. By default, the database record
and the resource file are not deleted.
body
HTTP POST
request
The content of the file, URL, or text of the resource to
upload.
This parameter is required.
clientId
Request header or
parameter
Unique ID of the developer workstation that you are using
to execute the function.
This ID can contain up to 32 characters. You can use any
unique ID, for example, the MAC address of the developer
workstation.
This parameter is required.
Content-Length
Request header or
parameter
Designates the length, in bytes, of the resource that you are
uploading.
If you are uploading a file, enter the size of the file. If you
are uploading a URL, enter the number of bytes in the URL
string.
This parameter is required by the HTTP protocol. You do
not need to enter this parameter if your library calculates it
automatically.
Content-Type
Request header or
parameter
Identifies the type of content that you are sending over
HTTP. This parameter must be set to one of the following
values:
•
application/octet-stream—Use this value for
photograph or video files
•
text/plain—Use this value for journals and URLs
This parameter is required.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
4-2
OL-21552-01
Chapter 4
REST API Function
REST Function Description
Table 4-1
HTTP Library Parameters for the uploadData Function (continued)
Parameter
Type
Description
debug
Request header or
parameter
Designates whether the HTTP request is echoed to the
developer workstation.
•
true—The HTTP request is echoed to the developer
workstation
•
false—The HTTP request is not echoed to the
developer workstation
This parameter is optional.By default, HTTP requests are
not echoed.
description
Request header or
parameter
Description of the resource, which appears in the IDC and
Cisco IPICS mobile client.
The description can contain up to 255 characters.
This parameter is optional.
documentType
Request header or
parameter
The type of resource to upload. Valid values are:
•
Journal
•
Photo
•
Video
This parameter is required.
filename
Request header or
parameter
File name of the photograph or video to upload. If the
filename exists, the Cisco IPICS server modifies it to make
it unique.
This parameter is required for a photograph or video. Do
not include this parameter when you are uploading a
journal.
referenceType
Request header or
parameter
Designates the type of video that you are uploading. Valid
values are:
•
Clip—Use when you are uploading a video file
•
Stream—Use when you are uploading a URL of a live
video
This option required if you are uploading video. It is not
used for photographs or resources.
spwd
Request header or
parameter
Unique session ID. This ID is generated and returned when
you use the startSession function to log in to Cisco IPICS
web services and is used for the entire web services
session.
This parameter is required.
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
4-3
Chapter 4
REST API Function
REST Examples
Return Result
Cisco IPICS returns the following for the uploadData function:
•
resourceId—Unique identifier that the Cisco IPICS server assigns to the resource that you uploaded
•
errorCode—One of the following:
– SUCCESS—The function executed successfully
– FAIL_AUTH—An invalid session ID was specified with the spwd parameter
– FAIL_DOCUMENT_NOTSUPPORTED—An invalid value for the DocumentType parameter
was specified
– FAIL_FIELD_VALIDATION—An invalid parameter was entered
– FAIL_FILETOOOBIG—You are attempting to upload a file that is too big to fit on Cisco IPICS
server disk, or you are attempting to upload a video file that exceeds that maximum size for a
video file that is configured in the Cisco IPICS Administration Console
– FAIL_INTERNAL—An internal error occurred
– FAIL_IO—The disk on the Cisco IPICS server experienced a problem or the disk is full.
– FAIL_MODULECONTEXT—This Cisco IPICS server to which you want to upload the
resource is not on line
– FAIL_UNSUPPORTED_FILE_FORMAT—You are attempting to upload a photograph or
video file that is in a format that Cisco IPICS does not support
– WARN_FILENAME_CHANGED—You uploaded a file with the same name as a file that exists
on the Cisco IPICS server and the system changed the name of the file that you uploaded
– WARN_INCORRECT_MIMETYPE—The Content-Type parameter was not set or was set
incorrectly
– WARN_INVALID_URL—An invalid URL was entered
REST Examples
The following sections show examples of the uploadData function. These examples use the HTTP curl
library, but you can use any HTTP library with this function.
•
Example 1: Uploading a Video File, page 4-4
•
Example 2: Uploading a Video File with Debug Output, page 4-5
•
Example 3: Uploading a Photograph URL, page 4-5
•
Example 4: Uploading Journal Text, page 4-6
Example 1: Uploading a Video File
The following example shows a request and response when using the uploadData function to upload a
video file.
In this example:
•
The incident ID is 279
•
The session ID is 1275427188568415217882
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
4-4
OL-21552-01
Chapter 4
REST API Function
REST Examples
•
The client ID is idc123
•
The video file to upload is named fire.wmv
Request
curl -X POST http://ipicsserver.com/ipics_server/handsetservice/incident/279/uploaddata
-H "spwd: 1275427188568415217882" -H "clientId: idc123" -H "filename: fire.wmv"
-H "documentType: Video" -H "referenceType: Clip" -d @fire.wmv -H "Content-Type:
application/octet-stream" -H "description: curl video" -H "autoDelete: true"
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result resourceId="42"
incidentId="279" errorCode="WARN_FILENAME_CHANGED"/>
Example 2: Uploading a Video File with Debug Output
The following example shows a request and response when using the uploadData function to upload a
video file with the debug parameter set to “true”:
In this example:
•
The incident ID is 279
•
The session ID is 1275427188568415217882
•
The client ID is idc123
•
The video file to upload is named fire.wmv
Request
curl -X POST http://ipicsserver.com/ipics_server/handsetservice/incident/279/uploaddata -H
"spwd: 1275427188568415217882" -H "clientId: idc123" -H "filename: fire.wmv" -H
"documentType: Video" -H "referenceType: Clip" -d @fire.wmv -H "Content-Type:
application/octet-stream" -H "description: curl video" -H "autoDelete: true"
-H "debug: true"
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result resourceId="39"
incidentId="279" errorCode="WARN_FILENAME_CHANGED"><request><autoDelete>true
</autoDelete><description>curl video</description><documentType>Video</documentType>
<filename>1.279.3fire.wmv</filename><incidentId>279</incidentId><mediaType/><pmcId>idc123<
/pmcId><referenceType>Clip</referenceType><sessionId>1275427188568415217882</sessionId>
<spectrum>long</spectrum></request></result>
Example 3: Uploading a Photograph URL
The following example shows a request and response when using the uploadData function to upload a
photograph URL:
In this example:
•
The incident ID is 279
•
The session ID is 1275427188568415217882
•
The client ID is idc123
•
The photograph URL to upload is http://www.cisco.com//images/logo.jpg
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
4-5
Chapter 4
REST API Function
REST Examples
Request
curl -X POST http://ipicsserver.com/ipics_server/handsetservice/incident/279/uploaddata
-H "spwd: 1275427188568415217882" -H "clientId: idc123" -H "documentType: Photo"
-H "Content-Type: text/plain" -H "description: curl photo"
-d "http://www.cisco.com//images/logo.jpg"
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result resourceId="42"
incidentId="279" errorCode="SUCCESS"/>
Example 4: Uploading Journal Text
The following example shows a request and response when using the uploadData function to upload
journal text:
In this example:
•
The incident ID is 279
•
The session ID is 1275427188568415217882
•
The client ID is idc123
•
The journal text to upload is “Here is a new journal entry”
Request
curl -X POST http://ipicsserver.com/ipics_server/handsetservice/incident/279/uploaddata
-H "spwd: 1275427188568415217882" -H "clientId: idc123" -H "documentType: Journal"
-H "Content-Type: text/plain" -H "description: journal" -d "Here is a new journal entry"
Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?><result resourceId="42"
incidentId="279" errorCode="SUCCESS"/>
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
4-6
OL-21552-01
INDEX
description
A
1-1
function
activateIncident function
2-8
activateIncidentVtg function
activateVtg function
list of, See function
2-9
2-9
activating
incident
2-8
incident VTG
VTG
2-9
overview
2-8
summary
2-2
logging
1-8
security
1-7
value object
2-9
list of, See value object
addChannelToVtg function
2-10
summary
adding
3-1
application programming interface
channel to VTG
2-10
journal to incident
See API
2-11
photograph to incident
radio to VTG
associateChannelsToUser function
2-12
2-13
resource to VTG
2-11, 2-13
2-17
associatePhonesToUser function
2-18
associateRadiosToUser function
2-18
associateResourcesToIncident function
user
2-19
audio
to user group
to VTG
2-15
video to incident
VTG to VTG
2-14
2-15, 2-16
2-108, 2-109
enabling on IDC
2-108, 2-109
authentication
1-7
2-17
addJournalToIncident function
2-11
addParticipantsToVtg function
2-11
addPhotoToIncident function
addRadioToVtg function
2-12
B
BooleanVO
3-4
2-13
addResourcesToVtg function
AddressVO
disabling on IDC
2-13
C
3-4
addUserToUserGroup function
addUserToVtg function
2-14
addVideoToIncident function
addVtgToVtg function
API
2-14
2-17
channel
active
2-15, 2-16
2-91
adding to VTG
associated with
incident
authentication
1-7
2-10
user
2-55
2-54
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
IN-1
Index
VTG
client stub
2-55
associating with user
creating
2-20
deleting
2-28
generating
2-17
1-2
overview
1-1
createChannel function
2-20
2-21
disabling
2-33
createIncident function
enabling
2-35
createPhoto function
removing from VTG
createUser function
2-96
retrieving
all
createVtg function
2-45
channel
2-20
incident
incident
2-21
user
2-55
photograph
2-54
VTG
user
2-55
by search criterion
status
2-53
2-56
summary information
ChannelDetailVO
video
2-24
VTG
2-25
2-23
D
3-5
deactivateIncident function
3-5
2-26
deactivateIncidentVtg function
channel group
associated with VTG
deactivateVtg function
2-53
2-26
2-27
deactivating
retrieving
incident
2-44
associated with VTG
by search criterion
channels in
ChannelGroupVO
2-26
incident VTG
2-53
VTG
2-38
2-45
ChannelGroupContainerVO
ChannelVO
2-21
2-52
2-91
ChannelContainerVO
2-24
2-22
user group
2-38
detailed information
2-23
creating
2-45
associated with
all
2-22, 2-23
createVideo function
all in channel group
status
2-21
3-7
2-26
2-27
deletePmcProfile function
2-28
deleterResources function
2-28
deleting
3-7
channel
3-7
2-28
Cisco IPICS Dispatch Console profile
Cisco IPICS
photograph
application programming interface
See API
Dispatch Console profile, deleting
role, affect on function execution
version, retrieving
ClientDescriptorVO
2-28
2-1
2-62
3-8
2-28
radio
2-28
video
2-28
VTG
2-28, 2-29
developer workstation
1-1
DialAddressContainerVO
DialAddressVO
2-28
3-8
3-9
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
IN-2
OL-21552-01
Index
dialAllIncidentVtgMembers function
dialAllVtgMembers function
2-29
executing
API client code
2-30
dialIncidentVtgMember function
notification policy
2-31
dialing
policy
incident VTG members
2-32
findChannelGroups function
dial preferences
retrieving for user
setting
2-75
2-102
dialVtgMember function
2-32
digit ID
findChannels function
2-39
findIncidents function
2-38
findPhotos function
2-40
findRadios function
2-41
findUsers function
retrieving
setting
2-56
retrieving
setting
2-43, 2-44
function
activateIncident
2-57
2-8
activateIncidentVtg
2-104
activateVtg
disableChannel function
disableUser function
2-33
2-34
2-33
2-9
2-9
addChannelToVtg
disabling
channel
2-38, 2-41
2-42
findVideos function
2-103
digit password
user
2-37
F
2-30
one
2-36
2-31
VTG members
all
1-3
2-10
addJournalToIncident
2-11
addParticipantsToVtg
2-11
addPhotoToIncident
2-34
addRadioToVtg
2-12
2-13
addResourcesToVtg
2-13
addUserToUserGroup
E
addUserToVtg
Eclipse IDE
obtaining
addVtgToVtg
1-2
enableUser function
2-35
2-35
enabling
2-17
2-17
associatePhonesToUser
2-18
associateRadiosToUser
2-18
associateResourcesToIncident
channel
2-35
2-35
ending, web services session
endSession function
ErrorVO
2-15, 2-16
associateChannelsToUser
1-2
enableChannel function
user
2-14
addVideoToIncident
configuring
2-14
2-20
createIncident
2-21
createPhoto
2-36
createUser
2-36
createVideo
3-9
executeNotificationPolicy function
executePolicy function
createChannel
2-37
2-36
createVtg
2-19
2-21
2-22, 2-23
2-23
2-24
deactivateIncident
2-26
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
IN-3
Index
deactivateIncidentVtg
deactivateVtg
getChannelsForVtg
2-26
getChannelStatus
2-27
deletePmcProfile
getDigitId
2-28
deleteResources
2-56
2-56
getDigitPassword
2-28
dialAllIncidentVtgMembers
dialAllVtgMembers
2-55
getIncident
2-29
2-58
getIncidentDetails
2-30
dialIncidentVtgMember
2-57
2-58
getIncidentParticipants
2-31
dialVtgMember
2-32
getIncidentsForUser
disableChannel
2-33
getIncidentVtg
disableUser
enableChannel
2-60
enableUser
2-35
getIpicsVersion
endSession
2-36
getJournal
executeNotificationPolicy
2-63
2-63
getJournalsForIncident
2-39
getPhoto
findIncidents
2-38
getPhotoDetails
2-66
2-40
getPhotosForIncident
findRadios
2-41
getPmcProfile
getPolicy
2-43, 2-44
getAllChannelGroups
getAllChannels
getAllVtgs
getRadiosForIncident
getUser
2-48
2-71
2-73
getUserDetails
2-50
2-74
2-74
getUserDialPreference
2-50
getUserDirectory
2-51
2-51
getUserGroup
2-76
getUserGroupsForVtg
2-53
getChannelsAssociatedToUser
getChannelsForIncident
2-54
2-53, 2-55
getUserId
2-75
2-75
getUserGroupMembers
2-52
2-71
2-72
getUserAudioStatus
2-49
2-70
2-72
getUserAddress
2-48
getChannelDetails
2-69
getPolicyExecutionStatusDetails
getRadiosForVtg
getBelongingOpsViewForUser
getChannel
2-47
2-47
getAllUserGroups
2-69
getRadiosAssociatedToUser
2-46
getAllIncidentsWithIVtgStatus
getAllVideos
2-45
2-67
2-68
getPolicyExecutionStatus
2-45
getAllIncidents
getAllUsers
2-67
getPolicyDetails
2-44
getAllChannelsInChannelGroup
getAllRadios
2-66
getPoliciesAssociatedToUser
2-42
getAllPolicies
2-64
2-65
findPhotos
getAllPhotos
2-64
getPhonesAssociatedToUser
2-38, 2-41
findChannels
findVideos
2-61
2-62
getJournalDetails
2-36
2-37
findChannelGroups
findUsers
2-61
getIncidentVtgUserOptions
2-35
executePolicy
2-59
getIncidentVtgOptions
2-34
2-59
2-77
2-77
2-78
getUserListenerStatus
2-78
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
IN-4
OL-21552-01
Index
getUserNotificationPreference
getUserRoles
setNotificationPreference
2-80
getUsersAssociatedToRadio
getUsersForIncident
getUsersForVtg
getUserStatus
getVideo
setUserAddress
2-81
setVtgOptions
StartSession
2-84
getVideosForIncident
getVtgDetails
updatePhoto
2-85
getVtgOptions
getVtgsForIncident
2-89
isActiveVtg
4-4 to 4-6
overview
4-1
2-114
4-2
return result
2-91
2-91
isActiveIncidentVtg
isActiveUser
examples
parameters
2-90
isActiveChannel
2-114
uploadData
2-88
2-89
getVtgUserOptions
2-113
updateVirtualTalkGroup
2-87
getVtgsAssociatedToUser
getVtgStatus
2-113
updateVideo
2-86
getVtgParticipantStatus
getVtgsForVtg
2-112
updateUserGroup
2-86
getVtgParticipants
2-110
2-111
updateIncident
2-84
2-109
2-109
setVtgUserOptions
2-83
2-107
2-108
setUserListenerStatus
2-83
2-106
2-107
setUserAudioStatus
2-81
2-82
getVideoDetails
2-92
URL
4-1
using
4-1
4-4
2-93
2-93
notifyAllIncidentVtgMembers
notifyAllVtgMembers
notifyVtgMember
2-95
2-96
removeUserFromVtg
2-99
removeVtgFromVtg
2-100
removeVtgParticipants
2-97
2-98
2-101
getAllVideos function
2-102
2-48
2-48
getAllUserGroups function
getAllUsers function
2-102
getAllVtgs function
2-50
2-50
2-51
getChannelDetails function
2-104
setIncidentVtgOptions
2-49
getBelongingOpsViewForUser function
2-103
getChannel function
2-105
2-47
2-47
getAllPolicies function
getAllRadios function
2-45
2-46
getAllIncidentsWithIVtgStatus function
getAllPhotos function
2-100
setBelongingOpsViewForUser
setDigitPassword
2-45
getAllIncidents function
2-98
removeResourceFromIncident
setDialPreference
getAllChannels function
2-44
getAllChannelsInChannelGroup function
removePhoneAssociatedToUser
removeRadioFromVtg
G
getAllChannelGroups function
2-96
removeChannelFromVtg
savePmcProfile
2-94
2-94
notifynotifyIncidentVtg
setDigitId
setIncidentVtgUserOptions
2-79
2-51
2-53
2-52
getChannelsAssociatedToUser function
2-54
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
IN-5
Index
getChannelsForIncident function
getChannelsForVtg function
getChannelStatus function
getDigitId function
getUserListenerStatus function
2-53, 2-55
getUserNotificationPreference function
2-55
getUserRoles function
2-56
getDigitPassword function
2-57
getUsersForIncident function
getIncidentDetails function
2-58
getUsersForVtg function
getIncidentParticipants function
getIncidentsForUser function
getIncidentVtg function
getVideo function
2-59
getIncidentVtgOptions function
getJournal function
getVtgsForIncident function
2-64
getVtgStatus function
2-66
getPoliciesAssociatedToUser function
2-67
2-69
2-90
getPolicyExecutionStatus function
2-70
2-69
2-68
getRadiosAssociatedToUser function
getRadiosForIncident function
getUserAddress function
2-71
getUserDetails function
disabling audio
2-108, 2-109
enabling audio
2-108, 2-109
profile
2-71
information, saving
retrieving
2-73
2-101
2-67
retrieving
2-74
audio status
2-74
getUserDialPreference function
getUserDirectory function
2-78
IDC
2-72
getUserAudioStatus function
2-91
I
ID, system-generated
getPolicyExecutionStatusDetails function
getRadiosForVtg function
2-89
2-66
2-67
getPolicyDetails function
2-88
2-89
getVtgUserOptions function
getPhotosForIncident function
profile
2-75
2-75
2-74
2-67
incident
activating
2-72
2-8
adding
2-76
getUserGroupMembers function
getUserGroupsForVtg function
getUserId function
getVtgsForVtg function
2-64
2-65
getUserGropu function
2-87
getVtgsAssociatedToUser function
getPhotoDetails function
getUser function
2-86
getVtgParticipantStatus function
2-63
getPhonesAssociatedToUser function
getPolicy function
2-86
getVtgParticipants function
2-63
getPmcProfile function
2-84
2-85
getVtgOptions function
2-61
2-62
getJournalsForIncident function
getPhoto function
2-83
getVtgDetails function
2-61
getIncidentVtgUserOptions function
getJournalDetails function
2-84
getVideosForIncident function
2-60
getIpicsVersion function
2-81
2-83
getVideoDetails function
2-59
2-81
2-82
getUserStatus function
2-58
2-79
2-80
getUsersAssociatedToRadio function
2-56
getIncident function
2-78
journal to
2-77
2-77
2-78
2-11
photograph to
video to
2-12
2-15, 2-16
associating resource with
2-19
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
IN-6
OL-21552-01
Index
attributes, modifying
creating
isActiveChannel function
2-112
isActiveIncidentVtg function
2-21
deactivating
isActiveUser function
2-26
detailed information, retrieving
disassociating resource from
radios associated with
2-58
2-71
2-93
isActiveVtg function
2-93
J
2-46, 2-47
journal
by search criterion
2-39
adding to incident
channels associated with
detailed information
participants
2-55
2-11
retrieving
2-58
all
2-59
2-64
detailed information
photographs associated with
resources
2-59
2-66
JournalContainerVO
JournalDetailsContainerVO
users associated with
2-60
JournalDetailsVO
users associated with
IncidentContainerVO
JournalVO
3-14
3-14
3-15
2-81
3-10
L
3-10
IncidentParticipantVO
IncidentVO
2-84
2-63
3-14
2-58
videos associated with
2-63
summary information
summary information
IncidentDetailsVO
2-92
2-98
retrieving
all
2-91
3-11
log, of API invocations
1-8
3-12
incident VTG
activating
active
M
2-9
2-92
members
deactivating
2-26
of incident VTG, dialing one
dialing one member
inactive
2-31
of VTG
2-92
notifying, users
2-31
dialing all
2-94
dialing one
2-30
2-32
options
retrieving
setting
2-61
N
2-105
retrieving, options
2-60
ncidentParticipantContainerVO
user options
notification
retrieving
setting
2-61
incident VTG users
2-106
IncidentVtgOptionsVO
2-94
preferences
3-12
IncidentVtgUserOptionsVO
IntegerVO
3-11
retrieving
3-13
setting
2-79
2-107
3-13
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
IN-7
Index
VTG users
retrieving
all
all
2-94
one
2-47
associated with incident
2-95, 2-96
NotificationAddressContainerVO
NotificationAddressVO
by search criterion
3-16
2-40
summary information, retrieving
3-16
notification policy, executing
PhotoVO
2-36
notifyAllIncidentVtgMembers function
notifyAllVtgMembers function
2-94
2-65
3-19
policy
detailed information, retrieving
2-94
notifynotifyIncidentVtg function
notifyVtgMember function
2-66
executing
2-95
2-69
2-37
execution
2-96
detailed information, retrieving
2-70
summary information, retrieving
O
2-69
retrieving
all
ops view
assigning to user
2-102
function execution, affect on
retrieving
2-1
2-48
associated with user
2-67
detailed information
2-69
summary information
2-51
2-68
summary information, retrieving
PolicyActionVO
P
3-20
PolicyContainerVO
PaginationContextVO
PolicyDetailsVO
3-16
3-21
3-21
policy execution
participant
removing from VTG
retrieving
2-100
retrieving all, for incident
2-59
phone
associating with user
retrieving
summary information
2-69
PolicyTriggerVO
3-17
PolicyVO
PhotoContainerVO
2-69
PolicyExecutionStatusVO
3-17
PhotoDetailsVO
2-6, 2-70
PolicyExecutionStatusContainerVO
2-97
2-64
PhoneContainerVO
detailed information
status
2-18
disassociating from user
PhoneVO
2-68
3-22
3-22
3-22
3-23
3-18
3-18
R
photograph
adding to incident
attributes, modifying
creating
2-21
deleting
2-28
radio
2-12
adding to VTG
2-113
detailed information, retrieving
2-13
associated with
incident
2-66
VTG
2-71
2-72
associating with user
2-19
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
IN-8
OL-21552-01
Index
deleting
channel summary information
2-28
removing from VTG
Cisco IPICS version
2-98
retrieving
all
dial preferences
digit ID
2-48
associated with user
by search criterion
users associated with
RadioContainerVO
RadioDetailsVO
RadioVO
2-56
2-57
IDC
2-41
audio status
2-81
profile
3-23
incident
3-23
2-74
2-67
2-47, 2-58
all, with incident VTG status
3-24
removeChannelFromVtg function
removeRadioFromVtg function
associated with user
2-96
removePhoneAssociatedToUser function
2-97
removeUserFromVtg function
2-99
removeVtgFromVtg function
2-100
removeVtgParticipants function
2-100
resource
by search criterion
participants
2-98
removeResourceFromIncident function
2-98
resources
adding to VTG
2-19
disassociating from incident
retrieving, for incident
ResourceContainerVO
2-98
2-59
2-39
2-59
incident VTG
associated with incident
options
2-61
2-61
detailed information
2-64
2-63
summary information
2-63
2-51
phones associated with user
3-25
2-64
photograph
channel
all
2-47
associated with incident
2-45
all in channel group
2-45
by search criterion
detailed information
incident
summary information
user
2-55
detailed information
2-38
2-53
2-67
all
2-48
detailed information
2-69
execution
channel groups
detailed information
2-44
associated with VTG
by search criterion
channel status
2-65
policy
2-55
by search criterion
2-66
policies associated with user
2-54
VTG
2-66
2-40
associated with
all
2-60
all associated with incident
ops view
3-24
retrieving
all
2-60
journal
2-11, 2-13
associating with incident
2-46
2-59
user options
ResourceVO
2-62
2-75
digit password
2-71
2-52
2-53
2-38
2-70
summary information
summary information
2-69
2-68
2-56
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
IN-9
Index
radio
all
VTG
2-48
2-89
by search criterion
2-44
associated with
detailed information
incident
names of participants
user
2-71
of options
2-72
by search criterion
user options
all
2-91
2-1
2-50
incident
S
2-81
radio
2-81
savePmcProfile function
VTG
2-82
security
by search criterion
summary information
system-generated ID
2-79
2-6, 2-73
2-78
SessionVO
2-36
2-111
3-25
setBelongingOpsViewForUser function
setDialPreference function
setDigitId function
user group
associated with VTG
by search criterion
members
2-77
2-104
setIncidentVtgOptions function
2-76
setUserAddress function
setVtgOptions function
video
associated with incident
2-84
2-43
detailed information
summary information
2-84
2-83
starting session
2-110
2-111
StartSession function
StringVO
2-109
2-109
setVtgUserOptions function
2-50
2-107
2-108
setUserListenerStatus function
2-83
2-106
2-107
setUserAudioStatus function
2-80
by search criterion
2-105
setNotificationPreference function
2-77
summary information
user status
2-103
setIncidentVtgUserOptions function
2-41
2-102
2-102
setDigitPassword function
2-49
user roles
starting
2-75
notification preferences
1-7
ending
2-74
direct connect number
2-101
session
2-42
detailed information
all
2-87
role, affect on function execution
2-73
associated with
all
2-86, 2-90
of participants
2-41
user
address
2-86
status
2-71
VTG
2-85
2-111
3-25
system-generated ID, retrieving
2-78
VTG
all
2-51
associated with
user
2-88
U
updateIncident function
2-112
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
IN-10
OL-21552-01
Index
updatePhoto function
ops view
2-113
updateUserGroup function
updateVideo function
2-113
2-114
updateVirtualTalkGroup function
2-114
uploadData function
assigning
2-102
retrieving
2-51
phones associated with
policies associated with
examples
4-4, 4-6
radios associated with
overview
4-1
removing from VTG
parameters
address of user
4-4
2-71, 2-81
2-99
2-73
URL
4-1
all
using
4-1
by search criterion
XML schema
2-67
retrieving
4-2
return result
2-64
2-50
2-42
detailed information
4-1
user
2-74
direct connect number
active
summary information
2-93
adding
roles of
physical address
to user group
to VTG
UserContainerVO
UserDetailsVO
2-81
channel with
radio with
creating
2-18
all
2-22
setting
2-23
2-49
associated with VTG
2-75, 2-102
members
2-56
retrieving
setting
UserGroupDetailsVO
2-57
UserGroupVO
2-104
user roles, retrieving
2-34
2-97
UserRoleVO
UserVO
2-109
3-27
3-27
3-28
2-80
3-28
user status, retrieving
2-35
2-76
3-27
UserRoleContainerVO
2-93
notification preferences
2-41
2-77
UserGroupContainerVO
disassociating phone from
2-77
summary information
2-103
digit password
muting
2-113
by search criterion
retrieving
enabling
2-14
retrieving
2-19
digit ID
disabling
3-26
attributes, modifying
2-17
dial preferences
disabled
3-26
adding user to
phone with
2-88
user group
2-82
associating
creating
2-109
VTGs associated with
2-15
incident
2-83
unmuting
2-14
2-6, 2-73
2-80
status of
2-107
associated with
VTG
2-75
2-83
3-28
2-79, 2-107
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
IN-11
Index
PolicyTriggerVO
V
PolicyVO
value object
3-22
3-23
RadioContainerVO
AddressVO
3-4
RadioDetailsVO
BooleanVO
3-4
RadioVO
ChannelContainerVO
ChannelDetailVO
3-5
SessionVO
3-7
StringVO
3-8
3-8
3-9
3-10
UserRoleVO
3-11
UserVO
3-12
3-12
IncidentVtgUserOptionsVO
3-13
JournalDetailsVO
3-14
VtgDetailVO
3-14
VtgOptionsVO
3-15
NotificationAddressVO
PaginationContextVO
PhoneContainerVO
3-32
3-32
3-33
VtgParticipantVO
3-16
3-16
3-16
3-35
3-36
video
3-17
adding to incident
2-15, 2-16
attributes, modifying
PhotoContainerVO
3-34
3-34
VtgUserOptionsVO
VtgVO
3-17
3-18
3-18
3-19
creating
2-24
deleting
2-28
2-114
detailed information, retrieving
3-20
PolicyContainerVO
PolicyDetailsVO
3-32
VtgParticipantContainerVO
3-11
NotificationAddressContainerVO
PolicyActionVO
3-31
VtgDetailContainerVO
ncidentParticipantContainerVO
PhotoVO
3-29
3-29
VtgContainerVO
JournalDetailsContainerVO
PhotoDetailsVO
3-28
VideoVO
3-14
3-28
3-28
VideoDetailsVO
3-13
JournalContainerVO
PhoneVO
3-27
VideoContainerVO
IncidentVtgOptionsVO
3-27
3-27
UserRoleContainerVO
3-10
IncidentParticipantVO
JournalVO
3-26
UserGroupVO
IncidentDetailsVO
3-26
UserGroupDetailsVO
IncidentContainerVO
IntegerVO
3-25
UserGroupContainerVO
3-9
IncidentVO
3-25
UserDetailsVO
DialAddressContainerVO
3-24
3-25
UserContainerVO
ClientDescriptorVO
ErrorVO
3-7
3-7
DialAddressVO
3-24
ResourceVO
ChannelGroupContainerVO
ChannelVO
3-23
ResourceContainerVO
3-5
ChannelGroupVO
3-23
retrieving
3-21
all
3-21
2-50
associated with incident
PolicyExecutionStatusContainerVO
PolicyExecutionStatusVO
2-84
3-22
3-22
by search criterion
2-84
2-43
summary information, retrieving
2-83
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
IN-12
OL-21552-01
Index
VideoContainerVO
VideoDetailsVO
VideoVO
channel
3-29
3-29
3-31
from VTG
2-100
participant
2-100
virtual talk group
radio
See VTG
user
VO
2-98
2-99
VTG
See value object
all
active
2-51
associated with user
2-9
2-44
channel groups associated with
channel to
radio to
channels associated with
2-10
to VTG
in VTG
2-11, 2-13
2-17
user to
2-55
2-86
status
2-15
VTG to
2-53
participants
2-13
resource to
status
2-17
2-87
2-90
user groups associated with
2-51
2-7, 2-77
status
associated with
user
2-88
VTG
2-89
creating
2-114
deleting
2-90
retrieving
2-86
2-91
users associated with
2-25
deactivating
of options
user options
attributes, modifying
2-82
VTGs associated with
2-27
VtgContainerVO
2-28, 2-29
dialing
2-85
VtgDetailVO
3-32
3-32
VtgOptionsVO
3-33
all members
2-30
VtgParticipantContainerVO
one member
2-32
VtgParticipantVO
disabled
2-93
VtgVO
all users
2-94
one user
2-95, 2-96
3-34
3-34
VtgUserOptionsVO
notifying
2-89
3-32
VtgDetailContainerVO
detailed information, retrieving
options
2-88
by search criterion
2-93
adding
all
2-100
retrieving
VTG
activating
2-96
3-35
3-36
W
2-109, 2-110
participant
web services session
names
2-86
status
2-87
radios associated with
ending
starting
2-36
2-111
2-72
removing
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
OL-21552-01
IN-13
Index
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0
IN-14
OL-21552-01