GET users/{userIdentifier}/role

Return user's role using his id

Authorization

Access to this endpoint is granted if all following conditions are true:

  • Authenticated user passes at least one of the following conditions: Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the same center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user matches identifier given in "userIdentifier, studentIdentifier" uri parameter. Authenticated user is a staff member and is assigned to the online center as a user who matches identifier given in "userIdentifier, studentIdentifier" uri parameter.
  • Authenticated user who is either StaffMember, Student, Administrator, ProspectWithTrial, User

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userIdentifier

user's identifier

 PearsonEnglish.LearningServices.Business.Helpers.UserIdentifier

Required

Body Parameters

None.

Response Information

Resource Description

Staff member role

PearsonEnglish.LearningServices.Core.Models.Views.RoleViewModel
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.
RoleCode

string

None.
LoweredRoleName

string

None.
Description

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "0a0250b5-e669-4644-b155-89317fa9ac12",
  "RoleCode": "sample string 2",
  "LoweredRoleName": "sample string 3",
  "Description": "sample string 4"
}