Register   |  Login             

SCP API DETAILS

Alarm events


delete : /alarms/deleteAlarmEvent/{userId}/{alarmEventId}

delete

Description

Delete an Alarm by Id

Response Model
                            {
   errorCode (integer): Error code,
   errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
alarmEventId Alarm event id path Long
userId User id path Long
delete : /alarms/deleteAlarmEventsByCollectionId/{userId}

delete

Description

Delete alarm event by collectionId

Response Model
                            {  
	total (integer): Total,
    errorCode (integer): Error code,
    errorDesc (string): Error description
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
collectionId Collection id query String
get : /alarms/getAlarmEventDetail/{userId}/{alarmEventId}

get

Description

Get Alarm events‘ details by Id

Response Model
                            {  
   errorCode (integer): Error code,
   errorDesc (string): Error description
   id (long): Alarm id,
   alarm Name (string): Alarm name,
   alarmCode (string): Alarm code,
   severityName (string): Name severity,
   severity (short): Severity,
   resoucesName (string): Device name,
   resouces (long): DeviceId,
   createdDate (string): Date created,
   notificationMedia (short): Notice,
   status (short): Status,
   notificationMediaName (string): Name notice,
   alarmCategoryDTO: {  
      id (long): Id of alarm category,
      name (string): Alarm category name,
      code (string): Alarm category code,
      status (short): Alarm category status,
      description (string): Description,
      createdDate (string): Date created,
      lastmodifydate (string): Last modify date
   }
}
                        
Parameters
Parameter Description Parameter Type Data Type
alarmEventId Alarm event id path Long
userId User id path Long
get : /alarms/getAlarmEventList/{userId}

get

Description

Get Alarm Event List by Account Id

Response Model
                            {
	total (integer): Total alarm events,
	errorCode (integer): Error code,
	errorDesc (string): Error description,
	alarmEventDTOList : [
		{  
		   id (long): Id of warning,
		   alarmName (string): Alarm name,
		   alarmCode (string): Alarm code,
		   severityName (string): Name severity,
		   severity (short): Severity weight,
		   resoucesName (string): Device name,
		   resouces (long): Id device,
		   createdDate (string): Date created,
		   notificationMedia (short): Notice,
		   status (short): Status,
		   notificationMediaName (string): Name notice,
		   type (byte): Type
		}
	]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
alarmCategoryId Id of the type of alert query Long
alarmSeverity severity query Integer
fromDate From the date (dd-MM-yyyy) query String
searchKey Search by name or code alert query String
start recordings started query Integer
toDate Go to date (dd-MM-yyyy) query String
total Get the number of records query Integer
get : /alarms/getAlarmEventListByDevice/{userId}/{systemDeviceId}

get

Description

Get Alarm event list by Device Id

Response Model
                            {  
   total (integer): Total,
   errorCode (integer): Error code,
   errorDesc (string): Error description,
   alarmEventDTOList:[  
      {  
         id (long): Id,
         alarmName (string): Alarm name,
         alarmCode (string): Alarm code,
         severityName (string): Name severity,
         severity (short): Severity,
         resoucesName (string): Device name,
         resouces (long): DeviceId,
         createddate (string): Date created,
         notificationMedia (short): notice,
         status (short): Status,
         notificationMediaName (string): The name announcement,
         type (byte): Type
      }
   ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
systemDeviceId device id path Long
userId User id path Long
severity severity query Integer
start recordings started query Integer
total Get the number of records query Integer
get : /alarms/getAlarmEventRealtime/{userId}

get

Description

Get alarm event realtime by account Id

Response Model
                            {  
   total (integer): Total,
   errorCode (integer): Error code,
   errorDesc (string): Error description,
   alarmDTOList:[  
      {  
         id (long): Id of warning,
         alarmName (string): Alarm name,
         deviceName (string): Device name
      }
   ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
interval Period before the current date query Integer
systemDeviceId Device id query Long
get : /alarms/getCountAlarmEventsByCategory/{userId}

get

Description

Get count alarm event by category

Response Model
                            {  
   total (integer): Total,
   errorCode (integer): Error code,
   errorDesc (string): Error description,
   alarmEventsCountList:[  
      {  
         alarmEventsCount (integer): The number of warnings,
         name (string): Name warning
      }
   ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
start Records began query Integer
total Get the number of records query Integer
get : /alarms/getCountAlarmEventsByCategoryAndDevice/{userId}/{systemDeviceId}

get

Description

Get count alarm event by device Id

Response Model
                            {  
   total (integer): Total,
   errorCode (integer): Error code,
   errorDesc (string): Error description,
   alarmEventsCountList:[  
      {  
         alarmEventsCount (integer):The number of warnings,
         name (string):Name warning
      }
   ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
systemDeviceId System device id path Long
userId User id path Long
get : /alarms/getCountAlarmEventsByDevice/{userId}/{systemDeviceId}

get

Description

Count the event warning device

Response Model
                            {
	total (integer): Total,
	errorCode (integer): Error code,
	errorDesc (string): Error description,
	alarmEventsDeviceCountList: [
	    {
			deviceSystemId (long): System deviceId,
			deviceName (string): The name of the device,
			alarmEventsbyDeviceCount (integer): The number of warnings,
			groupbyDate (string): Date created
	    }
    ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
systemDeviceId Device id path Long
userId User id path Long
alarmCategoryId Id of the type of alert query Long
fromDate From date (dd-MM-yyyy) query String
toDate To date (dd-MM-yyyy) query String
get : /alarms/getCountAlarmEventsBySeverity/{userId}

get

Description

Get count alarm event by severity

Response Model
                            {  
   total (integer): Total,
   errorCode (integer): Error code,
   errorDesc (string): Error description,
   alarmEventsCountList:[  
      {  
         alarmEventsCount (integer):The number of warnings,
         name (string):Name warning
      }
   ]
}
                        
Parameters
Parameter Description Parameter Type Data Type
userId User id path Long
start Records began query Integer
total Get the number of records query Integer
Contact Information

Vietnam Post and Telecommunication Industry Technology (VNPT Technology)

Tel
Fax
Address
(+84) 4 3748 0922
(+84) 4 3748 0925
No. 124 Hoang Quoc Viet Street, Nghia Tan Ward, Cau Giay District, Hanoi
Introduction

•      VNPT Technology Introduction
•      SCP Introduction

Partners

•      Introduction
•      Certification process

Developers

•      SCP Discovery
•      APIs
•      Guideline Documents
•      Libraries

Legal

•      Terms of use
•      Privacy Policy
•      License Agreement

Copyright © 2017 VNPT Technology. All rights reserved.