امتثال
واجهة البرمجة

Notifications

The signed-in person's newest notifications

GET
/v1/me/notifications

Authorization

BearerAuth
headerAuthorizationBearer <token>

JWT access token. Obtain via POST /v1/auth/login.

Query Parameters

limit?Limit
Range1 <= value <= 50
Default20

Response Body

Successful Response

application/json
  1. response
items*array<>
unread*Unread
curl -X GET 'https://api.aisc.sa/v1/me/notifications'
{  "items": [    {      "created_at": "2019-08-24T14:15:22Z",      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "params": {},      "read_at": "2019-08-24T14:15:22Z",      "target_path": "string",      "template_id": "string"    }  ],  "unread": 0}

One of the signed-in person's notifications

GET
/v1/me/notifications/{item_id}

Authorization

BearerAuth
headerAuthorizationBearer <token>

JWT access token. Obtain via POST /v1/auth/login.

Path Parameters

item_id*Item Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
created_at*Created At
Formatdate-time
id*Id
Formatuuid
params*
read_at*|null
target_path*Target Path
template_id*Template Id
curl -X GET 'https://api.aisc.sa/v1/me/notifications/497f6eca-6276-4993-bfeb-53cbbbba6f08'
{  "created_at": "2019-08-24T14:15:22Z",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "params": {},  "read_at": "2019-08-24T14:15:22Z",  "target_path": "string",  "template_id": "string"}

Mark one notification read

POST
/v1/me/notifications/{item_id}/read

Authorization

BearerAuth
headerAuthorizationBearer <token>

JWT access token. Obtain via POST /v1/auth/login.

Path Parameters

item_id*Item Id
Formatuuid

Response Body

Successful Response

curl -X POST 'https://api.aisc.sa/v1/me/notifications/497f6eca-6276-4993-bfeb-53cbbbba6f08/read'
Empty
GET
/v1/u/{token}

Check the link and name the topics it stops. Writes nothing, so a mail scanner that opens links cannot unsubscribe anyone.

Authorization

BearerAuth
headerAuthorizationBearer <token>

JWT access token. Obtain via POST /v1/auth/login.

Path Parameters

token*Token

Response Body

Successful Response

application/json
  1. response
topic*Topic
topics*array<string>
curl -X GET 'https://api.aisc.sa/v1/u/string'
{  "topic": "string",  "topics": [    "string"  ]}
POST
/v1/u/{token}

Withdraw what the link names (RFC 8058 one-click: the body is ignored). Following it twice withdraws once; withdrawn is empty the second time.

Authorization

BearerAuth
headerAuthorizationBearer <token>

JWT access token. Obtain via POST /v1/auth/login.

Path Parameters

token*Token

Response Body

Successful Response

application/json
  1. response
withdrawn*array<string>
curl -X POST 'https://api.aisc.sa/v1/u/string'
{  "withdrawn": [    "string"  ]}

Knowledge

الصفحة السابقة

Orgs

الصفحة التالية