value objects - cisco.com · functions,” use value objects to describe characteristics of various...

Cisco IOL-21552-01

C H A P T E R 3
Value Objects
This 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 3-1

• Value Objects Descriptions, page 3-4

Value Objects OverviewThe Cisco IPICS web services API functions that are explained in Chapter 2, “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 3-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 3-1 API Value Object Summary

Value Name and Reference Description

AddressVO, page 3-4 Contains information about the address of a user

BooleanVO, page 3-4 Contains a boolean value that a function returns

ChannelContainerVO, page 3-5 Contains an array of summary information about 1 or more channels

ChannelDetailVO, page 3-5 Contains detailed information about a channel

ChannelGroupContainerVO, page 3-7 Contains an array of summary information about 1 or more channel groups

ChannelGroupVO, page 3-7 Contains summary information about a channel group

ChannelVO, page 3-7 Contains summary information about a channel

ClientDescriptorVO, page 3-8 Contains information about the type of client that connects to a web services session

DialAddressContainerVO, page 3-8 Contains an array of information about 1 or more dial preferences

DialAddressVO, page 3-9 Contains summary information about a dial number

ErrorVO, page 3-9 Contains an error code and error message, if returned by a function

3-1PICS API Reference Guide, Cisco IPICS Release 4.0

Chapter 3 Value ObjectsValue Objects Overview

IncidentContainerVO, page 3-10 Contains an array of summary information about 1 or more incidents

IncidentDetailsVO, page 3-10 Contains detailed information about an incident

IncidentParticipantContainerVO, page 3-11

Contains an array of information about 1 or more incident participants

IncidentParticipantVO, page 3-11 Contains summary information about an incident participant

IncidentVO, page 3-12 Contains summary information about an incident

IncidentVtgOptionsVO, page 3-12 Contains summary information about an incident VTG

IncidentVtgUserOptionsVO, page 3-13 Contains summary information about a user in an incident VTG

IntegerVO, page 3-13 Contains an integer value

JournalContainerVO, page 3-14 Contains an array of summary information about 1 or more journals

JournalDetailsContainerVO, page 3-14 Contains an array of detailed information about 1 or more journals

JournalDetailsVO, page 3-14 Contains detailed information about a journal

JournalVO, page 3-15 Contains summary information about a journal

NotificationAddressContainerVO, page 3-16

Contains an array of information about 1 or more notification addresses

NotificationAddressVO, page 3-16 Contains information about a notification address

PaginationContextVO, page 3-16 Contains attributes that designate the format and limits of the output of a function

PhoneContainerVO, page 3-17 Contains an array of information about 1 or more direct dial phones

PhoneVO, page 3-17 Contains summary information about a direct dial phone

PhotoContainerVO, page 3-18 Contains an array of information about 1 or more photographs

PhotoDetailsVO, page 3-18 Contains detailed information about a photograph that has been added to Cisco IPICS

PhotoVO, page 3-19 Contains summary information about a photograph that has been added to Cisco IPICS

PolicyActionVO, page 3-20 Contains information about a policy action

PolicyContainerVO, page 3-21 Contains an array of information about 1 or more policies

PolicyDetailsVO, page 3-21 Contains detailed information about a policy

PolicyExecutionStatusContainerVO, page 3-22

Contains an array of information about the execution of 1 or more policies

PolicyExecutionStatusVO, page 3-22 Contains information about the execution of a policy

PolicyTriggerVO, page 3-22 Contains information about a policy trigger

PolicyVO, page 3-23 Contains summary information about a policy

Table 3-1 API Value Object Summary (continued)


3-2Cisco IPICS API Reference Guide, Cisco IPICS Release 4.0

OL-21552-01

Chapter 3 Value ObjectsValue Objects Overview

RadioContainerVO, page 3-23 Contains an array of information about 1 or more radios

RadioDetailsVO, page 3-23 Contains detailed information about a radio

RadioVO, page 3-24 Contains summary information about a radio

ResourceContainerVO, page 3-24 Contains an array of information about 1 or more resources

ResourceVO, page 3-25 Contains information about a resource

SessionVO, page 3-25 Contains a web services session ID

StringVO, page 3-25 Contains a string

UserContainerVO, page 3-26 Contains an array of information about 1 or more users

UserDetailsVO, page 3-26 Contains detailed information about a user

UserGroupContainerVO, page 3-27 Contains an array of information about 1 or more user groups

UserGroupDetailsVO, page 3-27 Contains detailed information about a user group

UserGroupVO, page 3-27 Contains summary information about a user group

UserRoleContainerVO, page 3-28 Contains an array of information about 1 or more Cisco IPICS user roles

UserRoleVO, page 3-28 Contains information about a Cisco IPICS user role

UserVO, page 3-28 Contains summary information about a user

VideoContainerVO, page 3-29 Contains an array of information about 1 or more videos

VideoDetailsVO, page 3-29 Contains detailed information about a video that has been added to Cisco IPICS

VideoVO, page 3-31 Contains summary information about a video that has been added to Cisco IPICS

VtgContainerVO, page 3-32 Contains an array of summary information about 1 or more VTGs

VtgDetailContainerVO, page 3-32 Contains an array of detailed information about 1 or more VTGs

VtgDetailVO, page 3-32 Contains detailed information about a VTG

VtgOptionsVO, page 3-33 Contains information about options that are configured for a VTG

VtgParticipantContainerVO, page 3-34 Contains an array of information about participants in a VTG

VtgParticipantVO, page 3-34 Contains information about a VTG participant

VtgUserOptionsVO, page 3-35 Contains information about user options that are configured for a VTG

VtgVO, page 3-36 Contains summary information about a VTG

Table 3-1 API Value Object Summary (continued)



OL-21552-01

Chapter 3 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

AddressVOThe AddressVO value object contains information about the address of a Cisco IPICS user.

Table 3-2 describes the attributes of this value object.

BooleanVOThe BooleanVO value object contains a boolean value that a function returns.


Table 3-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.

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.


OL-21552-01


ChannelContainerVOThe ChannelContainerVO value object contains an array of summary information about one or more channels.


ChannelDetailVO The ChannelDetailVO value object contains detailed information about a channel.


Table 3-3 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

Table 3-4 ChannelContainerVO Attributes


channelVOs ChannelVO[] Contains an array of ChannelVO value objects


paginationContext PaginationContextVO Contains pagination information

Table 3-5 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.


id int Contains the unique ID of the channel. Cisco IPICS generated this ID when the channel was created in Cisco IPICS.


OL-21552-01


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 VAD1 is enabled for the channel (true means yes and false means no).

1. VAD = voice activity detection

Table 3-5 ChannelDetailVO Attributes (continued)



OL-21552-01


ChannelGroupContainerVOThe ChannelGroupContainerVO value object contains an array of summary information about one or more channel groups


ChannelGroupVOThe ChannelGroupVO value object contains summary information about a channel group.


ChannelVOThe ChannelVO value object contains summary information about a channel.


Table 3-6 ChannelGroupContainerVO Attributes


channelGroupVOs ChannelGroupVO[] Contains an array of ChannelGroupVO value objects



Table 3-7 ChannelGroupVO Attributes


Description String Contains a description of the channel group.


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 3-8 ChannelVO Attributes



id int Contains the unique ID of the channel. Cisco IPICS generated this ID when the channel was created in Cisco IPICS.


OL-21552-01


ClientDescriptorVOThe ClientDescriptorVO value object contains information about the type of client that connects to a web services session.


DialAddressContainerVOThe DialAddressContainerVO value object contains an array of information about one or more dial preferences.


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 3-8 ChannelVO Attributes (continued)


Table 3-9 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


OL-21552-01


DialAddressVOThe DialAddressVO value object contains summary information about a dial number.


ErrorVOThe ErrorVO value object contains an error code and message, if a function returns an error.


Table 3-10 DialAddressContainerVO Attributes


dialAddressVOs DialAddressVO[] Contains an array of DialAddressVO value objects



Table 3-11 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.

Table 3-12 ErrorVO Attributes


errorCode String Contains an error code

errorMessage String Contains an error message that a function returns


OL-21552-01


IncidentContainerVOThe ncidentContainerVO value object contains an array of summary information about one or more incidents.


IncidentDetailsVOThe IncidentDetailsVO value object contains detailed information about an incident.


Table 3-13 ncidentContainerVO Attributes


incidentVOs IncidentVO[] Contains an array of IncidentVO value objects



Table 3-14 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.


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.


OL-21552-01


IncidentParticipantContainerVOThe 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.


IncidentParticipantVOThe IncidentParticipantVO value object contains summary information about a resource in an incident. A resource is user, channel, photograph, radio, video, or VTG.


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.

Table 3-14 IncidentDetailsVO Attributes (continued)


Table 3-15 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


Table 3-16 IncidentParticipantVO Attributes



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.


OL-21552-01


IncidentVOThe IncidentVO value object contains summary information about an incident.


IncidentVtgOptionsVOThe IncidentVtgOptionsVO value object contains summary information about an incident VTG,


Table 3-17 IncidentVO Attributes


description String Contains a description of the incident.


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.


shortName String Not used.

state String Indicates the state of the incident (Active or Inactive).

Table 3-18 IncidentVtgOptionsVO Attributes



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).


OL-21552-01


IncidentVtgUserOptionsVOThe IncidentVtgUserOptionsVO value object contains summary information about an incident VTG user.


IntegerVOThe IntegerVO value object contains an integer value that a function returns


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).

pmcRegionId int Contains the preferred region in which the ICD displays the VTG.


Table 3-18 IncidentVtgOptionsVO Attributes (continued)


Table 3-19 IncidentVtgUserOptionsVO Attributes



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).


OL-21552-01


JournalContainerVOThe JournalContainerVO value object contains an array of summary information about one or more journals.


JournalDetailsContainerVOThe JournalDetailsContainerVO value object contains an array of detailed information about one or more journals


JournalDetailsVOThe JournalDetailsVO value object contains detailed information about a journal.


Table 3-20 IntegerVO Attributes


value int Contains an integer value that a function returns


Table 3-21 JournalContainerVO Attributes


journalVOs JournalVO[] Contains an array of JournalVO value objects



Table 3-22 JournalDetailsContainerVO Attributes


journals JournalDetailsVO[] Contains an array of JournalDetailsVO value objects




OL-21552-01


JournalVOThe JournalVO value object contains summary information about a journal.


Table 3-23 JournalDetailsVO Attributes


address AddressVO Not used.

created Date Contains the date and time at which the journal was created.

description String Not used.


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.


url String Not used.

Table 3-24 JournalVO Attributes


created Date Contains the date and time at which the journal was created.

description String Not used.


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.



ownerId int Contains the Cisco IPICS ID of the user who created the journal.


OL-21552-01


NotificationAddressContainerVOThe NotificationAddressContainerVO value object Contains an array of information about one or more notification addresses.


NotificationAddressVOThe NotificationAddressVO value object contains information about a notification address.


PaginationContextVOThe PaginationContextVO value object contains attributes that designate the format and limits of the output of a function.


title String Not used.

url String Not used.

Table 3-24 JournalVO Attributes (continued)


Table 3-25 NotificationAddressContainerVO Attributes


notificationAddressVOs NotificationAddressVO[] Contains an array of NotificationAddressVO value objects



Table 3-26 NotificationAddressVO Attributes



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).


OL-21552-01



PhoneContainerVOThe PhoneContainerVO value object contains an array of information about one or more direct dial phones.


PhoneVOThe PhoneVO value object contains summary information about a direct dial phone.


Table 3-27 PaginationContextVO Attributes


pageNumber int Contains the page number of the display

pageRecords int Contains the number of records to be displayed per page

totalPages int Contains the total number of pages to include in the display output

totalRecords int Contains the total number of records that the request returns.

Table 3-28 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


Table 3-29 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.


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.


OL-21552-01


PhotoContainerVOThe PhotoContainerVO value object Contains an array of information about one or more photographs.


PhotoDetailsVOThe PhotoDetailsVO value object contains detailed information about a photograph that has been added to Cisco IPICS.


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 3-29 PhoneVO Attributes (continued)


Table 3-30 PhoneContainerVO Attributes


photoVOs PhotoVO[] Contains an array of PhotoVO value objects



Table 3-31 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.


OL-21552-01


PhotoVOThe PhotoVO value object contains summary information about a photograph that has been added to Cisco IPICS.


dimension String Not used.

direction String Not used.

encoding String Not used.


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.


opsViewId int Contains the ops view with which the photograph is associated.


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.


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.

Table 3-31 PhotoDetailsVO Attributes (continued)



OL-21552-01


PolicyActionVOThe PolicyActionVO value object Contains information about a policy action.


Table 3-32 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.


id int Contains the unique ID of the photograph. Cisco IPICS generated this ID when the photograph was added in Cisco IPICS.


opsViewId int Contains the ops view with which the photograph is associated.


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.

Table 3-33 PolicyActionVO Attributes


description String Contains a description of the policy action.


id int Contains the unique ID of the policy action. Cisco IPICS generated this ID when the policy action was created in Cisco IPICS.


OL-21552-01


PolicyContainerVOThe PolicyContainerVO value object contains an array of information about 1 or more policies.


PolicyDetailsVOThe PolicyDetailsVO value object contains detailed information about a policy.


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 3-33 PolicyActionVO Attributes (continued)


Table 3-34 PolicyContainerVO Attributes


policyVOs PolicyVO[] Contains an array of PolicyVO value objects



Table 3-35 PolicyDetailsVO Attributes


actions PolicyActionVO[] Contains an array of PolicyActionVO value objects.

description String Contains a description of the policy.


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.


OL-21552-01


PolicyExecutionStatusContainerVOThe PolicyExecutionStatusContainerVO value object contains an array of information about the execution of one or more policies.


PolicyExecutionStatusVOThe PolicyExecutionStatusVO value object contains information about the execution of a policy.


PolicyTriggerVOThe PolicyTriggerVO value object contains detailed about a policy trigger.


Table 3-36 PolicyExecutionStatusContainerVO Attributes


policyExecutionStatusVOs policyExecutionStatusVO[] Contains an array of PolicyExecutionStatusVO value objects



Table 3-37 PolicyExecutionStatusVO Attributes


actions PolicyActionVO[] Contains and array of PolicyActionVO value objects.



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.


statusMessage String Contains information about the execution of the policy.


OL-21552-01


PolicyVOThe PolicyVO value object contains summary information about a policy.


RadioContainerVOTheRadioContainerVO value object contains an array of information about one or more radios.


RadioDetailsVOThe RadioDetailsVO value object contains detailed information about a radio.

Table 3-38 PolicyTriggerVO Attributes


description String Contains a description of the policy trigger.


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 3-39 PolicyVO Attributes




id int Contains the unique ID of the policy, which Cisco IPICS generates when you add the policy to Cisco IPICS.


Table 3-40 TheRadioContai Attributes


radioVOs RadioVO[] Contains an array of RadioVO value objects




OL-21552-01



RadioVOThe RadioVO value object contains summary information about a radio.


ResourceContainerVOThe ResourceContainerVO value object contains an array of information about one or more resources (channels, radios, users, and VTGs).


Table 3-41 RadioDetailsVO Attributes


control String Contains control type of the radio (serial or tone).

description String Contains a description of the radio.


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 3-42 RadioVO Attributes


description String Contains a description of the radio.


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).


OL-21552-01


ResourceVOThe ResourceVO value object contains information about a resource (channel, radio, user, or VTG).


SessionVOThe SessionVO value object contains a web services session ID.


StringVOThe StringVO value object stores a string that a function returns.


Table 3-43 ResourceContainerVO Attributes


resources ResourceVO[] Contains an array of ResourceVO value objects



Table 3-44 ResourceVO Attributes


description String Contains a description of the resource.


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.

Table 3-45 SessionVO Attributes


sessionId String Contains the ID of the current web services session



OL-21552-01


UserContainerVOThe UserContainerVO value object contains an array of information about 1 or more users.


UserDetailsVOThe UserDetailsVO value object contains detailed information about a user.


Table 3-46 StringVO Attributes


value String Contains the string that a function returns


Table 3-47 UserContainerVO Attributes


userVOs UserVO[] Contains an array of UserVO value objects



Table 3-48 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.


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.


OL-21552-01


UserGroupContainerVOThe UserGroupContainerVO value object contains an array of information about one or more user groups.


UserGroupDetailsVOThe UserGroupDetailsVO value object contains detailed information about a user group.


UserGroupVOThe UserGroupVO value object contains summary information about a user group.


Table 3-49 UserGroupContainerVO Attributes


userGroupVOs UserGtoupVO[] Contains an array of UserGroupVO value objects



Table 3-50 UserGroupDetailsVO Attributes


description String Contains a description of user group.


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 3-51 UserGroupVO Attributes


description String Contains a description of the user group.



OL-21552-01


UserRoleContainerVOThe UserRoleContainerVO value object contains an array of information about one or more Cisco IPICS user roles.


UserRoleVOThe UserRoleVO value object contains information about a Cisco IPICS user role.


UserVOThe UserVO value object contains summary information about a user.


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 3-51 UserGroupVO Attributes (continued)


Table 3-52 UserRoleContainerVO Attributes


userRoleVOs UserRoleVO[] Contains an array of UserRoleVO value objects.



Table 3-53 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.


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.


OL-21552-01


VideoContainerVOThe VideoContainerVO value object contains an array of information about one or more videos.


VideoDetailsVOThe VideoDetailsVO value object contains detailed information about a video that has been added to Cisco IPICS.


Table 3-54 UserVO Attributes


description String Contains a description of the user.


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.

Table 3-55 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



OL-21552-01


Table 3-56 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.


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.


opsViewId int Contains the ID of the ops view that is associated with the video.


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.


OL-21552-01


VideoVOThe VideoVO value object contains summary information about a video that has been added to Cisco IPICS.



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 3-56 VideoDetailsVO Attributes (continued)


Table 3-57 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.


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


opsViewId int Contains the ID of the ops view that is associated with the video.



OL-21552-01


VtgContainerVOThe VtgContainerVO value object contains an array of summary information about one or more VTGs.


VtgDetailContainerVOThe VtgDetailContainerVO value object contains an array of detailed information about one or more VTGs.


VtgDetailVOThe VtgDetailVO value object contains detailed information about a VTG.

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.


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 3-57 VideoVO Attributes (continued)


Table 3-58 VtgContainerVO Attributes


vtgVOs VtgVO[] Contains an array of VtgVO value objects



Table 3-59 VtgDetailContainerVO Attributes


vtgDetails VtgDetailVO[] Contains an array of VtgDetailVO value objects




OL-21552-01



VtgOptionsVOThe VtgOptionsVO value object contains information about options that are configured for a VTG.


Table 3-60 VtgDetailVO Attributes


defaultVtgId int Not used.

description String Contains a description of the VTG.


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.

Table 3-61 VtgOptionsVO Attributes


allowVad boolean Indicates whether VAD1 is enabled for the VTG (true means yes and false means no).


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).


OL-21552-01


VtgParticipantContainerVOThe VtgParticipantContainerVO value object contains an array of detailed information about VTG participants (channels, channel groups, radios, users, user groups, and VTGs).


VtgParticipantVOThe VtgParticipantVO value object contains information about a VTG participant (channel, channel group, radio, user, user group, or VTG).

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 3-61 VtgOptionsVO Attributes (continued)


Table 3-62 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




OL-21552-01



VtgUserOptionsVOThe VtgUserOptionsVO value object contains information about user options that are configured for a VTG.


Table 3-63 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.


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).

Table 3-64 VtgUserOptionsVO Attributes



latch boolean Indicates whether the latch function is configured for use by the VTG user (true means yes and false means no).


OL-21552-01


VtgVOThe VtgVO value object contains summary information about a VTG.


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 3-64 VtgUserOptionsVO Attributes (continued)


Table 3-65 VtgVO Attributes


description String Contains description of the VTG.


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).


OL-21552-01

value objects - cisco.com · functions,” use value objects to describe characteristics of various...

Documents