Jump to

• Request
• Response

Get the list of roles

get

/ec-auth-svc/rest/v3.0/authroles

Retrieves the list of roles for a specific role type.

Request

Query Parameters

• studyRoleType(required): string
  Study role type

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object DisplayRoleDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DisplayRoleDto"
    }
}

Nested Schema : DisplayRoleDto

Type: object

Show Source

• id(required): string (uuid)
• objectVersionNumber(required): number
• roleCategory(required): string
• roleCategoryLabel(required): string
• roleName(required): string
• roleNameLabel(required): string
• roleSubCategory: string
• roleSubCategoryLabel(required): string
• roleType(required): string
• unblinded: string

{
    "required":[
        "id",
        "objectVersionNumber",
        "roleCategory",
        "roleCategoryLabel",
        "roleName",
        "roleNameLabel",
        "roleSubCategoryLabel",
        "roleType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "roleName":{
            "type":"string"
        },
        "roleType":{
            "type":"string"
        },
        "roleCategory":{
            "type":"string"
        },
        "roleSubCategory":{
            "type":"string"
        },
        "unblinded":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "roleNameLabel":{
            "type":"string"
        },
        "roleCategoryLabel":{
            "type":"string"
        },
        "roleSubCategoryLabel":{
            "type":"string"
        }
    }
}

400 Response

Bad request

Body ()

Root Schema : RespDisplayRoleDto

Type: object

Show Source

• id(required): string (uuid)
• objectVersionNumber(required): number
• roleCategory(required): string
• roleCategoryLabel(required): string
• roleName(required): string
• roleNameLabel(required): string
• roleSubCategory: string
• roleSubCategoryLabel(required): string
• roleType(required): string
• unblinded: string

{
    "required":[
        "id",
        "objectVersionNumber",
        "roleCategory",
        "roleCategoryLabel",
        "roleName",
        "roleNameLabel",
        "roleSubCategoryLabel",
        "roleType"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "roleName":{
            "type":"string"
        },
        "roleType":{
            "type":"string"
        },
        "roleCategory":{
            "type":"string"
        },
        "roleSubCategory":{
            "type":"string"
        },
        "unblinded":{
            "type":"string"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "roleNameLabel":{
            "type":"string"
        },
        "roleCategoryLabel":{
            "type":"string"
        },
        "roleSubCategoryLabel":{
            "type":"string"
        }
    }
}

Back to Top