Base APIs
Notification type details for provided identifier
| HTTP method | GET |
| URI | https://api.rambase.net/base/notification-types/{notificationTypeId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {notificationTypeId} |
Notification type identifier
Integer, minimum 100 |
| Successful HTTP status code | 200 |
| API resource identifier | 371, version 8 |
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.
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.
| $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] |
| $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 |
| $format String, optional | Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json" |
| $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. |
| $select String, optional | Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select 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.
NotificationTypeId
Notification type identifier
>{Integer}</NotificationTypeId>Status
Status of transaction message.
Possible domain values can be found here
>{Integer}</Status>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>Category
Category of notification type (warning, information etc)
Possible domain values can be found here
>{String}</Category>Description
Description of notification definition.
>{String}</Description>TechnicalDescription
Description/note of the transaction message.
>{String}</TechnicalDescription>Priority
Priority of notification with this notification type.
>{Integer}</Priority>Message
Message of the notification definition.
>{String}</Message>TranslatedMessage
The notification definition message in user language.
>{String}</TranslatedMessage>ForwardNotifications
True if notifications created with this definition will be forwarded when the owner object is forwarded.
>{Boolean}</ForwardNotifications>IsEnabled
True if notification type is enabled for current company
>{Boolean}</IsEnabled>AssociatedCompanySettingDefintion
Company setting definition associated with the notification definiton. Through the company setting, you might be able to disable this kind of notifications.
>CompanySettingDefinitionId
Company setting definition identifier
>{Integer}</CompanySettingDefinitionId>CompanySettingDefinitionLink
Company setting definition reference
>{String}</CompanySettingDefinitionLink>NotificationTypeId
Notification type identifier
": "{Integer}",Status
Status of transaction message.
Possible domain values can be found here
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",Category
Category of notification type (warning, information etc)
Possible domain values can be found here
": "{String}",Description
Description of notification definition.
": "{String}",TechnicalDescription
Description/note of the transaction message.
": "{String}",Priority
Priority of notification with this notification type.
": "{Integer}",Message
Message of the notification definition.
": "{String}",TranslatedMessage
The notification definition message in user language.
": "{String}",ForwardNotifications
True if notifications created with this definition will be forwarded when the owner object is forwarded.
": "{Boolean}",IsEnabled
True if notification type is enabled for current company
": "{Boolean}",AssociatedCompanySettingDefintion
Company setting definition associated with the notification definiton. Through the company setting, you might be able to disable this kind of notifications.
": {CompanySettingDefinitionId
Company setting definition identifier
": "{Integer}",CompanySettingDefinitionLink
Company setting definition 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 100027 HTTP 400 | Missing mandatory parameter {0} |
| Error 101420 HTTP 404 | Setting definition not found |