Contents


Alarm List

Alarm List
Camera DI
Camera DO
Camera Motion
Camera PIR
Camera Tampering
Camera Disconnected
Storage Failure
Storage Full
Storage Void
Station DI
Station DO
Fan Error


Alarm XML Schema

XML message format

<xs:complexType name="Alarm">
	<xs:sequence>
		<xs:element name="AlarmID" type="xs:integer"/>
		<xs:element name="Name" type="xs:string"/>
		<xs:element name="Description" type="xs:string"/>
		<xs:element name="UranusEvent" type="vv:UranusEvent"/>
		<xs:element name="Status" type="vv:AlarmStatus"/>
	</xs:sequence>
</xs:complexType>
AlarmID         : The identify string of alarm.
Name     		: The name of alarm.
Description     : The description of alarm.
UranusEvent     : The content of trigger condition.
Status     		: The status of alarm.

<xs:complexType name="UranusEvent">
	<xs:sequence>
		<xs:element name="Type" type="vv:EventNotificationType"/>
		<xs:choice>
			<!-- Camera Event -->
			<xs:element name="CamEvent" type="vv:CamEventNotification"/>
			<!-- Status Event -->
			<xs:element name="CamConn" type="vv:CamConnEvent"/>
			<xs:element name="StorageConn" type="vv:StorageConnEvent"/>
			<xs:element name="StorageCap" type="vv:StorageCapEvent"/>
			<xs:element name="DIOStatus" type="vv:DIOStatusEvent"/>
			<xs:element name="FanStatus" type="vv:FanStatusEvent"/>			
		</xs:choice>
	</xs:sequence>
</xs:complexType>
<xs:simpleType name="EventNotificationType">
    <xs:restriction base="xs:string">
        <!-- Camera Event -->
        <xs:enumeration value="CamEvent"/>
        <!-- Status Event -->
        <xs:enumeration value="CamConn"/>
        <xs:enumeration value="StorageConn"/>
        <xs:enumeration value="StorageCapacity"/>
        <xs:enumeration value="DIOStatus"/>
        <xs:enumeration value="FanStatus"/>
    </xs:restriction>
</xs:simpleType>
<xs:complexType name="CamEventNotification">
	<xs:sequence>
		<xs:element name="Event" type="vv:CamEventInfo"/>
	</xs:sequence>
</xs:complexType>
<xs:complexType name="CamEventInfo">
	<xs:sequence>
		<xs:element name="CamName" type="xs:string"/>
		<xs:element name="RefName" type="xs:string"/>
		<xs:element name="EventType" type="vv:CamEventType"/>
		<xs:element name="EventTime" type="xs:string"/>
		<xs:element name="ServerTime" type="xs:string"/>
		<xs:element name="DI" type="vv:EvnDIO"/>
		<xs:element name="DO" type="vv:EvnDIO"/>
		<xs:element name="Motion" type="vv:CamEvnMotion"/>
		<xs:element name="PIR" type="vv:CamEvnPIR"/>
		<xs:element name="Tampering" type="vv:CamEvnTampering"/>
	</xs:sequence>
	<xs:attribute name="isRec" type="xs:boolean" use="optional"/>
</xs:complexType>
CamName   : Camera ID
RefName   : Camera name
EventType : Alarm trigger type
EventTime : The camera time when the alarm is triggered
ServerTime: The server time when the alarm is triggered
isRec     : Indicate if the camera that the alarm belongs to is in recording status or not

<xs:simpleType name="CamEventType">
    <xs:restriction base="xs:string">
        <xs:enumeration value="DI"/>
        <xs:enumeration value="DO"/>
        <xs:enumeration value="Motion"/>
        <xs:enumeration value="PIR"/>
        <xs:enumeration value="Tampering"/>
    </xs:restriction>
</xs:simpleType>
<xs:complexType name="EvnDIO">
	<xs:sequence>
		<xs:element name="Index" type="xs:int"/>
		<xs:element name="Value" type="xs:string"/>
	</xs:sequence>
</xs:complexType>
<xs:complexType name="CamEvnMotion">
    <xs:sequence>
        <xs:element name="Index" type="xs:int"/>
        <xs:element name="Percent" type="xs:int"/>
    </xs:sequence>
</xs:complexType>
<xs:complexType name="CamEvnPIR">
    <xs:sequence>
        <xs:element name="Index" type="xs:int"/>
        <xs:element name="Value" type="xs:string"/>
    </xs:sequence>
</xs:complexType>
<xs:complexType name="CamEvnTampering">
    <xs:sequence>
        <xs:element name="Value" type="xs:string"/>
    </xs:sequence>
</xs:complexType>
<xs:complexType name="CamConnEvent">
	<xs:sequence>
		<xs:element name="CamName" type="xs:string"/>
		<xs:element name="RefName" type="xs:string"/>
		<xs:element name="ServerTime" type="xs:string"/>
		<xs:element name="State">
			<xs:simpleType>
				<xs:restriction base="xs:string">
					<xs:enumeration value="Connected"/>
					<xs:enumeration value="Lost"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:element>
	</xs:sequence>
</xs:complexType>
<xs:complexType name="StorageConnEvent">
	<xs:sequence>
		<xs:element name="ServerTime" type="xs:string"/>
		<xs:element name="Storage" type="xs:string"/>
		<xs:element name="State">
			<xs:simpleType>
				<xs:restriction base="xs:string">
					<xs:enumeration value="Available"/>
					<xs:enumeration value="Unavailable"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:element>
	</xs:sequence>
</xs:complexType>
<xs:complexType name="StorageCapEvent">
	<xs:sequence>
		<xs:element name="ServerTime" type="xs:string"/>
		<xs:element name="Storage" type="xs:string"/>
		<xs:element name="State">
			<xs:simpleType>
				<xs:restriction base="xs:string">
					<xs:enumeration value="Healthy"/>
					<xs:enumeration value="Exhausted"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:element>
	</xs:sequence>
</xs:complexType>
<xs:complexType name="DIOStatusEvent">
	<xs:sequence>
		<xs:element name="DeviceName" type="xs:string"/>
		<xs:element name="RefName" type="xs:string"/>
		<xs:element name="EventType" type="vv:DIOStatusEventType"/>
		<xs:element name="ServerTime" type="xs:string"/>
		<xs:element name="DI" type="vv:EvnDIO"/>
		<xs:element name="DO" type="vv:EvnDIO"/>
	</xs:sequence>
</xs:complexType>
<xs:complexType name="FanStatusEvent">
	<xs:sequence>
		<xs:element name="ServerTime" type="xs:string"/>
		<xs:element name="Fan" type="xs:int"/>
		<xs:element name="State">
			<xs:simpleType>
				<xs:restriction base="xs:string">
					<xs:enumeration value="Fine"/>
					<xs:enumeration value="Error"/>
				</xs:restriction>
			</xs:simpleType>
		</xs:element>
	</xs:sequence>
</xs:complexType>
<xs:complexType name="AlarmStatus">
    <xs:sequence>
        <xs:element name="Priority" type="vv:AlarmPriority"/>
        <xs:element name="State" type="vv:AlarmState"/>
    </xs:sequence>
</xs:complexType>
Priority    : The priority of alarm.
State       : The state of alarm.

<xs:simpleType name="AlarmPriority">
    <xs:restriction base="xs:string">
        <xs:enumeration value="Reminder"/>
        <xs:enumeration value="Minor"/>
        <xs:enumeration value="Normal"/>
        <xs:enumeration value="Major"/>
        <xs:enumeration value="Critical"/>
    </xs:restriction>
</xs:simpleType>
<xs:simpleType name="AlarmState">
    <xs:restriction base="xs:string">
        <xs:enumeration value="New"/>
        <xs:enumeration value="Assigned"/>
        <xs:enumeration value="InProgress"/>
        <xs:enumeration value="Resolved"/>
        <xs:enumeration value="Closed"/>
        <xs:enumeration value="Later"/>
        <xs:enumeration value="Reject"/>
        <xs:enumeration value="Ignore"/>
        <xs:enumeration value="AutoClosed"/>
        <xs:enumeration value="FalseAlarm"/>
    </xs:restriction>
</xs:simpleType>

 

Alarm XML Content

Camera DI

Detail Message of event

CamName   : Camera ID
RefName   : Camera name
EventType : Alarm trigger type
EventTime : The camera time when the alarm is triggered
ServerTime: The server time when the alarm is triggered
Index     : The index value of DI
Value     : The status of DI which means the DI is rising

Example

<Alarm>
    <AlarmID>1</AlarmID>
    <Name>Alarm name</Name>
    <Description>Alarm name</Description>
    <UranusEvent>
        <Type>CamEvent</Type>
        <CamEvent>
            <Event isRec="true">
                <CamName>C_2</CamName>
                <RefName>c_Camera 02</RefName>
                <EventType>DI</EventType>
                <EventTime>2019-12-09T11:48:37.851+08:00</EventTime>
                <ServerTime>2019-12-09T11:48:37.851+08:00</ServerTime>
                <DI>
                    <Index>1</Index>
                    <Value>Rising</Value>
                </DI>
            </Event>
        </CamEvent>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Camera DO

Detail Message of event

CamName   : Camera ID
RefName   : Camera name
EventType : Alarm trigger type
EventTime : The camera time when the alarm is triggered
ServerTime: The server time when the alarm is triggered
Index     : The index value of DO
Value     : The status of DO which means the DO is rising

Example

<Alarm>
    <AlarmID>1</AlarmID>
    <Name>Alarm name</Name>
    <Description>Alarm name</Description>
    <UranusEvent>
        <Type>CamEvent</Type>
        <CamEvent>
            <Event isRec="true">
                <CamName>C_2</CamName>
                <RefName>c_Camera 02</RefName>
                <EventType>DO</EventType>
                <EventTime>2019-12-09T11:48:37.851+08:00</EventTime>
                <ServerTime>2019-12-09T11:48:37.851+08:00</ServerTime>
                <DO>
                    <Index>1</Index>
                    <Value>Rising</Value>
                </DO>
            </Event>
        </CamEvent>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Camera Motion

Detail Message of event

CamName   : Camera ID
RefName   : Camera name
EventType : Alarm trigger type
EventTime : The camera time when the alarm is triggered
ServerTime: The server time when the alarm is triggered
Index     : The index value of motion window
Percent   : The object percentage for the window in detection operation

Example

<Alarm>
    <AlarmID>503</AlarmID>
    <Name>New alarm333</Name>
    <Description>New alarm333</Description>
    <UranusEvent>
        <Type>CamEvent</Type>
        <CamEvent>
            <Event isRec="true">
                <CamName>C_4</CamName>
                <RefName>c_Camera 04</RefName>
                <EventType>Motion</EventType>
                <EventTime>2019-12-09T13:21:54.114+08:00</EventTime>
                <ServerTime>2019-12-09T13:21:54.114+08:00</ServerTime>
                <Motion>
                    <Index>0</Index>
                    <Percent>18</Percent>
                </Motion>
            </Event>
        </CamEvent>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Camera PIR

Detail Message of event

CamName   : Camera ID
RefName   : Camera name
EventType : Alarm trigger type
EventTime : The camera time when the alarm is triggered
ServerTime: The server time when the alarm is triggered
Index     : The index value of PIR
Value     : The status of PIR which means the PIR is triggered

Example

<Alarm>
    <AlarmID>578</AlarmID>
    <Name>New alarm 555</Name>
    <Description>New alarm 555</Description>
    <UranusEvent>
        <Type>CamEvent</Type>
        <CamEvent>
            <Event isRec="true">
                <CamName>C_7</CamName>
                <RefName>c_Camera 07</RefName>
                <EventType>PIR</EventType>
                <EventTime>2019-12-09T13:33:57.718+08:00</EventTime>
                <ServerTime>2019-12-09T13:33:57.718+08:00</ServerTime>
                <PIR>
                    <Index>0</Index>
                    <Value>Trigger</Value>
                </PIR>
            </Event>
        </CamEvent>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Camera Tampering

Detail Message of event

CamName   : Camera ID
RefName   : Camera name
EventType : Alarm trigger type
EventTime : The camera time when the alarm is triggered
ServerTime: The server time when the alarm is triggered
Value     : The status of tampering which means the camera is being tampered

Example

<Alarm>
    <AlarmID>619</AlarmID>
    <Name>New alarm 555</Name>
    <Description>New alarm 555</Description>
    <UranusEvent>
        <Type>CamEvent</Type>
        <CamEvent>
            <Event isRec="true">
                <CamName>C_7</CamName>
                <RefName>c_Camera 07</RefName>
                <EventType>Tampering</EventType>
                <EventTime>2019-12-09T13:43:40.211+08:00</EventTime>
                <ServerTime>2019-12-09T13:43:40.211+08:00</ServerTime>
                <Tampering>
                    <Value>Trigger</Value>
                </Tampering>
            </Event>
        </CamEvent>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Camera Disconnected

Detail Message of event

CamName   : Camera ID
RefName   : Camera name
ServerTime: The server time when the alarm is triggered
State     : The status of camera which means the camera is disconnected

Example

<Alarm>
    <AlarmID>685</AlarmID>
    <Name>New alarm 555</Name>
    <Description>New alarm 555</Description>
    <UranusEvent>
        <Type>CamConn</Type>
        <CamConn>
			<CamName>C_7</CamName>
            <RefName>c_Camera 07</RefName>
            <ServerTime>2019-12-09T14:14:19.941+08:00</ServerTime>
            <State>Lost</State>
        </CamConn>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Storage Failure

Detail Message of event

ServerTime	: The server time when the alarm is triggered
Storage     : The storage name
State     	: The status of storage which means the storage is failure

Example

<Alarm>
    <AlarmID>665</AlarmID>
    <Name>Alarm name</Name>
    <Description>Alarm name</Description>
    <UranusEvent>
        <Type>StorageConn</Type>
        <StorageConn>
            <ServerTime>2019-12-09T13:56:28.550+08:00</ServerTime>
            <Storage>Volume2</Storage>
            <State>Unavailable</State>
        </StorageConn>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Storage Full

Detail Message of event

ServerTime	: The server time when the alarm is triggered
Storage     : Unused
State     	: The status of storage which means the storage is full

Example

<Alarm>
    <AlarmID>665</AlarmID>
    <Name>Alarm name</Name>
    <Description>Alarm name</Description>
    <UranusEvent>
        <Type>StorageCapacity</Type>
        <StorageCap>
            <ServerTime>2019-12-09T13:56:28.550+08:00</ServerTime>
            <Storage></Storage>
            <State>Exhausted</State>
        </StorageCap>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Storage Void

Detail Message of event

ServerTime	: The server time when the alarm is triggered
Storage     : Unused
State     	: The status of storage which means that no recordable volume

Example

<Alarm>
    <AlarmID>9494</AlarmID>
    <Name>void</Name>
    <Description>void</Description>
    <UranusEvent>
        <Type>StorageVoid</Type>
        <StorageVoid>
            <ServerTime>2020-02-06T15:28:53.157+08:00</ServerTime>
            <State>Exhausted</State>
        </StorageVoid>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Station DI

Detail Message of event

DeviceName	: Station ID
RefName   	: Station name
EventType   : Alarm trigger type
ServerTime	: The server time when the alarm is triggered
Index       : The index value of DI
Value       : The status of DI which means the DI is rising

Example

<Alarm>
    <AlarmID>504</AlarmID>
    <Name>Alarm name</Name>
    <Description>Alarm name</Description>
    <UranusEvent>
        <Type>DIOStatus</Type>
        <DIOStatus>
            <DeviceName>S_{06840a09-4d7e-5714-962b-deb5267c43bb}</DeviceName>
            <RefName>s_NV_R0030</RefName>
            <EventType>DI</EventType>
            <ServerTime>2019-12-09T13:21:56.787+08:00</ServerTime>
            <DI>
                <Index>2</Index>
                <Value>Rising</Value>
            </DI>
        </DIOStatus>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Station DO

Detail Message of event

DeviceName	: Station ID
RefName   	: Station name
EventType   : Alarm trigger type
ServerTime	: The server time when the alarm is triggered
Index       : The index value of DO
Value       : The status of DO which means the DO is rising

Example

<Alarm>
    <AlarmID>504</AlarmID>
    <Name>Alarm name</Name>
    <Description>Alarm name</Description>
    <UranusEvent>
        <Type>DIOStatus</Type>
        <DIOStatus>
            <DeviceName>S_{06840a09-4d7e-5714-962b-deb5267c43bb}</DeviceName>
            <RefName>s_NV_R0030</RefName>
            <EventType>DO</EventType>
            <ServerTime>2019-12-09T13:21:56.787+08:00</ServerTime>
            <DO>
                <Index>2</Index>
                <Value>Rising</Value>
            </DO>
        </DIOStatus>
    </UranusEvent>
    <Status>
        <Priority>Normal</Priority>
        <State>New</State>
    </Status>
</Alarm>


Fan Error

Detail Message of event

ServerTime	: The server time when the alarm is triggered
Fan     	: The index value of fan
State     	: The status of fan which means the fan is error

Example

<Alarm>
	<AlarmID>628</AlarmID>
	<Name>Alarm name</Name>
	<Description>Alarm name</Description>
	<UranusEvent>
		<Type>FanStatus</Type>
		<FanStatus>
			<ServerTime>2019-12-09T13:49:31.032+08:00</ServerTime>
			<Fan>2</Fan>
			<State>Error</State>
		</FanStatus>
	</UranusEvent>
	<Status>
		<Priority>Normal</Priority>
		<State>New</State>
	</Status>
</Alarm>