Adminwiki: 1 revision imported

2023-10-17T11:27:27Z

1 revision imported

← Older revision	Revision as of 07:27, 17 October 2023
(No difference)

api>Admin: Created page with "This operation close a notification. = URL = https://web.safestamper.com/api/notification/close = Parameters = * '''sharedkey''': Your API client shared ke..."

2021-04-12T10:10:53Z

Created page with "This operation close a notification. = URL = <nowiki>https://web.safestamper.com/api/notification/close</nowiki> = Parameters = * '''sharedkey''': Your API client shared ke..."

New page

This operation close a notification.

= URL =
<nowiki>https://web.safestamper.com/api/notification/close</nowiki>

= Parameters =
* '''sharedkey''': Your API client shared key
* '''authkey''': Authkey of notification owner
* '''code''': Code of notification to close
* '''signature''': Parameters signature, as explained in [[Signature parameter]]

= Returns =

A JSON object with the following fields:

* '''entryDate''': Date of notification
* '''code''': Notification code
* '''subject''': Subject of notification
* '''body''': Body content of notification
* '''recipientType''': Send type of the notification
* '''recipientMail''': E-mail address of the notification recipient
* '''recipientPhone''': Phone of the notification recipient
* '''recipientName''': Name of the notification recipient
* '''attachmentName''': Attachment name of notification
* '''state''': State of notification
** ''PENDING'' The notification is pending to read
** ''READ'' The notificaction has been read
* '''certificates''': List of certificates generated from this notification
** '''entryDate''': Date of certificate
** '''code''': Certificate code
** '''url''': Public URL for certificate download
* '''readings''': List of readings of this notification
** '''ip''': IP from which the notification was read
** '''country''': Country code from which the notification was read
** '''city''': City from which the notification was read
** '''date''': Date read
** '''downloadAttachment''': Indicates if the attachment was downloaded

= HTTP Errors =

* '''401''' Unauthorized: the authkey does not exist or is not authorized
* '''403''' Forbidden: the sharedkey or signature are not valid
* '''404''' Not found: the notification does not exist or does not belong to the user

= Example =

REQUEST:
<pre>
https://web.safestamper.com/api/notification/get
?authkey=0021d81c-e4a5-4869-8384-2fd70cdb58ec
&code=170316-6K5D2Q
&sharedkey=axvmfqn8aex21mxhq5zsj7l482saxfu7j4hh
&signature=b1b22b34967fdf2eb67c3569a1e8b90f9fb63e77
</pre>

RESPONSE (actual response has no line breaks or indentation):
<pre>
{
"entryDate": "2017-03-16T12:59:08Z",
"code": "170316-6K5D2Q",
"state": "READED",
"subject": "Example notification",
"body": "Notification text",
"recipientType": "EMAIL",
"recipientMail": "jdoe@example.com",
"recipientPhone": "",
"recipientName": "John Doe",
"certificates": [
{
"entryDate": "2017-03-16T12:59:44Z",
"code": "170316-WMZMFS",
"url": "http:\/\/dev.safestamper.com:9001\/certificate\/170316-WMZMFS",
}],
"readings": [
{
"ip": "127.0.0.1",
"date": "2017-03-16T12:59:34Z",
"downloadAttachment": "false"
}]
}
</pre>

Notification/close - Revision history

Adminwiki: 1 revision imported

api>Admin: Created page with "This operation close a notification. = URL = https://web.safestamper.com/api/notification/close = Parameters = * '''sharedkey''': Your API client shared ke..."