Value Objects Descriptions
The 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
AddressBookUserContainerVO
The AddressBookUserContainerVO value object contains an array of AddressBookUserVO value objects.
Table 1-2 describes the attributes of this value object.
Table 1-2 AddressBookUserContainerVO Attributes
|
|
|
addressBookUsers |
AddressBookUserVO[] |
An array of one or more AddressBookUserVO value objects |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
paginationContextVo |
PaginationContextVO |
Contains pagination information |
AddressBookUserDetailVO
The AddressBookUserDetailVO value object contains detailed information for an entry in an IDC contacts list.
Table 1-3 describes the attributes of this value object.
Table 1-3 AddressBookUserDetailVO Attributes
|
|
|
address |
String |
Contains the number and street of the contact list entry. |
city |
String |
Contains the city of the contact list entry. |
contactInfoList |
ContactInfoVO[] |
An array of one or more ContactInfoVO value objects. |
country |
String |
Contains the country of the of the contact list entry. |
description |
String |
Contains the description of the of the contact list entry. |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution. |
firstName |
String |
Contains the first name of the of the contact list entry. |
globalUser |
boolean |
If true, the entry is in the Global Contacts list. If false, the entry is in the Private Contacts list. |
isFavorite |
boolean |
If true, the entry is in the Favorite Contacts list. If false, the entry is not in the Favorite Contacts list. |
lastName |
String |
Contains the last name of the contact list entry. |
state |
String |
Contains the state of the contact list entry. |
userId |
int |
Contains the ID of the contact list entry. |
userLogin |
String |
Contains the Cisco IPICS user name of the Global Contacts list entry |
zip |
String |
Contains the postal code of the contact list entry |
AddressBookUserVO
The AddressBookUserVO value object contains metadata that corresponds to an entry in an IDC contacts list.
Table 1-4 describes the attributes of this value object.
Table 1-4 AddressBookUserVO Attributes
|
|
|
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution. |
firstName |
String |
Contains the first name of the contact list entry. |
globalUser |
boolean |
If true, the entry is in the Global Contacts. If false, the entry is in the Private Contacts. |
isFavorite |
boolean |
If true, the entry is in the Favorite Contacts list. If false, the entry is not in the Favorite Contacts list. |
lastName |
String |
Contains the last name of the contact list entry. |
userId |
int |
Contains the ID of the contact list entry. |
userLogin |
String |
Contains the Cisco IPICS user name of the Global Contacts list entry. |
AddressVO
The AddressVO value object contains information about the address of a Cisco IPICS user.
Table 1-5 describes the attributes of this value object.
Table 1-5 AddressVO Attributes
|
|
|
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. |
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. |
BooleanVO
The BooleanVO value object contains a boolean value that a function returns.
Table 1-6 describes the attributes of this value object.
Table 1-6 BooleanVO Attributes
|
|
|
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 |
ChannelConnectionContainerVO
The ChannelConnectionContainerVO value object contains an array of information about one or more channel connections.
Table 1-7 describes the attributes of this value object.
Table 1-7 ChannelConnectionContainerVO Attributes
|
|
|
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 |
ChannelConnectionVO
The ChannelConnectionVO value object contains information about a channel connection.
Table 1-8 describes the attributes of this value object.
Table 1-8 ChannelConnectionVO Attributes
|
|
|
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. |
ChannelContainerVO
The ChannelContainerVO value object contains an array of summary information about one or more channels.
Table 1-9 describes the attributes of this value object.
Table 1-9 ChannelContainerVO Attributes
|
|
|
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 |
ChannelDetailVO
The ChannelDetailVO value object contains detailed information about a channel.
Table 1-10 describes the attributes of this value object.
Table 1-10 ChannelDetailVO Attributes
|
|
|
codec |
String |
Contains codec information about the channel. |
colorization |
String |
Contains the color of the channel that appears in the IDC. |
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. |
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 VAD is enabled for the channel ( true means yes and false means no). |
ChannelGroupContainerVO
The ChannelGroupContainerVO value object contains an array of summary information about one or more channel groups
Table 1-11 describes the attributes of this value object.
Table 1-11 ChannelGroupContainerVO Attributes
|
|
|
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 |
ChannelGroupVO
The ChannelGroupVO value object contains summary information about a channel group.
Table 1-12 describes the attributes of this value object.
Table 1-12 ChannelGroupVO Attributes
|
|
|
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. |
ChannelVO
The ChannelVO value object contains summary information about a channel.
Table 1-13 describes the attributes of this value object.
Table 1-13 ChannelVO Attributes
|
|
|
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 |
ClientDescriptorVO
The ClientDescriptorVO value object contains information about the type of client that connects to a web services session.
Table 1-14 describes the attributes of this value object.
Table 1-14 ClientDescriptorVO Attributes
|
|
|
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 |
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 |
ContactInfoContainerVO
The ContactInfoContainerVO value object contains an array of ContactInfoVO value objects.
Table 1-15 describes the attributes of this value object.
Table 1-15 ContactInfoContainerVO Attributes
|
|
|
contactInfoList |
ContactInfoVO[] |
An array of one or more ContactInfoVO value objects |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
paginationContextVo |
PaginationContextVO |
Contains pagination information |
ContactInfoVO
The ContactInfoVO value object contains phone number or email contact information for an IDC contact list entry.
Table 1-16 describes the attributes of this value object.
Table 1-16 ContactInfoVO Attributes
|
|
|
contactInfoId |
int |
Contains the unique ID of the contact information. |
defaultContact |
boolean |
Applies to a phone number only. If true, this phone number the default phone number. If false, this phone number is not the default phone number. When you click the Call icon for a contact in a Contact list in the IDC, the system initiates a call to the default phone number through the IDC dialer. |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution. |
infoString |
String |
Contains a phone number or email address. |
infoType |
String |
Describes the type of information that is represented by infoString:
- email-personal —Designates a personal email address
- email-work —Designates a work email address
- phone-business —Designates a business phone number
- phone-home —Designates a home phone number phone-mobile- designates a mobile phone number
- phone-mobile —Designates a mobile phone number
|
privateUserId |
int |
Contains the unique ID of the Private Contacts list entry that this contact belongs to. This field does not apply to the Global Contacts list. |
DialAddressContainerVO
The DialAddressContainerVO value object contains an array of information about one or more dial preferences.
Table 1-17 describes the attributes of this value object.
Table 1-17 DialAddressContainerVO Attributes
|
|
|
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 |
DialAddressVO
The DialAddressVO value object contains summary information about a dial number.
Table 1-18 describes the attributes of this value object.
Table 1-18 DialAddressVO Attributes
|
|
|
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. |
ErrorVO
The ErrorVO value object contains an error code and message, if a function returns an error.
Table 1-19 describes the attributes of this value object.
Table 1-19 ErrorVO Attributes
|
|
|
errorCode |
String |
Contains an error code |
errorMessage |
String |
Contains an error message that a function returns |
GlobalMediaMapVO
The GlobalMediaMapVO value object contains the VTGs that are active in Cisco IPICS.
Table 1-20 describes the attributes of this value object.
Table 1-20 GlobalMediaMapVO
|
|
|
vtgDetails |
VtgDetailVO[] |
Contains list of all active VTGs |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
version |
int |
Contains the version of the current global media map. |
IdcSessionContainerVO
The IdcSessionContainerVO value object contains an array of information about one or more IDC sessions.
Table 1-21 describes the attributes of this value object.
Table 1-21 IdcSessionContainerVO Attributes
|
|
|
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 |
IdcSessionVO
The IdcSessionVO value object contains information about an IDC session.
Table 1-22 describes the attributes of this value object.
Table 1-22 IdcSessionVO Attributes
|
|
|
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. |
IncidentContainerVO
The ncidentContainerVO value object contains an array of summary information about one or more incidents.
Table 1-23 describes the attributes of this value object.
Table 1-23 ncidentContainerVO Attributes
|
|
|
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 |
IncidentDetailsVO
The IncidentDetailsVO value object contains detailed information about an incident.
Table 1-24 describes the attributes of this value object.
Table 1-24 IncidentDetailsVO Attributes
|
|
|
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. |
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-25 describes the attributes of this value object.
Table 1-25 IncidentParticipantContainerVO Attributes
|
|
|
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 |
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-26 describes the attributes of this value object.
Table 1-26 IncidentParticipantVO Attributes
|
|
|
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. |
IncidentVO
The IncidentVO value object contains summary information about an incident.
Table 1-27 describes the attributes of this value object.
Table 1-27 IncidentVO Attributes
|
|
|
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. |
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). |
IncidentVtgOptionsVO
The IncidentVtgOptionsVO value object contains summary information about an incident VTG,
Table 1-28 describes the attributes of this value object.
Table 1-28 IncidentVtgOptionsVO Attributes
|
|
|
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 VAD is enabled for the incident VTG ( true means yes and false means no). |
pmcRegionId |
int |
Contains the preferred region in which the ICD displays the VTG. |
IncidentVtgUserOptionsVO
The IncidentVtgUserOptionsVO value object contains summary information about an incident VTG user.
Table 1-29 describes the attributes of this value object.
Table 1-29 IncidentVtgUserOptionsVO Attributes
|
|
|
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). |
IntegerVO
The IntegerVO value object contains an integer value that a function returns
Table 1-30 describes the attributes of this value object.
Table 1-30 IntegerVO Attributes
|
|
|
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 |
JournalContainerVO
The JournalContainerVO value object contains an array of summary information about one or more journals.
Table 1-31 describes the attributes of this value object.
Table 1-31 JournalContainerVO Attributes
|
|
|
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 |
JournalDetailsContainerVO
The JournalDetailsContainerVO value object contains an array of detailed information about one or more journals
Table 1-32 describes the attributes of this value object.
Table 1-32 JournalDetailsContainerVO Attributes
|
|
|
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 |
JournalDetailsVO
The JournalDetailsVO value object contains detailed information about a journal.
Table 1-33 describes the attributes of this value object.
Table 1-33 JournalDetailsVO Attributes
|
|
|
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. |
JournalVO
The JournalVO value object contains summary information about a journal.
Table 1-34 describes the attributes of this value object.
Table 1-34 JournalVO Attributes
|
|
|
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. |
LocationContainerVO
The LocationContainerVO value object contains an array of information about one or more locations.
Table 1-35 describes the attributes of this value object.
Table 1-35 LocationContainerVO Attributes
|
|
|
locationVOs |
locationVO[] |
Contains an array of locationVO value objects |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
LocationVO
The LocationVO value object contains information about a location.
Table 1-36 describes the attributes of this value object.
Table 1-36 LocationVO Attributes
|
|
|
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 |
MediaConnectionAddressVO
The MediaConnectionAddressVO value object contains information about a media connection.
Table 1-37 describes the attributes of this value object.
Table 1-37 MediaConnectionAddressVO Attributes
|
|
|
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 |
MediaConnectionContainerVO
The MediaConnectionContainerVO value object contains an array of information about one or more media connections.
Table 1-38 describes the attributes of this value object.
Table 1-38 MediaConnectionContainerVO
|
|
|
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 |
MediaConnectionVO
The MediaConnectionVO value object contains SIP connection information about a designated resource.
Table 1-40 describes the attributes of this value object.
Table 1-39 MediaConnectionVO Attributes
|
|
|
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
|
MulticastAddressContainerVO
The MulticastAddressContainerVO value object contains an array of information about one or more media connections.
Table 1-40 describes the attributes of this value object.
Table 1-40 MulticastAddressContainerVO Attributes
|
|
|
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 |
MulticastAddressVO
The MulticastAddressVO value object contains information about a multicast address.
Table 1-41 describes the attributes of this value object.
Table 1-41 MulticastAddressVO Attributes
|
|
|
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 |
NotificationAddressContainerVO
The NotificationAddressContainerVO value object Contains an array of information about one or more notification addresses.
Table 1-42 describes the attributes of this value object.
Table 1-42 NotificationAddressContainerVO Attributes
|
|
|
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 |
NotificationAddressVO
The NotificationAddressVO value object contains information about a notification address.
Table 1-43 describes the attributes of this value object.
Table 1-43 NotificationAddressVO Attributes
|
|
|
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). |
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-44 describes the attributes of this value object.
Table 1-44 PaginationContextVO Attributes
|
|
|
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. |
PhoneContainerVO
The PhoneContainerVO value object contains an array of information about one or more direct dial phones.
Table 1-45 describes the attributes of this value object.
Table 1-45 PhoneContainerVO Attributes
|
|
|
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 |
PhoneVO
The PhoneVO value object contains summary information about a direct dial phone.
Table 1-46 describes the attributes of this value object.
Table 1-46 PhoneVO Attributes
|
|
|
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. |
PhotoContainerVO
The PhotoContainerVO value object Contains an array of information about one or more photographs.
Table 1-45 describes the attributes of this value object.
Table 1-47 PhoneContainerVO Attributes
|
|
|
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 |
PhotoDetailsVO
The PhotoDetailsVO value object contains detailed information about a photograph that has been added to Cisco IPICS.
Table 1-48 describes the attributes of this value object.
Table 1-48 PhotoDetailsVO Attributes
|
|
|
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. |
url |
String |
Contains the URL of the photograph. |
width |
int |
Not used. |
PhotoVO
The PhotoVO value object contains summary information about a photograph that has been added to Cisco IPICS.
Table 1-49 describes the attributes of this value object.
Table 1-49 PhotoVO Attributes
|
|
|
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. |
PolicyActionVO
The PolicyActionVO value object Contains information about a policy action.
Table 1-50 describes the attributes of this value object.
Table 1-50 PolicyActionVO Attributes
|
|
|
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. |
PolicyContainerVO
The PolicyContainerVO value object contains an array of information about 1 or more policies.
Table 1-51 describes the attributes of this value object.
Table 1-51 PolicyContainerVO Attributes
|
|
|
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 |
PolicyDetailsVO
The PolicyDetailsVO value object contains detailed information about a policy.
Table 1-52 describes the attributes of this value object.
Table 1-52 PolicyDetailsVO Attributes
|
|
|
actions |
PolicyActionVO[] |
Contains an 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. |
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. |
PolicyExecutionStatusContainerVO
The PolicyExecutionStatusContainerVO value object contains an array of information about the execution of one or more policies.
Table 1-53 describes the attributes of this value object.
Table 1-53 PolicyExecutionStatusContainerVO Attributes
|
|
|
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 |
PolicyExecutionStatusVO
The PolicyExecutionStatusVO value object contains information about the execution of a policy.
Table 1-54 describes the attributes of this value object.
Table 1-54 PolicyExecutionStatusVO Attributes
|
|
|
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. |
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. |
PolicyTriggerVO
The PolicyTriggerVO value object contains detailed about a policy trigger.
Table 1-55 describes the attributes of this value object.
Table 1-55 PolicyTriggerVO Attributes
|
|
|
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. |
PolicyVO
The PolicyVO value object contains summary information about a policy.
Table 1-56 describes the attributes of this value object.
Table 1-56 PolicyVO Attributes
|
|
|
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. |
RadioContainerVO
TheRadioContainerVO value object contains an array of information about one or more radios.
Table 1-57 describes the attributes of this value object.
Table 1-57 TheRadioContai Attributes
|
|
|
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 |
RadioDetailsVO
The RadioDetailsVO value object contains detailed information about a radio.
Table 1-58 describes the attributes of this value object.
Table 1-58 RadioDetailsVO Attributes
|
|
|
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). |
RadioVO
The RadioVO value object contains summary information about a radio.
Table 1-59 describes the attributes of this value object.
Table 1-59 RadioVO Attributes
|
|
|
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. |
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). |
ResourceContainerVO
The ResourceContainerVO value object contains an array of information about one or more resources (channels, radios, users, and VTGs).
Table 1-60 describes the attributes of this value object.
Table 1-60 ResourceContainerVO Attributes
|
|
|
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 |
ResourceVO
The ResourceVO value object contains information about a resource (channel, radio, user, or VTG).
Table 1-61 describes the attributes of this value object.
Table 1-61 ResourceVO Attributes
|
|
|
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. |
SessionVO
The SessionVO value object contains a web services session ID.
Table 1-62 describes the attributes of this value object.
Table 1-62 SessionVO Attributes
|
|
|
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 |
StringVO
The StringVO value object stores a string that a function returns.
Table 1-63 describes the attributes of this value object.
Table 1-63 StringVO Attributes
|
|
|
value |
String |
Contains the string that a function returns |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
UserContainerVO
The UserContainerVO value object contains an array of information about 1 or more users.
Table 1-64 describes the attributes of this value object.
Table 1-64 UserContainerVO Attributes
|
|
|
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 |
UserDetailsVO
The UserDetailsVO value object contains detailed information about a user.
Table 1-65 describes the attributes of this value object.
Table 1-65 UserDetailsVO Attributes
|
|
|
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. |
UserGroupContainerVO
The UserGroupContainerVO value object contains an array of information about one or more user groups.
Table 1-66 describes the attributes of this value object.
Table 1-66 UserGroupContainerVO Attributes
|
|
|
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 |
UserGroupDetailsVO
The UserGroupDetailsVO value object contains detailed information about a user group.
Table 1-67 describes the attributes of this value object.
Table 1-67 UserGroupDetailsVO Attributes
|
|
|
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. |
UserGroupVO
The UserGroupVO value object contains summary information about a user group.
Table 1-68 describes the attributes of this value object.
Table 1-68 UserGroupVO Attributes
|
|
|
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. |
UserRoleContainerVO
The UserRoleContainerVO value object contains an array of information about one or more Cisco IPICS user roles.
Table 1-69 describes the attributes of this value object.
Table 1-69 UserRoleContainerVO Attributes
|
|
|
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 |
UserRoleVO
The UserRoleVO value object contains information about a Cisco IPICS user role.
Table 1-70 describes the attributes of this value object.
Table 1-70 UserRoleVO Attributes
|
|
|
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. |
UserVO
The UserVO value object contains summary information about a user.
Table 1-71 describes the attributes of this value object.
Table 1-71 UserVO Attributes
|
|
|
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. |
VideoContainerVO
The VideoContainerVO value object contains an array of information about one or more videos.
Table 1-72 describes the attributes of this value object.
Table 1-72 VideoContainerVO Attributes
|
|
|
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 |
VideoDetailsVO
The VideoDetailsVO value object contains detailed information about a video that has been added to Cisco IPICS.
Table 1-73 describes the attributes of this value object.
Table 1-73 VideoDetailsVO Attributes
|
|
|
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. |
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. |
VideoVO
The VideoVO value object contains summary information about a video that has been added to Cisco IPICS.
Table 1-74 describes the attributes of this value object.
Table 1-74 VideoVO Attributes
|
|
|
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. |
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. |
VSOMCameraContainerVO
The VSOMCameraContainerVO value object contains an array of information about one or more VSOM cameras.
Table 1-75 describes the attributes of this value object.
Table 1-75 VSOMCameraContainerVO Attributes
|
|
|
vsomCameraVO |
VSOMCameraVO[] |
Contains an array of VSOMCameraVO value objects |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
paginationContextVO |
PaginationContextVO |
Contains pagination information |
VSOMCameraVO
The VSOMCameraVO value object contains summary information about a VSOM camera.
Table 1-76 describes the attributes of this value object.
Table 1-76 VSOMCameraVO Attributes
|
|
|
address |
AddressVO |
Contains information about the physical address where the camera was setup |
associatedVSOMLocation |
String |
Contains the location that is configured in VSOM for the camera |
associatedVSOMLocationId |
String |
Contains the ID of the location that is configured in VSOM for the camera |
cameraAssociationTime |
long |
Contains the information about the camera association time for recording |
description |
String |
Contains a description of the camera |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
id |
int |
Contains the unique ID of the camera that Cisco IPICS generates when you add the camera to Cisco IPICS. |
name |
String |
Contain the name of the camera |
opsViewId |
int |
Contains the ops view with which the camera is associated |
vsomCameraId |
String |
Contains the unique ID of the camera that generates when you add the Camera to VSOM |
vsomCameraType |
String |
Contains the type of the camera |
vsomId |
int |
Contains the unique ID of the VSOM server, which Cisco IPICS generates when you add the VSOM server to Cisco IPICS |
VSOMContainerVO
The VSOMContainerVO value object contains an array of information about one or more VSOM servers.
Table 1-77 describes the attributes of this value object.
Table 1-77 VSOMContainerVO Attributes
|
|
|
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
paginationContextVO |
PaginationContextVO |
Contains pagination information |
vsomVOs |
VSOMVO[] |
Contains an array of VSOMVO value objects |
VSOMVO
The VSOMVO value object contains summary information about a VSOM server.
Table 1-78 describes the attributes of this value object.
Table 1-78 VSOMVO Attributes
|
|
|
description |
String |
Contains a description of the VSOM server |
id |
int |
Contains the unique ID of the VSOM server, which CISCO IPICS generates when you add the VSOM server to Cisco IPICS |
ipAddress |
String |
Contains the IP address of the VSOM server |
name |
String |
Contain the name of the VSOM server |
VtgContainerVO
The VtgContainerVO value object contains an array of summary information about one or more VTGs.
Table 1-79 describes the attributes of this value object.
Table 1-79 VtgContainerVO Attributes
|
|
|
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 |
VtgDetailContainerVO
The VtgDetailContainerVO value object contains an array of detailed information about one or more VTGs.
Table 1-80 describes the attributes of this value object.
Table 1-80 VtgDetailContainerVO Attributes
|
|
|
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 |
VtgDetailVO
The VtgDetailVO value object contains detailed information about a VTG.
Table 1-81 describes the attributes of this value object.
Table 1-81 VtgDetailVO Attributes
|
|
|
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. |
VtgOptionsVO
The VtgOptionsVO value object contains information about options that are configured for a VTG.
Table 1-82 describes the attributes of this value object.
Table 1-82 VtgOptionsVO Attributes
|
|
|
allowVad |
boolean |
Indicates whether VAD is enabled for the VTG ( true means yes and false means no). |
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
|
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-83 describes the attributes of this value object.
Table 1-83 VtgParticipantContainerVO Attributes
|
|
|
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 |
errorVO |
ErrorVO |
Contains an error code and message, if an exception occurs during function execution |
paginationContext |
PaginationContextVO |
Contains pagination information |
VtgParticipantVO
The VtgParticipantVO value object contains information about a VTG participant (channel, channel group, radio, user, user group, or VTG).
Table 1-84 describes the attributes of this value object.
Table 1-84 VtgParticipantVO Attributes
|
|
|
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). |
VtgUserOptionsVO
The VtgUserOptionsVO value object contains information about user options that are configured for a VTG.
Table 1-85 describes the attributes of this value object.
Table 1-85 VtgUserOptionsVO Attributes
|
|
|
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
|
VtgVO
The VtgVO value object contains summary information about a VTG.
Table 1-86 describes the attributes of this value object.
Table 1-86 VtgVO Attributes
|
|
|
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). |