Documentation
Start typing to search…

🏫 Admin Platform Actions

Table of Contents

  1. Introduction
  2. List of Admin Actions
  3. Example Action: view_dashboard
  4. Example Action: view_student

Introduction

This section details the actions triggered within the admin platform when users navigate through different pages.

List of Admin Actions

  • view_app_parameters
  • view_dashboard
  • view_all_attendance_sheets
  • view_attendance_list
  • view_all_students
  • view_student
  • view_all_teachers
  • view_teacher
  • view_all_groups
  • view_group
  • view_all_externals
  • view_external
  • view_all_documents
  • view_document
  • view_all_surveys
  • view_survey
  • view_statistics
  • view_alerts
  • view_settings
  • view_all_trainings
  • view_training

Each action follows the same format as view_dashboard, replacing the relevant action in the LOCATION field of the request body.

Example Action: view_dashboard

Description

This action is triggered when an admin user views the dashboard.

Headers

{
  "x-edusign-webhook-type": "app-form-completion",
  "x-edusign-school-id": "school_id_placeholder",
  "x-edusign-app-id": "app_id_placeholder",
  "x-edusign-lang": "en",
  "x-edusign-hmac": "hmac_placeholder",
  "x-edusign-client-id": "client_id_placeholder"
}

Body

{
  "ACTION": "apicall",
  "LOCATION": "view_dashboard",
  "caller": {
    "userId": "user_id_placeholder",
    "userType": "school",
    "appId": "app_id_placeholder",
    "schoolId": "school_id_placeholder"
  },
  "context": {
    "schoolId": "school_id_placeholder"
  },
  "environment": {}
}

Expected Response

[
    {
        "id": "qf71q",
        "block": "title",
        "text": "Dashboard Overview"
    },
    {
        "id": "5h41k",
        "block": "text",
        "text": "# Welcome to the Dashboard\nHere you can find an overview of your platform's statistics and key insights."
    }
]

Example Action: view_student

Description

Triggered when an administrator views a student's details.

Headers

{
  "x-edusign-webhook-type": "app-form-completion",
  "x-edusign-school-id": "school_id_placeholder",
  "x-edusign-app-id": "app_id_placeholder",
  "x-edusign-lang": "en",
  "x-edusign-hmac": "hmac_placeholder",
  "x-edusign-client-id": "client_id_placeholder"
}

Body

{
  "ACTION": "apicall",
  "LOCATION": "view_student",
  "caller": {
    "userId": "user_id_placeholder",
    "userType": "school",
    "appId": "app_id_placeholder",
    "schoolId": "school_id_placeholder"
  },
  "context": {
    "studentId": "student_id_placeholder",
    "schoolId": "school_id_placeholder"
  },
  "environment": {}
}

Expected Response

[
  {
    "id": "unique_id_3",
    "block": "title",
    "text": "Student Details"
  },
  {
    "id": "unique_id_4",
    "block": "text",
    "text": "# Student Information\nDetails about the selected student."
  }
]

Updated 2 months ago

What’s Next