API

System APIs

POST system/role-templates/{roleTemplateId}/duties

Creates a new duty assignment for provided role template

HTTP method POST
URI https://api.rambase.net/system/role-templates/{roleTemplateId}/duties
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {roleTemplateId} Role template identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 6497, version 2

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
<Duty>
2
     <DutyId
DutyId

Required/mandatory field

Duty identifier

Minimum value: 100000

>
{Integer}</DutyId>
3
</Duty>
1
{
2
     "duty": {
3
          "dutyId
DutyId

Required/mandatory field

Duty identifier

Minimum value: 100000

":
"{Integer}"
4
     }
5
}

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 105262 HTTP 400 Duty is only available in {0}
Error 109053 HTTP 400 Local duties can not be assigned to role templates
Error 109116 HTTP 400 Duties allowing organizational unit restriction cannot be added to role templates meant for company roles
Error 109054 HTTP 403 The user level for this duty is not allowed on this role template
Error 109052 HTTP 400 The duty already exists on the role template