Interface RegistrationQueryOptions

Hierarchy

Properties

courseId?: string

Only retrieve resources having courseId

datetimeFilter?: DateFilterField

Specifies field that since and until parameters (see DateFilter) are applied to

filter?: string

Optional string which filters results by a specified field, described by filterBy

filterBy?: string

Optional parameter for specifying the field and order by which to sort the results. Valid values are :

  • tags
  • course_title
  • learner_first_name
  • learner_last_name
  • registration_id
includeChildResults?: boolean

Include information about each learning object, not just the top level in the results

includeInteractionsAndObjectives?: boolean

Include interactions and objectives in the results

includeRuntime?: boolean

Include runtime details in the results

learnerId?: string

Only retrieve resources having learnerId

more?: string

A pagination token that was returned on the more property of paginated requests. If there are more results to be collected, the token can be provided here to get the next page of results. When passing this token, no other filter parameters can be sent as part of the request. The resources will continue to respect the filters passed in by the original request.

orderBy?: string

Optional parameter for specifying the field and order by which to sort the results. Valid values are :

  • created_asc
  • created_desc
  • updated_asc
  • updated_desc
  • course_title_asc
  • course_title_desc
  • learner_first_name_asc
  • learner_first_name_desc
  • learner_last_name_asc
  • learner_last_name_desc
scope?: string

The auth scope to use for the given method invocation

since?: string

Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

tags?: string[]

Filter items matching ANY tag provided (not ALL)

until?: string

Filter by ISO 8601 TimeStamp inclusive (defaults to UTC)

Generated using TypeDoc