Notifications

Get first notification

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.

Example

$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       https://api.checkdomain.de/v1/notifications

Response

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"
    }
}

Status-Codes

Code	Description
200	Ok
204	No more notifications to retrieve

Delete a notification

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.

Example

$ curl --header "Authorization: Bearer {token}" \
       --header "Accept: application/json" \
       --request DELETE \
       https://api.checkdomain.de/v1/notifications/{notification}

Response

HTTP/1.1 204 No Content

Requirements

Name	Type	Required	Description
notification	integer (\d+)		Notification identifier

Status-Codes

Code	Description
204	Notification deleted