Library Assignments


Get Library Assignment details

Properties

  • Name
    key
    Type
    string
    Description

    Top-level assignment key (e.g. library_intro_research_assignment_convertible).

  • Name
    name
    Type
    string
    Description

    Human-readable assignment set name.

  • Name
    cost
    Type
    integer
    Description

    Cost to unlock the assignment set.

  • Name
    rewardPoints
    Type
    integer
    Description

    Reward points granted for the set.

  • Name
    rewards
    Type
    array
    Description

    Array of reward names (strings).

  • Name
    assignments
    Type
    array
    Description

    Array of assignment objects.

  • Name
    assignments[].name
    Type
    string
    Description

    Assignment subsection name (may be empty).

  • Name
    assignments[].tasks
    Type
    array
    Description

    Array of task objects for the assignment.

  • Name
    assignments[].tasks[].title
    Type
    string
    Description

    Task title or requirement heading (may be empty).

  • Name
    assignments[].tasks[].text
    Type
    array
    Description

    List of task option strings or requirement lines.

Request

GET
https://api.mouse.rip/library-assignments
const libraryAssignments = await fetch('https://api.mouse.rip/library-assignments">
console.log(libraryAssignments)

Response

{
  "library_intro_research_assignment_convertible": {
    "name": "Catalog Library Mice",
    "cost": 0,
    "rewardPoints": 20,
    "rewards": ["Yellow Tome of Wisdom", "Wealth Charms"],
    "assignments": [
      {
        "name": "Catalog Library Assignment",
        "tasks": [
          {
            "title": "All seven of the following:",
            "text": [
              "1 Bookborn Mouse",
              "1 Effervescent Mouse",
              "1 Explorator Mouse",
              "1 Flutterby Mouse",
              "1 Infiltrator Mouse",
              "1 Pocketwatch Mouse",
              "1 Walker Mouse"
            ]
          }
        ]
      }
    ]
  },
  "library_research_assignment_convertible": {
    "name": "Library Research",
    "cost": 20,
    "rewardPoints": 30,
    "rewards": ["Yellow Tome of Wisdom", "Green Tome of Wisdom", "Purple Tome of Wisdom", "Wealth Charms"],
    "assignments": [
      {
        "name": "Library Mice Assignment",
        "tasks": [
          {
            "title": "Two of the following:",
            "text": [
              "1 Bookborn Mouse",
              "1 Flutterby Mouse",
              "1 Steam Grip Mouse",
              "1 Tome Sprite Mouse",
              "1 Scribe Mouse"
            ]
          },
          {
            "title": "Three of the following:",
            "text": [
              "2 Effervescent Mice",
              "2 Explorator Mice",
              "2 Infiltrator Mice",
            ...