API

Sales APIs

GET sales/contracts/{salesContractId}/notification-rules/{notificationRuleId}

Details about a specific notification of a sales contract

HTTP method GET
URI https://api.rambase.net/sales/contracts/{salesContractId}/notification-rules/{notificationRuleId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {salesContractId} Customer sales contract identifier
Integer, minimum 100000
- URI parameter {notificationRuleId} The unique notification identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3892, 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.

Format:
1
1

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.

Format:
1
<NotificationRule>
2
     <NotificationRuleId
NotificationRuleId

The unique notification identifier

>{Integer}</NotificationRuleId>
3
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
4
     <NotificationType
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>
5
     <DaysBeforeExpirationDate
DaysBeforeExpirationDate

Number of days to notify before the event. Used to calculate the value NotifyDate

>{Integer}</DaysBeforeExpirationDate>
6
     <NotifyDate
NotifyDate

Recalculated everytime ExpirationDate or DaysBeforeExpirationDate is updated

>{Date}</NotifyDate>
7
     <NotifyBy
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>
8
     <NotifyEmployee
NotifyEmployee

Link to the person who should be notified

>
9
          <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
10
          <FirstName
FirstName

First name of employee

>{String}</FirstName>
11
          <LastName
LastName

Last name of employee

>{String}</LastName>
12
          <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
13
     </NotifyEmployee>
14
</NotificationRule>
1
{
2
     "notificationRule": {
3
          "notificationRuleId
NotificationRuleId

The unique notification identifier

": "{Integer}",
4
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
5
          "notificationType
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}",
6
          "daysBeforeExpirationDate
DaysBeforeExpirationDate

Number of days to notify before the event. Used to calculate the value NotifyDate

": "{Integer}",
7
          "notifyDate
NotifyDate

Recalculated everytime ExpirationDate or DaysBeforeExpirationDate is updated

": "{Date}",
8
          "notifyBy
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}",
9
          "notifyEmployee
NotifyEmployee

Link to the person who should be notified

": {
10
               "employeeId
EmployeeId

Employee identifier

": "{Integer}",
11
               "firstName
FirstName

First name of employee

": "{String}",
12
               "lastName
LastName

Last name of employee

": "{String}",
13
               "employeeLink
EmployeeLink

Employee reference

": "{String}"
14
          }
15
     }
16
}

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 104881 HTTP 404 Sales contract notification not found