Cisco IPICS API Reference Guide, Release 4.0
Index
Downloads: This chapterpdf (PDF - 512.0KB) The complete bookPDF (PDF - 6.21MB) | Feedback

Index

Table Of Contents

A - B - C - D - E - F - G - I - J - L - M - N - O - P - R - S - U - V - W -

Index

A

activateIncident function 2-8

activateIncidentVtg function 2-9

activateVtg function 2-9

activating

incident 2-8

incident VTG 2-9

VTG 2-9

addChannelToVtg function 2-10

adding

channel to VTG 2-10

journal to incident 2-11

photograph to incident 2-12

radio to VTG 2-13

resource to VTG 2-11, 2-13

user

to user group 2-14

to VTG 2-15

video to incident 2-15, 2-16

VTG to VTG 2-17

addJournalToIncident function 2-11

addParticipantsToVtg function 2-11

addPhotoToIncident function 2-12

addRadioToVtg function 2-13

addResourcesToVtg function 2-13

AddressVO 3-4

addUserToUserGroup function 2-14

addUserToVtg function 2-14

addVideoToIncident function 2-15, 2-16

addVtgToVtg function 2-17

API

authentication 1-7

description 1-1

function

list of, See function

overview 2-8

summary 2-2

logging 1-8

security 1-7

value object

list of, See value object

summary 3-1

application programming interface

See API

associateChannelsToUser function 2-17

associatePhonesToUser function 2-18

associateRadiosToUser function 2-18

associateResourcesToIncident function 2-19

audio

disabling on IDC 2-108, 2-109

enabling on IDC 2-108, 2-109

authentication 1-7

B

BooleanVO 3-4

C

channel

active 2-91

adding to VTG 2-10

associated with

incident 2-55

user 2-54

VTG 2-55

associating with user 2-17

creating 2-20

deleting 2-28

disabling 2-33

enabling 2-35

removing from VTG 2-96

retrieving

all 2-45

all in channel group 2-45

associated with

incident     1

user     1

VTG     1

by search criterion 2-38

detailed information 2-53

status 2-56

summary information 2-52

status 2-91

ChannelContainerVO 3-5

ChannelDetailVO 3-5

channel group

associated with VTG 2-53

retrieving

all 2-44

associated with VTG 2-53

by search criterion 2-38

channels in 2-45

ChannelGroupContainerVO 3-7

ChannelGroupVO 3-7

ChannelVO 3-7

Cisco IPICS

application programming interface

See API

Dispatch Console profile, deleting 2-28

role, affect on function execution 2-1

version, retrieving 2-62

ClientDescriptorVO 3-8

client stub

generating 1-2

overview 1-1

createChannel function 2-20

createIncident function 2-21

createPhoto function 2-21

createUser function 2-22, 2-23

createVideo function 2-23

createVtg function 2-24

creating

channel 2-20

incident 2-21

photograph 2-21

user 2-22

user group 2-23

video 2-24

VTG 2-25

D

deactivateIncident function 2-26

deactivateIncidentVtg function 2-26

deactivateVtg function 2-27

deactivating

incident 2-26

incident VTG 2-26

VTG 2-27

deletePmcProfile function 2-28

deleterResources function 2-28

deleting

channel 2-28

Cisco IPICS Dispatch Console profile 2-28

photograph 2-28

radio 2-28

video 2-28

VTG 2-28, 2-29

developer workstation 1-1

DialAddressContainerVO 3-8

DialAddressVO 3-9

dialAllIncidentVtgMembers function 2-29

dialAllVtgMembers function 2-30

dialIncidentVtgMember function 2-31

dialing

incident VTG members 2-31

VTG members

all 2-30

one 2-32

dial preferences

retrieving for user 2-75

setting 2-102

dialVtgMember function 2-32

digit ID

retrieving 2-56

setting 2-103

digit password

retrieving 2-57

setting 2-104

disableChannel function 2-33

disableUser function 2-34

disabling

channel 2-33

user 2-34

E

Eclipse IDE

configuring 1-2

obtaining 1-2

enableChannel function 2-35

enableUser function 2-35

enabling

channel 2-35

user 2-35

ending, web services session 2-36

endSession function 2-36

ErrorVO 3-9

executeNotificationPolicy function 2-36

executePolicy function 2-37

executing

API client code 1-3

notification policy 2-36

policy 2-37

F

findChannelGroups function 2-38, 2-41

findChannels function 2-39

findIncidents function 2-38

findPhotos function 2-40

findRadios function 2-41

findUsers function 2-42

findVideos function 2-43, 2-44

function

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, 2-16

addVtgToVtg 2-17

associateChannelsToUser 2-17

associatePhonesToUser 2-18

associateRadiosToUser 2-18

associateResourcesToIncident 2-19

createChannel 2-20

createIncident 2-21

createPhoto 2-21

createUser 2-22, 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, 2-41

findChannels 2-39

findIncidents 2-38

findPhotos 2-40

findRadios 2-41

findUsers 2-42

findVideos 2-43, 2-44

getAllChannelGroups 2-44

getAllChannels 2-45

getAllChannelsInChannelGroup 2-45

getAllIncidents 2-46

getAllIncidentsWithIVtgStatus 2-47

getAllPhotos 2-47

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

getChannelsAssociatedToUser 2-54

getChannelsForIncident 2-53, 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

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

notifynotifyIncidentVtg 2-95

notifyVtgMember 2-96

removeChannelFromVtg 2-96

removePhoneAssociatedToUser 2-97

removeRadioFromVtg 2-98

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

uploadData

examples4-4to 4-6

overview 4-1

parameters 4-2

return result 4-4

URL 4-1

using 4-1

G

getAllChannelGroups function 2-44

getAllChannels function 2-45

getAllChannelsInChannelGroup function 2-45

getAllIncidents function 2-46

getAllIncidentsWithIVtgStatus function 2-47

getAllPhotos function 2-47

getAllPolicies function 2-48

getAllRadios function 2-48

getAllUserGroups function 2-49

getAllUsers function 2-50

getAllVideos function 2-50

getAllVtgs function 2-51

getBelongingOpsViewForUser function 2-51

getChannelDetails function 2-53

getChannel function 2-52

getChannelsAssociatedToUser function 2-54

getChannelsForIncident function 2-53, 2-55

getChannelsForVtg function 2-55

getChannelStatus function 2-56

getDigitId function 2-56

getDigitPassword function 2-57

getIncidentDetails function 2-58

getIncident function 2-58

getIncidentParticipants function 2-59

getIncidentsForUser function 2-59

getIncidentVtg function 2-60

getIncidentVtgOptions function 2-61

getIncidentVtgUserOptions function 2-61

getIpicsVersion function 2-62

getJournalDetails function 2-63

getJournal function 2-63

getJournalsForIncident function 2-64

getPhonesAssociatedToUser function 2-64

getPhotoDetails function 2-66

getPhoto function 2-65

getPhotosForIncident function 2-66

getPmcProfile function 2-67

getPoliciesAssociatedToUser function 2-67

getPolicyDetails function 2-69

getPolicyExecutionStatusDetails function 2-70

getPolicyExecutionStatus function 2-69

getPolicy function 2-68

getRadiosAssociatedToUser function 2-71

getRadiosForIncident function 2-71

getRadiosForVtg function 2-72

getUserAddress function 2-73

getUserAudioStatus function 2-74

getUserDetails function 2-74

getUserDialPreference function 2-75

getUserDirectory function 2-75

getUser function 2-72

getUserGropu function 2-76

getUserGroupMembers function 2-77

getUserGroupsForVtg function 2-77

getUserId function 2-78

getUserListenerStatus function 2-78

getUserNotificationPreference function 2-79

getUserRoles function 2-80

getUsersAssociatedToRadio function 2-81

getUsersForIncident function 2-81

getUsersForVtg function 2-82

getUserStatus function 2-83

getVideoDetails function 2-84

getVideo function 2-83

getVideosForIncident function 2-84

getVtgDetails function 2-85

getVtgOptions function 2-86

getVtgParticipants function 2-86

getVtgParticipantStatus function 2-87

getVtgsAssociatedToUser function 2-88

getVtgsForIncident function 2-89

getVtgsForVtg function 2-89

getVtgStatus function 2-90

getVtgUserOptions function 2-91

I

ID, system-generated 2-78

IDC

disabling audio 2-108, 2-109

enabling audio 2-108, 2-109

profile

information, saving 2-101

retrieving 2-67

retrieving

audio status 2-74

profile 2-67

incident

activating 2-8

adding

journal to 2-11

photograph to 2-12

video to 2-15, 2-16

associating resource with 2-19

attributes, modifying 2-112

creating 2-21

deactivating 2-26

detailed information, retrieving 2-58

disassociating resource from 2-98

radios associated with 2-71

retrieving

all 2-46, 2-47

by search criterion 2-39

channels associated with 2-55

detailed information 2-58

participants 2-59

photographs associated with 2-66

resources 2-59

summary information 2-58

users associated with 2-60

videos associated with 2-84

users associated with 2-81

IncidentContainerVO 3-10

IncidentDetailsVO 3-10

IncidentParticipantVO 3-11

IncidentVO 3-12

incident VTG

activating 2-9

active 2-92

deactivating 2-26

dialing one member 2-31

inactive 2-92

notifying, users 2-94

options

retrieving 2-61

setting 2-105

retrieving, options 2-60

user options

retrieving 2-61

setting 2-106

IncidentVtgOptionsVO 3-12

IncidentVtgUserOptionsVO 3-13

IntegerVO 3-13

isActiveChannel function 2-91

isActiveIncidentVtg function 2-92

isActiveUser function 2-93

isActiveVtg function 2-93

J

journal

adding to incident 2-11

retrieving

all 2-64

detailed information 2-63

summary information 2-63

JournalContainerVO 3-14

JournalDetailsContainerVO 3-14

JournalDetailsVO 3-14

JournalVO 3-15

L

log, of API invocations 1-8

M

members

of incident VTG, dialing one 2-31

of VTG

dialing all 2-30

dialing one 2-32

N

ncidentParticipantContainerVO 3-11

notification

incident VTG users 2-94

preferences

retrieving 2-79

setting 2-107

VTG users

all 2-94

one 2-95, 2-96

NotificationAddressContainerVO 3-16

NotificationAddressVO 3-16

notification policy, executing 2-36

notifyAllIncidentVtgMembers function 2-94

notifyAllVtgMembers function 2-94

notifynotifyIncidentVtg function 2-95

notifyVtgMember function 2-96

O

ops view

assigning to user 2-102

function execution, affect on 2-1

retrieving 2-51

P

PaginationContextVO 3-16

participant

removing from VTG 2-100

retrieving all, for incident 2-59

phone

associating with user 2-18

disassociating from user 2-97

retrieving 2-64

PhoneContainerVO 3-17

PhoneVO 3-17

PhotoContainerVO 3-18

PhotoDetailsVO 3-18

photograph

adding to incident 2-12

attributes, modifying 2-113

creating 2-21

deleting 2-28

detailed information, retrieving 2-66

retrieving

all 2-47

associated with incident 2-66

by search criterion 2-40

summary information, retrieving 2-65

PhotoVO 3-19

policy

detailed information, retrieving 2-69

executing 2-37

execution

detailed information, retrieving 2-70

summary information, retrieving 2-69

retrieving

all 2-48

associated with user 2-67

detailed information 2-69

summary information 2-68

summary information, retrieving 2-68

PolicyActionVO 3-20

PolicyContainerVO 3-21

PolicyDetailsVO 3-21

policy execution

retrieving

detailed information 2-6, 2-70

summary information 2-69

status 2-69

PolicyExecutionStatusContainerVO 3-22

PolicyExecutionStatusVO 3-22

PolicyTriggerVO 3-22

PolicyVO 3-23

R

radio

adding to VTG 2-13

associated with

incident 2-71

VTG 2-72

associating with user 2-19

deleting 2-28

removing from VTG 2-98

retrieving

all 2-48

associated with user 2-71

by search criterion 2-41

users associated with 2-81

RadioContainerVO 3-23

RadioDetailsVO 3-23

RadioVO 3-24

removeChannelFromVtg function 2-96

removePhoneAssociatedToUser function 2-97

removeRadioFromVtg function 2-98

removeResourceFromIncident function 2-98

removeUserFromVtg function 2-99

removeVtgFromVtg function 2-100

removeVtgParticipants function 2-100

resource

adding to VTG 2-11, 2-13

associating with incident 2-19

disassociating from incident 2-98

retrieving, for incident 2-59

ResourceContainerVO 3-24

ResourceVO 3-25

retrieving

channel

all 2-45

all in channel group 2-45

associated with

incident     1

user     1

VTG     1

by search criterion 2-38

detailed information 2-53

channel groups

all 2-44

associated with VTG 2-53

by search criterion 2-38

channel status 2-56

channel summary information 2-52

Cisco IPICS version 2-62

dial preferences 2-75

digit ID 2-56

digit password 2-57

IDC

audio status 2-74

profile 2-67

incident 2-47, 2-58

all, with incident VTG status 2-46

associated with user 2-60

by search criterion 2-39

participants 2-59

resources 2-59

incident VTG

associated with incident 2-60

options 2-61

user options 2-61

journal

all associated with incident 2-64

detailed information 2-63

summary information 2-63

ops view 2-51

phones associated with user 2-64

photograph

all 2-47

associated with incident 2-66

by search criterion 2-40

detailed information 2-66

summary information 2-65

policies associated with user 2-67

policy

all 2-48

detailed information 2-69

execution

detailed information     1

summary information     1

summary information 2-68

radio

all 2-48

associated with

incident     1

user     1

VTG     1

by search criterion 2-41

user

address 2-73

all 2-50

associated with

incident     1

radio     1

VTG     1

by search criterion 2-42

detailed information 2-74

direct connect number 2-75

notification preferences 2-79

summary information 2-6, 2-73

system-generated ID 2-78

user group

all 2-49

associated with VTG 2-77

by search criterion 2-41

members 2-77

summary information 2-76

user roles 2-80

user status 2-83

video

all 2-50

associated with incident 2-84

by search criterion 2-43

detailed information 2-84

summary information 2-83

VTG

all 2-51

associated with

user     1

VTG     1

by search criterion 2-44

detailed information 2-85

names of participants 2-86

status

of options     1, 2

of participants     1

user options 2-91

role, affect on function execution 2-1

S

savePmcProfile function 2-101

security 1-7

session

ending 2-36

starting 2-111

SessionVO 3-25

setBelongingOpsViewForUser function 2-102

setDialPreference function 2-102

setDigitId function 2-103

setDigitPassword function 2-104

setIncidentVtgOptions function 2-105

setIncidentVtgUserOptions function 2-106

setNotificationPreference function 2-107

setUserAddress function 2-107

setUserAudioStatus function 2-108

setUserListenerStatus function 2-109

setVtgOptions function 2-109

setVtgUserOptions function 2-110

starting session 2-111

StartSession function 2-111

StringVO 3-25

system-generated ID, retrieving 2-78

U

updateIncident function 2-112

updatePhoto function 2-113

updateUserGroup function 2-113

updateVideo function 2-114

updateVirtualTalkGroup function 2-114

uploadData function

examples 4-4, 4-6

overview 4-1

parameters 4-2

return result 4-4

URL 4-1

using 4-1

XML schema 4-1

user

active 2-93

adding

physical address 2-107

to user group 2-14

to VTG 2-15

associated with

incident 2-81

VTG 2-82

associating

channel with 2-17

phone with 2-18

radio with 2-19

creating 2-22

dial preferences 2-75, 2-102

digit ID

retrieving 2-56

setting 2-103

digit password

retrieving 2-57

setting 2-104

disabled 2-93

disabling 2-34

disassociating phone from 2-97

enabling 2-35

muting 2-109

notification preferences 2-79, 2-107

ops view

assigning 2-102

retrieving 2-51

phones associated with 2-64

policies associated with 2-67

radios associated with 2-71, 2-81

removing from VTG 2-99

retrieving

address of user 2-73

all 2-50

by search criterion 2-42

detailed information 2-74

direct connect number 2-75

summary information 2-6, 2-73

roles of 2-80

status of 2-83

unmuting 2-109

VTGs associated with 2-88

UserContainerVO 3-26

UserDetailsVO 3-26

user group

adding user to 2-14

attributes, modifying 2-113

creating 2-23

retrieving

all 2-49

associated with VTG 2-77

by search criterion 2-41

members 2-77

summary information 2-76

UserGroupContainerVO 3-27

UserGroupDetailsVO 3-27

UserGroupVO 3-27

UserRoleContainerVO 3-28

user roles, retrieving 2-80

UserRoleVO 3-28

user status, retrieving 2-83

UserVO 3-28

V

value object

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

IncidentDetailsVO 3-10

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

ncidentParticipantContainerVO 3-11

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

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

video

adding to incident 2-15, 2-16

attributes, modifying 2-114

creating 2-24

deleting 2-28

detailed information, retrieving 2-84

retrieving

all 2-50

associated with incident 2-84

by search criterion 2-43

summary information, retrieving 2-83

VideoContainerVO 3-29

VideoDetailsVO 3-29

VideoVO 3-31

virtual talk group

See VTG

VO

See value object

VTG

activating 2-9

active 2-93

adding

channel to 2-10

radio to 2-13

resource to 2-11, 2-13

to VTG 2-17

user to 2-15

VTG to 2-17

all 2-51

associated with

user 2-88

VTG 2-89

attributes, modifying 2-114

creating 2-25

deactivating 2-27

deleting 2-28, 2-29

detailed information, retrieving 2-85

dialing

all members 2-30

one member 2-32

disabled 2-93

notifying

all users 2-94

one user 2-95, 2-96

options 2-109, 2-110

participant

names 2-86

status 2-87

radios associated with 2-72

removing

channel 2-96

from VTG 2-100

participant 2-100

radio 2-98

user 2-99

VTG 2-100

retrieving

all 2-51

associated with user 2-88

by search criterion 2-44

channel groups associated with 2-53

channels associated with 2-55

participants

in VTG     1

status     1

status 2-90

user groups associated with 2-7, 2-77

status

of options 2-90

retrieving 2-86

user options 2-91

users associated with 2-82

VTGs associated with 2-89

VtgContainerVO 3-32

VtgDetailContainerVO 3-32

VtgDetailVO 3-32

VtgOptionsVO 3-33

VtgParticipantContainerVO 3-34

VtgParticipantVO 3-34

VtgUserOptionsVO 3-35

VtgVO 3-36

W

web services session

ending 2-36

starting 2-111