PDF - This Chapter (556.0 KB)

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