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

Value Objects

Table Of Contents

Value Objects

Value Objects Overview

Value Objects Descriptions

AddressVO

BooleanVO

ChannelContainerVO

ChannelDetailVO

ChannelGroupContainerVO

ChannelGroupVO

ChannelVO

ClientDescriptorVO

DialAddressContainerVO

DialAddressVO

ErrorVO

IncidentContainerVO

IncidentDetailsVO

IncidentParticipantContainerVO

IncidentParticipantVO

IncidentVO

IncidentVtgOptionsVO

IncidentVtgUserOptionsVO

IntegerVO

JournalContainerVO

JournalDetailsContainerVO

JournalDetailsVO

JournalVO

NotificationAddressContainerVO

NotificationAddressVO

PaginationContextVO

PhoneContainerVO

PhoneVO

PhotoContainerVO

PhotoDetailsVO

PhotoVO

PolicyActionVO

PolicyContainerVO

PolicyDetailsVO

PolicyExecutionStatusContainerVO

PolicyExecutionStatusVO

PolicyTriggerVO

PolicyVO

RadioContainerVO

RadioDetailsVO

RadioVO

ResourceContainerVO

ResourceVO

SessionVO

StringVO

UserContainerVO

UserDetailsVO

UserGroupContainerVO

UserGroupDetailsVO

UserGroupVO

UserRoleContainerVO

UserRoleVO

UserVO

VideoContainerVO

VideoDetailsVO

VideoVO

VtgContainerVO

VtgDetailContainerVO

VtgDetailVO

VtgOptionsVO

VtgParticipantContainerVO

VtgParticipantVO

VtgUserOptionsVO

VtgVO


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

Value Objects Descriptions

Value Objects Overview

The 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

Contains information about the address of a user

BooleanVO

Contains a boolean value that a function returns

ChannelContainerVO

Contains an array of summary information about 1 or more channels

ChannelDetailVO

Contains detailed information about a channel

ChannelGroupContainerVO

Contains an array of summary information about 1 or more channel groups

ChannelGroupVO

Contains summary information about a channel group

ChannelVO

Contains summary information about a channel

ClientDescriptorVO

Contains information about the type of client that connects to a web services session

DialAddressContainerVO

Contains an array of information about 1 or more dial preferences

DialAddressVO

Contains summary information about a dial number

ErrorVO

Contains an error code and error message, if returned by a function

IncidentContainerVO

Contains an array of summary information about 1 or more incidents

IncidentDetailsVO

Contains detailed information about an incident

IncidentParticipantContainerVO

Contains an array of information about 1 or more incident participants

IncidentParticipantVO

Contains summary information about an incident participant

IncidentVO

Contains summary information about an incident

IncidentVtgOptionsVO

Contains summary information about an incident VTG

IncidentVtgUserOptionsVO

Contains summary information about a user in an incident VTG

IntegerVO

Contains an integer value

JournalContainerVO

Contains an array of summary information about 1 or more journals

JournalDetailsContainerVO

Contains an array of detailed information about 1 or more journals

JournalDetailsVO

Contains detailed information about a journal

JournalVO

Contains summary information about a journal

NotificationAddressContainerVO

Contains an array of information about 1 or more notification addresses

NotificationAddressVO

Contains information about a notification address

PaginationContextVO

Contains attributes that designate the format and limits of the output of a function

PhoneContainerVO

Contains an array of information about 1 or more direct dial phones

PhoneVO

Contains summary information about a direct dial phone

PhotoContainerVO

Contains an array of information about 1 or more photographs

PhotoDetailsVO

Contains detailed information about a photograph that has been added to Cisco IPICS

PhotoVO

Contains summary information about a photograph that has been added to Cisco IPICS

PolicyActionVO

Contains information about a policy action

PolicyContainerVO

Contains an array of information about 1 or more policies

PolicyDetailsVO

Contains detailed information about a policy

PolicyExecutionStatusContainerVO

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

PolicyExecutionStatusVO

Contains information about the execution of a policy

PolicyTriggerVO

Contains information about a policy trigger

PolicyVO

Contains summary information about a policy

RadioContainerVO

Contains an array of information about 1 or more radios

RadioDetailsVO

Contains detailed information about a radio

RadioVO

Contains summary information about a radio

ResourceContainerVO

Contains an array of information about 1 or more resources

ResourceVO

Contains information about a resource

SessionVO

Contains a web services session ID

StringVO

Contains a string

UserContainerVO

Contains an array of information about 1 or more users

UserDetailsVO

Contains detailed information about a user

UserGroupContainerVO

Contains an array of information about 1 or more user groups

UserGroupDetailsVO

Contains detailed information about a user group

UserGroupVO

Contains summary information about a user group

UserRoleContainerVO

Contains an array of information about 1 or more Cisco IPICS user roles

UserRoleVO

Contains information about a Cisco IPICS user role

UserVO

Contains summary information about a user

VideoContainerVO

Contains an array of information about 1 or more videos

VideoDetailsVO

Contains detailed information about a video that has been added to Cisco IPICS

VideoVO

Contains summary information about a video that has been added to Cisco IPICS

VtgContainerVO

Contains an array of summary information about 1 or more VTGs

VtgDetailContainerVO

Contains an array of detailed information about 1 or more VTGs

VtgDetailVO

Contains detailed information about a VTG

VtgOptionsVO

Contains information about options that are configured for a VTG

VtgParticipantContainerVO

Contains an array of information about participants in a VTG

VtgParticipantVO

Contains information about a VTG participant

VtgUserOptionsVO

Contains information about user options that are configured for a VTG

VtgVO

Contains summary information about a VTG


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

AddressVO

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

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

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.


BooleanVO

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

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

Table 3-3 BooleanVO Attributes 

Attribute Name
Type
Description

value

boolean

Contains the boolean value that a function returns

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution


ChannelContainerVO

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

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

Table 3-4 ChannelContainerVO Attributes 

Attribute Name
Type
Description

channelVOs

ChannelVO[]

Contains an array of ChannelVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


ChannelDetailVO

The ChannelDetailVO value object contains detailed information about a channel.

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

Table 3-5 ChannelDetailVO Attributes 

Attribute Name
Type
Description

codec

String

Contains codec information about the channel.

colorization

String

Contains the color of the channel that appears in the IDC.

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

1 VAD = voice activity detection


ChannelGroupContainerVO

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

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

Table 3-6 ChannelGroupContainerVO Attributes 

Attribute Name
Type
Description

channelGroupVOs

ChannelGroupVO[]

Contains an array of ChannelGroupVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


ChannelGroupVO

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

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

Table 3-7 ChannelGroupVO Attributes 

Attribute Name
Type
Description

Description

String

Contains a description of the channel group.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

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

Name

String

Contains the name of the channel group, or the name to find when using a Find function.


ChannelVO

The ChannelVO value object contains summary information about a channel.

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

Table 3-8 ChannelVO Attributes 

Attribute Name
Type
Description

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

id

int

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

isSecure

boolean

Indicates whether the channel is designated as secure (true means yes and false means no).

name

String

Contains the name of the channel


ClientDescriptorVO

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

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

Table 3-9 ClientDescriptorVO Attributes 

Attribute Name
Type
Description

clientId

String

Contains the ID of the client

clientType

String

Contains the type of client (for example, IDC or iPhone)

cpuMhz

float

Not used

hwVersion

String

Not used

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


DialAddressContainerVO

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

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

Table 3-10 DialAddressContainerVO Attributes 

Attribute Name
Type
Description

dialAddressVOs

DialAddressVO[]

Contains an array of DialAddressVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


DialAddressVO

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

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

Table 3-11 DialAddressVO Attributes 

Attribute Name
Type
Description

dialNumber

String

Contains dial number, which is the phone number that the policy engine uses when dialing out.

dialPreferenceOrder

int

Contains the order of telephone numbers at which Cisco IPICS contacts a user when a user-associated policy executes or when a dispatcher initiates a dial out to invite a user to join an active VTG.

errorVO

ErroVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the dial address. Cisco IPICS generated this ID when the dial address was created in Cisco IPICS.

type

String

Contains type of dial number.


ErrorVO

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

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

Table 3-12 ErrorVO Attributes 

Attribute Name
Type
Description

errorCode

String

Contains an error code

errorMessage

String

Contains an error message that a function returns


IncidentContainerVO

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

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

Table 3-13 ncidentContainerVO Attributes 

Attribute Name
Type
Description

incidentVOs

IncidentVO[]

Contains an array of IncidentVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


IncidentDetailsVO

The IncidentDetailsVO value object contains detailed information about an incident.

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

Table 3-14 IncidentDetailsVO Attributes 

Attribute Name
Type
Description

address

AddressVO

Contains the physical address where the incident is taking place.

commanderId

int

Not used.

createDate

Date

Contains the date and time at which the incident was created.

description

String

Contains a description of the incident.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the incident. Cisco IPICS generated this ID when the incident was created.

incidentVtgId

int

Contains the ID of the incident VTG that is associated with the incident, if an associated incident VTG exists.

name

String

Contains the full the name of the incident.

opsviewId

int

Contains the ID of the ops view to which the incident belongs.

ownerId

int

Contains the ID of the user who created the incident. Cisco IPICS generated this ID when the user was created in Cisco IPICS.

pmcRegionId

int

Contains the preferred region in which the ICD displays the incident.

priority

short

Not used.

resourceType

String

Not used.

shortName

String

Not used.

startDate

Date

Contains the date and time at which the incident was activated.

state

String

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

stopDate

Date

Contains the date and time at which the incident was deactivated.


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 3-15 describes the attributes of this value object.

Table 3-15 IncidentParticipantContainerVO Attributes 

Attribute Name
Type
Description

incidentParticipantVOs

incidentParticipantVO

Contains an array of IncidentParticiapntVO value objects

ErrorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


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 3-16 describes the attributes of this value object.

Table 3-16 IncidentParticipantVO Attributes 

Attribute Name
Type
Description

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the incident participant. Cisco IPICS generated this ID when the incident participant was added.

name

String

Contains the name of the incident participant.

participantType

String

Contains the type of the incident resource.


IncidentVO

The IncidentVO value object contains summary information about an incident.

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

Table 3-17 IncidentVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the incident.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the incident. Cisco IPICS generated this ID when the incident was created.

incidentVtgId

int

Contains the ID of the incident VTG that is associated with the incident, if an associated incident VTG exists.

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 3-18 describes the attributes of this value object.

Table 3-18 IncidentVtgOptionsVO Attributes 

Attribute Name
Type
Description

errorVO

ErroVO

Contains an error code and message, if an exception occurs during function execution.

latch

boolean

Indicates whether the incident VTG is latchable (true means yes and false means no).

listenOnly

boolean

Indicates whether incident VTG is configured as listen only (true means yes and false means no).

rxMute

String

Indicates whether audio to or from the incident VTG is muted when the PTT button is pressed in the IDC or on an IP phone. Valid values are:

all-When PTT is engaged, RX (receive transmission) is muted on all voice resources

this-When PTT is engaged, RX is muted on this incident VTG

none-When PTT is engaged, no voice resources are muted

allowVad

boolean

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

pmcRegionId

int

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

1 VAD = voice activity detection


IncidentVtgUserOptionsVO

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

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

Table 3-19 IncidentVtgUserOptionsVO Attributes 

Attribute Name
Type
Description

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

latch

boolean

Indicates whether the incident VTG is latchable (true means yes and false means no)

listenOnly

boolean

Indicates whether incident VTG is configured as listen only (true means yes and false means no).

rxMute

boolean

Indicates whether audio to or from the incident VTG is muted when the PTT button is pressed in the IDC or on an IP phone (true means yes and false means no).


IntegerVO

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

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

Table 3-20 IntegerVO Attributes 

Attribute Name
Type
Description

value

int

Contains an integer value that a function returns

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution


JournalContainerVO

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

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

Table 3-21 JournalContainerVO Attributes 

Attribute Name
Type
Description

journalVOs

JournalVO[]

Contains an array of JournalVO value objects

ErrorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


JournalDetailsContainerVO

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

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

Table 3-22 JournalDetailsContainerVO Attributes 

Attribute Name
Type
Description

journals

JournalDetailsVO[]

Contains an array of JournalDetailsVO value objects

ErrorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


JournalDetailsVO

The JournalDetailsVO value object contains detailed information about a journal.

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

Table 3-23 JournalDetailsVO Attributes 

Attribute Name
Type
Description

address

AddressVO

Not used.

created

Date

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

description

String

Not used.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the journal. Cisco IPICS generated this ID when the journal was created.

language

String

Contains the language of the journal text.

message

String

Contains the journal text.

name

String

Not used.

opsViewId

int

Contains the ID of the ops view that is associated with the user who created the journal entry.

owner

UserVO

Not used.

ownerId

int

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

resourceType

String

Not used.

url

String

Not used.


JournalVO

The JournalVO value object contains summary information about a journal.

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

Table 3-24 JournalVO Attributes 

Attribute Name
Type
Description

created

Date

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

description

String

Not used.

errorVO

ErroVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the journal. Cisco IPICS generated this ID when the journal was created.

message

String

Contains the journal text.

name

String

Not used.

owner

UserVO

Not used.

ownerId

int

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

resourceType

String

Not used.

title

String

Not used.

url

String

Not used.


NotificationAddressContainerVO

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

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

Table 3-25 NotificationAddressContainerVO Attributes 

Attribute Name
Type
Description

notificationAddressVOs

NotificationAddressVO[]

Contains an array of NotificationAddressVO value objects

ErrorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


NotificationAddressVO

The NotificationAddressVO value object contains information about a notification address.

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

Table 3-26 NotificationAddressVO Attributes 

Attribute Name
Type
Description

errorVO

ErroVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the notification address. Cisco IPICS generated this ID when the notification address was added in Cisco IPICS.

notificationAddress

String

Contains the e-mail address, pager number, of phone number of the device that is to receive the notification.

type

String

Contains the type of notification (email, pager, or sms).


PaginationContextVO

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

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

Table 3-27 PaginationContextVO Attributes 

Attribute Name
Type
Description

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.


PhoneContainerVO

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

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

Table 3-28 PhoneContainerVO Attributes 

Attribute Name
Type
Description

phoneVOs

PhoneVO[]

Contains an array of PhoneVO value objects

ErrorVO

ErroVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


PhoneVO

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

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

Table 3-29 PhoneVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the phone number (for example, business or home).

dialDestination

String

Contains the number to dial for the phone.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the phone, which Cisco IPICS generates when you add the phone to Cisco IPICS.

name

String

Contains the direct dial phone label.

ownerId

int

Contains Cisco IPICS ID of the user who created the phone.

sipdn

String

Contains the unique ID of the phone, which Cisco IPICS generates when you add the phone to Cisco IPICS.


PhotoContainerVO

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

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

Table 3-30 PhoneContainerVO Attributes 

Attribute Name
Type
Description

photoVOs

PhotoVO[]

Contains an array of PhotoVO value objects

ErrorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


PhotoDetailsVO

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

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

Table 3-31 PhotoDetailsVO Attributes 

Attribute Name
Type
Description

address

AddressVO

Contains information about the physical address where the photograph was taken.

autoDelete

boolean

If true, the Cisco IPICS database record for the photograph and the photograph file (if the file exists on the Cisco IPICS server) are deleted automatically when all incidents with which the photograph are associated are deleted. If false, the Cisco IPICS database record for the photograph and the photograph file are never deleted automatically.

colorDepth

short

Contains color depth information about the photograph.

created

Date

Contains the date and time at which the photograph was added to IPICS.

description

String

Contains a description of the photograph.

dimension

String

Not used.

direction

String

Not used.

encoding

String

Not used.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

height

int

Not used.

id

int

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

name

String

Not used.

opsViewId

int

Contains the ops view with which the photograph is associated.

owner

UserVO

Not used.

ownerId

int

Contains the unique ID of the user who added the photograph. Cisco IPICS generated this ID when the user was added in Cisco IPICS.

palette

String

Not used.

resourceType

String

Not used.

spectrum

String

Not used.

title

String

Contains a brief title, or name, of the photograph.

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 3-32 describes the attributes of this value object.

Table 3-32 PhotoVO Attributes 

Attribute Name
Type
Description

autoDelete

boolean

If true, the Cisco IPICS database record for the photograph and the photograph file (if the file exists on the Cisco IPICS server) are deleted automatically when all incidents with which the photograph are associated are deleted. If false, the Cisco IPICS database record for the photograph and the photograph file are never deleted automatically.

created

Date

Contains the date and time at which the photograph was created.

description

String

Contains a description of the photograph.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

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

name

String

Not used.

opsViewId

int

Contains the ops view with which the photograph is associated.

owner

UserVO

Not used.

ownerId

int

Contains the unique ID of the user who added the photograph. Cisco IPICS generated this ID when the user was added in Cisco IPICS.

resourceType

String

Not used

title

String

Contains a brief title, or name, of the photograph.

url

String

Contains the URL of the photograph.


PolicyActionVO

The PolicyActionVO value object Contains information about a policy action.

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

Table 3-33 PolicyActionVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the policy action.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

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

message

String

Contains the text of the message that a policy notification action sends

name

String

Contains the name of the policy.

startTime

String

Contains the configured start date and time for the policy.

status

String

Contains the status of the policy, such as such as Successful, Executing, or Failed.

type

String

Contains policy action type.


PolicyContainerVO

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

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

Table 3-34 PolicyContainerVO Attributes 

Attribute Name
Type
Description

policyVOs

PolicyVO[]

Contains an array of PolicyVO value objects

ErrorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


PolicyDetailsVO

The PolicyDetailsVO value object contains detailed information about a policy.

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

Table 3-35 PolicyDetailsVO Attributes 

Attribute Name
Type
Description

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 3-36 describes the attributes of this value object.

Table 3-36 PolicyExecutionStatusContainerVO Attributes 

Attribute Name
Type
Description

policyExecutionStatusVOs

policyExecutionStatusVO[]

Contains an array of PolicyExecutionStatusVO value objects

ErrorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


PolicyExecutionStatusVO

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

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

Table 3-37 PolicyExecutionStatusVO Attributes 

Attribute Name
Type
Description

actions

PolicyActionVO[]

Contains and array of PolicyActionVO value objects.

description

String

Contains a description of the policy.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

executionDate

String

Contains the date and time at which the policy last executed

executionStatus

String

Contains latest execution status of the policy, such as Successful, Executing, or Failed.

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 3-38 describes the attributes of this value object.

Table 3-38 PolicyTriggerVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the policy trigger.

errorVO

ErroVO

Contains an error code and message, if an exception occurs during function execution.

id

int

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

name

String

Contains the name of the policy trigger.


PolicyVO

The PolicyVO value object contains summary information about a policy.

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

Table 3-39 PolicyVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the policy.

errorVO

ErroVO

Contains an error code and message, if an exception occurs during function execution.

id

int

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

name

String

Contains the name of the policy.


RadioContainerVO

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

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

Table 3-40 TheRadioContai Attributes 

Attribute Name
Type
Description

radioVOs

RadioVO[]

Contains an array of RadioVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


RadioDetailsVO

The RadioDetailsVO value object contains detailed information about a radio.

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

Table 3-41 RadioDetailsVO Attributes 

Attribute Name
Type
Description

control

String

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

description

String

Contains a description of the radio.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the radio, which Cisco IPICS generates when you add the radio to Cisco IPICS.

location

int

Contains the location that was configured for the radio when the radio was added to Cisco IPICS.

name

String

Contains the name of the radio.

type

String

Indicates the type of the radio (Nextel or EFJ).


RadioVO

The RadioVO value object contains summary information about a radio.

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

Table 3-42 RadioVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the radio.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

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 3-43 describes the attributes of this value object.

Table 3-43 ResourceContainerVO Attributes 

Attribute Name
Type
Description

resources

ResourceVO[]

Contains an array of ResourceVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


ResourceVO

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

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

Table 3-44 ResourceVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the resource.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the resource, which Cisco IPICS generates when you add the resource to Cisco IPICS.

name

String

Contains the name of the resource.

resourceType

String

Contains the type of the resource.


SessionVO

The SessionVO value object contains a web services session ID.

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

Table 3-45 SessionVO Attributes 

Attribute Name
Type
Description

sessionId

String

Contains the ID of the current web services session

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution


StringVO

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

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

Table 3-46 StringVO Attributes 

Attribute Name
Type
Description

value

String

Contains the string that a function returns

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution


UserContainerVO

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

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

Table 3-47 UserContainerVO Attributes 

Attribute Name
Type
Description

userVOs

UserVO[]

Contains an array of UserVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


UserDetailsVO

The UserDetailsVO value object contains detailed information about a user.

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

Table 3-48 UserDetailsVO Attributes 

Attribute Name
Type
Description

allowUnsecurePatch

Boolean

If true, the user can combine secure and unsecure channels in a patch. If false, the user can use only non-secure channels in a patch.

description

String

Contains a description of the user.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

firstName

String

Contains the first name of the user.

id

int

Contains the unique ID of the use, which Cisco IPICS generates when you add the user to Cisco IPICS.

lastName

String

Contains the last name of the user.

name

String

Contains the name of the user to be displayed in the Cisco IPICS Administration Console.

roles

String[]

Contains an array Cisco IPICS roles that are associated with the user.

userLogin

String

Contains the Cisco IPICS user name of the user.


UserGroupContainerVO

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

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

Table 3-49 UserGroupContainerVO Attributes 

Attribute Name
Type
Description

userGroupVOs

UserGtoupVO[]

Contains an array of UserGroupVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


UserGroupDetailsVO

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

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

Table 3-50 UserGroupDetailsVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of user group.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the user group, which Cisco IPICS generates when you add the user group to Cisco IPICS.

name

String

Contains the name of the user group.

users

UserVO[]

Contains an array of UserVO value objects.


UserGroupVO

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

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

Table 3-51 UserGroupVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the user group.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the user group, which Cisco IPICS generates when you add the user group to Cisco IPICS.

name

String

Contains the name of the user group.


UserRoleContainerVO

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

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

Table 3-52 UserRoleContainerVO Attributes 

Attribute Name
Type
Description

userRoleVOs

UserRoleVO[]

Contains an array of UserRoleVO value objects.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


UserRoleVO

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

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

Table 3-53 UserRoleVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the user role.

displayName

String

Contains name of the role as it appears in the Cisco IPICS Administration Console GUI.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the user role, which Cisco IPICS generates when you add the user role to Cisco IPICS.

name

String

Contains the names of the user role.


UserVO

The UserVO value object contains summary information about a user.

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

Table 3-54 UserVO Attributes 

Attribute Name
Type
Description

description

String

Contains a description of the user.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

firstName

String

Contains the first name of the user.

id

int

Contains the unique ID of the user, which Cisco IPICS generates when you add the user to Cisco IPICS.

lastName

String

Contains the last name of the user.

name

String

Contains complete name of the user.

userLogin

String

Contains the Cisco IPICS user name of the user.


VideoContainerVO

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

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

Table 3-55 VideoContainerVO Attributes 

Attribute Name
Type
Description

videoVOs

VideoVO[]

Contains and array of VideoVO value objects

errorVO

ErroVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


VideoDetailsVO

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

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

Table 3-56 VideoDetailsVO Attributes 

Attribute Name
Type
Description

address

AddressVO

Contains the physical address where the photograph was taken.

autoDelete

boolean

If true, the Cisco IPICS database record for the video and the video file (if the file exists on the Cisco IPICS server) are deleted automatically when all incidents with which the video are associated are deleted. If false, the Cisco IPICS database record for the video and the video file are never deleted automatically.

cameraModel

String

Not used.

cameraSrcType

String

Not used.

cameraUrl

String

Not used.

colorDepth

int

Not used.

created

Date

Contains the date and time at which the video was added to Cisco IPICS.

description

String

Contains a description of the video.

dimension

String

Not used.

direction

String

Not used.

encoding

String

Not used.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

has Audio

boolean

Indicates whether video includes audio (true means yes and false means no).

hasPtz

boolean

Not used.

iconUrl

String

Not used.

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 3-57 describes the attributes of this value object.

Table 3-57 VideoVO Attributes 

Attribute Name
Type
Description

autoDelete

boolean

If true, the Cisco IPICS database record for the video and the video file (if the file exists on the Cisco IPICS server) are deleted automatically when all incidents with which the video are associated are deleted. If false, the Cisco IPICS database record for the video and the video file are never deleted automatically.

cameraModel

String

Not used.

cameraSrcType

String

Not used.

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.


VtgContainerVO

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

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

Table 3-58 VtgContainerVO Attributes 

Attribute Name
Type
Description

vtgVOs

VtgVO[]

Contains an array of VtgVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


VtgDetailContainerVO

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

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

Table 3-59 VtgDetailContainerVO Attributes 

Attribute Name
Type
Description

vtgDetails

VtgDetailVO[]

Contains an array of VtgDetailVO value objects

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution

paginationContext

PaginationContextVO

Contains pagination information


VtgDetailVO

The VtgDetailVO value object contains detailed information about a VTG.

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

Table 3-60 VtgDetailVO Attributes 

Attribute Name
Type
Description

defaultVtgId

int

Not used.

description

String

Contains a description of the VTG.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the VTG. Cisco IPICS generates this ID when you add the VTG to Cisco IPICS.

mcastaddr

String

Contains the multicast address that is assigned to the VTG.

name

String

Contains name of the VTG.

port

int

Contains multicast address port number that is assigned to the VTG.

status

String

Contains the current status of the VTG (such as active, inactive, pending)

vtgId

int

Contains the unique ID of the VTG. Cisco IPICS generates this ID when you add the VTG to Cisco IPICS.


VtgOptionsVO

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

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

Table 3-61 VtgOptionsVO Attributes 

Attribute Name
Type
Description

allowVad

boolean

Indicates whether VAD1 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

1 VAD = voice activity detection


VtgParticipantContainerVO

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

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

Table 3-62 VtgParticipantContainerVO Attributes 

Attribute Name
Type
Description

channelGroupParticipants

VtgParticipantVO[]

Contains an array of VtgParticipantVO value objects

channelParticipants

VtgParticipantVO[]

Contains an array of VtgParticipantVO value objects

radioParticipants

VtgParticipantVO[]

Contains an array of VtgParticipantVO value objects

userGroupParticipants

VtgParticipantVO[]

Contains an array of VtgParticipantVO value objects

userParticipants

VtgParticipantVO[]

Contains an array of VtgParticipantVO value objects

vtgParticipants

VtgParticipantVO[]

Contains an array of VtgParticipantVO value objects

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 3-63 describes the attributes of this value object.

Table 3-63 VtgParticipantVO Attributes 

Attribute Name
Type
Description

allocationStatus

String

Contains the status of the allocation of the participant to the VTG.

allocationStatusMessage

String

Contains a message that relates to the allocation status.

description

String

Contains a description of the VTG participant.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

groupId

int

Not used.

id

int

Contains the unique ID of the association between the participant and the VTG. Cisco IPICS generates this ID when the VTG is activated.

name

String

Contains the name of the VTG participant.

participantId

int

Contains the unique ID of the participant that is associated with the VTG. Cisco IPICS generated this ID when the participant was created in Cisco IPICS.

resourceType

String

Contains type of vtg participant (channel / radio).

status

String

Contains status of vtg participant.

userLogin

String

Contains the Cisco IPICS user name of a user participant.

isSecure

boolean

Indicates whether the channel is designated as secure (true means yes and false means no).


VtgUserOptionsVO

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

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

Table 3-64 VtgUserOptionsVO Attributes 

Attribute Name
Type
Description

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

latch

boolean

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

listenOnly

boolean

Indicates whether listen only mode is configured for the VTG user (true means yes and false means no).

rxMute

boolean

Indicates whether audio to or from the incident VTG is muted when the PTT button is pressed in the IDC or on an IP phone. Valid values are:

all—When PTT is engaged, RX (receive transmission) is muted on all voice resources

this—When PTT is engaged, RX is muted on this incident VTG

none—When PTT is engaged, no voice resources are muted


VtgVO

The VtgVO value object contains summary information about a VTG.

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

Table 3-65 VtgVO Attributes 

Attribute Name
Type
Description

description

String

Contains description of the VTG.

errorVO

ErrorVO

Contains an error code and message, if an exception occurs during function execution.

id

int

Contains the unique ID of the VTG. Cisco IPICS generates this ID when you add the VTG to Cisco IPICS.

name

String

Contains the name of the VTG.

status

String

Contains the current status of VTG (such as active, inactive, pending).