System APIs
Creates a new notification
| HTTP method | POST |
| URI | https://api.rambase.net/system/users/{userId}/notifications |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {userId} |
User identifier
Integer, minimum 100 |
| Successful HTTP status code | 201 |
| API resource identifier | 6285, version 7 |
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.
Subject
Required/mandatory field
Subject of the notification
>{String}</Subject>TriggeredBy
Required/mandatory field
The user id the notification is sent from
Minimum value: 100
>{Integer}</TriggeredBy>Category
The type of category the notification belongs to
Applicable domain values can be found here
This field is optional.
>{Integer}</Category>Url
Url used to store link with all app information like id, filter, sorting, +++
This field is optional.
>{String}</Url>Recipient
Required/mandatory field
The user id the notification is sent to
Minimum value: 100
>{Integer}</Recipient>IsPinned
Marked the notification as pinned/important
Default value: False
This field is optional.
>{Boolean}</IsPinned>Subject
Required/mandatory field
Subject of the notification
": "{String}",TriggeredBy
Required/mandatory field
The user id the notification is sent from
Minimum value: 100
": "{Integer}",Category
The type of category the notification belongs to
Applicable domain values can be found here
This field is optional.
": "{Integer}",Url
Url used to store link with all app information like id, filter, sorting, +++
This field is optional.
": "{String}",Recipient
Required/mandatory field
The user id the notification is sent to
Minimum value: 100
": "{Integer}",IsPinned
Marked the notification as pinned/important
Default value: False
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. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
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.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
UserNotificationId
Notification identifier
>{Integer}</UserNotificationId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Subject
Subject of the notification
>{String}</Subject>TriggeredBy
The user id the notification is sent from
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>Category
The type of category the notification belongs to
Possible domain values can be found here
>{Integer}</Category>Url
Url used to store link with all app information like id, filter, sorting, +++
>{String}</Url>Recipient
The user id the notification is sent to
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>IsPinned
Marked the notification as pinned/important
>{Boolean}</IsPinned>UserNotificationLink
Notification reference
>{String}</UserNotificationLink>UserNotificationId
Notification identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Status
Status of notification
Possible domain values can be found here
": "{Integer}",Subject
Subject of the notification
": "{String}",TriggeredBy
The user id the notification is sent from
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"Category
The type of category the notification belongs to
Possible domain values can be found here
": "{Integer}",Url
Url used to store link with all app information like id, filter, sorting, +++
": "{String}",Recipient
The user id the notification is sent to
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"IsPinned
Marked the notification as pinned/important
": "{Boolean}",UserNotificationLink
Notification reference
": "{String}"
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 101013 HTTP 404 | Sub-module not found |
| Error 101420 HTTP 404 | Setting definition not found |