API

Procurement APIs

GET procurement/orders/{purchaseOrderId}/notifications/{notificationId}

Notification details for the provided purchase order notification

HTTP method GET
URI https://api.rambase.net/procurement/orders/{purchaseOrderId}/notifications/{notificationId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {purchaseOrderId} Purchase order identifier
Integer, minimum 100000
- URI parameter {notificationId} Notification identifier
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3002, 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.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable 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
<Notification>
2
     <NotificationId
NotificationId

Notification identifier

>{Integer}</NotificationId>
3
     <Status
Status

Status of the notification

Possible domain values can be found here

>{Integer}</Status>
4
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Message
Message

The message from the notification definition, expanded with parameters.

>{String}</Message>
6
     <TranslatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

>{String}</TranslatedMessage>
7
     <Approval>
8
          <CurrentUserCanApprove
CurrentUserCanApprove

True if current user is allowed to approve the notification.

This field is greyed out because it is an expandable field. You have to add $expand=Approval.CurrentUserCanApprove in your request URI to get this field

>{Boolean}</CurrentUserCanApprove>
9
          <Priority
Priority

Requested priority of the approval request.

Possible domain values can be found here

>{Integer}</Priority>
10
          <ApprovalRule
ApprovalRule

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

>
11
               <ApprovalRuleId
ApprovalRuleId

Approval rule identifier

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

>{Integer}</ApprovalRuleId>
12
               <Name
Name

Name of the approval rule

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

>{String}</Name>
13
               <Description
Description

Approval rule description

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

>{String}</Description>
14
               <SendRequestToDefaultApprovers
SendRequestToDefaultApprovers

Send request to all approvers selected as default approvers

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

>{Boolean}</SendRequestToDefaultApprovers>
15
               <ApprovalRuleLink
ApprovalRuleLink

Approval rule reference

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

>{String}</ApprovalRuleLink>
16
          </ApprovalRule>
17
          <Request>
18
               <Value
Value

Value which was approved (if approved).

>{String}</Value>
19
               <Comment
Comment

Message entered by the user when requesting approval

>{String}</Comment>
20
               <Approver>
21
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
22
                    <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Approval.Request.Approver.LastName in your request URI to get this field

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

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Approval.Request.Approver.FirstName in your request URI to get this field

>{String}</FirstName>
24
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
25
               </Approver>
26
          </Request>
27
          <Response>
28
               <IsApproved
IsApproved

True if the notification needs approval, and is approved.

>{Boolean}</IsApproved>
29
               <Comment
Comment

Message entered by the user when approving or denying the approval request

>{String}</Comment>
30
               <ReviewedAt
ReviewedAt

Date and time of approvel.

>{Datetime}</ReviewedAt>
31
               <ReviewedBy
ReviewedBy

The employee who approved the notification.

>
32
                    <EmployeeId
EmployeeId

Employee identifier

>{Integer}</EmployeeId>
33
                    <LastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Approval.Response.ReviewedBy.LastName in your request URI to get this field

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

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Approval.Response.ReviewedBy.FirstName in your request URI to get this field

>{String}</FirstName>
35
                    <EmployeeLink
EmployeeLink

Employee reference

>{String}</EmployeeLink>
36
               </ReviewedBy>
37
          </Response>
38
     </Approval>
39
     <RegardingItem>
40
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
41
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
42
     </RegardingItem>
43
     <MessageParameters
MessageParameters

Parameters used when expanding the message.

>
44
          <MessageParameter>
45
               <Key
Key

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

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

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

>{String}</Value>
47
          </MessageParameter>
48
     </MessageParameters>
49
     <CreatedBy
CreatedBy

The user who created the notification.

>
50
          <UserId
UserId

User identifier

>{Integer}</UserId>
51
          <Name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy.Name in your request URI to get this field

>{String}</Name>
52
          <FirstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy.FirstName in your request URI to get this field

>{String}</FirstName>
53
          <UserLink
UserLink

User reference

>{String}</UserLink>
54
     </CreatedBy>
55
     <NotificationType>
56
          <NotificationTypeId
NotificationTypeId

Notification type identifier

>{String}</NotificationTypeId>
57
          <Category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

>{String}</Category>
58
          <Priority
Priority

Priority of notification with this notification type.

>{String}</Priority>
59
          <ForwardNotifications
ForwardNotifications

True if notifications created with this definition will be forwarded when the owner object is forwarded.

>{Boolean}</ForwardNotifications>
60
          <NotificationTypeLink
NotificationTypeLink

Notification type reference

>{String}</NotificationTypeLink>
61
     </NotificationType>
62
</Notification>
1
{
2
     "notification": {
3
          "notificationId
NotificationId

Notification identifier

": "{Integer}",
4
          "status
Status

Status of the notification

Possible domain values can be found here

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

Date and time of creation

": "{Datetime}",
6
          "message
Message

The message from the notification definition, expanded with parameters.

": "{String}",
7
          "translatedMessage
TranslatedMessage

The translated message from the notification definition, expanded with parameters.

": "{String}",
8
          "approval": {
9
               "currentUserCanApprove
CurrentUserCanApprove

True if current user is allowed to approve the notification.

This field is greyed out because it is an expandable field. You have to add $expand=Approval.CurrentUserCanApprove in your request URI to get this field

": "{Boolean}",
10
               "priority
Priority

Requested priority of the approval request.

Possible domain values can be found here

": "{Integer}",
11
               "approvalRule
ApprovalRule

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

": {
12
                    "approvalRuleId
ApprovalRuleId

Approval rule identifier

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

": "{Integer}",
13
                    "name
Name

Name of the approval rule

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

": "{String}",
14
                    "description
Description

Approval rule description

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

": "{String}",
15
                    "sendRequestToDefaultApprovers
SendRequestToDefaultApprovers

Send request to all approvers selected as default approvers

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

": "{Boolean}",
16
                    "approvalRuleLink
ApprovalRuleLink

Approval rule reference

This field is greyed out because it is an expandable field. You have to add $expand=Approval.ApprovalRule in your request URI to get this field

": "{String}"
17
               },
18
               "request": {
19
                    "value
Value

Value which was approved (if approved).

": "{String}",
20
                    "comment
Comment

Message entered by the user when requesting approval

": "{String}",
21
                    "approver": {
22
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
23
                         "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Approval.Request.Approver.LastName in your request URI to get this field

": "{String}",
24
                         "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Approval.Request.Approver.FirstName in your request URI to get this field

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

Employee reference

": "{String}"
26
                    }
27
               },
28
               "response": {
29
                    "isApproved
IsApproved

True if the notification needs approval, and is approved.

": "{Boolean}",
30
                    "comment
Comment

Message entered by the user when approving or denying the approval request

": "{String}",
31
                    "reviewedAt
ReviewedAt

Date and time of approvel.

": "{Datetime}",
32
                    "reviewedBy
ReviewedBy

The employee who approved the notification.

": {
33
                         "employeeId
EmployeeId

Employee identifier

": "{Integer}",
34
                         "lastName
LastName

Last name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Approval.Response.ReviewedBy.LastName in your request URI to get this field

": "{String}",
35
                         "firstName
FirstName

First name of employee

This field is greyed out because it is an expandable field. You have to add $expand=Approval.Response.ReviewedBy.FirstName in your request URI to get this field

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

Employee reference

": "{String}"
37
                    }
38
               }
39
          },
40
          "regardingItem": {
41
               "itemId
ItemId

Item-number of the object

": "{Integer}",
42
               "itemLink
ItemLink

API reference to the item

": "{String}"
43
          },
44
          "messageParameters
MessageParameters

Parameters used when expanding the message.

": [
45
               {
46
                    "key
Key

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

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

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

": "{String}"
48
               }
49
          ],
50
          "createdBy
CreatedBy

The user who created the notification.

": {
51
               "userId
UserId

User identifier

": "{Integer}",
52
               "name
Name

Name of the user

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy.Name in your request URI to get this field

": "{String}",
53
               "firstName
FirstName

First name of the user

This field is greyed out because it is an expandable field. You have to add $expand=CreatedBy.FirstName in your request URI to get this field

": "{String}",
54
               "userLink
UserLink

User reference

": "{String}"
55
          },
56
          "notificationType": {
57
               "notificationTypeId
NotificationTypeId

Notification type identifier

": "{String}",
58
               "category
Category

Category of notification type (warning, information etc)

Possible domain values can be found here

": "{String}",
59
               "priority
Priority

Priority of notification with this notification type.

": "{String}",
60
               "forwardNotifications
ForwardNotifications

True if notifications created with this definition will be forwarded when the owner object is forwarded.

": "{Boolean}",
61
               "notificationTypeLink
NotificationTypeLink

Notification type reference

": "{String}"
62
          }
63
     }
64
}

Possible error codes the response might return:

Error 101746 HTTP 404 Product structure not found. Id: {0}
Error 102267 HTTP 404 Product structure operation not found
Error 102746 HTTP 400 The parameter value can not be more than {0}
Error 102747 HTTP 400 Error in formula: {0}
Error 105186 HTTP 400 Postings are not allowed on control accounts.
Error 101490 HTTP 400 Illegal Account {0}: This account has been blocked for {1}-documents
Error 101491 HTTP 400 Illegal Account {0}: Check the account's FromPeriod and ToPeriod
Error 101517 HTTP 400 Illegal Account {0}: This account require ICTDB.
Error 102482 HTTP 400 Department is required for general ledger account {0}
Error 102483 HTTP 400 Finance project is required for general ledger account {0}
Error 102484 HTTP 400 Asset is required for general ledger account {0}
Error 102485 HTTP 400 Dimension {0} ({1}) is required for general ledger account {2}
Error 101313 HTTP 400 Department number is not valid: {0}
Error 101320 HTTP 400 The project number is not valid: {0}
Error 101500 HTTP 400 Project {0} could not be used : Check project FromPeriod and ToPeriod.
Error 101501 HTTP 400 Asset is not allowed on general ledger account {0}
Error 101326 HTTP 400 The asset number is not valid : {0}
Error 102486 HTTP 400 Invalid value for dimension {0}