Get first notification
Retrieves the oldest unprocessed notification. To be able to retrieve the next notification you have to issue a DELETE request on /v1/notifications/{notification}.
To understand how our notification system is meant to be used read our article about How our notification system works.
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
https://api.checkdomain.de/v1/notifications
HTTP/1.1 200 OK
{
"id": 1,
"action": "create",
"type": "domain",
"status": "success",
"message": "Your domain name was registered successfully",
"created": "2017-11-22T10:49:02+0100",
"retrieved": null,
"resource": {
"id": 1,
"name": "checkdomain-api.de"
}
}
Code | Description |
---|---|
200 | Ok |
204 | No more notifications to retrieve |
Delete a notification
Our notifications have to be read one by one. That said, to be able to get the next notification in the queue, you have to delete the last notification you retrieved. Issue this DELETE command to remove a notification from the queue.
The notification will not be deleted physically. Nevertheless you will not be able to get any information about the deleted notification out of our systems again.
$ curl --header "Authorization: Bearer {token}" \
--header "Accept: application/json" \
--request DELETE \
https://api.checkdomain.de/v1/notifications/{notification}
HTTP/1.1 204 No Content
Name | Type | Required | Description |
---|---|---|---|
notification | integer (\d+) | Notification identifier |
Code | Description |
---|---|
204 | Notification deleted |