API

Human resource APIs

PUT human-resources/employees/{employeeId}/bookmarks/{bookmarkId}

Update a specific bookmark

HTTP method PUT
URI https://api.rambase.net/human-resources/employees/{employeeId}/bookmarks/{bookmarkId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {employeeId} Employee identifier
Integer
- URI parameter {bookmarkId} A unique identifier for a RamBase Bookmark Item
Integer
Successful HTTP status code 200
API resource identifier 1797, 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.

Format:
1
<Bookmark
Bookmark

This field is optional.

>
2
     <Title
Title

The title of the Bookmark. This is the title/text that will be displayed in the bookmark menu tree.

This field is optional.

>{String}</Title>
3
     <Url
Url

The URL we will navigate to when clicking a bookmark. This can be either a relative or an absolute URL.

This field is optional.

>{String}</Url>
4
     <IconName
IconName

Each bookmark can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.

This field is optional.

>{String}</IconName>
5
     <OrderIndex
OrderIndex

The order of bookmarks are controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.

This field is optional.

>{Integer}</OrderIndex>
6
     <ParentBookmark
ParentBookmark

This field is optional.

>
7
          <ParentBookmarkId
ParentBookmarkId

A reference to the parent bookmark id. Will contain the BookmarkId of the parent bookmark.

This field is optional.

>{Integer}</ParentBookmarkId>
8
     </ParentBookmark>
9
</Bookmark>
1
{
2
     "bookmark
Bookmark

This field is optional.

": {
3
          "title
Title

The title of the Bookmark. This is the title/text that will be displayed in the bookmark menu tree.

This field is optional.

": "{String}",
4
          "url
Url

The URL we will navigate to when clicking a bookmark. This can be either a relative or an absolute URL.

This field is optional.

": "{String}",
5
          "iconName
IconName

Each bookmark can have an icon associated with it. If your RamBase Menu Item should have an icon this field must contain the name of an icon that exists in the RamBase icon set.

This field is optional.

": "{String}",
6
          "orderIndex
OrderIndex

The order of bookmarks are controlled by this index field. A lower number will mean a higher rank in the menu. Index 0 will be on the top of the menu.

This field is optional.

": "{Integer}",
7
          "parentBookmark
ParentBookmark

This field is optional.

": {
8
               "parentBookmarkId
ParentBookmarkId

A reference to the parent bookmark id. Will contain the BookmarkId of the parent bookmark.

This field is optional.

": "{Integer}"
9
          }
10
     }
11
}

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.

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
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 100657 HTTP 404 PARENTMENUNO not found
Error 100658 HTTP 400 TITLE can not be empty on a menu-item
Error 100661 HTTP 400 Can not move a node to one of its own children