GET global/rambase-systems/{ramBaseSystemId}/users?search={search}

Returns users for a system

Note: Log in to check if your API client have access to run this resource
Version: 12
Success HTTP Status Code: 200
Maximum items from list ($top): 80

Uri parameters

{ramBaseSystemId} Integer A useridentificator in the hattelandsystem

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 is 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.

search String, optional Provides a searchstring for users. Will search in Name, FirstName, Email and phone
$inlinecount String, optional Only usable when the result is a list. Set to "allpages" if you want size of the result list to be returned. Accepted values are: "allpages", "none"
$top String, optional Only usable when the result is a list. Set the number of objects to return in result list. Maximum limit is specific for each resource, but is default 80.
$skip Integer, optional Only usable when the result is a list. Set the number of objects to skip in the result list.
$filter String, optional Only usable when the result is a list. Use to filter the result list, see the Filter and OrderBy page for more information about this.
$orderby String, optional Only usable when the result is a list. Use to order the result list, see Filter and OrderBy page for more information about this.
$expand String, optional Use to expand Output fields that are not shown by default in the output result. Possible Expandable fields are listed in the Output tab for the resource. Accepts a comma-separated list of expandable Output Field names. See the Expand and Select page for more information about this.
$showDomainDescriptions Boolean, optional Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

FirstName String User identifier.
LicensedRamBaseSystemName String The descriptive name of the system a user belogs to.
Name String User identifier.
RamBasePartnerId Integer Unique identifier for a customers partner.
RamBasePartnerName String The name of a customers partner.
Status Integer Status of the user.
UserId Integer User identifier.

See the page about filters and sorting on how to use sortable parameters

FirstName String User identifier
LicensedRamBaseSystemName String The descriptive name of the system a user belogs to.
Name String User identifier
RamBasePartnerId Integer Unique identifier for a customers partner
RamBasePartnerName String The name of a customers partner
Status Integer Status of the user
UserId Integer User identifier

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
<Users>
2
     <User>
3
          <UserId
UserId

User identifier

>
{Integer}</UserId>
4
          <FirstName
FirstName

First name of the user

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

Name of the user

>
{String}</Name>
6
          <Status
Status

User status ID

Possible domain values can be found here when logged in

>
{Integer}</Status>
7
          <AdmittanceLevel
AdmittanceLevel

Accumulated admittance level for employee at given date.

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

>
{Integer}</AdmittanceLevel>
8
          <PriceCategory
PriceCategory

The level a user has in regards to licensing. We have 4 price categories; Self service- (most basic), Single task-, Functional- and Cross functional user (most advanced). Calculated admittance level for a user will define the price category based on threshold values.

Possible domain values can be found here when logged in

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

>
{Integer}</PriceCategory>
9
          <LicensedRamBaseSystem
LicensedRamBaseSystem

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

>
10
               <RamBaseSystemId
RamBaseSystemId

The system identificator name of the system a user belogs to.

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

>
{Integer}</RamBaseSystemId>
11
               <Name
Name

The descriptive name of the system a user belogs to.

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

>
{String}</Name>
12
          </LicensedRamBaseSystem>
13
          <Authentication
Authentication

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

>
14
               <Username
Username

The users login name

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

>
{String}</Username>
15
               <OneTimePassword
OneTimePassword

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

>
16
                    <MobilePhone
MobilePhone

Users email address. Used to send change notifications and one time passwords

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

>
{String}</MobilePhone>
17
                    <Email
Email

Users mobile number. Used to send one time passwords to user.

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

>
{String}</Email>
18
                    <SendBy
SendBy

Domain value id for onetime password delivery type (email, sms)

Possible domain values can be found here when logged in

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

>
{Integer}</SendBy>
19
                    <Allow
Allow

Sets a flag if the user should be allowed to login to RamBase from other locations than the main office by two factor authentication.

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

>
{Boolean}</Allow>
20
               </OneTimePassword>
21
          </Authentication>
22
          <ConsultantFor
ConsultantFor

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

>
23
               <RamBasePartnerId
RamBasePartnerId

Unique identifier for a customers partner

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

>
{Integer}</RamBasePartnerId>
24
               <Name
Name

The name of a customers partner

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

>
{String}</Name>
25
          </ConsultantFor>
26
          <UserLink
UserLink

User reference

>
{String}</UserLink>
27
     </User>
28
</Users>
1
{
2
     "users": [
3
          {
4
               "userId
UserId

User identifier

":
"{Integer}",
5
               "firstName
FirstName

First name of the user

":
"{String}",
6
               "name
Name

Name of the user

":
"{String}",
7
               "status
Status

User status ID

Possible domain values can be found here when logged in

":
"{Integer}",
8
               "admittanceLevel
AdmittanceLevel

Accumulated admittance level for employee at given date.

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

":
"{Integer}",
9
               "priceCategory
PriceCategory

The level a user has in regards to licensing. We have 4 price categories; Self service- (most basic), Single task-, Functional- and Cross functional user (most advanced). Calculated admittance level for a user will define the price category based on threshold values.

Possible domain values can be found here when logged in

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

":
"{Integer}",
10
               "licensedRamBaseSystem
LicensedRamBaseSystem

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

":
{
11
                    "ramBaseSystemId
RamBaseSystemId

The system identificator name of the system a user belogs to.

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

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

The descriptive name of the system a user belogs to.

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

":
"{String}"
13
               },
14
               "authentication
Authentication

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

":
{
15
                    "username
Username

The users login name

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

":
"{String}",
16
                    "oneTimePassword
OneTimePassword

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

":
{
17
                         "mobilePhone
MobilePhone

Users email address. Used to send change notifications and one time passwords

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

":
"{String}",
18
                         "email
Email

Users mobile number. Used to send one time passwords to user.

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

":
"{String}",
19
                         "sendBy
SendBy

Domain value id for onetime password delivery type (email, sms)

Possible domain values can be found here when logged in

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

":
"{Integer}",
20
                         "allow
Allow

Sets a flag if the user should be allowed to login to RamBase from other locations than the main office by two factor authentication.

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

":
"{Boolean}"
21
                    }
22
               },
23
               "consultantFor
ConsultantFor

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

":
{
24
                    "ramBasePartnerId
RamBasePartnerId

Unique identifier for a customers partner

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

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

The name of a customers partner

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

":
"{String}"
26
               },
27
               "userLink
UserLink

User reference

":
"{String}"
28
          }
29
     ]
30
}

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: