API

Procurement APIs

GET procurement/returns/{supplierReturnId}/notifications?regardingItemId={itm}

List of all notifications for the specified supplier return

HTTP method GET
URI https://api.rambase.net/procurement/returns/{supplierReturnId}/notifications?regardingItemId={itm}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {supplierReturnId} Supplier return identifier
Integer, minimum 100000
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 3241, version 6

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.

regardingItemId Integer, optional Query parameter for limiting notifications to specific item. Blank query parameter will hide all notifications regarding specific items.
$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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ApprovalPriority Integer Requested priority of the approval request.
ApprovalRequestComment String Message entered by the user when requesting approval.
ApprovalResponseComment String Message entered by the user when approving or denying the approval request.
ApprovedAt Datetime Date and time of approvel. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
ApprovedBy Integer Employee identifier.
Category String Category of notification type (warning, information etc).
CreatedAt Datetime Date and time of creation. Available macros: now(), startOfDay(), endOfDay(), currentDate(), currentMonth(), currentYear(), startOfMonth(), endOfMonth(), startOfYear(), endOfYear(), startOfWeek(), endOfWeek(), previousYear(), previousMonth()
CreatedBy Integer User identifier.
ForwardNotifications Boolean True if notifications created with this definition will be forwarded when the owner object is forwarded.
IsApproved Boolean True if the notification needs approval, and is approved.
NotificationId Integer Notification identifier.
NotificationTypeId String Notification type identifier.
Priority String Priority of notification with this notification type.
Status Integer Status of the notification.

Read more about filters and sorting on how to use sortable parameters

ApprovalPriority Integer Requested priority of the approval request.
ApprovalRequestComment String Message entered by the user when requesting approval
ApprovalResponseComment String Message entered by the user when approving or denying the approval request
ApprovedAt Datetime Date and time of approvel.
ApprovedBy Integer Employee identifier
Category String Category of notification type (warning, information etc)
CreatedAt Datetime Date and time of creation
CreatedBy Integer User identifier
ForwardNotifications Boolean True if notifications created with this definition will be forwarded when the owner object is forwarded.
IsApproved Boolean True if the notification needs approval, and is approved.
NotificationId Integer Notification identifier
NotificationTypeId String Notification type identifier
Priority String Priority of notification with this notification type.
Status Integer Status of the notification

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
<Notifications>
2
     <Notification>
3
          <NotificationId
NotificationId

Notification identifier

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

Status of the notification

Possible domain values can be found here

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

Date and time of creation

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

The message from the notification definition, expanded with parameters.

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

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

>{String}</TranslatedMessage>
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=Notification.Approval.CurrentUserCanApprove in your request URI to get this field

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

Requested priority of the approval request.

Possible domain values can be found here

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

This field is greyed out because it is an expandable field. You have to add $expand=Notification.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=Notification.Approval.ApprovalRule in your request URI to get this field

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

Name of the approval rule

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

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

Approval rule description

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

>{String}</Description>
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=Notification.Approval.ApprovalRule in your request URI to get this field

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

Approval rule reference

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

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

Value which was approved (if approved).

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

Message entered by the user when requesting approval

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

Employee identifier

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

True if the notification needs approval, and is approved.

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

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

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

Date and time of approvel.

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

The employee who approved the notification.

>
33
                         <EmployeeId
EmployeeId

Employee identifier

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

>{String}</EmployeeLink>
37
                    </ReviewedBy>
38
               </Response>
39
          </Approval>
40
          <CreatedBy
CreatedBy

The user who created the notification.

>
41
               <UserId
UserId

User identifier

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

Name of the user

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

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

First name of the user

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

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

User reference

>{String}</UserLink>
45
          </CreatedBy>
46
          <NotificationType>
47
               <NotificationTypeId
NotificationTypeId

Notification type identifier

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

Priority of notification with this notification type.

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

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

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

Notification type reference

>{String}</NotificationTypeLink>
52
          </NotificationType>
53
          <NotificationLink
NotificationLink

Notification reference

>{String}</NotificationLink>
54
     </Notification>
55
     <Paging
Paging

Detailed paging information for this list.

>
56
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
57
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
58
          <Page
Page

Page index

>{Integer}</Page>
59
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
60
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
61
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
62
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
63
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
64
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
65
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
66
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
67
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
68
     </Paging>
69
</Notifications>
1
{
2
     "notifications": [
3
          {
4
               "notificationId
NotificationId

Notification identifier

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

Status of the notification

Possible domain values can be found here

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

Date and time of creation

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

The message from the notification definition, expanded with parameters.

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

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

": "{String}",
9
               "approval": {
10
                    "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=Notification.Approval.CurrentUserCanApprove in your request URI to get this field

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

Requested priority of the approval request.

Possible domain values can be found here

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

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

": {
13
                         "approvalRuleId
ApprovalRuleId

Approval rule identifier

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

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

Name of the approval rule

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

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

Approval rule description

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

": "{String}",
16
                         "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=Notification.Approval.ApprovalRule in your request URI to get this field

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

Approval rule reference

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

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

Value which was approved (if approved).

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

Message entered by the user when requesting approval

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

Employee identifier

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

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

True if the notification needs approval, and is approved.

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

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

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

Date and time of approvel.

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

The employee who approved the notification.

": {
34
                              "employeeId
EmployeeId

Employee identifier

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

Last name of employee

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

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

First name of employee

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

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

Employee reference

": "{String}"
38
                         }
39
                    }
40
               },
41
               "createdBy
CreatedBy

The user who created the notification.

": {
42
                    "userId
UserId

User identifier

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

Name of the user

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

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

First name of the user

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

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

User reference

": "{String}"
46
               },
47
               "notificationType": {
48
                    "notificationTypeId
NotificationTypeId

Notification type identifier

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

Category of notification type (warning, information etc)

Possible domain values can be found here

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

Priority of notification with this notification type.

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

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

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

Notification type reference

": "{String}"
53
               },
54
               "notificationLink
NotificationLink

Notification reference

": "{String}"
55
          }
56
     ],
57
     "paging
Paging

Detailed paging information for this list.

": {
58
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
59
          "position
Position

Position of the first element in the list

": "{Integer}",
60
          "page
Page

Page index

": "{Integer}",
61
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
62
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
63
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
64
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
65
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
66
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
67
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
68
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
69
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
70
     }
71
}

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