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
© Copyright 2024 Paperzz