Interface WKAssignmentParameters

Parameters that can be passed to the WaniKani API to filter a request for an Assignment Collection.

See

interface WKAssignmentParameters {
    available_after?: WKDatableString | Date;
    available_before?: WKDatableString | Date;
    burned?: boolean;
    hidden?: boolean;
    ids?: number[];
    immediately_available_for_lessons?: boolean;
    immediately_available_for_review?: boolean;
    in_review?: boolean;
    levels?: WKLevel[];
    page_after_id?: number;
    page_before_id?: number;
    srs_stages?: WKSrsStageNumber[];
    started?: boolean;
    subject_ids?: number[];
    subject_types?: WKSubjectTuple;
    unlocked?: boolean;
    updated_after?: WKDatableString | Date;
}

Hierarchy (View Summary)

Properties

available_after? available_before? burned? hidden? ids? immediately_available_for_lessons? immediately_available_for_review? in_review? levels? page_after_id? page_before_id? srs_stages? started? subject_ids? subject_types? unlocked? updated_after?

Properties

Optionalavailable_after

available_after?: WKDatableString | Date

Only assignments available at or after this time are returned.

Optionalavailable_before

available_before?: WKDatableString | Date

Only assignments available at or before this time are returned.

Optionalburned

burned?: boolean

When set to true, returns assignments that have a value in data.burned_at. Returns assignments with a null data.burned_at if false.

Optionalhidden

hidden?: boolean

Return assignments with a matching value in the hidden attribute.

Optionalids

ids?: number[]

Only resources where data.id matches one of the array values are returned.

Optionalimmediately_available_for_lessons

immediately_available_for_lessons?: boolean

When set to true, returns assignments which are immediately available for lessons.

Optionalimmediately_available_for_review

immediately_available_for_review?: boolean

When set to true, returns assignments which are immediately available for review.

Optionalin_review

in_review?: boolean

When set to true, returns assignments which are in the review state.

Optionallevels

levels?: WKLevel[]

Only assignments where the associated subject level matches one of the array values are returned. Valid values range from 1 to 60.

Optionalpage_after_id

page_after_id?: number

Get a collection's next page containing pages.per_page resources after the given ID.

This will take precedence over page_before_id if both are specified.

Optionalpage_before_id

page_before_id?: number

Get a collection's previous page containing pages.per_page resources before the given ID.

The page_after_id parameter takes precedence over this if it is specified alongside this parameter.

Optionalsrs_stages

srs_stages?: WKSrsStageNumber[]

Only assignments where data.srs_stage matches one of the array values are returned. Valid values range from 0 to 9.

Optionalstarted

started?: boolean

When set to true, returns assignments that have a value in data.started_at. Returns assignments with a null data.started_at if false.

Optionalsubject_ids

subject_ids?: number[]

Only assignments where data.subject_id matches one of the array values are returned.

Optionalsubject_types

subject_types?: WKSubjectTuple

Only assignments where data.subject_type matches one of the array values are returned. Valid values are: radical, kanji, or vocabulary.

Optionalunlocked

unlocked?: boolean

When set to true, returns assignments that have a value in data.unlocked_at. Returns assignments with a null data.unlocked_at if false.

Optionalupdated_after

updated_after?: WKDatableString | Date

Only resources updated after this time are returned.

Settings

On This Page

Properties