Cisco IPIC
OL-27164-02
C H A P T E R 1
Value ObjectsThis chapter provide detailed descriptions of each value object (VO) that is used by the Cisco IPICS web services API functions. It includes these topics:
• Value Objects Overview, page 1-1
• Value Objects Descriptions, page 1-4
Value Objects OverviewThe Cisco IPICS web services API functions that are explained in Chapter 1, “Web Services API Functions,” use value objects to describe characteristics of various items and to store information. In addition, some value objects contain other value objects.
Table 1-1 provides a summary of the Cisco IPICS web services API VOs. Each VO is described in detail in the section that is referenced.
Table 1-1 API Value Object Summary
Value Name and Reference Description
AddressVO, page 1-4 Contains information about the address of a user
BooleanVO, page 1-5 Contains a boolean value that a function returns
ChannelConnectionContainerVO, page 1-5
Contains an array of information about one or more channel connections
ChannelContainerVO, page 1-6 Contains an array of summary information about 1 or more channels
ChannelDetailVO, page 1-6 Contains detailed information about a channel
ChannelGroupContainerVO, page 1-8 Contains an array of summary information about 1 or more channel groups
ChannelGroupVO, page 1-8 Contains summary information about a channel group
ChannelVO, page 1-9 Contains summary information about a channel
ClientDescriptorVO, page 1-9 Contains information about the type of client that connects to a web services session
DialAddressContainerVO, page 1-10 Contains an array of information about 1 or more dial preferences
DialAddressVO, page 1-10 Contains summary information about a dial number
1-1S API Reference Guide, Cisco IPICS Release 4.5
Chapter 1 Value ObjectsValue Objects Overview
ErrorVO, page 1-11 Contains an error code and error message, if returned by a function
IdcSessionContainerVO, page 1-11 Contains an array of information about one or more IDC sessions
IdcSessionVO, page 1-12 Contains information about an IDC session
IncidentContainerVO, page 1-12 Contains an array of summary information about 1 or more incidents
IncidentDetailsVO, page 1-13 Contains detailed information about an incident
IncidentParticipantContainerVO, page 1-13
Contains an array of information about 1 or more incident participants
IncidentParticipantVO, page 1-14 Contains summary information about an incident participant
IncidentVO, page 1-14 Contains summary information about an incident
IncidentVtgOptionsVO, page 1-15 Contains summary information about an incident VTG
IncidentVtgUserOptionsVO, page 1-16 Contains summary information about a user in an incident VTG
IntegerVO, page 1-16 Contains an integer value
JournalContainerVO, page 1-16 Contains an array of summary information about 1 or more journals
JournalDetailsContainerVO, page 1-17 Contains an array of detailed information about 1 or more journals
JournalDetailsVO, page 1-17 Contains detailed information about a journal
JournalVO, page 1-18 Contains summary information about a journal
LocationContainerVO, page 1-18 Contains an array of information about one or more locations
LocationVO, page 1-18 Contains information about a location
MediaConnectionAddressVO, page 1-19 Contains information about a media connection
MediaConnectionContainerVO, page 1-19
Contains an array of information about one or more media connections
MediaConnectionVO, page 1-20 Contains SIP connection information about a designated resource
MulticastAddressContainerVO, page 1-20
Contains an array of information about one or more media connections
MulticastAddressVO, page 1-21 Contains information about a multicast address
NotificationAddressContainerVO, page 1-21
Contains an array of information about 1 or more notification addresses
NotificationAddressVO, page 1-21 Contains information about a notification address
PaginationContextVO, page 1-22 Contains attributes that designate the format and limits of the output of a function
Table 1-1 API Value Object Summary (continued)
Value Name and Reference Description
1-2Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Overview
PhoneContainerVO, page 1-22 Contains an array of information about 1 or more direct dial phones
PhoneVO, page 1-23 Contains summary information about a direct dial phone
PhotoContainerVO, page 1-23 Contains an array of information about 1 or more photographs
PhotoDetailsVO, page 1-24 Contains detailed information about a photograph that has been added to Cisco IPICS
PhotoVO, page 1-25 Contains summary information about a photograph that has been added to Cisco IPICS
PolicyActionVO, page 1-25 Contains information about a policy action
PolicyContainerVO, page 1-26 Contains an array of information about 1 or more policies
PolicyDetailsVO, page 1-26 Contains detailed information about a policy
PolicyExecutionStatusContainerVO, page 1-27
Contains an array of information about the execution of 1 or more policies
PolicyExecutionStatusVO, page 1-27 Contains information about the execution of a policy
PolicyTriggerVO, page 1-28 Contains information about a policy trigger
PolicyVO, page 1-28 Contains summary information about a policy
RadioContainerVO, page 1-29 Contains an array of information about 1 or more radios
RadioDetailsVO, page 1-29 Contains detailed information about a radio
RadioVO, page 1-29 Contains summary information about a radio
ResourceContainerVO, page 1-30 Contains an array of information about 1 or more resources
ResourceVO, page 1-30 Contains information about a resource
SessionVO, page 1-31 Contains a web services session ID
StringVO, page 1-31 Contains a string
UserContainerVO, page 1-31 Contains an array of information about 1 or more users
UserDetailsVO, page 1-31 Contains detailed information about a user
UserGroupContainerVO, page 1-32 Contains an array of information about 1 or more user groups
UserGroupDetailsVO, page 1-32 Contains detailed information about a user group
UserGroupVO, page 1-33 Contains summary information about a user group
UserRoleContainerVO, page 1-33 Contains an array of information about 1 or more Cisco IPICS user roles
UserRoleVO, page 1-34 Contains information about a Cisco IPICS user role
UserVO, page 1-34 Contains summary information about a user
VideoContainerVO, page 1-34 Contains an array of information about 1 or more videos
VideoDetailsVO, page 1-35 Contains detailed information about a video that has been added to Cisco IPICS
VideoVO, page 1-36 Contains summary information about a video that has been added to Cisco IPICS
Table 1-1 API Value Object Summary (continued)
Value Name and Reference Description
1-3Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
Value Objects DescriptionsThe following sections describe each Cisco IPICS API VO in detail. The tables in these sections provide this information:
• Attribute name—Name of a VO attribute
• Type—Type of VO attribute
• Description—Description of the VO attribute
AddressVO
The AddressVO value object contains information about the address of a Cisco IPICS user.
Table 1-2 describes the attributes of this value object.
VtgContainerVO, page 1-37 Contains an array of summary information about 1 or more VTGs
VtgDetailContainerVO, page 1-38 Contains an array of detailed information about 1 or more VTGs
VtgDetailVO, page 1-38 Contains detailed information about a VTG
VtgOptionsVO, page 1-38 Contains information about options that are configured for a VTG
VtgParticipantContainerVO, page 1-39 Contains an array of information about participants in a VTG
VtgParticipantVO, page 1-40 Contains information about a VTG participant
VtgUserOptionsVO, page 1-40 Contains information about user options that are configured for a VTG
VtgVO, page 1-41 Contains summary information about a VTG
Table 1-1 API Value Object Summary (continued)
Value Name and Reference Description
Table 1-2 AddressVO Attributes
Attribute Name Type Description
city String Contains the name of the address city.
country String Contains the name of the address country.
elevation float Not used.
elevationUnits String Not used.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the address. Cisco IPICS generates this ID when you add the address to Cisco IPICS.
latitude float Not used.
1-4Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
BooleanVO
The BooleanVO value object contains a boolean value that a function returns.
Table 1-3 describes the attributes of this value object.
ChannelConnectionContainerVO
The ChannelConnectionContainerVO value object contains an array of information about one or more channel connections.
Table 1-4 describes the attributes of this value object.
ChannelConnectionVO
The ChannelConnectionVO value object contains information about a channel connection.
Table 1-5 describes the attributes of this value object.
longitude float Not used.
state String Contains the name of the address state.
street String Contains the name of the address street.
streetExtra String Store addition information related to street, such as an apartment number.
zip String Contains the address ZIP code.
Table 1-2 AddressVO Attributes (continued)
Table 1-3 BooleanVO Attributes
Attribute Name Type Description
value boolean Contains the boolean value that a function returns
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
Table 1-4 ChannelConnectionContainerVO Attributes
Attribute Name Type Description
channelConnectionVOs ChannelConnectionVO[] Contains an array of ChannelConnectionVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-5Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
ChannelContainerVO
The ChannelContainerVO value object contains an array of summary information about one or more channels.
Table 1-6 describes the attributes of this value object.
ChannelDetailVO
The ChannelDetailVO value object contains detailed information about a channel.
Table 1-7 describes the attributes of this value object.
Table 1-5 ChannelConnectionVO Attributes
Attribute Name Type Description
channelId int Contains the unique ID of the channel. Cisco IPICS generated this ID when the channel was created in Cisco IPICS
connectionId int Contains the unique ID of the channel connection. Cisco IPICS generated this ID when the channel connection was created in Cisco IPICS
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
codec String Contains codec info about the channel connection
locationId int Contains location info about the channel connection.
multicastAddress String Contains the multicast IP address of the channel connection.
Port int Contains port information about the channel connection.
Table 1-6 ChannelContainerVO Attributes
Attribute Name Type Description
channelVOs ChannelVO[] Contains an array of ChannelVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-7 ChannelDetailVO Attributes
Attribute Name Type Description
codec String Contains codec information about the channel.
colorization String Contains the color of the channel that appears in the IDC.
1-6Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
conType String Contains the channel connection type.
Desc String Contains a description of the channel.
dialedNumber String Not used.
disable boolean Indicates whether a channel is disabled (true) or enabled (false).
duplex String Indicates whether channel is full duplex or half duplex.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the channel. Cisco IPICS generated this ID when the channel was created in Cisco IPICS.
latchable boolean Indicates whether the channel is latchable (true means yes and false means no).
lmrg_delay_time int Designates the number of milliseconds that the LMR gateway delays audio from the channel before sending it to the radio. Valid values are 0 through 1500.
lmrg_hangover_time int Designates the number of milliseconds that the LMR gateway maintains the radio transmitting after the LMR gateway receives the last audio packet from a transmission from the channel. Valid values are 0 through 1500.
maxVoiceStreams int Not used.
mcastAddr String Contains the multicast address of the channel.
name String Contains the name of the channel.
port int Contains the port number that the channel uses.
ptttimeout int Not used.
region String Contains the preferred region in which the IDC displays the incident.
rfc2198_pt int Not used.
rfc2833event_pt int Sends the designated DTMF tones on the channel.
rfc2833tone_pt int Sends the designated single-frequency tones on the channel.
Table 1-7 ChannelDetailVO Attributes (continued)
Attribute Name Type Description
1-7Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
ChannelGroupContainerVO
The ChannelGroupContainerVO value object contains an array of summary information about one or more channel groups
Table 1-8 describes the attributes of this value object.
ChannelGroupVO
The ChannelGroupVO value object contains summary information about a channel group.
Table 1-9 describes the attributes of this value object.
rxmute String Indicates whether audio to or from the channel is muted when the PTT button is pressed in the IDC or on an IP phone. Valid values are:
• all—When PTT is engaged, RX (receive transmission) is muted on all voice resources
• this—When PTT is engaged, RX is muted on this channel
• none—When PTT is engaged, no voice resources are muted
secure boolean Indicates whether the channel is secure (true means yes and false means no).
sipPort int Not used.
sipProxyIp String Not used.
txmute boolean Indicates whether the channel is configured as listen only (true means yes and false means no).
vad boolean Indicates whether VAD1 is enabled for the channel (true means yes and false means no).
1. VAD = voice activity detection
Table 1-7 ChannelDetailVO Attributes (continued)
Attribute Name Type Description
Table 1-8 ChannelGroupContainerVO Attributes
Attribute Name Type Description
channelGroupVOs ChannelGroupVO[] Contains an array of ChannelGroupVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-8Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
ChannelVO
The ChannelVO value object contains summary information about a channel.
Table 1-10 describes the attributes of this value object.
ClientDescriptorVO
The ClientDescriptorVO value object contains information about the type of client that connects to a web services session.
Table 1-11 describes the attributes of this value object.
Table 1-9 ChannelGroupVO Attributes
Attribute Name Type Description
Description String Contains a description of the channel group.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the channel group. Cisco IPICS generated this ID when the channel group was created in Cisco IPICS.
Name String Contains the name of the channel group, or the name to find when using a Find function.
Table 1-10 ChannelVO Attributes
Attribute Name Type Description
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
id int Contains the unique ID of the channel. Cisco IPICS generated this ID when the channel was created in Cisco IPICS.
isSecure boolean Indicates whether the channel is designated as secure (true means yes and false means no).
name String Contains the name of the channel
Table 1-11 ClientDescriptorVO Attributes
Attribute Name Type Description
clientId String Contains the ID of the client
clientType String Contains the type of client (for example, IDC or iPhone)
cpuMhz float Not used
hwVersion String Not used
1-9Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
DialAddressContainerVO
The DialAddressContainerVO value object contains an array of information about one or more dial preferences.
Table 1-12 describes the attributes of this value object.
DialAddressVO
The DialAddressVO value object contains summary information about a dial number.
Table 1-13 describes the attributes of this value object.
ipicsVersion String Contains Cisco IPICS version that is running on the server that the client connects to
manufacturer String Not used
model String Not used
osVersion String Not used
preferredLanguage String Not used
ramFree long Not used
ramTotal long Not used
screenHeight int Not used
screenWidth int Not used
storeFree long Not used
storeTotal long Not used
supportedVideoFormats String Not used
Table 1-11 ClientDescriptorVO Attributes (continued)
Attribute Name Type Description
Table 1-12 DialAddressContainerVO Attributes
Attribute Name Type Description
dialAddressVOs DialAddressVO[] Contains an array of DialAddressVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-10Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
ErrorVO
The ErrorVO value object contains an error code and message, if a function returns an error.
Table 1-14 describes the attributes of this value object.
IdcSessionContainerVO
The IdcSessionContainerVO value object contains an array of information about one or more IDC sessions.
Table 1-15 describes the attributes of this value object.
Table 1-13 DialAddressVO Attributes
Attribute Name Type Description
dialNumber String Contains dial number, which is the phone number that the policy engine uses when dialing out.
dialPreferenceOrder int Contains the order of telephone numbers at which Cisco IPICS contacts a user when a user-associated policy executes or when a dispatcher initiates a dial out to invite a user to join an active VTG.
errorVO ErroVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the dial address. Cisco IPICS generated this ID when the dial address was created in Cisco IPICS.
type String Contains type of dial number.
Table 1-14 ErrorVO Attributes
Attribute Name Type Description
errorCode String Contains an error code
errorMessage String Contains an error message that a function returns
Table 1-15 IdcSessionContainerVO Attributes
Attribute Name Type Description
idcSessionVOs IdcSessionVO[] Contains an array of IdcSessionVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-11Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
IdcSessionVO
The IdcSessionVO value object contains information about an IDC session.
Table 1-16 describes the attributes of this value object.
IncidentContainerVO
The ncidentContainerVO value object contains an array of summary information about one or more incidents.
Table 1-17 describes the attributes of this value object.
Table 1-16 IdcSessionVO Attributes
Attribute Name Type Description
address String Contains the IP address of the IDC client
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
idcSessionId int Contains the unique ID of the IDC client session. Cisco IPICS generates this ID when the client session is established.
idcId int Any unique ID, such as the MAC address, of the client from which you execute this function
lastActivity Date Date and time that the client last communicated with the Cisco IPCIS server.
location String Location of the IDC client.
opsViewName String Name of the ops view that the user who is logged in to the IDC belongs to.
userId int Unique ID of the user of the user who is logged in to the IDC?. Cisco IPICS generates this ID when the user is created.
userName String Cisco IPICS user name of the user who is logged in to IDC.
version String Version information of the IDC software.
Table 1-17 ncidentContainerVO Attributes
Attribute Name Type Description
incidentVOs IncidentVO[] Contains an array of IncidentVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-12Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
IncidentDetailsVO
The IncidentDetailsVO value object contains detailed information about an incident.
Table 1-18 describes the attributes of this value object.
IncidentParticipantContainerVO
The IncidentParticipantContainerVO value object contains an array of information about one or more resources in an incident. Resources are users, channels, photographs, radios, videos, or VTGs.
Table 1-18 IncidentDetailsVO Attributes
Attribute Name Type Description
address AddressVO Contains the physical address where the incident is taking place.
commanderId int Not used.
createDate Date Contains the date and time at which the incident was created.
description String Contains a description of the incident.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the incident. Cisco IPICS generated this ID when the incident was created.
incidentVtgId int Contains the ID of the incident VTG that is associated with the incident, if an associated incident VTG exists.
name String Contains the full the name of the incident.
opsviewId int Contains the ID of the ops view to which the incident belongs.
ownerId int Contains the ID of the user who created the incident. Cisco IPICS generated this ID when the user was created in Cisco IPICS.
pmcRegionId int Contains the preferred region in which the ICD displays the incident.
priority short Not used.
resourceType String Not used.
shortName String Not used.
startDate Date Contains the date and time at which the incident was activated.
state String Indicates the state of the incident (Active or Inactive).
stopDate Date Contains the date and time at which the incident was deactivated.
1-13Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
Table 1-19 describes the attributes of this value object.
IncidentParticipantVO
The IncidentParticipantVO value object contains summary information about a resource in an incident. A resource is user, channel, photograph, radio, video, or VTG.
Table 1-20 describes the attributes of this value object.
IncidentVO
The IncidentVO value object contains summary information about an incident.
Table 1-21 describes the attributes of this value object.
Table 1-19 IncidentParticipantContainerVO Attributes
Attribute Name Type Description
incidentParticipantVOs incidentParticipantVO Contains an array of IncidentParticiapntVO value objects
ErrorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-20 IncidentParticipantVO Attributes
Attribute Name Type Description
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the incident participant. Cisco IPICS generated this ID when the incident participant was added.
name String Contains the name of the incident participant.
participantType String Contains the type of the incident resource.
Table 1-21 IncidentVO Attributes
Attribute Name Type Description
description String Contains a description of the incident.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the incident. Cisco IPICS generated this ID when the incident was created.
incidentVtgId int Contains the ID of the incident VTG that is associated with the incident, if an associated incident VTG exists.
1-14Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
IncidentVtgOptionsVO
The IncidentVtgOptionsVO value object contains summary information about an incident VTG,
Table 1-22 describes the attributes of this value object.
incidentVtgStatus String Status of the incident VTG that is associated with the incident.
name String Contains the name of the incident.
ownerId int Contains the Cisco IPICS ID of the user who created the incident.
pmcRegionId int Contains the preferred region in which the ICD displays the incident.
resourceType String Not used.
shortName String Not used.
state String Indicates the state of the incident (Active or Inactive).
Table 1-21 IncidentVO Attributes (continued)
Attribute Name Type Description
Table 1-22 IncidentVtgOptionsVO Attributes
Attribute Name Type Description
errorVO ErroVO Contains an error code and message, if an exception occurs during function execution.
latch boolean Indicates whether the incident VTG is latchable (true means yes and false means no).
listenOnly boolean Indicates whether incident VTG is configured as listen only (true means yes and false means no).
rxMute String Indicates whether audio to or from the incident VTG is muted when the PTT button is pressed in the IDC or on an IP phone. Valid values are:
• all—When PTT is engaged, RX (receive transmission) is muted on all voice resources
• this—When PTT is engaged, RX is muted on this incident VTG
• none—When PTT is engaged, no voice resources are muted
allowVad boolean Indicates whether VAD1 is enabled for the incident VTG (true means yes and false means no).
1. VAD = voice activity detection
pmcRegionId int Contains the preferred region in which the ICD displays the VTG.
1-15Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
IncidentVtgUserOptionsVO
The IncidentVtgUserOptionsVO value object contains summary information about an incident VTG user.
Table 1-23 describes the attributes of this value object.
IntegerVO
The IntegerVO value object contains an integer value that a function returns
Table 1-24 describes the attributes of this value object.
JournalContainerVO
The JournalContainerVO value object contains an array of summary information about one or more journals.
Table 1-25 describes the attributes of this value object.
Table 1-23 IncidentVtgUserOptionsVO Attributes
Attribute Name Type Description
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
latch boolean Indicates whether the incident VTG is latchable (true means yes and false means no)
listenOnly boolean Indicates whether incident VTG is configured as listen only (true means yes and false means no).
rxMute boolean Indicates whether audio to or from the incident VTG is muted when the PTT button is pressed in the IDC or on an IP phone (true means yes and false means no).
Table 1-24 IntegerVO Attributes
Attribute Name Type Description
value int Contains an integer value that a function returns
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
Table 1-25 JournalContainerVO Attributes
Attribute Name Type Description
journalVOs JournalVO[] Contains an array of JournalVO value objects
ErrorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-16Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
JournalDetailsContainerVO
The JournalDetailsContainerVO value object contains an array of detailed information about one or more journals
Table 1-26 describes the attributes of this value object.
JournalDetailsVO
The JournalDetailsVO value object contains detailed information about a journal.
Table 1-27 describes the attributes of this value object.
Table 1-26 JournalDetailsContainerVO Attributes
Attribute Name Type Description
journals JournalDetailsVO[] Contains an array of JournalDetailsVO value objects
ErrorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-27 JournalDetailsVO Attributes
Attribute Name Type Description
address AddressVO Not used.
created Date Contains the date and time at which the journal was created.
description String Not used.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the journal. Cisco IPICS generated this ID when the journal was created.
language String Contains the language of the journal text.
message String Contains the journal text.
name String Not used.
opsViewId int Contains the ID of the ops view that is associated with the user who created the journal entry.
owner UserVO Not used.
ownerId int Contains the Cisco IPICS ID of the user who created the journal.
resourceType String Not used.
url String Not used.
1-17Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
JournalVO
The JournalVO value object contains summary information about a journal.
Table 1-28 describes the attributes of this value object.
LocationContainerVO
The LocationContainerVO value object contains an array of information about one or more locations.
Table 1-29 describes the attributes of this value object.
LocationVO
The LocationVO value object contains information about a location.
Table 1-30 describes the attributes of this value object.
Table 1-28 JournalVO Attributes
Attribute Name Type Description
created Date Contains the date and time at which the journal was created.
description String Not used.
errorVO ErroVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the journal. Cisco IPICS generated this ID when the journal was created.
message String Contains the journal text.
name String Not used.
owner UserVO Not used.
ownerId int Contains the Cisco IPICS ID of the user who created the journal.
resourceType String Not used.
title String Not used.
url String Not used.
Table 1-29 LocationContainerVO Attributes
Attribute Name Type Description
locationVOs locationVO[] Contains an array of locationVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
1-18Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
MediaConnectionAddressVO
The MediaConnectionAddressVO value object contains information about a media connection.
Table 1-31 describes the attributes of this value object.
MediaConnectionContainerVO
The MediaConnectionContainerVO value object contains an array of information about one or more media connections.
Table 1-32 describes the attributes of this value object.
Table 1-30 LocationVO Attributes
Attribute Name Type Description
description String Contains a description of the location.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique Cisco IPICS ID of the location. Cisco IPICS generated this ID when the location was added in Cisco IPICS.
name String Contains the name of the location
Table 1-31 MediaConnectionAddressVO Attributes
Attribute Name Type Description
dn String Contains the dial number that is configured for this resource on the media server
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
ipaddress String Contains the IP address of the media server that is hosting the media connection
port int Contains the media server port number of the media server that the IDC connects to
Table 1-32 MediaConnectionContainerVO
Attribute Name Type Description
connections MediaConnectionVO[] Contains an array of MediaConnectionVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
poll_freq int Not used
1-19Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
MediaConnectionVO
The MediaConnectionVO value object contains SIP connection information about a designated resource.
Table 1-34 describes the attributes of this value object.
MulticastAddressContainerVO
The MulticastAddressContainerVO value object contains an array of information about one or more media connections.
Table 1-34 describes the attributes of this value object.
Table 1-33 MediaConnectionVO Attributes
Attribute Name Type Description
tg_id int ID of the resource with this media connection.
tg_type String Type of the resource.
state String The state of resource allocation process.
addr_type String Type of media connection to the media server. Valid values are:
• mcast—Multicast connection
• sip—SIP connection
codec String Codec to be used for this media connection (G.711 | or G.729).
addresses MediaConnectionAddressVO[] Contains an array of MediaConnectionAddressVO value objects.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
mediaServerType int Type of media server that is hosting the media connection. Valid values are:
• –1—Media server type not available
• 0—RMS
• 1—UMS
Table 1-34 MulticastAddressContainerVO Attributes
Attribute Name Type Description
multicastAddresseses MulticastAddressVO[] Contains an array of MulticastAddressVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-20Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
MulticastAddressVO
The MulticastAddressVO value object contains information about a multicast address.
Table 1-35 describes the attributes of this value object.
NotificationAddressContainerVO
The NotificationAddressContainerVO value object Contains an array of information about one or more notification addresses.
Table 1-36 describes the attributes of this value object.
NotificationAddressVO
The NotificationAddressVO value object contains information about a notification address.
Table 1-37 describes the attributes of this value object.
Table 1-35 MulticastAddressVO Attributes
Attribute Name Type Description
address String IP address of the multicast address.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Unique ID of the multicast address in Cisco IPICS. Cisco IPICS generated this ID when the multicast address was added in Cisco IPICS.
location String Contains location information of the multicast address.
port int Contains port information of the multicast address
status String Contains status information of the multicast address
type String Contains type information of the multicast address
usedBy String Contains resource and user information of the multicast address
Table 1-36 NotificationAddressContainerVO Attributes
Attribute Name Type Description
notificationAddressVOs NotificationAddressVO[] Contains an array of NotificationAddressVO value objects
ErrorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-21Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
PaginationContextVO
The PaginationContextVO value object contains attributes that designate the format and limits of the output of a function.
If an API function that accepts the PaginationContextVO parameter is executed without this VO, the function returns all records that match its query. Be aware that this situation can consume significant resources on the Cisco IPICS server if there are many records.
Table 1-38 describes the attributes of this value object.
PhoneContainerVO
The PhoneContainerVO value object contains an array of information about one or more direct dial phones.
Table 1-39 describes the attributes of this value object.
Table 1-37 NotificationAddressVO Attributes
Attribute Name Type Description
errorVO ErroVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the notification address. Cisco IPICS generated this ID when the notification address was added in Cisco IPICS.
notificationAddress String Contains the e-mail address, pager number, of phone number of the device that is to receive the notification.
type String Contains the type of notification (email, pager, or sms).
Table 1-38 PaginationContextVO Attributes
Attribute Name Type Description
pageNumber int Contains the page number of the display. This attribute is required.
pageRecords int Contains the number of records to be displayed per page. This attribute is required.
totalPages int Contains the total number of pages to include in the display output. This attribute is populated automatically in the response to a function call.
totalRecords int Contains the total number of records that the request returns. This attribute is populated automatically in the response to a function call.
1-22Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
PhoneVO
The PhoneVO value object contains summary information about a direct dial phone.
Table 1-40 describes the attributes of this value object.
PhotoContainerVO
The PhotoContainerVO value object Contains an array of information about one or more photographs.
Table 1-39 describes the attributes of this value object.
Table 1-39 PhoneContainerVO Attributes
Attribute Name Type Description
phoneVOs PhoneVO[] Contains an array of PhoneVO value objects
ErrorVO ErroVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-40 PhoneVO Attributes
Attribute Name Type Description
description String Contains a description of the phone number (for example, business or home).
dialDestination String Contains the number to dial for the phone.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the phone, which Cisco IPICS generates when you add the phone to Cisco IPICS.
name String Contains the direct dial phone label.
ownerId int Contains Cisco IPICS ID of the user who created the phone.
sipdn String Contains the unique ID of the phone, which Cisco IPICS generates when you add the phone to Cisco IPICS.
Table 1-41 PhoneContainerVO Attributes
Attribute Name Type Description
photoVOs PhotoVO[] Contains an array of PhotoVO value objects
ErrorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-23Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
PhotoDetailsVO
The PhotoDetailsVO value object contains detailed information about a photograph that has been added to Cisco IPICS.
Table 1-42 describes the attributes of this value object.
Table 1-42 PhotoDetailsVO Attributes
Attribute Name Type Description
address AddressVO Contains information about the physical address where the photograph was taken.
autoDelete boolean If true, the Cisco IPICS database record for the photograph and the photograph file (if the file exists on the Cisco IPICS server) are deleted automatically when all incidents with which the photograph are associated are deleted. If false, the Cisco IPICS database record for the photograph and the photograph file are never deleted automatically.
colorDepth short Contains color depth information about the photograph.
created Date Contains the date and time at which the photograph was added to IPICS.
description String Contains a description of the photograph.
dimension String Not used.
direction String Not used.
encoding String Not used.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
height int Not used.
id int Contains the unique ID of the photograph. Cisco IPICS generated this ID when the photograph was added in Cisco IPICS.
name String Not used.
opsViewId int Contains the ops view with which the photograph is associated.
owner UserVO Not used.
ownerId int Contains the unique ID of the user who added the photograph. Cisco IPICS generated this ID when the user was added in Cisco IPICS.
palette String Not used.
resourceType String Not used.
spectrum String Not used.
title String Contains a brief title, or name, of the photograph.
1-24Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
PhotoVO
The PhotoVO value object contains summary information about a photograph that has been added to Cisco IPICS.
Table 1-43 describes the attributes of this value object.
PolicyActionVO
The PolicyActionVO value object Contains information about a policy action.
url String Contains the URL of the photograph.
width int Not used.
Table 1-42 PhotoDetailsVO Attributes (continued)
Attribute Name Type Description
Table 1-43 PhotoVO Attributes
Attribute Name Type Description
autoDelete boolean If true, the Cisco IPICS database record for the photograph and the photograph file (if the file exists on the Cisco IPICS server) are deleted automatically when all incidents with which the photograph are associated are deleted. If false, the Cisco IPICS database record for the photograph and the photograph file are never deleted automatically.
created Date Contains the date and time at which the photograph was created.
description String Contains a description of the photograph.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the photograph. Cisco IPICS generated this ID when the photograph was added in Cisco IPICS.
name String Not used.
opsViewId int Contains the ops view with which the photograph is associated.
owner UserVO Not used.
ownerId int Contains the unique ID of the user who added the photograph. Cisco IPICS generated this ID when the user was added in Cisco IPICS.
resourceType String Not used
title String Contains a brief title, or name, of the photograph.
url String Contains the URL of the photograph.
1-25Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
Table 1-44 describes the attributes of this value object.
PolicyContainerVO
The PolicyContainerVO value object contains an array of information about 1 or more policies.
Table 1-45 describes the attributes of this value object.
PolicyDetailsVO
The PolicyDetailsVO value object contains detailed information about a policy.
Table 1-46 describes the attributes of this value object.
Table 1-44 PolicyActionVO Attributes
Attribute Name Type Description
description String Contains a description of the policy action.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the policy action. Cisco IPICS generated this ID when the policy action was created in Cisco IPICS.
message String Contains the text of the message that a policy notification action sends
name String Contains the name of the policy.
startTime String Contains the configured start date and time for the policy.
status String Contains the status of the policy, such as such as Successful, Executing, or Failed.
type String Contains policy action type.
Table 1-45 PolicyContainerVO Attributes
Attribute Name Type Description
policyVOs PolicyVO[] Contains an array of PolicyVO value objects
ErrorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-46 PolicyDetailsVO Attributes
Attribute Name Type Description
actions PolicyActionVO[] Contains an array of PolicyActionVO value objects.
description String Contains a description of the policy.
1-26Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
PolicyExecutionStatusContainerVO
The PolicyExecutionStatusContainerVO value object contains an array of information about the execution of one or more policies.
Table 1-47 describes the attributes of this value object.
PolicyExecutionStatusVO
The PolicyExecutionStatusVO value object contains information about the execution of a policy.
Table 1-48 describes the attributes of this value object.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the policy. Cisco IPICS generated this ID when the policy was created in Cisco IPICS.
name String Contains the name of policy.
triggers PolicyTriggerVO[] Contains an array of PolicyTriggerVO value objects.
Table 1-46 PolicyDetailsVO Attributes (continued)
Attribute Name Type Description
Table 1-47 PolicyExecutionStatusContainerVO Attributes
Attribute Name Type Description
policyExecutionStatusVOs policyExecutionStatusVO[] Contains an array of PolicyExecutionStatusVO value objects
ErrorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-48 PolicyExecutionStatusVO Attributes
Attribute Name Type Description
actions PolicyActionVO[] Contains and array of PolicyActionVO value objects.
description String Contains a description of the policy.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
executionDate String Contains the date and time at which the policy last executed
executionStatus String Contains latest execution status of the policy, such as Successful, Executing, or Failed.
1-27Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
PolicyTriggerVO
The PolicyTriggerVO value object contains detailed about a policy trigger.
Table 1-49 describes the attributes of this value object.
PolicyVO
The PolicyVO value object contains summary information about a policy.
Table 1-50 describes the attributes of this value object.
id int Contains the unique ID of the policy, which Cisco IPICS generates when you add the policy to Cisco IPICS.
name String Contains the name of the policy.
statusMessage String Contains information about the execution of the policy.
Table 1-48 PolicyExecutionStatusVO Attributes (continued)
Attribute Name Type Description
Table 1-49 PolicyTriggerVO Attributes
Attribute Name Type Description
description String Contains a description of the policy trigger.
errorVO ErroVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the policy trigger, which Cisco IPICS generates when you add the policy trigger to Cisco IPICS.
name String Contains the name of the policy trigger.
Table 1-50 PolicyVO Attributes
Attribute Name Type Description
description String Contains a description of the policy.
errorVO ErroVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the policy, which Cisco IPICS generates when you add the policy to Cisco IPICS.
name String Contains the name of the policy.
1-28Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
RadioContainerVO
TheRadioContainerVO value object contains an array of information about one or more radios.
Table 1-51 describes the attributes of this value object.
RadioDetailsVO
The RadioDetailsVO value object contains detailed information about a radio.
Table 1-52 describes the attributes of this value object.
RadioVO
The RadioVO value object contains summary information about a radio.
Table 1-53 describes the attributes of this value object.
Table 1-51 TheRadioContai Attributes
Attribute Name Type Description
radioVOs RadioVO[] Contains an array of RadioVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-52 RadioDetailsVO Attributes
Attribute Name Type Description
control String Contains control type of the radio (serial or tone).
description String Contains a description of the radio.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the radio, which Cisco IPICS generates when you add the radio to Cisco IPICS.
location int Contains the location that was configured for the radio when the radio was added to Cisco IPICS.
name String Contains the name of the radio.
type String Indicates the type of the radio (Nextel or EFJ).
Table 1-53 RadioVO Attributes
Attribute Name Type Description
description String Contains a description of the radio.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
1-29Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
ResourceContainerVO
The ResourceContainerVO value object contains an array of information about one or more resources (channels, radios, users, and VTGs).
Table 1-54 describes the attributes of this value object.
ResourceVO
The ResourceVO value object contains information about a resource (channel, radio, user, or VTG).
Table 1-55 describes the attributes of this value object.
id int Contains the unique ID of the radio, which Cisco IPICS generates when you add the radio to Cisco IPICS.
locationId int Contains Cisco IPICS location of the radio.
name String Contains the name of the radio.
radioControlType String Contains control type of the radio (serial or tone).
pooledResourceInd boolean Indicates whether radio is pooled resource (true means yes and false means no).
Table 1-53 RadioVO Attributes (continued)
Attribute Name Type Description
Table 1-54 ResourceContainerVO Attributes
Attribute Name Type Description
resources ResourceVO[] Contains an array of ResourceVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-55 ResourceVO Attributes
Attribute Name Type Description
description String Contains a description of the resource.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the resource, which Cisco IPICS generates when you add the resource to Cisco IPICS.
name String Contains the name of the resource.
resourceType String Contains the type of the resource.
1-30Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
SessionVO
The SessionVO value object contains a web services session ID.
Table 1-56 describes the attributes of this value object.
StringVO
The StringVO value object stores a string that a function returns.
Table 1-57 describes the attributes of this value object.
UserContainerVO
The UserContainerVO value object contains an array of information about 1 or more users.
Table 1-58 describes the attributes of this value object.
UserDetailsVO
The UserDetailsVO value object contains detailed information about a user.
Table 1-59 describes the attributes of this value object.
Table 1-56 SessionVO Attributes
Attribute Name Type Description
sessionId String Contains the ID of the current web services session
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
Table 1-57 StringVO Attributes
Attribute Name Type Description
value String Contains the string that a function returns
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
Table 1-58 UserContainerVO Attributes
Attribute Name Type Description
userVOs UserVO[] Contains an array of UserVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-31Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
UserGroupContainerVO
The UserGroupContainerVO value object contains an array of information about one or more user groups.
Table 1-60 describes the attributes of this value object.
UserGroupDetailsVO
The UserGroupDetailsVO value object contains detailed information about a user group.
Table 1-61 describes the attributes of this value object.
Table 1-59 UserDetailsVO Attributes
Attribute Name Type Description
allowUnsecurePatch Boolean If true, the user can combine secure and unsecure channels in a patch. If false, the user can use only non-secure channels in a patch.
description String Contains a description of the user.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
firstName String Contains the first name of the user.
id int Contains the unique ID of the use, which Cisco IPICS generates when you add the user to Cisco IPICS.
lastName String Contains the last name of the user.
name String Contains the name of the user to be displayed in the Cisco IPICS Administration Console.
roles String[] Contains an array Cisco IPICS roles that are associated with the user.
userLogin String Contains the Cisco IPICS user name of the user.
Table 1-60 UserGroupContainerVO Attributes
Attribute Name Type Description
userGroupVOs UserGtoupVO[] Contains an array of UserGroupVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-32Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
UserGroupVO
The UserGroupVO value object contains summary information about a user group.
Table 1-62 describes the attributes of this value object.
UserRoleContainerVO
The UserRoleContainerVO value object contains an array of information about one or more Cisco IPICS user roles.
Table 1-63 describes the attributes of this value object.
Table 1-61 UserGroupDetailsVO Attributes
Attribute Name Type Description
description String Contains a description of user group.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the user group, which Cisco IPICS generates when you add the user group to Cisco IPICS.
name String Contains the name of the user group.
users UserVO[] Contains an array of UserVO value objects.
Table 1-62 UserGroupVO Attributes
Attribute Name Type Description
description String Contains a description of the user group.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the user group, which Cisco IPICS generates when you add the user group to Cisco IPICS.
name String Contains the name of the user group.
Table 1-63 UserRoleContainerVO Attributes
Attribute Name Type Description
userRoleVOs UserRoleVO[] Contains an array of UserRoleVO value objects.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-33Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
UserRoleVO
The UserRoleVO value object contains information about a Cisco IPICS user role.
Table 1-64 describes the attributes of this value object.
UserVO
The UserVO value object contains summary information about a user.
Table 1-65 describes the attributes of this value object.
VideoContainerVO
The VideoContainerVO value object contains an array of information about one or more videos.
Table 1-66 describes the attributes of this value object.
Table 1-64 UserRoleVO Attributes
Attribute Name Type Description
description String Contains a description of the user role.
displayName String Contains name of the role as it appears in the Cisco IPICS Administration Console GUI.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the user role, which Cisco IPICS generates when you add the user role to Cisco IPICS.
name String Contains the names of the user role.
Table 1-65 UserVO Attributes
Attribute Name Type Description
description String Contains a description of the user.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
firstName String Contains the first name of the user.
id int Contains the unique ID of the user, which Cisco IPICS generates when you add the user to Cisco IPICS.
lastName String Contains the last name of the user.
name String Contains complete name of the user.
userLogin String Contains the Cisco IPICS user name of the user.
1-34Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
VideoDetailsVO
The VideoDetailsVO value object contains detailed information about a video that has been added to Cisco IPICS.
Table 1-67 describes the attributes of this value object.
Table 1-66 VideoContainerVO Attributes
Attribute Name Type Description
videoVOs VideoVO[] Contains and array of VideoVO value objects
errorVO ErroVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-67 VideoDetailsVO Attributes
Attribute Name Type Description
address AddressVO Contains the physical address where the photograph was taken.
autoDelete boolean If true, the Cisco IPICS database record for the video and the video file (if the file exists on the Cisco IPICS server) are deleted automatically when all incidents with which the video are associated are deleted. If false, the Cisco IPICS database record for the video and the video file are never deleted automatically.
cameraModel String Not used.
cameraSrcType String Not used.
cameraUrl String Not used.
colorDepth int Not used.
created Date Contains the date and time at which the video was added to Cisco IPICS.
description String Contains a description of the video.
dimension String Not used.
direction String Not used.
encoding String Not used.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
has Audio boolean Indicates whether video includes audio (true means yes and false means no).
hasPtz boolean Not used.
iconUrl String Not used.
1-35Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
VideoVO
The VideoVO value object contains summary information about a video that has been added to Cisco IPICS.
Table 1-68 describes the attributes of this value object.
id int Contains the unique ID of the video, which Cisco IPICS generates when you add the video to Cisco IPICS
isFixedLocation boolean Not used.
language String Not used.
name String Not used.
opsViewId int Contains the ID of the ops view that is associated with the video.
owner UserVO Not used.
ownerId int Contains the unique ID of the user who added the video. Cisco IPICS generated this ID when the user was added in Cisco IPICS.
palette String Not used.
rate int Not used.
rateUnits String Not used.
resourceType String Not used.
spectrum String Not used.
title String Contains a brief title, or name, of the video.
url String Contains the URL of the video.
videoType String Not used.
videoUrl String Not used.
vsomUrl String Not used.
Table 1-67 VideoDetailsVO Attributes (continued)
Attribute Name Type Description
Table 1-68 VideoVO Attributes
Attribute Name Type Description
autoDelete boolean If true, the Cisco IPICS database record for the video and the video file (if the file exists on the Cisco IPICS server) are deleted automatically when all incidents with which the video are associated are deleted. If false, the Cisco IPICS database record for the video and the video file are never deleted automatically.
cameraModel String Not used.
cameraSrcType String Not used.
1-36Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
VtgContainerVO
The VtgContainerVO value object contains an array of summary information about one or more VTGs.
Table 1-69 describes the attributes of this value object.
cameraUrl String Not used.
created date Contains the date and time at which the video was added to Cisco IPICS
description String Contains a description of the video.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
hasPtz boolean Not used.
iconUrl String Not used.
id int Contains the unique ID of the video, which Cisco IPICS generates when you add the video to Cisco IPICS
name String Not used.
opsViewId int Contains the ID of the ops view that is associated with the video.
owner UserVO Not used.
ownerId int Contains the unique ID of the user who added the video. Cisco IPICS generated this ID when the user was added in Cisco IPICS.
resourceType String Not used.
title String Contains a brief title, or name, of the video
url String Contains the URL of the video.
videoType String Not used.
videoUrl String Not used.
vsomUrl String Not used.
Table 1-68 VideoVO Attributes (continued)
Attribute Name Type Description
Table 1-69 VtgContainerVO Attributes
Attribute Name Type Description
vtgVOs VtgVO[] Contains an array of VtgVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
1-37Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
VtgDetailContainerVO
The VtgDetailContainerVO value object contains an array of detailed information about one or more VTGs.
Table 1-70 describes the attributes of this value object.
VtgDetailVO
The VtgDetailVO value object contains detailed information about a VTG.
Table 1-71 describes the attributes of this value object.
VtgOptionsVO
The VtgOptionsVO value object contains information about options that are configured for a VTG.
Table 1-72 describes the attributes of this value object.
Table 1-70 VtgDetailContainerVO Attributes
Attribute Name Type Description
vtgDetails VtgDetailVO[] Contains an array of VtgDetailVO value objects
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-71 VtgDetailVO Attributes
Attribute Name Type Description
defaultVtgId int Not used.
description String Contains a description of the VTG.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the VTG. Cisco IPICS generates this ID when you add the VTG to Cisco IPICS.
mcastaddr String Contains the multicast address that is assigned to the VTG.
name String Contains name of the VTG.
port int Contains multicast address port number that is assigned to the VTG.
status String Contains the current status of the VTG (such as active, inactive, pending)
vtgId int Contains the unique ID of the VTG. Cisco IPICS generates this ID when you add the VTG to Cisco IPICS.
1-38Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
VtgParticipantContainerVO
The VtgParticipantContainerVO value object contains an array of detailed information about VTG participants (channels, channel groups, radios, users, user groups, and VTGs).
Table 1-73 describes the attributes of this value object.
Table 1-72 VtgOptionsVO Attributes
Attribute Name Type Description
allowVad boolean Indicates whether VAD1 is enabled for the VTG (true means yes and false means no).
1. VAD = voice activity detection
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
latch boolean Indicates whether the VTG is latchable (true means yes and false means no).
listenOnly boolean Indicates whether the VTG is listen only mode (true means yes and false means no).
pmcRegionId int Contains the preferred region in which the ICD displays the VTG.
rxMute String Indicates whether audio to or from the VTG is muted when the PTT button is pressed in the IDC or on an IP phone. Valid values are:
• all—When PTT is engaged, RX (receive transmission) is muted on all voice resources
• this—When PTT is engaged, RX is muted on this incident VTG
• none—When PTT is engaged, no voice resources are muted
Table 1-73 VtgParticipantContainerVO Attributes
Attribute Name Type Description
channelGroupParticipants VtgParticipantVO[] Contains an array of VtgParticipantVO value objects
channelParticipants VtgParticipantVO[] Contains an array of VtgParticipantVO value objects
radioParticipants VtgParticipantVO[] Contains an array of VtgParticipantVO value objects
userGroupParticipants VtgParticipantVO[] Contains an array of VtgParticipantVO value objects
userParticipants VtgParticipantVO[] Contains an array of VtgParticipantVO value objects
vtgParticipants VtgParticipantVO[] Contains an array of VtgParticipantVO value objects
1-39Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
VtgParticipantVO
The VtgParticipantVO value object contains information about a VTG participant (channel, channel group, radio, user, user group, or VTG).
Table 1-74 describes the attributes of this value object.
VtgUserOptionsVO
The VtgUserOptionsVO value object contains information about user options that are configured for a VTG.
Table 1-75 describes the attributes of this value object.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution
paginationContext PaginationContextVO Contains pagination information
Table 1-73 VtgParticipantContainerVO Attributes (continued)
Attribute Name Type Description
Table 1-74 VtgParticipantVO Attributes
Attribute Name Type Description
allocationStatus String Contains the status of the allocation of the participant to the VTG.
allocationStatusMessage String Contains a message that relates to the allocation status.
description String Contains a description of the VTG participant.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
groupId int Not used.
id int Contains the unique ID of the association between the participant and the VTG. Cisco IPICS generates this ID when the VTG is activated.
name String Contains the name of the VTG participant.
participantId int Contains the unique ID of the participant that is associated with the VTG. Cisco IPICS generated this ID when the participant was created in Cisco IPICS.
resourceType String Contains type of vtg participant (channel / radio).
status String Contains status of vtg participant.
userLogin String Contains the Cisco IPICS user name of a user participant.
isSecure boolean Indicates whether the channel is designated as secure (true means yes and false means no).
1-40Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
VtgVO
The VtgVO value object contains summary information about a VTG.
Table 1-76 describes the attributes of this value object.
Table 1-75 VtgUserOptionsVO Attributes
Attribute Name Type Description
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
latch boolean Indicates whether the latch function is configured for use by the VTG user (true means yes and false means no).
listenOnly boolean Indicates whether listen only mode is configured for the VTG user (true means yes and false means no).
rxMute boolean Indicates whether audio to or from the incident VTG is muted when the PTT button is pressed in the IDC or on an IP phone. Valid values are:
• all—When PTT is engaged, RX (receive transmission) is muted on all voice resources
• this—When PTT is engaged, RX is muted on this incident VTG
• none—When PTT is engaged, no voice resources are muted
Table 1-76 VtgVO Attributes
Attribute Name Type Description
description String Contains description of the VTG.
errorVO ErrorVO Contains an error code and message, if an exception occurs during function execution.
id int Contains the unique ID of the VTG. Cisco IPICS generates this ID when you add the VTG to Cisco IPICS.
name String Contains the name of the VTG.
status String Contains the current status of VTG (such as active, inactive, pending).
1-41Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02
Chapter 1 Value ObjectsValue Objects Descriptions
1-42Cisco IPICS API Reference Guide, Cisco IPICS Release 4.5
OL-27164-02