Get For Project

GET

/api/v1/learners/project/{project_id}

Get the learners for the given project and package.

Args: package: The package to get the learners for. project: The project to get the learners for. ordering_param: The ordering parameters. paginated_params: The pagination parameters.

Returns: QueryResults: The learners.

Parameters

Path Parameters

project_id

required

Project Id

string format: uuid

Query Parameters

order_by

Order By

string

default: created_at

order_by_direction

string

Allowed values: ASC DESC

limit

Limit

integer

default: 100 > 0 < 101

offset

Offset

integer

Responses

200

Successful Response

HeaderPaginatedResponse[PublicLearnerSchema]

A list of responses with pagination information.

For backwards compatibility, this also exposes pagination using the following header format:

Access-Control-Expose-Headers: Content-Range
Content-Range: $FIRST_ITEM_IN_BATCH-$LAST_ITEM_IN_BACH/$TOTAL_ITEMS_AVAILABLE

object

status

string

Allowed values: success fail error

message

Message

string

default: OK.

code

Code

string

default: 200

data

required

Data

Array<object>

PublicLearnerSchema

Public schema to represent the learner

object

user_id

required

User Id

string

package

required

ProjectPackage

An enumeration.

string

Allowed values: QUANTUM_DISCOVERY QUANTUM_DISCOVERY_CHEMISTRY QUANTUM_DISCOVERY_LIGHT QUANTUM_DISCOVERY_PLAY QUANTUM_DISCOVERY_ESSENTIAL LEARN_BY_CODING VQPU

progress

Progress

object

key

additional properties

StageType

object

stage

required

ProgressStage

Enumeration of progress types

string

Allowed values: DONE SKIP IN_PROGRESS

timecode

required

Timecode

integer

id

required

Id

string format: uuid

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

pagination

required

JSendPagination

Pagination information

object

total

required

Total

integer

start

required

Start

integer

end

required

End

integer

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string