Function Name and Reference
|
|
Functions for User Management |
addUserToUserGroup |
Adds a user to a user group |
associateChannelsToUser |
Associates one or more channels with a user |
associatePhonesToUser |
Associates one or more phones with a user |
associateRadiosToUser |
Associates one or more radios with a designated user |
createUser |
Creates a Cisco IPICS user |
createUserGroup |
Creates a user group |
deletePmcProfile |
Deletes IDC profile information for the designated user |
disableUser |
Disables a Cisco IPICS user |
enableUser |
Enables a Cisco IPICS user |
isActiveUser |
Determines if a user is active or disabled |
removePhoneAssociatedToUser |
Disassociates a phone from a user |
savePmcProfile |
Saves IDC profile information for the designated user |
setBelongingOpsViewForUser |
Assigns an ops view to a designated user |
setDialPreference |
Adds a new dial preference for a user |
setDigitId |
Sets digit IDs for a user |
setDigitPassword |
Sets a digit password for a user |
setNotificationPreference |
Adds a new notification preference for a user |
setUserAddress |
Adds a physical address for a user |
setUserAudioStatus |
Enables or disables the ability of a user to hear and transmit audio on a PMC |
setUserListenerStatus |
Enables or disables the ability of a user to transmit audio on a PMC |
updateUserGroup |
Modifies various attributes of a user group |
Functions for VTG Management |
activateVtg |
Activates a VTG (if it is not activated already) |
addChannelToVtg |
Adds a channel to an active or inactive VTG |
addRadioToVtg |
Adds a radio to an active or inactive VTG |
addParticipantsToVtg |
Adds any combination of resources (channel, radio, user, and VTG) to a VTG |
addResourcesToVtg |
Adds one or more resources of the same type (users, channels, radios, or VTGs) to a VTG |
addUserToVtg |
Adds a user to an active or inactive VTG |
addVtgParticipants |
Adds any combination of resources (channels, radios, users, and VTGs) to a VTG |
addVtgToVtg |
Add a VTG to another VTG |
createPatchVtg |
Creates a patch VTG with the designated name |
createVtg |
Creates a VTG with the designated name |
deactivateVtg |
Deactivates a VTG |
isActiveVtg |
Determines if a VTG is active or disabled |
removeChannelFromVtg |
Removes a channel from a VTG |
removeUserFromVtg |
Removes a user from a VTG |
removeRadioFromVtg |
Removes a radio from a VTG. |
removeVtgFromVtg |
Removes a VTG from a VTG |
setVtgOptions |
Sets various options for a VTG |
setVtgUserOptions |
Sets various options for a designated user in a VTG |
updateVirtualTalkGroup |
Modifies various attributes of a video |
Functions for Incident Management |
activateIncident |
Activates an incident (if it is not activated already) |
activateIncidentVtg |
Creates and activates an incident VTG for a designated incident |
addCameraToIncident |
Adds a VSOM camera to an incident |
addJournalToIncident |
Creates a journal entry and associates it with an incident |
addPhotoToIncident |
Adds the URL of a photograph to an incident and associates the photograph with the incident |
addVideoToIncident |
Creates the URL of a video to an incident and associates the video with the incident |
associateResourcesToIncident |
Associates one or more resources of the same type (users, channels, photographs, radios, videos, or VTGs) with an incident. |
createIncident |
Creates an incident |
createPhoto |
Adds the URL of a photograph to Cisco IPICS |
createVideo |
Adds the URL of a video to Cisco IPICS |
deactivateIncident |
Deactivates an incident |
deactivateIncidentVtg |
Deactivates an incident VTG |
isActiveIncidentVtg |
Determines if an incident VTG in a designated incident is active or inactive |
removeResourceFromIncident |
Disassociates one or more resource from an incident |
removeVtgParticipants |
Removes one or more participants from a VTG |
saveAssociatedCameraToIncident |
Associates the designated camera with the designated incident |
setIncidentVtgOptions |
Sets various options for an incident VTG |
setIncidentVtgUserOptions |
Sets various options for a designated user in an incident VTG |
updateIncident |
Modifies various attributes of an incident |
updatePhoto |
Modifies various attributes of a photograph |
updateVideo |
Modifies various attributes of a video |
Functions for Channel Management |
addMulticastChannelConnection |
Adds one or more multicast connections for the designated channel |
associateUsersToChannel |
Associates one or more users with a channel |
createChannel |
Creates a channel |
disableChannel |
Changes a channel to DISABLED state if the current channel state is IDLE |
enableChannel |
Changes a channel IDLE state if the current channel state is DISABLED |
isActiveChannel |
Determines if a channel is active or disabled |
Functions for Radio Management |
associateUsersToRadio |
Associates one or more users with a radio |
releaseRadio |
Releases a reserved serial controlled radio that has been reserved for a user |
reserveRadio |
Marks a serial controlled radio as reserved for a user |
Functions for Camera Management |
createCamera |
Adds a VSOM camera to Cisco IPICS |
Functions for Policy and Dial Function Management |
dialAllIncidentVtgMembers |
Dials out to all user who are members of an incident VTG |
dialAllVtgMembers |
Dials out to all users who are members of a VTG, including members of user groups that are part of the VTG |
dialIncidentVtgMember |
Dials out to the specified member of an incident VTG |
dialVtgMember |
Dials out to the specified member of a VTG |
executeNotificationPolicy |
Executes the notification policy that has the designated ID |
executePolicy |
Executes a designated policy |
executePolicyForUser |
Executes a designated policy for a designated user |
notifyAllIncidentVtgMembers |
Sends a notification to each user in the incident VTG of the designated incident |
notifyAllVtgMembers |
Sends a notification to each user in the incident VTG of the designated incident |
notifyIncidentVtgMember |
Notifies a designated member of an incident VTG |
notifyVtgMember |
Notifies a specific member of a VTG |
Functions for Location Management |
createLocation |
Adds a location to Cisco IPICS |
deleteLocation |
Deletes a location from Cisco IPICS |
updateLocation |
Modifies information about a location |
Functions for IDC Contact List Management |
addToFavorite |
Adds the designated entry from the Private Contacts list or the Global Contacts list on your IDC to the Favorite Contacts list on your IDC |
createContact |
Adds a phone number or email address to an existing entry in the Private Contacts list on your IDC |
createPrivateUser |
Adds an entry to the Private Contacts list on your IDC |
deleteContact |
Deletes a phone number or email address from an existing entry in the Private Contacts list on your IDC |
deletePrivateUser |
Deletes the designated entry from the Private Contacts list on your IDC |
removeFromFavorite |
Removes the designated entry from the favorite Contacts list on your IDC |
searchAddressBook |
Searches the designated contacts list on your IDC for an entry that contains the specified string |
updateContact |
Modifies a phone number or email address for an existing Private Contacts list entry on your IDC |
updatePrivateUser |
Modifies information for an existing entry in the Private Contacts list on your IDC |
Functions for Obtaining Information |
findChannelGroups |
Retrieves each channel group with a name that matches a designated search criterion |
findChannels |
Retrieves each channel with a name that matches a designated search criterion |
findIncidents |
Retrieves each incident with a name that matches a designated search criterion |
findPhotos |
Retrieves each photograph with a name that matches a designated search criterion |
findRadios |
Retrieves each radio with a name that matches a designated search criterion |
findUserGroups |
Retrieves each user group with a name that matches a designated search criterion |
findUsers |
Retrieves each user with a user name that matches a designated search criterion |
findVideos |
Retrieves each video with a name that matches a designated search criterion |
findVtgs |
Retrieves each VTG with a name that matches a designated search criterion |
getAddressBook |
Retrieves the list of entries from the Private Contacts list or the Global Contacts list on your IDC |
getAddressBookEntry |
Retrieves an entry from the Private Contacts list or the Global Contacts list on your IDC |
getAllChannelGroups |
Retrieves all channel groups that are associated with your Cisco IPICS ops view |
getAllChannels |
Retrieves all channels that are associated with your Cisco IPICS ops view |
getAllChannelsInChannelGroup |
Retrieves all channels that are in the designated channel group |
getAllIncidents |
Retrieves all incidents that are associated with your Cisco IPICS ops view |
getAllIncidentsWithIVtgStatus |
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 |
getAllLocations |
Retrieves all locations that are configured in Cisco IPICS |
getAllMulticastAddresses |
Retrieves all multicast addresses that are configured in Cisco IPICS |
getAllPhotos |
Retrieves all photographs that are associated with your Cisco IPICS ops view |
getAllPolicies |
Retrieves all policies that are associated with your Cisco IPICS ops view |
getAllRadios |
Retrieves all radios that are associated with your Cisco IPICS ops view |
getAllUserGroups |
Retrieves all user groups that are associated with your Cisco IPICS ops view |
getAllUsers |
Retrieves all Cisco IPICS users that are associated with your Cisco IPICS ops view |
getAllVideos |
Retrieves all videos that are associated with your Cisco IPICS ops view |
getAllVtgs |
Retrieves all VTGs that are associated with your Cisco IPICS ops view |
getBelongingOpsViewForUser |
Retrieves the ops view to which a designated user belongs |
getChannel |
Retrieves summary information about a designated channel |
getChannelDetails |
Retrieves detailed information about a designated channel |
getChannelGroupsForVtg |
Retrieves a list of channel groups s that are associated with a designated VTG. |
getChannelsAssociatedToUser |
Retrieves all channels that are associated with a user |
getChannelsForIncident |
Retrieves a list of channels that are associated with an incident |
getChannelsForVtg |
Retrieves a list of channels that are associated with a VTG |
getContacts |
Retrieves all phone numbers and email addresses from the designated entry in the Private Contacts list on your IDC |
getDigitId |
Retrieves the digit ID for a user |
getDigitPassword |
Retrieves the digit password for a user |
getFavorite |
Retrieves a list of entries in the Favorite Contacts list on your IDC |
getGlobalMediaMap |
Retrieves the current global media map and its version number and sends this information to the IDC |
getGlobalMediaMapVersion |
Retrieves the current global media map version number and sends this version information to the IDC |
getIncident |
Retrieves summary information about a designated incident |
getIncidentDetails |
Retrieves detailed information about a designated incident |
getIncidentParticipants |
Retrieves all resources (channels, journals, radios, photographs, users, videos, and VTGs) that are associated with an incident. |
getIncidentsForUser |
Retrieves a list of all incidents that are associated with a designated user. |
getIncidentVtg |
Retrieves information about the incident VTG that is associated with a designated incident |
getIncidentVtgOptions |
Retrieves VTG options for the incident VTG that is associated with a designated incident |
getIncidentVtgUserOptions |
Retrieves incident VTG options for an incident VTG user. |
getIpicsVersion |
Retrieves the version of Cisco IPICS that is running on active Cisco IPICS server |
getJournal |
Retrieves summary information about a designated journal |
getJournalDetails |
Retrieves summary information about a designated journal |
getJournalsForIncident |
Retrieves all journals for a designated incident |
getLazyTalkgroupStatus |
Retrieves the connection status of the designated channel |
getLocationById |
Retrieves summary information about the location with the designated ID |
getLocationByName |
Retrieves summary information about the location with the designated name |
getLoggedInIDCUsers |
Retrieves Cisco IPICS users who are logged in to an IDC that is in on-line mode |
getMulticastAddressByAddress |
Retrieves information about the multicast address with the designated IP address |
getMulticastAddressById |
Retrieves information about the multicast address with the designated multicast address identifier |
getPhonesAssociatedToUser |
Retrieves all phones that are associated with a designated user |
getPhoto |
Retrieves summary information about a photograph |
getPhotoDetails |
Retrieves detailed information about a photograph |
getPhotosForIncident |
Retrieves a list of photographs that are associated with a designated incident. |
getPmcProfile |
Retrieves IDC profile information for the designated user |
getPoliciesAssociatedToUser |
Retrieves all policies that are associated with a designated user |
getPolicy |
Retrieves summary information about a policy |
getPolicyDetails |
Retrieves detailed information about a policy |
getPolicyExecutionStatus |
Retrieves the status of the execution of a designated policy |
getPolicyExecutionStatusDetails |
Retrieves detailed status information about the execution of each policy that is associated with a designated user |
getRadioDetails |
Retrieve detailed information about a designated radio |
getRadiosAssociatedToUser |
Retrieves a list of radios that are associated with a designated user |
getRadiosForIncident |
Retrieves a list of radios that are associated with a designated incident. |
getRadiosForVtg |
Retrieves a list of radios that are associated with a designated VTG. |
getUser |
Retrieves summary information about the designated user |
getUserAddress |
Retrieves the physical address of a designated user |
getUserAudioStatus |
Retrieves a flag that indicates if the PMC of a user has audio disabled or enabled |
getUserDetails |
Retrieves detailed information about a designated user |
getUserDialPreference |
Retrieves the dial preference that is associated with a designated user |
getUserDirectory |
Retrieves the users for whom a direct connect number is assigned in the designated serial radio descriptor file |
getUserGroup |
Retrieves summary information about the designated user group |
getUserGroupMembers |
Retrieves all the users in a designated user group |
getUserGroupsForVtg |
Retrieves user groups that are associated with a designated VTG |
getUserId |
Retrieves the system-generated user ID for the designated user |
getUserListenerStatus |
Retrieves a flag that indicates whether the PMC of a user is in listen-only mode |
getUserNotificationPreference |
Retrieves the notification preference that is associated with a designated user |
getUserRoles |
Retrieves the list of roles for a designated user |
getUsersAssociatedToChannel |
Return a list of users that are associated with a designated channel |
getUsersAssociatedToPolicy |
Return a list of users that are associated with a designated policy |
getUsersAssociatedToRadio |
Return a list of users that are associated with a designated radio |
getUsersForIncident |
Retrieves a list of users that are associated with a designated incident |
getUsersForVtg |
Retrieves a list of users that are associated with a designated VTG |
getUserStatus |
Retrieves the active status of one or more users |
getVideo |
Retrieves summary information about the designated video |
getVideoDetails |
Retrieves detailed information about the designated video |
getVideosForIncident |
Retrieves a list of videos that are associated with a designated incident |
getVSOMCamera |
Retrieves detailed information about the designated VSOM camera |
getVSOMCamerasAddedInIPICS |
Retrieves each VSOM camera that has been added in Cisco IPICS and that have a name that matches a designated search criterion |
getVSOMCamerasForIncident |
Retrieves each VSOM camera that is associated with a designated incident and that has a name that matches a designated search criterion |
getVSOMs |
Retrieves information about VSOM servers that have been added in Cisco IPICS |
getVtgDetails |
Retrieves detailed information about the designated VTG |
getVtgOptions |
Retrieves information about the status of a variety of options for a VTG |
getVtgParticipants |
Retrieves all participants in a VTG |
getVtgParticipantStatus |
Retrieves the status of VTG participant |
getVtgsAssociatedToUser |
Retrieves all VTGs that are associated with a user |
getVtgsForIncident |
Retrieves a list of VTGs that are associated with a designated incident |
getVtgsForVtg |
Retrieves a list of VTGs that are associated with a designated VTG. |
getVtgStatus |
Retrieves the ID, name, description, and status of a VTG |
getVtgUserOptions |
Retrieves the settings of the latch, listen only, and rxmute VTG options settings for a designated VTG and user |
Functions for General Operations |
createMulticastAddresses |
Adds one or a series of sequential multicast addresses to Cisco IPICS |
deleteResources |
Deletes designated resources |
endSession |
Ends a web services session |
joinLazyTalkgroup |
Creates a SIP connection between the designated client and the designated resource |
leaveLazyTalkgroup |
Terminates the SIP connection between the designated client and the designated resource |
startSession |
Starts a web services session |