POST Alert/Delete

Delete an alert in PISuite. If there are no reads for the alert, then delete the alert. Otherwise mark the alert as inactive.

Request Information

URI Parameters

None.

Body Parameters

Alert ID and Client Site ID as stored in PiSuite

AlertDelete
NameDescriptionTypeAdditional information
ClientSiteID

integer

None.
ID

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "ClientSiteID": 1,
  "ID": 2
}

application/xml, text/xml

Sample: 
<AlertDelete xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PiSuite.DataModels.Api4Client">
  <ClientSiteID>1</ClientSiteID>
  <ID>2</ID>
</AlertDelete>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Status of deletion

AlertUpdateStatus

Response Formats

application/json, text/json

Sample: 
1

application/xml, text/xml

Sample: 
<AlertUpdateStatus xmlns="http://schemas.datacontract.org/2004/07/PiSuite.DataModels.Api4Client">Updated</AlertUpdateStatus>