REST API GUIDE

tutorhub-platformadmin-service

Version: 1.0.2

Architectural Design Credit and Contact Information

The architectural design of this microservice is credited to . For inquiries, feedback, or further information regarding the architecture, please direct your communication to:

Email:

We encourage open communication and welcome any questions or discussions related to the architectural aspects of this microservice.

Documentation Scope

Welcome to the official documentation for the PlatformAdmin Service’s REST API. This document is designed to provide a comprehensive guide to interfacing with our PlatformAdmin Service exclusively through RESTful API endpoints.

Intended Audience

This documentation is intended for developers and integrators who are looking to interact with the PlatformAdmin Service via HTTP requests for purposes such as creating, updating, deleting and querying PlatformAdmin objects.

Overview

Within these pages, you will find detailed information on how to effectively utilize the REST API, including authentication methods, request and response formats, endpoint descriptions, and examples of common use cases.

Beyond REST It’s important to note that the PlatformAdmin Service also supports alternative methods of interaction, such as gRPC and messaging via a Message Broker. These communication methods are beyond the scope of this document. For information regarding these protocols, please refer to their respective documentation.

Authentication And Authorization

To ensure secure access to the PlatformAdmin service’s protected endpoints, a project-wide access token is required. This token serves as the primary method for authenticating requests to our service. However, it’s important to note that access control varies across different routes:

Protected API: Certain API (routes) require specific authorization levels. Access to these routes is contingent upon the possession of a valid access token that meets the route-specific authorization criteria. Unauthorized requests to these routes will be rejected.

**Public API **: The service also includes public API (routes) that are accessible without authentication. These public endpoints are designed for open access and do not require an access token.

Token Locations

When including your access token in a request, ensure it is placed in one of the following specified locations. The service will sequentially search these locations for the token, utilizing the first one it encounters.

Location Token Name / Param Name
Query access_token
Authorization Header Bearer
Header tutorhub-access-token
Cookie tutorhub-access-token

Please ensure the token is correctly placed in one of these locations, using the appropriate label as indicated. The service prioritizes these locations in the order listed, processing the first token it successfully identifies.

Api Definitions

This section outlines the API endpoints available within the PlatformAdmin service. Each endpoint can receive parameters through various methods, meticulously described in the following definitions. It’s important to understand the flexibility in how parameters can be included in requests to effectively interact with the PlatformAdmin service.

This service is configured to listen for HTTP requests on port 3005, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

This service is accessible via the following environment-specific URLs:

Parameter Inclusion Methods: Parameters can be incorporated into API requests in several ways, each with its designated location. Understanding these methods is crucial for correctly constructing your requests:

Query Parameters: Included directly in the URL’s query string.

Path Parameters: Embedded within the URL’s path.

Body Parameters: Sent within the JSON body of the request.

Session Parameters: Automatically read from the session object. This method is used for parameters that are intrinsic to the user’s session, such as userId. When using an API that involves session parameters, you can omit these from your request. The service will automatically bind them to the API layer, provided that a session is associated with your request.

Note on Session Parameters: Session parameters represent a unique method of parameter inclusion, relying on the context of the user’s session. A common example of a session parameter is userId, which the service automatically associates with your request when a session exists. This feature ensures seamless integration of user-specific data without manual input for each request.

By adhering to the specified parameter inclusion methods, you can effectively utilize the PlatformAdmin service’s API endpoints. For detailed information on each endpoint, including required parameters and their accepted locations, refer to the individual API definitions below.

Common Parameters

The PlatformAdmin service’s business API support several common parameters designed to modify and enhance the behavior of API requests. These parameters are not individually listed in the API route definitions to avoid repetition. Instead, refer to this section to understand how to leverage these common behaviors across different routes. Note that all common parameters should be included in the query part of the URL.

Supported Common Parameters:

By utilizing these common parameters, you can tailor the behavior of API requests to suit your specific requirements, ensuring optimal performance and usability of the PlatformAdmin service.

Error Response

If a request encounters an issue, whether due to a logical fault or a technical problem, the service responds with a standardized JSON error structure. The HTTP status code within this response indicates the nature of the error, utilizing commonly recognized codes for clarity:

Each error response is structured to provide meaningful insight into the problem, assisting in diagnosing and resolving issues efficiently.

{
  "result": "ERR",
  "status": 400,
  "message": "errMsg_organizationIdisNotAValidID",
  "errCode": 400,
  "date": "2024-03-19T12:13:54.124Z",
  "detail": "String"
}

Object Structure of a Successfull Response

When the PlatformAdmin service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope not only contains the data but also includes essential metadata, such as configuration details and pagination information, to enrich the response and provide context to the client.

Key Characteristics of the Response Envelope:

Design Considerations: The structure of a API’s response data is meticulously crafted during the service’s architectural planning. This design ensures that responses adequately reflect the intended data relationships and service logic, providing clients with rich and meaningful information.

Brief Data: Certain API’s return a condensed version of the object data, intentionally selecting only specific fields deemed useful for that request. In such instances, the API documentation will detail the properties included in the response, guiding developers on what to expect.

API Response Structure

The API utilizes a standardized JSON envelope to encapsulate responses. This envelope is designed to consistently deliver both the requested data and essential metadata, ensuring that clients can efficiently interpret and utilize the response.

HTTP Status Codes:

Success Response Format:

For successful operations, the response includes a "status": "OK" property, signaling the successful execution of the request. The structure of a successful response is outlined below:

{
  "status":"OK",
  "statusCode": 200,   
  "elapsedMs":126,
  "ssoTime":120,
  "source": "db",
  "cacheKey": "hexCode",
  "userId": "ID",
  "sessionId": "ID",
  "requestId": "ID",
  "dataName":"products",
  "method":"GET",
  "action":"list",
  "appVersion":"Version",
  "rowCount":3
  "products":[{},{},{}],
  "paging": {
    "pageNumber":1, 
    "pageRowCount":25, 
    "totalRowCount":3,
    "pageCount":1
  },
  "filters": [],
  "uiPermissions": []
}

Handling Errors:

For details on handling error scenarios and understanding the structure of error responses, please refer to the “Error Response” section provided earlier in this documentation. It outlines how error conditions are communicated, including the use of HTTP status codes and standardized JSON structures for error messages.

Resources

PlatformAdmin service provides the following resources which are stored in its own database as a data object. Note that a resource for an api access is a data object for the service.

AdminIssue resource

AdminIssue Resource Properties

Name Type Required Default Definition
reportedBy ID User who filed the issue (student or tutor).
reportedUserId ID (Optional) User being complained about
coursePackId ID (Optional) ID of the related coursePack, if content/pack is complained about
description Text Long text/body of the complaint/issue.
issueType Enum Type of complaint (user, content, or other).
status Enum Issue investigation status (open/investigating/resolved/dismissed).
adminNote String Internal/admin note for progress or findings (not visible to original user).
resolution Enum Resolution outcome chosen by admin when closing the issue.

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

issueType Enum Property

Property Definition : Type of complaint (user, content, or other).Enum Options

Name Value Index
user "user"" 0
content "content"" 1
other "other"" 2
status Enum Property

Property Definition : Issue investigation status (open/investigating/resolved/dismissed).Enum Options

Name Value Index
open "open"" 0
investigating "investigating"" 1
resolved "resolved"" 2
dismissed "dismissed"" 3
resolution Enum Property

Property Definition : Resolution outcome chosen by admin when closing the issue.Enum Options

Name Value Index
dismissed "dismissed"" 0
warned "warned"" 1
courseEditRequired "courseEditRequired"" 2
courseRemoved "courseRemoved"" 3
userSuspended "userSuspended"" 4
userBanned "userBanned"" 5
acknowledged "acknowledged"" 6

AdminModerationAction resource

Resource Definition : Action performed by an admin to moderate user, coursePack, profile, or material. All admin actions logged for audit trail. Only admins can create. AdminModerationAction Resource Properties

Name Type Required Default Definition
adminId ID Admin performing moderation action.
targetType Enum Moderation target type (user/coursePack/profile/material).
targetId ID ID of moderation target object (userId, coursePackId, etc).
actionType Enum Type of moderation action (suspend, ban, edit, remove, approve, warn).
actionReason String Reason for moderation action, as recorded by the admin.
actionDate Date Datetime when the action took place.
targetUserId ID UserId of the person affected by the moderation action. For user moderation: the user being moderated. For content moderation: the tutor who owns the content.

Enum Properties

Enum properties are represented as strings in the database. The values are mapped to their corresponding names in the application layer.

targetType Enum Property

Property Definition : Moderation target type (user/coursePack/profile/material).Enum Options

Name Value Index
user "user"" 0
coursePack "coursePack"" 1
profile "profile"" 2
material "material"" 3
actionType Enum Property

Property Definition : Type of moderation action (suspend, ban, edit, remove, approve, warn).Enum Options

Name Value Index
suspend "suspend"" 0
ban "ban"" 1
edit "edit"" 2
remove "remove"" 3
approve "approve"" 4
warn "warn"" 5

AdminAnalyticsReport resource

Resource Definition : Stores generated analytics/reporting URLs/metadata for admin dashboard access. Reports are generated by backend tasks/edge (future), but listing is for download/view. AdminAnalyticsReport Resource Properties

Name Type Required Default Definition
reportType String Type of the analytics report (enrollments, revenue, complaints, etc).
filterParams String Filter params as stringified JSON for reporting input.
generatedAt Date Date/time report was generated.
reportUrl String Accessible URL where generated report is stored (PDF, CSV, etc).

Business Api

Create Adminissue API

[Default create API] — This is the designated default create API for the adminIssue data object. Frontend generators and AI agents should use this API for standard CRUD operations. Student or tutor files a new complaint/issue. Admin receives for review/investigation. Only admins can update or alter status; creator can get their own.

Rest Route

The createAdminIssue API REST controller can be triggered via the following route:

/v1/adminissues

Rest Request Parameters

The createAdminIssue api has got 8 regular request parameters

Parameter Type Required Population
reportedBy ID true request.body?.[“reportedBy”]
reportedUserId ID false request.body?.[“reportedUserId”]
coursePackId ID false request.body?.[“coursePackId”]
description Text true request.body?.[“description”]
issueType Enum true request.body?.[“issueType”]
status Enum true request.body?.[“status”]
adminNote String false request.body?.[“adminNote”]
resolution Enum false request.body?.[“resolution”]
reportedBy : User who filed the issue (student or tutor).
reportedUserId : (Optional) User being complained about
coursePackId : (Optional) ID of the related coursePack, if content/pack is complained about
description : Long text/body of the complaint/issue.
issueType : Type of complaint (user, content, or other).
status : Issue investigation status (open/investigating/resolved/dismissed).
adminNote : Internal/admin note for progress or findings (not visible to original user).
resolution : Resolution outcome chosen by admin when closing the issue.

REST Request To access the api you can use the REST controller with the path POST /v1/adminissues

  axios({
    method: 'POST',
    url: '/v1/adminissues',
    data: {
            reportedBy:"ID",  
            reportedUserId:"ID",  
            coursePackId:"ID",  
            description:"Text",  
            issueType:"Enum",  
            status:"Enum",  
            adminNote:"String",  
            resolution:"Enum",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminIssue",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"adminIssue": {
		"id": "ID",
		"reportedBy": "ID",
		"reportedUserId": "ID",
		"coursePackId": "ID",
		"description": "Text",
		"issueType": "Enum",
		"issueType_idx": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"adminNote": "String",
		"resolution": "Enum",
		"resolution_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Adminissue API

[Default update API] — This is the designated default update API for the adminIssue data object. Frontend generators and AI agents should use this API for standard CRUD operations. Admin investigates/updates an issue: change status, add internal note, resolve/dismiss. Strictly admin-only.

Rest Route

The updateAdminIssue API REST controller can be triggered via the following route:

/v1/adminissues/:adminIssueId

Rest Request Parameters

The updateAdminIssue api has got 8 regular request parameters

Parameter Type Required Population
adminIssueId ID true request.params?.[“adminIssueId”]
reportedUserId ID false request.body?.[“reportedUserId”]
coursePackId ID false request.body?.[“coursePackId”]
description Text false request.body?.[“description”]
issueType Enum false request.body?.[“issueType”]
status Enum false request.body?.[“status”]
adminNote String false request.body?.[“adminNote”]
resolution Enum false request.body?.[“resolution”]
adminIssueId : This id paremeter is used to select the required data object that will be updated
reportedUserId : (Optional) User being complained about
coursePackId : (Optional) ID of the related coursePack, if content/pack is complained about
description : Long text/body of the complaint/issue.
issueType : Type of complaint (user, content, or other).
status : Issue investigation status (open/investigating/resolved/dismissed).
adminNote : Internal/admin note for progress or findings (not visible to original user).
resolution : Resolution outcome chosen by admin when closing the issue.

REST Request To access the api you can use the REST controller with the path PATCH /v1/adminissues/:adminIssueId

  axios({
    method: 'PATCH',
    url: `/v1/adminissues/${adminIssueId}`,
    data: {
            reportedUserId:"ID",  
            coursePackId:"ID",  
            description:"Text",  
            issueType:"Enum",  
            status:"Enum",  
            adminNote:"String",  
            resolution:"Enum",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminIssue",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"adminIssue": {
		"id": "ID",
		"reportedBy": "ID",
		"reportedUserId": "ID",
		"coursePackId": "ID",
		"description": "Text",
		"issueType": "Enum",
		"issueType_idx": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"adminNote": "String",
		"resolution": "Enum",
		"resolution_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"reporterUser": {}
}

Get Adminissue API

[Default get API] — This is the designated default get API for the adminIssue data object. Frontend generators and AI agents should use this API for standard CRUD operations. Fetches a single issue by ID. Admins may get any; creator may get/view their own for status updates.

Rest Route

The getAdminIssue API REST controller can be triggered via the following route:

/v1/adminissues/:adminIssueId

Rest Request Parameters

The getAdminIssue api has got 1 regular request parameter

Parameter Type Required Population
adminIssueId ID true request.params?.[“adminIssueId”]
adminIssueId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/adminissues/:adminIssueId

  axios({
    method: 'GET',
    url: `/v1/adminissues/${adminIssueId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

This route’s response is constrained to a select list of properties, and therefore does not encompass all attributes of the resource.

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminIssue",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"adminIssue": {
		"reporter": {
			"email": "String",
			"fullname": "String"
		},
		"reportedUser": {
			"email": "String",
			"fullname": "String"
		},
		"coursePack": {
			"tutorProfileId": "ID",
			"title": "String"
		},
		"isActive": true
	}
}

List Adminissues API

[Default list API] — This is the designated default list API for the adminIssue data object. Frontend generators and AI agents should use this API for standard CRUD operations. List issues with filters for admin dashboard: by status/type/target. Admin only.

Rest Route

The listAdminIssues API REST controller can be triggered via the following route:

/v1/adminissues

Rest Request Parameters The listAdminIssues api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/adminissues

  axios({
    method: 'GET',
    url: '/v1/adminissues',
    data: {
    
    },
    params: {
    
        }
  });

REST Response

This route’s response is constrained to a select list of properties, and therefore does not encompass all attributes of the resource.

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminIssues",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"adminIssues": [
		{
			"reporter": [
				{
					"email": "String",
					"fullname": "String",
					"roleId": "String"
				},
				{},
				{}
			],
			"reportedUser": [
				{
					"email": "String",
					"fullname": "String",
					"roleId": "String"
				},
				{},
				{}
			],
			"coursePack": [
				{
					"tutorProfileId": "ID",
					"title": "String"
				},
				{},
				{}
			],
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Adminmoderationaction API

[Default create API] — This is the designated default create API for the adminModerationAction data object. Frontend generators and AI agents should use this API for standard CRUD operations. Admin records a moderation action against a user/object. Admin only. Write-side audit log for all moderator events.

Rest Route

The createAdminModerationAction API REST controller can be triggered via the following route:

/v1/adminmoderationactions

Rest Request Parameters

The createAdminModerationAction api has got 7 regular request parameters

Parameter Type Required Population
adminId ID true request.body?.[“adminId”]
targetType Enum true request.body?.[“targetType”]
targetId ID true request.body?.[“targetId”]
actionType Enum true request.body?.[“actionType”]
actionReason String true request.body?.[“actionReason”]
actionDate Date true request.body?.[“actionDate”]
targetUserId ID true request.body?.[“targetUserId”]
adminId : Admin performing moderation action.
targetType : Moderation target type (user/coursePack/profile/material).
targetId : ID of moderation target object (userId, coursePackId, etc).
actionType : Type of moderation action (suspend, ban, edit, remove, approve, warn).
actionReason : Reason for moderation action, as recorded by the admin.
actionDate : Datetime when the action took place.
targetUserId : UserId of the person affected by the moderation action. For user moderation: the user being moderated. For content moderation: the tutor who owns the content.

REST Request To access the api you can use the REST controller with the path POST /v1/adminmoderationactions

  axios({
    method: 'POST',
    url: '/v1/adminmoderationactions',
    data: {
            adminId:"ID",  
            targetType:"Enum",  
            targetId:"ID",  
            actionType:"Enum",  
            actionReason:"String",  
            actionDate:"Date",  
            targetUserId:"ID",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminModerationAction",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"adminModerationAction": {
		"id": "ID",
		"adminId": "ID",
		"targetType": "Enum",
		"targetType_idx": "Integer",
		"targetId": "ID",
		"actionType": "Enum",
		"actionType_idx": "Integer",
		"actionReason": "String",
		"actionDate": "Date",
		"targetUserId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"targetUser": {}
}

Get Adminmoderationaction API

[Default get API] — This is the designated default get API for the adminModerationAction data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get one moderation action. Admin only.

Rest Route

The getAdminModerationAction API REST controller can be triggered via the following route:

/v1/adminmoderationactions/:adminModerationActionId

Rest Request Parameters

The getAdminModerationAction api has got 1 regular request parameter

Parameter Type Required Population
adminModerationActionId ID true request.params?.[“adminModerationActionId”]
adminModerationActionId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/adminmoderationactions/:adminModerationActionId

  axios({
    method: 'GET',
    url: `/v1/adminmoderationactions/${adminModerationActionId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

This route’s response is constrained to a select list of properties, and therefore does not encompass all attributes of the resource.

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminModerationAction",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"adminModerationAction": {
		"admin": {
			"email": "String",
			"fullname": "String"
		},
		"isActive": true
	}
}

List Adminmoderationactions API

[Default list API] — This is the designated default list API for the adminModerationAction data object. Frontend generators and AI agents should use this API for standard CRUD operations. List all admin moderation actions, filterable by actionType/targetType/date. For admin dashboard audit log.

Rest Route

The listAdminModerationActions API REST controller can be triggered via the following route:

/v1/adminmoderationactions

Rest Request Parameters The listAdminModerationActions api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/adminmoderationactions

  axios({
    method: 'GET',
    url: '/v1/adminmoderationactions',
    data: {
    
    },
    params: {
    
        }
  });

REST Response

This route’s response is constrained to a select list of properties, and therefore does not encompass all attributes of the resource.

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminModerationActions",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"adminModerationActions": [
		{
			"admin": [
				{
					"email": "String",
					"fullname": "String"
				},
				{},
				{}
			],
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Adminanalyticsreport API

[Default create API] — This is the designated default create API for the adminAnalyticsReport data object. Frontend generators and AI agents should use this API for standard CRUD operations. Create record for a new analytics report (usually admin-triggered on dashboard, actual report process may be async via edge controller in future). Admin-only; records metadata and download URL of available report.

Rest Route

The createAdminAnalyticsReport API REST controller can be triggered via the following route:

/v1/adminanalyticsreports

Rest Request Parameters

The createAdminAnalyticsReport api has got 4 regular request parameters

Parameter Type Required Population
reportType String true request.body?.[“reportType”]
filterParams String false request.body?.[“filterParams”]
generatedAt Date true request.body?.[“generatedAt”]
reportUrl String true request.body?.[“reportUrl”]
reportType : Type of the analytics report (enrollments, revenue, complaints, etc).
filterParams : Filter params as stringified JSON for reporting input.
generatedAt : Date/time report was generated.
reportUrl : Accessible URL where generated report is stored (PDF, CSV, etc).

REST Request To access the api you can use the REST controller with the path POST /v1/adminanalyticsreports

  axios({
    method: 'POST',
    url: '/v1/adminanalyticsreports',
    data: {
            reportType:"String",  
            filterParams:"String",  
            generatedAt:"Date",  
            reportUrl:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminAnalyticsReport",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"adminAnalyticsReport": {
		"id": "ID",
		"reportType": "String",
		"filterParams": "String",
		"generatedAt": "Date",
		"reportUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Adminanalyticsreport API

[Default get API] — This is the designated default get API for the adminAnalyticsReport data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get one analytics report record for download from admin dashboard. Admin only.

Rest Route

The getAdminAnalyticsReport API REST controller can be triggered via the following route:

/v1/adminanalyticsreports/:adminAnalyticsReportId

Rest Request Parameters

The getAdminAnalyticsReport api has got 1 regular request parameter

Parameter Type Required Population
adminAnalyticsReportId ID true request.params?.[“adminAnalyticsReportId”]
adminAnalyticsReportId : This id paremeter is used to query the required data object.

REST Request To access the api you can use the REST controller with the path GET /v1/adminanalyticsreports/:adminAnalyticsReportId

  axios({
    method: 'GET',
    url: `/v1/adminanalyticsreports/${adminAnalyticsReportId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

This route’s response is constrained to a select list of properties, and therefore does not encompass all attributes of the resource.

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminAnalyticsReport",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"adminAnalyticsReport": {
		"isActive": true
	}
}

List Adminanalyticsreports API

[Default list API] — This is the designated default list API for the adminAnalyticsReport data object. Frontend generators and AI agents should use this API for standard CRUD operations. List all analytics reports for admin dashboard access (download/view). Admin only.

Rest Route

The listAdminAnalyticsReports API REST controller can be triggered via the following route:

/v1/adminanalyticsreports

Rest Request Parameters The listAdminAnalyticsReports api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/adminanalyticsreports

  axios({
    method: 'GET',
    url: '/v1/adminanalyticsreports',
    data: {
    
    },
    params: {
    
        }
  });

REST Response

This route’s response is constrained to a select list of properties, and therefore does not encompass all attributes of the resource.

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminAnalyticsReports",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"adminAnalyticsReports": [
		{
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Myissues API

Students and tutors list their own reported issues. Ownership check ensures users only see their own reports.

Rest Route

The listMyIssues API REST controller can be triggered via the following route:

/v1/myissues

Rest Request Parameters The listMyIssues api has got no request parameters.

REST Request To access the api you can use the REST controller with the path GET /v1/myissues

  axios({
    method: 'GET',
    url: '/v1/myissues',
    data: {
    
    },
    params: {
    
        }
  });

REST Response

This route’s response is constrained to a select list of properties, and therefore does not encompass all attributes of the resource.

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "adminIssues",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"adminIssues": [
		{
			"reportedUser": [
				{
					"email": "String",
					"fullname": "String"
				},
				{},
				{}
			],
			"coursePack": [
				{
					"title": "String"
				},
				{},
				{}
			],
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Authentication Specific Routes

Common Routes

Route: currentuser

Route Definition: Retrieves the currently authenticated user’s session information.

Route Type: sessionInfo

Access Route: GET /currentuser

Parameters

This route does not require any request parameters.

Behavior

// Sample GET /currentuser call
axios.get("/currentuser", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response Returns the session object, including user-related data and token information.

{
  "sessionId": "9cf23fa8-07d4-4e7c-80a6-ec6d6ac96bb9",
  "userId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
  "email": "user@example.com",
  "fullname": "John Doe",
  "roleId": "user",
  "tenantId": "abc123",
  "accessToken": "jwt-token-string",
  ...
}

Error Response 401 Unauthorized: No active session found.

{
  "status": "ERR",
  "message": "No login found"
}

Notes

Route: permissions

*Route Definition*: Retrieves all effective permission records assigned to the currently authenticated user.

*Route Type*: permissionFetch

Access Route: GET /permissions

Parameters

This route does not require any request parameters.

Behavior

// Sample GET /permissions call
axios.get("/permissions", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

Returns an array of permission objects.

[
  {
    "id": "perm1",
    "permissionName": "adminPanel.access",
    "roleId": "admin",
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  },
  {
    "id": "perm2",
    "permissionName": "orders.manage",
    "roleId": null,
    "subjectUserId": "d92b9d4c-9b1e-4e95-842e-3fb9c8c1df38",
    "subjectUserGroupId": null,
    "objectId": null,
    "canDo": true,
    "tenantCodename": "store123"
  }
]

Each object reflects a single permission grant, aligned with the givenPermissions model:

Error Responses

{
  "status": "ERR",
  "message": "No login found"
}

Notes

Tip: Applications can cache permission results client-side or server-side, but should occasionally refresh by calling this endpoint, especially after login or permission-changing operations.

Route: permissions/:permissionName

Route Definition: Checks whether the current user has access to a specific permission, and provides a list of scoped object exceptions or inclusions.

Route Type: permissionScopeCheck

Access Route: GET /permissions/:permissionName

Parameters

Parameter Type Required Population
permissionName String Yes request.params.permissionName

Behavior

// Sample GET /permissions/orders.manage
axios.get("/permissions/orders.manage", {
  headers: {
    "Authorization": "Bearer your-jwt-token"
  }
});

Success Response

{
  "canDo": true,
  "exceptions": [
    "a1f2e3d4-xxxx-yyyy-zzzz-object1",
    "b2c3d4e5-xxxx-yyyy-zzzz-object2"
  ]
}

All sources, documents and other digital materials are copyright of .

About Us

For more information please visit our website: .

. .