GET user/getRole?LoginName={LoginName}&Token={Token}

Get all roles for the specific user. Privilege "View" of licensed agenda "Users" required. Privilege "View" of item "Roles" of agenda "Users" required. Data may also be restricted by record permission "View" of agenda "User"

Request Information

Authorization

Authorization by token required

Availability

Method disabled by configuration

URI Parameters

Name	Description	Type	Additional information
LoginName	Unique identification of the person in the system	string	Required String length: inclusive between 0 and 100
Token	The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds	globally unique identifier	Required

Name

Description

Type

Additional information

LoginName

Unique identification of the person in the system

string

Required

String length: inclusive between 0 and 100

Token

The action is authorized by this token. Token should generated by calling action "POST login". Expiration time of each token is 20 seconds

globally unique identifier

Required

Body Parameters

None.

Response Information

Response Codes

Http Code	Error Number	Description
200 request succesfully done	0	Access priviliges for Person [{0}] stored successfully
400 bad request	1002	Entry parameter missing or parameter bindigs failed
401 unauthorized	1000	Token {0} not found
401 unauthorized	1001	Token {0} already expired
401 unauthorized	1006	Ip filter violated for ip client address [{0}]
401 unauthorized	1007	Ip filter [{0}] parsing failed
401 unauthorized	1008	Request rate policy violated for [{0}]
403 server refuses fo fulfill the request	1401	Privilege View of agenda Users violated for [LoginName {0}]
403 server refuses fo fulfill the request	1404	Privilege View of item Roles of agenda Users violated for [LoginName {0}]
403 server refuses fo fulfill the request	1412	Record permission View of agenda User violated for [{0}]
404 required resource does not exist on the server	1400	User for [LoginName {0}, ID_Firma {1}] not found or it could be a system user
404 required resource does not exist on the server	1410	No roles found
415 unsupported Media Type		The request entity has a media type which the server or resource does not support. Only application/json and application/xml are supported

Resource Description

UserRoleGetResp

Name	Description	Type	Additional information
Roles		Collection of UserRole	None.
LoginName	Unique identification of the user in the system	string	None.

Response Formats

application/json

Sample:

{"LoginName":"John.Doo","Roles":[{"Name":"Administration","TimeLastChange":"\/Date(1733227751806)\/"}]}

application/xml

Sample:


<Response>
  <LoginName>John.Doo</LoginName>
  <Roles>
    <UserRole>
      <Name>Administration</Name>
      <TimeLastChange>2024-12-03T12:09:11.8064452Z</TimeLastChange>
    </UserRole>
  </Roles>
</Response>

text/json

Sample:

{
  "LoginName": "sample string 1",
  "Roles": [
    {
      "TimeLastChange": "2024-12-03T18:26:44.677613+01:00"
    },
    {
      "TimeLastChange": "2024-12-03T18:26:44.677613+01:00"
    }
  ]
}

text/xml

Sample:

<Response xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <LoginName>sample string 1</LoginName>
  <Roles>
    <UserRole>
      <TimeLastChange>2024-12-03T18:26:44.677613+01:00</TimeLastChange>
    </UserRole>
    <UserRole>
      <TimeLastChange>2024-12-03T18:26:44.677613+01:00</TimeLastChange>
    </UserRole>
  </Roles>
</Response>