RamBase REST APIs
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 16 |
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.
ValidFrom
Valid from date
This field is optional.
>{Date}</ValidFrom>ValidTo
Valid to date
This field is optional.
>{Date}</ValidTo>Comment
Description of why the user has been assigned to the role
This field is optional.
>{String}</Comment>UserId
Required/mandatory field
User identifier
Minimum value: 100
>{Integer}</UserId>ValidFrom
Valid from date
This field is optional.
": "{Date}",ValidTo
Valid to date
This field is optional.
": "{Date}",Comment
Description of why the user has been assigned to the role
This field is optional.
": "{String}",UserId
Required/mandatory field
User identifier
Minimum value: 100
": "{Integer}"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. |
| $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] |
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.
UserAssignmentId
User assignment identifier
>{Integer}</UserAssignmentId>Status
Status for the user assignments
Possible domain values can be found here
>{Integer}</Status>ValidFrom
Valid from date
ValidTo
Valid to date
Comment
Description of why the user has been assigned to the role
>{String}</Comment>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>UserAssignmentId
User assignment identifier
": "{Integer}",Status
Status for the user assignments
Possible domain values can be found here
": "{Integer}",ValidFrom
Valid from date
ValidTo
Valid to date
Comment
Description of why the user has been assigned to the role
": "{String}",UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"
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 101013 HTTP 404 | Sub-module 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 108144 HTTP 400 | Valid from date cannot be changed after assignment is activated |
| Error 101060 HTTP 400 | Valid from-date can not be less than today |
| 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) |