Date: Fri, 29 Mar 2024 10:19:55 +0000 (UTC) Message-ID: <630550710.11809.1711707595492@catch-kbase-p> Subject: Exported From Confluence MIME-Version: 1.0 Content-Type: multipart/related; boundary="----=_Part_11808_1631057650.1711707595481" ------=_Part_11808_1631057650.1711707595481 Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable Content-Location: file:///C:/exported.html
Resource representing a single notification message for a user.
This resource supports the following methods: DELETE, GET, PAT= CH
Deletes a single notification message
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if the user does not have permission to= delete notifications for this user. |
404 - NotFound | Returned if notification message was not found.<= /td> |
Removes a notification from the users collection of in-app notifications=
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{userId} | 32B00F17-D492-4DAD-AD6A-DEBD61EFA119 | ID of the user whose in-box the notification bel= ongs to. |
{notificationId} | 2E2A2B7F-EEEA-4649-8F34-4A841426F27B | ID of the notification message |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Status Code
200 - OK
Retrieves information about a single notification message.
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if the user does not have permission to= view notifications for this user. |
404 - NotFound | Returned if notification message was not found.<= /td> |
Retrieves a notification identified by it's user and notification identi= fier
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{userId} | 32B00F17-D492-4DAD-AD6A-DEBD61EFA119 | ID of the user whose in-box the notification bel= ongs to. |
{notificationId} | 2E2A2B7F-EEEA-4649-8F34-4A841426F27B | ID of the notification message |
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "OccurredAt": "2012-01-01T14:04:05Z", "Id": "2e2a2b7f-eeea-4649-8f34-4a841426f27b", "HtmlSummary": "Joe Bloggs has created requirement 'All close buttons sho= uld be red'", "Viewed": false, "IconClass": "requirement-icon", "IconTitle": "Requirement", "Self": "http://localhost/api/user/32b00f17-d492-4dad-ad6a-debd61efa119/n= otification/2e2a2b7f-eeea-4649-8f34-4a841426f27b" }
Status Code
200 - OK
Patch an existing notification message (Allows updating the Viewed prope= rty)
These are the expected status codes returned by the service. In addition= , some other status codes may be returned if either an internal error occur= s or there is an authentication issue (such as an expired OAuth token).
Status | Description |
---|---|
200 - OK | Returned if the request was completed successful= ly. |
403 - Forbidden | Returned if you do not have permission to mark t= his notification message as being viewed. |
Marks the notification as having been viewed by the user (will cause mes= sage to be displayed in grey color within the in-app notifications inbox)= p>
Request Headers
Key | Value | Description |
---|---|---|
Accept | application/json |
Request Parameters
Key | Value | Description |
---|---|---|
{userId} | 32B00F17-D492-4DAD-AD6A-DEBD61EFA119 | ID of the user whose in-box the notification bel= ongs to. |
{notificationId} | 2E2A2B7F-EEEA-4649-8F34-4A841426F27B | ID of the notification message |
Request Body
{ "Viewed": true }
Response Headers
Key | Value | Description |
---|---|---|
Content-Type | application/json; charset=3Dutf-8 |
Response Body
{ "OccurredAt": "2012-01-01T14:04:05Z", "Id": "2e2a2b7f-eeea-4649-8f34-4a841426f27b", "HtmlSummary": "Joe Bloggs has created requirement 'All close buttons sho= uld be red'", "Viewed": true, "IconClass": "requirement-icon", "IconTitle": "Requirement", "Self": "http://localhost/api/user/32b00f17-d492-4dad-ad6a-debd61efa119/n= otification/2e2a2b7f-eeea-4649-8f34-4a841426f27b" }
Status Code
200 - OK