API

System APIs

POST system/roles/{roleId}/user-assignments

Creates a new user assignment for provided role.

HTTP method POST
URI https://api.rambase.net/system/roles/{roleId}/user-assignments
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {roleId} Role identifier
Integer, minimum 100000
Successful HTTP status code 201
API resource identifier 1925, version 10

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
<UserAssignment>
2
     <ValidFrom
ValidFrom

Valid from date

This field is optional.

>{Date}</ValidFrom>
3
     <ValidTo
ValidTo

Valid to date

This field is optional.

>{Date}</ValidTo>
4
     <Comment
Comment

Description of why the user has been assigned to the role

This field is optional.

>{String}</Comment>
5
     <User>
6
          <UserId
UserId

Required/mandatory field

User identifier

Minimum value: 100

>{Integer}</UserId>
7
     </User>
8
</UserAssignment>
1
{
2
     "userAssignment": {
3
          "validFrom
ValidFrom

Valid from date

This field is optional.

": "{Date}",
4
          "validTo
ValidTo

Valid to date

This field is optional.

": "{Date}",
5
          "comment
Comment

Description of why the user has been assigned to the role

This field is optional.

": "{String}",
6
          "user": {
7
               "userId
UserId

Required/mandatory field

User identifier

Minimum value: 100

": "{Integer}"
8
          }
9
     }
10
}

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
<UserAssignment>
2
     <UserAssignmentId
UserAssignmentId

User assignment identifier

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

Status for the user assignments

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

Valid from date

>{Date}</ValidFrom>
5
     <ValidTo
ValidTo

Valid to date

>{Date}</ValidTo>
6
     <Comment
Comment

Description of why the user has been assigned to the role

>{String}</Comment>
7
     <Database
Database

Database the user has been assigned the role for

>{String}</Database>
8
     <User>
9
          <UserId
UserId

User identifier

>{Integer}</UserId>
10
          <UserLink
UserLink

User reference

>{String}</UserLink>
11
     </User>
12
</UserAssignment>
1
{
2
     "userAssignment": {
3
          "userAssignmentId
UserAssignmentId

User assignment identifier

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

Status for the user assignments

": "{Integer}",
5
          "validFrom
ValidFrom

Valid from date

": "{Date}",
6
          "validTo
ValidTo

Valid to date

": "{Date}",
7
          "comment
Comment

Description of why the user has been assigned to the role

": "{String}",
8
          "database
Database

Database the user has been assigned the role for

": "{String}",
9
          "user": {
10
               "userId
UserId

User identifier

": "{Integer}",
11
               "userLink
UserLink

User reference

": "{String}"
12
          }
13
     }
14
}

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
Error 103011 HTTP 400 Valid to date must be later or equal to start date when access points record is deactivated
Error 108139 HTTP 400 Valid to date is required
Error 104396 HTTP 400 Set a valid to date that is a maximum of 3 days in the future
Error 101806 HTTP 400 The Valid to-date of the document is not valid
Error 101061 HTTP 400 Valid to-date can not be less than valid from-date
Error 102139 HTTP 400 Comment is required
Error 101052 HTTP 400 User assignment already exists on the role (conflicting period)