Categories Resource

Description

Categories are used to organize modules (Articulate Rise 360 Microlearning). Categories can be created by admins of Project Arc, and are then used to group modules logically. Each category stores references to the module IDs it contains.

Categories

Modules are grouped into categories, and a single module may belong to multiple categories.

Example

Categories:

{
  "_id": string,
  "createdAt": number,
  "updatedAt": number,
  "name": string,
  "description": string,
  "schemaVersion": 1,
  "tags": string[],
}

Create Category - (Project Arc Admin)

POST /categories

Example Request:

{
  "name": "Cybersecurity",
  "description": "Security awareness training modules",
  "tags": ["New", "Popular"]
}

Example Response (201 Created):

{
  "success": true,
  "message": "created category successfully.",
  "data": {
    "name": "Cybersecurity",
    "description": "Security awareness training modules",
    "tags": ["New", "Popular"],
  }
}

---

Get All Categories

GET /categories

Example Response (200 OK):

{
  "success": true,
  "message": "retrieved categories successfully.",
  "data": [
    {
      "_id": "cat123",
      "createdAt": 1672444800000,
      "updatedAt": 1672444800000,
      "name": "Cybersecurity",
      "description": "Security awareness training modules",
      "schemaVersion": 1,
      "tags": ["New"],
      "moduleCount": 3
    }
    // ...more categories
  ]
}

---

Get Category by ID

GET /categories/{category_id}

Example Response (200 OK):

{
  "success": true,
  "message": "retrieved category successfully.",
  "data": {
    "_id": "cat123",
    "createdAt": 1672444800000,
    "updatedAt": 1672444800000,
    "name": "Cybersecurity",
    "description": "Security awareness training modules",
    "schemaVersion": 1,
    "tags": ["New"],
    "moduleCount": 2
  }
}

---

Update Category - (Project-Arc Admin)

PATCH /categories/{category_id}

Example Request:

{
  "tags": ["Popular"], // optional
}

Example Response (200 OK):

{
  "success": true,
  "message": "updated category successfully.",
  "data": {
    "name": "Cybersecurity",
    "description": "Security awareness training modules",
    "tags": ["Popular"],
  }
}

---

Delete Category - (Project-Arc Admin)

DELETE /categories/{category_id}

Example Response (200 OK):

{
  "success": true,
  "message": "deleted category successfully."
}