@bachman-dev/wanikani-api-types - v2.0.0
    Preparing search index...

    Interface Assignment

    Assignments contain information about a user's progress on a particular subject, including their current state and timestamps for various progress milestones. Assignments are created when a user has passed all the components of the given subject and the assignment is at or below their current level for the first time.

    https://docs.api.wanikani.com/20170710/#assignments

    interface Assignment {
        data: {
            available_at: null | DatableString;
            burned_at: null | DatableString;
            created_at: DatableString;
            hidden: boolean;
            passed_at: null | DatableString;
            resurrected_at: null | DatableString;
            srs_stage: SpacedRepetitionSystemStageNumber;
            started_at: null | DatableString;
            subject_id: number;
            subject_type: SubjectType;
            unlocked_at: null | DatableString;
        };
        data_updated_at: DatableString;
        id: number;
        object: "assignment";
        url: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    data data_updated_at id object url

    Properties

    data: {
        available_at: null | DatableString;
        burned_at: null | DatableString;
        created_at: DatableString;
        hidden: boolean;
        passed_at: null | DatableString;
        resurrected_at: null | DatableString;
        srs_stage: SpacedRepetitionSystemStageNumber;
        started_at: null | DatableString;
        subject_id: number;
        subject_type: SubjectType;
        unlocked_at: null | DatableString;
    }

    Data for the returned assignment.

    Type declaration

    • available_at: null | DatableString

      When the related subject will be available in the user's review queue.

    • burned_at: null | DatableString

      When the user reaches SRS stage 9 the first time.

    • created_at: DatableString

      When the assignment was created.

    • hidden: boolean

      Indicates if the associated subject has been hidden, preventing it from appearing in lessons or reviews.

    • passed_at: null | DatableString

      When the user reaches SRS stage 5 for the first time.

    • resurrected_at: null | DatableString

      When the subject is resurrected and placed back in the user's review queue.

    • srs_stage: SpacedRepetitionSystemStageNumber

      The current SRS stage interval. The interval range is determined by the related subject's Spaced Repetition System.

    • started_at: null | DatableString

      When the user completes the lesson for the related subject.

    • subject_id: number

      Unique identifier of the associated subject.

    • subject_type: SubjectType

      The type of the associated subject.

    • unlocked_at: null | DatableString

      When the related subjects has its prerequisites satisfied and is made available in lessons.

      Prerequisites are:

      • The subject components have reached SRS stage 5 once (they have been “passed”).
      • The user's level is equal to or greater than the level of the assignment’s subject.
    data_updated_at: DatableString

    For a resource, this is the last time that particular resource was updated.

    id: number

    A unique number identifying the assignment.

    object: "assignment"

    The kind of object returned.

    url: string

    The URL of the requested resource.

    Settings

    On This Page

    Properties