Sales APIs
Creates a new notification
| HTTP method | POST |
| URI | https://api.rambase.net/sales/contracts/{salesContractId}/notification-rules |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {salesContractId} |
Customer sales contract identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 3891, version 4 |
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.
NotificationType
Required/mandatory field
The type of notification to be given.
Link to a domain value (DOV).
Examples: Renewval, Review and Expired
Applicable domain values can be found here
>{Integer}</NotificationType>DaysBeforeExpirationDate
Required/mandatory field
Number of days to notify before the event. Used to calculate the value NotifyDate
Minimum value: 0
>{Integer}</DaysBeforeExpirationDate>NotifyBy
Required/mandatory field
How the notification should be sent stored as a domain link (DOV).
Examples: Email or Task
Applicable domain values can be found here
>{Integer}</NotifyBy>NotifyEmployee
Required/mandatory field
Link to the person who should be notified
>EmployeeId
Required/mandatory field
Employee identifier
Minimum value: 100
>{Integer}</EmployeeId>NotificationType
Required/mandatory field
The type of notification to be given.
Link to a domain value (DOV).
Examples: Renewval, Review and Expired
Applicable domain values can be found here
": "{Integer}",DaysBeforeExpirationDate
Required/mandatory field
Number of days to notify before the event. Used to calculate the value NotifyDate
Minimum value: 0
": "{Integer}",NotifyBy
Required/mandatory field
How the notification should be sent stored as a domain link (DOV).
Examples: Email or Task
Applicable domain values can be found here
": "{Integer}",NotifyEmployee
Required/mandatory field
Link to the person who should be notified
": {EmployeeId
Required/mandatory field
Employee identifier
Minimum value: 100
": "{Integer}"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.
NotificationRuleId
The unique notification identifier
>{Integer}</NotificationRuleId>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>NotificationType
The type of notification to be given.
Link to a domain value (DOV).
Examples: Renewval, Review and Expired
Possible domain values can be found here
>{Integer}</NotificationType>DaysBeforeExpirationDate
Number of days to notify before the event. Used to calculate the value NotifyDate
>{Integer}</DaysBeforeExpirationDate>NotifyDate
Recalculated everytime ExpirationDate or DaysBeforeExpirationDate is updated
>{Date}</NotifyDate>NotifyBy
How the notification should be sent stored as a domain link (DOV).
Examples: Email or Task
Possible domain values can be found here
>{Integer}</NotifyBy>NotifyEmployee
Link to the person who should be notified
>EmployeeId
Employee identifier
>{Integer}</EmployeeId>FirstName
First name of employee
>{String}</FirstName>LastName
Last name of employee
>{String}</LastName>EmployeeLink
Employee reference
>{String}</EmployeeLink>NotificationRuleId
The unique notification identifier
": "{Integer}",CreatedAt
Date and time of creation
": "{Datetime}",NotificationType
The type of notification to be given.
Link to a domain value (DOV).
Examples: Renewval, Review and Expired
Possible domain values can be found here
": "{Integer}",DaysBeforeExpirationDate
Number of days to notify before the event. Used to calculate the value NotifyDate
": "{Integer}",NotifyDate
Recalculated everytime ExpirationDate or DaysBeforeExpirationDate is updated
": "{Date}",NotifyBy
How the notification should be sent stored as a domain link (DOV).
Examples: Email or Task
Possible domain values can be found here
": "{Integer}",NotifyEmployee
Link to the person who should be notified
": {EmployeeId
Employee identifier
": "{Integer}",FirstName
First name of employee
": "{String}",LastName
Last name of employee
": "{String}",EmployeeLink
Employee 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 104976 HTTP 400 | The notify days cannot be before the start date or todays date |
| Error 104881 HTTP 404 | Sales contract notification not found |