INDEX
addParticipantsToVtg function
A
addPhotoToIncident function
activateIncident function
2-10
activateIncidentVtg function
activateVtg function
addRadioToVtg function
2-11
AddressBookUserDetailVO
2-10
AddressBookUserVO
incident VTG
VTG
2-11
AddressVO
2-12
addChannelToVtg function
2-13
4-4
4-5
4-6
4-6
addUserToVtg function
2-12
addVtgToVtg function
2-26
2-18
2-19
addVideoToIncident function
adding
2-20
2-21
API
channel to VTG
2-12
authentication
email address
description
to Private Contacts list
2-27
entry to Favorite Contacts list
journal to incident
overview
2-14
phone number
from Private Contacts list
to Private Contacts list
2-38
REST-based
3-2
web services
2-10
summary
2-27
3-1
web services
2-16
2-16
resource to VTG
1-1
list of, See function
2-14
photograph to incident
1-7
function
2-18
multicast connection to channel
radio to VTG
2-17, 2-18
addUserToUserGroup function
addCameraToIncident function
camera
2-16
AddressBookUserContainerVO
activating
incident
2-16
addResourcesToVtg function
2-12
2-15
2-15, 2-17
logging
1-8
security
1-7
2-2
value object
user
list of, See value object
to user group
to VTG
2-19
2-19
video to incident
4-1
application programming interface
2-20, 2-21
VSOM camera to incident
VTG to VTG
summary
See API
2-13
associateChannelsToUser function
2-21
addJournalToIncident function
2-14
addMulticastChannelConnection function
2-14
2-22
associatePhonesToUser function
2-22
associateRadiosToUser function
2-23
associateResourcesToIncident function
2-24
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-1
Index
associateUsersToChannel function
associateUsersToRadio function
2-25
2-25
audio
by search criterion
detailed information
status
disabling on IDC
2-140, 2-141
enabling on IDC
2-140, 2-141
authentication
2-51
2-68
2-72
summary information
status
2-118
users associated with
1-7
2-68
2-103
ChannelConnectionContainerVO
ChannelContainerVO
B
ChannelDetailVO
BooleanVO
4-7
4-7, 4-8
4-8
channel group
4-7
associated with VTG
2-69
retrieving
C
all
2-58
associated with VTG
camera
adding to Cisco IPICS
by search criterion
2-26
associating with incident
channels in
2-132
2-50
2-60
ChannelGroupContainerVO
channel
active
ChannelGroupVO
2-118
adding multicast connection to
adding to VTG
2-14
user
Dispatch Console profile, deleting
role, affect on function execution
associating users with user
associating with user
2-27
deleting
2-40
2-25
2-22
version, retrieving
ClientDescriptorVO
2-39
2-1
2-80
4-11
client stub
generating
disabling
2-45
enabling
2-47
overview
1-2
1-1
ContactInfoContainerVO
removing from VTG
2-126
ContactInfoVO
4-12
4-12
contact list
retrieving
all
4-11
See API
2-70
2-71
creating
4-10
application programming interface
2-69
VTG
4-10
Cisco IPICS
2-12
associated with
incident
ChannelVO
2-69
entry
2-59
all in channel group
2-60
adding to Private Contacts list
2-30
associated with
email address, modifying
2-144
incident
phone number, modifying
2-144
user
VTG
2-70
2-69
2-71
Favorite, adding
entry to
2-18
Global, retrieving all entries
2-58
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-2
OL-30494-01
Index
modifying entry
2-146
D
Private
deleting entry from
deactivateIncident function
2-39
email address, adding
deactivateIncidentVtg function
2-27
deactivateVtg function
phone number
adding
incident
2-38
email address
VTG
2-72
phone number
2-37
2-38
deleteLocation function
2-72
private, deleting email address
2-36
deleteContact function
2-57, 2-58
searching, for entry
2-37
2-36
incident VTG
retrieving
entries
2-36
deactivating
2-27
deleting
2-36
2-38
2-133
2-38
deletePmcProfile function
2-39
deletePrivateUser function
2-39
createCamera function
2-26
deleterResources function
createChannel function
2-27
deleting
createContact function
2-27
channel
createIncident function
2-28
Cisco IPICS Dispatch Console profile
createLocation function
createPatchVtg function
createPhoto function
2-30
2-31, 2-32
createVideo function
location
radio
2-40
video
2-40
VTG
2-40, 2-41
1-1
DialAddressContainerVO
2-35
DialAddressVO
4-13
4-14
dialAllIncidentVtgMembers function
2-27
entry in Private Contacts list
2-30
dialAllVtgMembers function
2-28, 2-29
dialIncidentVtgMember function
location
2-28
dialing
patch VTG
2-34
incident VTG members
photograph
2-30
VTG members
user
all
one
2-31
user group
2-121
2-32
2-41
2-42
incident
SIP connection
2-38
2-40
developer workstation
2-32
creating
channel
2-39
2-38
photograph
2-30
createUser function
createVtg function
2-29
2-33
createPrivateUser function
2-40
email address, from Private Contacts list
2-28
createMulticastAddresses function
2-40
2-43
2-43
2-42
2-44
dial preferences
video
2-32
retrieving for user
VTG
2-35
setting
2-98
2-135
dialVtgMember function
2-44
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-3
Index
digit ID
notification policy
retrieving
setting
policy
2-73
2-49, 2-50
2-135
digit password
retrieving
setting
F
2-73
2-136
Favorite Contacts list
disableChannel function
disableUser function
2-45
removing, entry from
2-46
2-126
retrieving, entries from
disabling
2-74
findChannelGroups function
channel
user
2-45
2-46
E
findChannels function
2-52
findIncidents function
2-51
findPhotos function
2-52
findRadios function
2-53
findUsers function
Eclipse IDE
obtaining
2-55, 2-56
function
1-2
activateIncident
1-2
email address
2-10
activateIncidentVtg
adding to Private Contacts list
enableChannel function
activateVtg
2-27
deleting from Private Contacts list
enableUser function
2-50, 2-54
2-55
findVideos function
configuring
2-11
2-12
addCameraToIncident
2-38
addChannelToVtg
2-47
2-13
2-12
addJournalToIncident
2-47
enabling
2-14
addMulticastChannelConnection
channel
user
addParticipantsToVtg
2-47
addPhotoToIncident
2-47
ending, web services session
endSession function
entries
2-48
addRadioToVtg
2-48
2-16
2-17, 2-18
addUserToUserGroup
2-57
entry
addUserToVtg
adding to Favorite Contacts list
addVtgToVtg
2-39
removing from Favorite Contacts list
2-126
retrieving all from Favorite Contacts list
2-74
4-14
executeNotificationPolicy function
executePolicyForUser function
executePolicy function
2-48
2-50
2-49
executing
API client code
1-3
2-18
2-19
addVideoToIncident
2-18
deleting from Private Contacts list
ErrorVO
2-15
2-16
addResourcesToVtg
2-48
2-14
2-20
2-21
associateChannelsToUser
2-22
associatePhonesToUser
2-22
associateRadiosToUser
2-23
associateResourcesToIncident
associateUsersToChannel
associateUsersToRadio
createCamera
2-26
createChannel
2-27
2-24
2-25
2-25
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-4
OL-30494-01
Index
createContact
2-27
getAllChannelGroups
createIncident
2-28
getAllChannels
createLocation
createMulticastAddresses
createPhoto
getAllPhotos
2-63
getAllRadios
2-35
deactivateIncident
deactivateIncidentVtg
getAllUsers
2-36
2-65
2-65
deactivateVtg
2-37
getAllVideos
deleteContact
2-38
getAllVtgs
deleteLocation
2-64
getAllUserGroups
2-36
2-66
2-66
getBelongingOpsViewForUser
2-38
deletePmcProfile
2-39
getChannel
deletePrivateUser
2-39
getChannelDetails
deleteResources
dialAllIncidentVtgMembers
2-41
dialIncidentVtgMember
getChannelsForIncident
2-43
getChannelStatus
dialVtgMember
2-44
getContacts
disableChannel
2-45
getDigitId
disableUser
getFavorite
2-47
2-69, 2-70
2-71
2-72
2-73
2-73
2-74
enableUser
2-47
getGlobalMediaMap
endSession
2-48
getGlobalMediaMapVersion
executeNotificationPolicy
executePolicy
2-48
executePolicyForUser
2-50
2-50, 2-54
2-75
2-76
getIncidentParticipants
getIncidentsForUser
findChannels
2-52
getIncidentVtg
findIncidents
2-51
getIncidentVtgOptions
2-77
2-78
2-78
2-79
findPhotos
2-52
getIncidentVtgUserOptions
findRadios
2-53
getIpicsVersion
findUsers
findVideos
getJournal
2-55
getAddressBook
getAddressBookEntry
2-80
2-81
getJournalsForIncident
2-57
2-58
2-79
2-81
getJournalDetails
2-55, 2-56
2-75
2-76
getIncidentDetails
2-49
findChannelGroups
getIncident
2-69
2-72
getDigitPassword
2-46
enableChannel
2-68
getChannelsForVtg
2-42
2-67
2-68
getChannelsAssociatedToUser
2-40
dialAllVtgMembers
2-62
2-63
getAllPolicies
2-32
2-61
2-62
getAllMulticastAddresses
2-30
2-60
2-60
getAllLocations
2-31, 2-32
createVideo
getAllIncidents
getAllIncidentsWithIVtgStatus
2-33
createPrivateUser
createVtg
2-29
2-30
createUser
2-59
getAllChannelsInChannelGroup
2-28
createPatchVtg
2-58
getLazyTalkgroupStatus
2-82
2-82
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-5
Index
getLocationById
getVideoDetails
2-83
getLocationByName
getVideosForIncident
2-84
getLoggedInIDCUsers
getVSOMCamera
2-84
getMulticastAddressByAddress
getMulticastAddressById
2-85
getPmcProfile
2-89
getVtgsForVtg
2-91
getPolicyExecutionStatus
getVtgStatus
2-91
getPolicyExecutionStatusDetails
getRadioDetails
2-92
getRadiosAssociatedToUser
getRadiosForIncident
getRadiosForVtg
2-93
getUserAddress
2-118
2-119
2-120
2-120
getUserDetails
notifyAllVtgMembers
getUserDialPreference
getUserGroup
2-122
notifyAllIncidentVtgMembers
2-96
2-97
getUserDirectory
2-121
leaveLazyTalkgroup
2-96
getUserAudioStatus
notifyVtgMember
2-98
policy
2-99
getUserGroupsForVtg
2-124
2-125
removeChannelFromVtg
2-100
removeFromFavorite
2-101
getUserListenerStatus
2-102
2-126
removeRadioFromVtg
getUsersAssociatedToChannel
2-103
removeUserFromVtg
2-104
removeVtgFromVtg
getUsersAssociatedToRadio
2-105
removeVtgParticipants
getUsersForVtg
getUserStatus
getVideo
2-106
2-107
2-107
reserveRadio
2-128
2-129
getUsersAssociatedToPolicy
2-105
2-127
2-128
removeResourceFromIncident
2-103
getUsersForIncident
2-126
removePhoneAssociatedToUser
2-101
getUserNotificationPreference
2-124
3-3
releaseRadio
2-99
2-122
2-123
notifynotifyIncidentVtg
2-98
getUserGroupMembers
getUserRoles
2-118
joinLazyTalkgroup
2-95
getUserId
2-117
isActiveIncidentVtg
isActiveVtg
2-95
2-116
getVtgUserOptions
isActiveUser
2-94
2-115
2-116
isActiveChannel
2-93
2-114
getVtgsAssociatedToUser
getVtgsForIncident
2-90
getPolicyDetails
getUser
2-113
getVtgParticipantStatus
2-89
getPoliciesAssociatedToUser
getPolicy
2-113
getVtgParticipants
2-88
2-111
2-112
getVtgOptions
2-88
2-110
2-111
getVtgDetails
getPhotosForIncident
2-109
getVSOMCamerasAddedInIPICS
getVSOMs
2-86
2-87
getPhotoDetails
2-109
getVSOMCamerasForIncident
2-86
getPhonesAssociatedToUser
getPhoto
2-108
2-130
2-130
2-131
saveAssociatedCameraToIncident
savePmcProfile
2-132
2-132
searchAddressBook
2-133
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-6
OL-30494-01
Index
setBelongingOpsViewForUser
setDialPreference
setDigitId
getAllRadios function
2-134
getAllUserGroups function
2-134
getAllUsers function
2-135
setDigitPassword
setIncidentVtgUserOptions
setNotificationPreference
setUserAddress
setVtgOptions
getChannelDetails function
2-139
2-68
2-68
getChannelsForIncident function
2-141
getChannelsForVtg function
2-141
getChannelStatus function
2-142
getContacts function
2-143
talkgroup/join
getDigitId function
3-4
2-72
2-73
updateContact
2-144
getFavorite function
updateIncident
2-145
getGlobalMediaMap function
updatePhoto
updateUserGroup
updateVideo
getDigitPassword function
userdirectory
2-74
getIncidentDetails function
getIncident function
2-146
2-76
getIncidentVtg function
2-148
2-78
2-78
2-79
getIncidentVtgUserOptions function
3-13
getIpicsVersion function
getJournalDetails function
G
getJournal function
getAddressBookEntry function
getAddressBook function
getAllChannels function
2-60
getAllIncidentsWithIVtgStatus function
2-63
getLoggedInIDCUsers function
2-84
2-84
2-61
getMulticastAddressById function
2-62
getPhotoDetails function
getPhoto function
2-85
2-86
getPhonesAssociatedToUser function
2-62
getAllMulticastAddresses function
2-82
getMulticastAddressByAddress function
2-60
2-63
2-82
2-83
getLocationByName function
getAllChannelsInChannelGroup function
getAllLocations function
2-81
getLocationById function
2-59
getAllIncidents function
2-81
getLazyTalkgroupStatus function
2-58
2-79
2-80
getJournalsForIncident function
2-58
2-57
getAllChannelGroups function
getAllPolicies function
2-77
getIncidentVtgOptions function
3-8
2-75
2-76
getIncidentsForUser function
2-148
getAllPhotos function
2-75
getIncidentParticipants function
2-147
updateVirtualTalkGroup
uploaddata
2-73
getGlobalMediaMapVersion function
2-146
updatePrivateUser
2-69, 2-70
2-72
3-6
2-145
2-69
2-71
talkgroup/leave
updateLocation
2-67
getChannelsAssociatedToUser function
2-140
setVtgUserOptions
2-66
getChannel function
setUserListenerStatus
2-66
getBelongingOpsViewForUser function
2-138
2-139
setUserAudioStatus
StartSession
getAllVtgs function
2-137
2-65
2-65
getAllVideos function
2-136
setIncidentVtgOptions
2-64
2-86
2-88
2-87
getPhotosForIncident function
2-88
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-7
Index
getPmcProfile function
getVtgParticipantStatus function
2-89
getPoliciesAssociatedToUser function
getPolicyDetails function
getVtgsForIncident function
2-91
getPolicyExecutionStatus function
getPolicy function
2-92
getRadiosForIncident function
2-117
information
2-94
version
getUserDetails function
2-75
4-14
2-96
2-97
getUserDialPreference function
getUserDirectory function
2-75
GlobalMediaMapVO
2-96
getUserAudioStatus function
I
2-98
2-98
ID, system-generated
2-95
2-101
IDC
getUserGropu function
2-99
getUserGroupMembers function
getUserGroupsForVtg function
2-99
2-100
disabling audio
2-140, 2-141
enabling audio
2-140, 2-141
profile
2-101
information, saving
getUserListenerStatus function
2-101
getUserNotificationPreference function
retrieving
2-102
2-89
audio status
2-103
profile
2-96
2-89
getUsersAssociatedToPolicy function
2-104
IdcSessionContainerVO
getUsersAssociatedToRadio function
2-105
IdcSessonVO
getUsersForIncident function
getUsersForVtg function
getUserStatus function
2-105
activating
2-108
journal to
getVSOMCamera function
2-109
2-109
getVSOMCamerasForIncident function
video to
2-110
2-111
2-111
getVtgDetails function
getVtgOptions function
2-16
2-20, 2-21
VSOM camera to
creating
2-113
2-113
2-13
associating resource with
attributes, modifying
2-112
getVtgParticipants function
2-14
photograph to
getVSOMCamerasAddedInIPICS function
getVSOMs function
2-10
adding
2-107
getVideosForIncident function
2-84
incident
2-107
getVideoDetails function
4-15
4-15
IDC users, retrieving
2-106
2-132
retrieving
2-103
getUsersAssociatedToChannel function
getVideo function
2-118
retrieving
2-93
2-95
getUserAddress function
getUserRoles function
2-116
global media map
2-93
getRadiosForVtg function
2-115
2-116
getVtgUserOptions function
getRadiosAssociatedToUser function
getUserId function
getVtgsForVtg function
getVtgStatus function
2-91
2-90
getRadioDetails function
getUser function
getVtgsAssociatedToUser function
2-89
getPolicyExecutionStatusDetails function
2-114
2-24
2-145
2-28, 2-29
deactivating
2-36
detailed information, retrieving
2-76
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-8
OL-30494-01
Index
disassociating resource from
radios associated with
2-128
joinLazyTalkgroup function
retrieving
all
J
2-94
journal
2-60, 2-61
by search criterion
adding to incident
2-52
channels associated with
detailed information
participants
2-14
retrieving
2-70
all
2-76
2-82
detailed information
2-77
photographs associated with
resources
2-76
JournalDetailsContainerVO
users associated with
2-78
JournalDetailsVO
users associated with
IncidentContainerVO
JournalVO
2-11
2-119
dialing one member
2-28
deleting
2-38
all
2-43
LocationContainerVO
2-123
options
LocationVO
setting
2-83, 2-84
4-22
4-22
log, of API invocations
2-79
1-8
2-137
retrieving, options
2-78
M
user options
retrieving
setting
2-62
summary information, retrieving
2-119
notifying, users
2-79
MediaConnectionAddressVO
2-138
4-18
IncidentVtgUserOptionsVO
MediaConnectionVO
4-19
4-20
2-118
isActiveIncidentVtg function
isActiveVtg function
2-120
2-119
4-23
4-23
members
of incident VTG, dialing one
isActiveChannel function
isActiveUser function
4-22
MediaConnectionContainerVO
IncidentVtgOptionsVO
IntegerVO
creating
2-145
retrieving
2-36
retrieving
2-122
location
attributes, modifying
deactivating
inactive
4-21
leaveLazyTalkgroup function
4-17
incident VTG
active
4-20
L
4-16
4-18
activating
4-20
2-105
4-16
IncidentParticipantVO
IncidentVO
2-109
2-81
4-20
summary information
videos associated with
2-81
summary information
2-88
JournalContainerVO
2-77
IncidentDetailsVO
2-121
2-43
of VTG
dialing all
dialing one
2-42
2-44
2-120
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-9
Index
multicast address
retrieving
phone
associating with user
2-62
summary information
MulticastAddressVO
disassociating from user
2-85, 2-86
MulticastAddressContainerVO
2-22
retrieving
4-24
2-86
PhoneContainerVO
4-24
2-127
4-26
phone number
adding to Private Contacts list
N
2-27
deleting from Private Contacts list
ncidentParticipantContainerVO
PhoneVO
4-17
4-26
PhotoContainerVO
notification
incident VTG users
PhotoDetailsVO
2-123
retrieving
4-27
adding to incident
2-102
2-16
attributes, modifying
2-139
VTG users
creating
2-30
all
deleting
2-40
2-123
one
4-27
photograph
preferences
setting
2-38
detailed information, retrieving
2-124, 2-125
NotificationAddressContainerVO
NotificationAddressVO
2-146
retrieving
4-25
all
4-25
notification policy, executing
notifyAllVtgMembers function
notifyVtgMember function
by search criterion
2-122
2-123
notifynotifyIncidentVtg function
2-63
associated with incident
2-48
notifyAllIncidentVtgMembers function
2-88
2-124
2-88
2-52
summary information, retrieving
PhotoVO
2-87
4-29
policy
2-124
detailed information, retrieving
executing
O
2-91
2-49, 2-50
execution
detailed information, retrieving
ops view
assigning to user
summary information, retrieving
2-134
function execution, affect on
retrieving
2-1
P
2-63
associated with user
2-89
detailed information
2-91
summary information
users associated with
participant
removing from VTG
PolicyActionVO
2-130
retrieving all, for incident
2-90
summary information, retrieving
4-26
2-77
2-91
retrieving
all
2-67
PaginationContextVO
2-92
2-104
4-29
PolicyContainerVO
PolicyDetailsVO
2-90
4-30
4-30
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-10
OL-30494-01
Index
policy execution
removeVtgFromVtg function
retrieving
removeVtgParticipants function
detailed information
2-8, 2-92
summary information
2-91
status
Favorite Contacts list, entry from
reserveRadio function
PolicyExecutionStatusContainerVO
PolicyExecutionStatusVO
policy function
reserving, radio
4-31
2-131
2-125, 2-131
adding to VTG
2-15, 2-17
associating with incident
4-32
retrieving, for incident
ResourceContainerVO
R
radio
incident
3-1
incident
2-23
user
removing from VTG
2-60
2-70
2-69
VTG
2-128
2-71
by search criterion
2-125, 2-131
retrieving
2-51
detailed information
2-68
channel groups
2-64
associated with user
by search criterion
users associated with
RadioContainerVO
all
2-93
by search criterion
2-93
channel status
2-105
2-69
2-50
2-72
channel summary information
4-32
Cisco IPICS version
4-33
2-68
2-80
contact list
4-33
releaseRadio function
2-58
associated with VTG
2-53
detailed information
RadioDetailsVO
2-59
associated with
2-25
2-40
reserving
4-34
all in channel group
associating with user
RadioVO
REST-based
all
2-94
associating users with user
all
4-34
2-77
channel
2-95
deleting
ResourceVO
2-128
retrieving
2-16
associated with
VTG
2-24
disassociating from incident
4-32
adding to VTG
2-126
resource
4-31
3-3
PolicyTriggerVO
2-130
removing
2-91
PolicyVO
2-130
Private
2-125
removeChannelFromVtg function
removeFromFavorite function
removeRadioFromVtg function
digit ID
2-126
2-127
2-98
2-73
digit password
2-73
Favorite Contacts list, entries
2-128
removeResourceFromIncident function
removeUserFromVtg function
dial preferences
2-126
removePhoneAssociatedToUser function
2-57
2-128
Global Contact list, entries
2-74
2-58
2-129
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-11
Index
global media map
information
version
execution
detailed information
2-75
2-75
summary information
IDC
audio status
profile
incident
2-96
2-89
IDC users
2-90
Private Contact list entries
2-58
Private Contacts list
email address
2-72
2-61, 2-76
phone number
2-72
all, with incident VTG status
associated with user
by search criterion
resources
2-60
radio
2-78
all
2-52
2-77
incident
2-77
user
VTG
associated with incident
2-78
2-79
all associated with incident
detailed information
2-82
all
2-81
summary information
summary information
2-62
2-65
2-105
radio
2-105
VTG
2-106
by search criterion
2-62
2-97
direct connect number
2-98
notification preferences
phones associated with user
2-86
photograph
summary information
system-generated ID
2-63
2-102
2-8, 2-95
2-101
user group
associated with incident
2-88
2-52
detailed information
summary information
all
2-65
associated with VTG
2-88
by search criterion
2-87
policies associated with user
2-89
policy
members
2-100
2-54
2-99
summary information
user roles
2-63
detailed information
2-55
detailed information
2-85, 2-86
2-67
by search criterion
2-93
2-96
incident
2-82, 2-83, 2-84
multicast address, summary information
all
2-53
associated with
2-81
location
ops view
2-95
user
address
multicast address
2-93
detailed information
journal
location, all
2-94
by search criterion
2-79
user options
all
2-64
associated with
incident VTG
options
2-91
summary information
2-84
participants
2-92
2-99
2-103
users associated with
2-91
channel
2-103
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-12
OL-30494-01
Index
policy
2-104
setDialPreference function
user status
2-107
setDigitId function
video
2-135
setDigitPassword function
all
by search criterion
setNotificationPreference function
setUserAddress function
2-108
summary information
VSOM cameras
setVtgOptions function
associated with incident
VSOM cameras, detailed information
VSOM server, information
2-109
creating
VTG
associated with
user
VTG
starting session
2-143
2-143
4-35
2-112
T
2-113
status
talkgroup/join function
of options
user options
3-4
talkgroup/leave function
2-113, 2-117
of participants
2-101
2-56
names of participants
3-6
terminating, SIP connection
2-114
2-122
2-118
role, affect on function execution
2-1
U
S
saveAssociatedCameraToIncident function
savePmcProfile function
2-132
updateContact function
2-144
updateIncident function
2-145
updateLocation function
updatePhoto function
2-132
searchAddressBook function
2-145
2-146
updatePrivateUser function
2-133
updateUserGroup function
1-7
updateVideo function
session
SessionVO
2-122
system-generated ID, retrieving
2-116
detailed information
starting
terminating
StringVO
by search criterion
ending
2-121
StartSession function
2-115
2-142
SIP connection
2-111
2-66
2-141
2-141
setVtgUserOptions function
2-111
2-139
2-140
setUserListenerStatus function
2-110
2-138
2-139
setUserAudioStatus function
2-107
added in Cisco IPICS
2-137
setIncidentVtgUserOptions function
2-109
2-55
detailed information
all
2-136
setIncidentVtgOptions function
2-66
associated with incident
security
2-134
2-147
2-148
updateVirtualTalkGroup function
2-48
uploaddata function
2-143
2-148
3-8
user
4-34
setBelongingOpsViewForUser function
2-146
2-134
active
2-120
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-13
Index
adding
policy
physical address
to user group
to VTG
2-139
by search criterion
2-19
roles of
2-106
phone with
2-22
UserContainerVO
2-23
UserDetailsVO
2-25
2-25
2-98, 2-135
2-73
all
digit password
2-120
disabling
2-46
2-73
members
2-54
2-99
UserGroupContainerVO
2-127
UserGroupDetailsVO
UserGroupVO
2-141
2-102, 2-139
ops view
user roles, retrieving
UserRoleVO
2-134
user status, retrieving
retrieving
2-67
UserVO
removing from VTG
4-36
4-37
2-103
2-107
4-38
2-86
policies associated with
radios associated with
4-36
4-38
assigning
phones associated with
2-99
4-37
UserRoleContainerVO
notification preferences
2-89
2-93, 2-105
2-129
retrieving
V
value object
AddressBookUserContainerVO
address of user
all
2-100
summary information
2-47
muting
2-65
by search criterion
disassociating phone from
enabling
2-32
associated with VTG
2-136
disabled
2-147
retrieving
2-135
setting
2-19
attributes, modifying
creating
retrieving
3-13
user group
digit ID
setting
4-35
adding user to
dial preferences
2-115
4-35
userdirectory function
2-31
retrieving
2-141
VTGs associated with
2-22
with channel
creating
2-107
unmuting
channel with
2-8, 2-95
2-103
status of
associating
with radio
2-98
summary information
2-105
radio with
2-97
direct connect number
associated with
VTG
2-55
detailed information
2-19
incident
2-104
2-96
2-65
AddressBookUserDetailVO
AddressBookUserVO
associated with
AddressVO
4-6
channel
BooleanVO
4-7
2-103
4-4
4-5
4-6
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-14
OL-30494-01
Index
ChannelConnectionContainerVO
ChannelContainerVO
ChannelDetailVO
PhotoVO
4-8
ChannelGroupVO
PolicyTriggerVO
PolicyVO
4-13
RadioVO
4-14
IdcSessionContainerVO
StringVO
4-16
IncidentVtgOptionsVO
UserGroupVO
UserVO
4-20
LocationVO
VideoVO
MediaConnectionAddressVO
MediaConnectionVO
4-23
4-24
ncidentParticipantContainerVO
NotificationAddressContainerVO
PhoneContainerVO
4-26
4-25
4-26
4-26
4-39
4-40
VSOMCameraVO
VSOMVO
4-17
4-25
4-41
4-42
4-42
4-43
VtgContainerVO
4-24
NotificationAddressVO
4-38
VSOMContainerVO
4-23
MulticastAddressContainerVO
PaginationContextVO
4-38
VSOMCameraContainerVO
4-22
MediaConnectionContainerVO
4-37
4-38
VideoDetailsVO
4-22
4-22
MulticastAddressVO
4-37
VideoContainerVO
4-21
LocationContainerVO
PhoneVO
UserRoleVO
4-20
4-36
4-36
UserRoleContainerVO
4-20
JournalDetailsContainerVO
JournalVO
4-35
UserGroupDetailsVO
4-19
4-20
JournalContainerVO
4-35
UserGroupContainerVO
4-18
IncidentVtgUserOptionsVO
JournalDetailsVO
4-35
UserDetailsVO
4-18
IntegerVO
4-34
UserContainerVO
4-17
4-34
4-34
SessionVO
4-16
IncidentParticipantVO
4-33
4-33
ResourceVO
4-15
IncidentContainerVO
4-32
ResourceContainerVO
4-15
4-31
4-32
RadioDetailsVO
GlobalMediaMapVO
4-31
4-32
RadioContainerVO
4-14
4-14
IncidentVO
4-30
PolicyExecutionStatusVO
4-12
4-12
IncidentDetailsVO
4-30
PolicyExecutionStatusContainerVO
4-11
DialAddressContainerVO
IdcSessonVO
4-29
PolicyDetailsVO
ContactInfoContainerVO
ErrorVO
4-29
PolicyContainerVO
4-10
ClientDescriptorVO
DialAddressVO
4-27
4-27
PolicyActionVO
4-10
4-11
ContactInfoVO
PhotoContainerVO
PhotoDetailsVO
4-7, 4-8
ChannelGroupContainerVO
ChannelVO
4-7
4-43
VtgDetailContainerVO
VtgDetailVO
VtgOptionsVO
4-43
4-44
4-44
VtgParticipantContainerVO
VtgParticipantVO
VtgUserOptionsVO
4-45
4-45
4-46
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-15
Index
VtgVO
to VTG
4-47
video
2-21
user to
adding to incident
creating
2-32
deleting
2-40
VTG to
2-20, 2-21
attributes, modifying
all
2-148
2-66
user
2-115
VTG
2-108
retrieving
2-116
attributes, modifying
creating
2-66
associated with incident
by search criterion
VideoContainerVO
VideoDetailsVO
deleting
2-55
2-37
2-40, 2-41
detailed information, retrieving
2-107
2-112
dialing
4-38
4-39
4-40
all members
2-42
one member
2-44
virtual talk group
disabled
See VTG
notifying
VO
See value object
VSOM
2-120
all users
2-123
one user
2-124, 2-125
options
cameras
2-141, 2-142
participant
added in Cisco IPICS, retrieving
associated with incident, retrieving
detailed information about
2-110
2-111
2-109
VSOM camera
names
2-113
status
2-114
patch, creating
2-34
radios associated with
adding to incident
VSOMCameraVO
4-41
4-42
VSOMContainerVO
4-42
VSOM server
channel
2-111
2-130
participant
2-130
user
VTG
2-128
2-129
VTG
4-43
2-126
from VTG
radio
information, retrieving
2-95
removing
2-13
VSOMCameraContainerVO
VSOMVO
2-148
2-35
deactivating
2-109
summary information, retrieving
VideoVO
2-21
associated with
detailed information, retrieving
all
2-19
2-130
retrieving
activating
active
all
2-12
2-66
associated with user
2-120
adding
by search criterion
channel to
radio to
2-12
2-16
resource to
2-115
2-56
channel groups associated with
channels associated with
2-69
2-71
2-15, 2-17
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-16
OL-30494-01
Index
participants
in VTG
2-113
status
status
2-114
2-117
user groups associated with
2-8, 2-100
status
of options
2-117
retrieving
2-113
user options
2-118
users associated with
2-106
VTGs associated with
VtgContainerVO
4-43
VtgDetailContainerVO
VtgDetailVO
4-43
4-44
VtgOptionsVO
4-44
VtgParticipantContainerVO
VtgParticipantVO
4-45
4-45
VtgUserOptionsVO
VtgVO
2-116
4-46
4-47
W
web services session
ending
starting
2-48
2-143
X
XML schema, for REST-based API functions
3-1
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
OL-30494-01
IN-17
Index
Cisco IPICS API Reference Guide, Cisco IPICS Release 4.6
IN-18
OL-30494-01