API

Procurement APIs

POST procurement/orders/{purchaseOrderId}/notifications

Creates a new notification for provided purchase order

HTTP method POST
URI https://api.rambase.net/procurement/orders/{purchaseOrderId}/notifications
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseOrderId} Purchase order identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 3006, version 1

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
<Notification
Notification

This field is optional.

>
2
     <RegardingItem
RegardingItem

This field is optional.

>
3
          <ItemId
ItemId

Item-number of the object

This field is optional.

>{Integer}</ItemId>
4
     </RegardingItem>
5
     <MessageParameters
MessageParameters

Parameters used when expanding the message.

This field is optional.

>
6
          <MessageParameter
MessageParameter

This field is optional.

>
7
               <Key
Key

Key of the message parameter. Found in the message of the notification definition.

This field is optional.

>{String}</Key>
8
               <Value
Value

The value that replaces the key in the message of the notification definition.

This field is optional.

>{String}</Value>
9
          </MessageParameter>
10
     </MessageParameters>
11
     <NotificationType
NotificationType

This field is optional.

>
12
          <NotificationTypeId
NotificationTypeId

Notification type identifier

This field is optional.

>{String}</NotificationTypeId>
13
     </NotificationType>
14
</Notification>
1
{
2
     "notification
Notification

This field is optional.

": {
3
          "regardingItem
RegardingItem

This field is optional.

": {
4
               "itemId
ItemId

Item-number of the object

This field is optional.

": "{Integer}"
5
          },
6
          "messageParameters
MessageParameters

Parameters used when expanding the message.

This field is optional.

": [
7
               {
8
                    "key
Key

Key of the message parameter. Found in the message of the notification definition.

This field is optional.

": "{String}",
9
                    "value
Value

The value that replaces the key in the message of the notification definition.

This field is optional.

": "{String}"
10
               }
11
          ],
12
          "notificationType
NotificationType

This field is optional.

": {
13
               "notificationTypeId
NotificationTypeId

Notification type identifier

This field is optional.

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

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.
$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.

Format:
1
1

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 101015 HTTP 404 Permission not found
Error 101420 HTTP 404 Setting definition not found