API

RamBase REST APIs

GET system/consultants?search={search}

Lists Partners for a system

HTTP method GET
URI https://api.rambase.net/system/consultants?search={search}
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 500
Successful HTTP status code 200
API resource identifier 3382, version 12

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
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
$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]
$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
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more 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.

Read more 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
<Consultants>
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

>{Integer}</Status>
7
          <LicensedRamBaseSystem>
8
               <RamBaseSystemId
RamBaseSystemId

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

>{String}</RamBaseSystemId>
9
               <Name
Name

The descriptive name of the system a user belogs to.

>{String}</Name>
10
          </LicensedRamBaseSystem>
11
          <Authentication>
12
               <Username
Username

The users login name

>{String}</Username>
13
               <OneTimePassword>
14
                    <MobilPhone
MobilPhone

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

>{String}</MobilPhone>
15
                    <Email
Email

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

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

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

Possible domain values can be found here

>{Integer}</SendBy>
17
                    <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.

>{Boolean}</Allow>
18
               </OneTimePassword>
19
          </Authentication>
20
          <ConsultantFor>
21
               <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.RamBasePartnerId in your request URI to get this field

>{Integer}</RamBasePartnerId>
22
               <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.Name in your request URI to get this field

>{String}</Name>
23
          </ConsultantFor>
24
          <UserLink
UserLink

User reference

>{String}</UserLink>
25
     </User>
26
     <Paging
Paging

Detailed paging information for this list.

>
27
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
28
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
29
          <Page
Page

Page index

>{Integer}</Page>
30
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
31
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
32
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
33
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
34
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
35
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
36
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
37
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
38
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
39
     </Paging>
40
</Consultants>
1
{
2
     "consultants": [
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

": "{Integer}",
8
               "licensedRamBaseSystem": {
9
                    "ramBaseSystemId
RamBaseSystemId

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

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

The descriptive name of the system a user belogs to.

": "{String}"
11
               },
12
               "authentication": {
13
                    "username
Username

The users login name

": "{String}",
14
                    "oneTimePassword": {
15
                         "mobilPhone
MobilPhone

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

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

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

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

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

Possible domain values can be found here

": "{Integer}",
18
                         "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.

": "{Boolean}"
19
                    }
20
               },
21
               "consultantFor": {
22
                    "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.RamBasePartnerId in your request URI to get this field

": "{Integer}",
23
                    "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.Name in your request URI to get this field

": "{String}"
24
               },
25
               "userLink
UserLink

User reference

": "{String}"
26
          }
27
     ],
28
     "paging
Paging

Detailed paging information for this list.

": {
29
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
30
          "position
Position

Position of the first element in the list

": "{Integer}",
31
          "page
Page

Page index

": "{Integer}",
32
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
33
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
34
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
35
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
36
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
37
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
38
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
39
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
40
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
41
     }
42
}

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: