System APIs
Update notification details for provided identifier
| HTTP method | PUT |
| URI | https://api.rambase.net/system/users/{userId}/notifications/{notificationId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {userId} |
User identifier
Integer, minimum 100 |
| - URI parameter {notificationId} |
Notification identifier
Integer, minimum 100000 |
| Successful HTTP status code | 200 |
| API resource identifier | 6288, version 5 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
UserNotification
This field is optional.
>Subject
Subject of the notification
This field is optional.
>{String}</Subject>TriggeredBy
The user id the notification is sent from
Minimum value: 100
This field is optional.
>{Integer}</TriggeredBy>Category
The type of category the notification belongs to
Applicable domain values can be found here
This field is optional.
>{Integer}</Category>ObjectReference
The document the notification is linked to
This field is optional.
>Database
Company code/database the object belongs to
This field is optional.
>{String}</Database>ObjectId
Identifier of the object
This field is optional.
>{Integer}</ObjectId>ObjectType
Type of object
This field is optional.
>{String}</ObjectType>ItemId
Item-number of the object
This field is optional.
>{Integer}</ItemId>ItemType
Type of item
This field is optional.
>{String}</ItemType>Recipient
The user id the notification is sent to
Minimum value: 100
This field is optional.
>{Integer}</Recipient>IsPinned
Marked the notification as pinned/important
This field is optional.
>{Boolean}</IsPinned>UserNotification
This field is optional.
": {Subject
Subject of the notification
This field is optional.
": "{String}",TriggeredBy
The user id the notification is sent from
Minimum value: 100
This field is optional.
": "{Integer}",Category
The type of category the notification belongs to
Applicable domain values can be found here
This field is optional.
": "{Integer}",ObjectReference
The document the notification is linked to
This field is optional.
": {Database
Company code/database the object belongs to
This field is optional.
": "{String}",ObjectId
Identifier of the object
This field is optional.
": "{Integer}",ObjectType
Type of object
This field is optional.
": "{String}",ItemId
Item-number of the object
This field is optional.
": "{Integer}",ItemType
Type of item
This field is optional.
": "{String}"Recipient
The user id the notification is sent to
Minimum value: 100
This field is optional.
": "{Integer}",IsPinned
Marked the notification as pinned/important
This field is optional.
": "{Boolean}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields. Fields colored in grey is expandable fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101814 HTTP 404 | Employee not found |