DeleteNotification Documentation
DeleteNotification
Draft documentation version
Documentation is partial and not validated !
Description
Version | V1 |
---|---|
Require User context | |
Authorization | |
Errors | NotExist |
Request
Route
Parameters
Parameter | Required | Sample | Description |
---|---|---|---|
NotificationID | 546 | ID of Notification in WEvent. Leave empty if you want to remove all your Notifications | |
Categories | Flux,Reflection | Categories as array of WEventCategoryEnum[]. Leave empty if you want to retreive all |
Remarks
- To override Content-type in your clients HTTP Accept Header, append the
.xml
suffix or?format=xml
- To embed the response in a jsonp callback, append
?callback=myCallback
Post Data sample
POST /xml/reply/DeleteNotification HTTP/1.1
Host: localhost
Content-Type: application/xml
Content-Length: length
<DeleteNotification xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WIT.DataCenter.DTOs.Request">
<NotificationID>0</NotificationID>
</DeleteNotification>
cURL command sample
curl -k -H "Authorization: Bearer [YOUR_ACCESS_TOKEN]" -H "Content-Type:application/xml" -X DELETE -d @filename.xml https://api.wit-datacenter.com/Notification
Remark
@filename.xml
contain your request parameters serialized in XML as described in Post Data sample bottom
Response
Returned Entity
Number of notifications deletedXML Sample
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">0</int>