Core
  1. Model
Core
  • Introduction
    • What is Core
    • HTTP Statuses
    • Request
    • Responses
    • Meta
    • Limit & Pagination
    • Query Parameters
  • Quick Start
    • Letters
  • Auth
    • Sign In with Email and Password
      POST
    • Get the Current Session
      GET
    • Sign Out the Current User
      POST
  • Users
    • Get All Users
      GET
    • Create a User
      POST
    • Retrieve an Existing User
      GET
    • Delete an Existing User
      DELETE
    • Update an Existing User
      PATCH
    • Get Current User
      GET
    • Update Current User
      PATCH
    • Get Current User Devices
      GET
    • Retrieve User Devices by User ID
      GET
    • Update Own Profile Image
      POST
    • Update User Image
      POST
    • Reset User Password
      PATCH
    • Get User Login History
      GET
  • Staff
    • Get All Staff
    • Retrieve an Existing Staff
    • Create a Staff
    • Delete an Existing Staff
    • Update an Existing Staff
  • Teachers
    • Get All Teachers
    • Retrieve an Existing Teacher
    • Create a Teacher
    • Delete an Existing Teacher
    • Update an Existing Teacher
  • Students
    • Get All Students
    • Retrieve an Existing Student
    • Create a Student
    • Delete an Existing Student
    • Update an Existing Student
    • Import Bulk Students
  • Roles
    • Get All Roles
    • Create a Role
    • Retrieve an Existing Role
    • Update an Existing Role
    • Delete an Existing Role
    • Get All Eligible Users for Role
    • Get All Members of Role
    • Add Bulk Member to Role
    • Remove Bulk Members from Role
  • Classes
    • Get All Classes
    • Create a Class
    • Delete an Existing Student Copy
    • Create a Class Copy
  • Statistics
    • Teachers
      • Get Teacher Gender Stats
      • Get Teacher Religion Distribution
      • Get Teacher Employment Stats
      • Get Teacher Age Stats
    • Students
      • Get Student Gender Stats
      • Get Student Religion Distribution
      • Get Student Weight Stats
      • Get Student Height Stats
      • Get Student Age Stats
      • Get Student Transportation Stats
      • Get Student Class Stats
    • Staffs
      • Get Staffs Gender Stats
      • Get Staffs Religion Distribution
      • Get Staffs Age Stats
      • Get Staffs Employment Stats
    • Users
      • Retrieve User Summary
    • Get All Stats
  • Letters
    • Get All Letters
    • Retrieve an Existing Letter
    • Create a Letter
    • List User Letter
    • List Current User Letter
    • List Recipients
  • Letter Actions
    • Initiate a Letter Action
  • Files
    • Create a Presigned URL
  • Schemas
    • Schemas
      • Letter
        • LetterHistory
        • LetterStatus
        • LetterType
      • User
        • UserProfile
      • Address
      • Meta
      • Base
      • bloodType
      • Religion
      • Gender
      • ParentInfo
      • Error
      • GenderStats
      • ReligionDistribution
      • WeightStats
      • HeightStats
      • AgeStats
      • TransportationStats
      • ClassStats
      • EducationHistoryObject
      • EmploymentStats
      • Location
      • EconomyStats
      • Actor
    • Model
      • User
      • Teacher
      • Staff
      • Student
      • Letter
      • Class
      • Roles
    • LoginHistory
  1. Model

Roles

{
    "id": "string",
    "name": "string",
    "icon": "string",
    "color": "string",
    "permissions": [
        "string"
    ],
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}
Built with