REST API GUIDE

tutorhub-coursescheduling-service

Version: 1.0.48

Handles all scheduling: tutor availability, lesson slot management/booking, preliminary meeting scheduling for screened courses. Ensures schedule privacy (authenticated only).

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 CourseScheduling Service’s REST API. This document is designed to provide a comprehensive guide to interfacing with our CourseScheduling Service exclusively through RESTful API endpoints.

Intended Audience

This documentation is intended for developers and integrators who are looking to interact with the CourseScheduling Service via HTTP requests for purposes such as creating, updating, deleting and querying CourseScheduling 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 CourseScheduling 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 CourseScheduling 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 CourseScheduling 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 CourseScheduling service.

This service is configured to listen for HTTP requests on port 3002, 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 CourseScheduling 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 CourseScheduling 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 CourseScheduling 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 CourseScheduling 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

CourseScheduling 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.

Availability resource

Resource Definition : Weekly availability window for a tutor, determines open slots for student booking. Each tuple is for a specific day/time window. Availability Resource Properties

Name Type Required Default Definition
tutorProfileId ID FK to tutorCatalog:tutorProfile. Only owner tutor or admin can edit.
dayOfWeek Enum Day of week: sunday-saturday.
startTime String Start time of window (HH:mm, 24h).
endTime String End time of window (HH:mm, 24h).
isRecurring Boolean If true, this slot recurs weekly.
specificDate Date Specific date (YYYY-MM-DD) for non-recurring availability. Null for recurring slots.
teachingMode Enum **

Enum Properties

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

dayOfWeek Enum Property

Property Definition : Day of week: sunday-saturday.Enum Options

Name Value Index
sunday "sunday"" 0
monday "monday"" 1
tuesday "tuesday"" 2
wednesday "wednesday"" 3
thursday "thursday"" 4
friday "friday"" 5
saturday "saturday"" 6
teachingMode Enum Property

Enum Options

Name Value Index
online "online"" 0
faceToFace "faceToFace"" 1
both "both"" 2

LessonSlot resource

LessonSlot Resource Properties

Name Type Required Default Definition
coursePackId ID FK to tutorCatalog:coursePack. Only tutors for the pack, enrolled student, or admin may update/view.
studentId ID FK to auth:user (student). Set on booking. Nullable when open (free).
scheduledDate Date Date for the lesson slot (yyyy-mm-dd).
scheduledTime String Start time of lesson (HH:mm 24h).
status Enum State of lesson slot (free, booked, completed, canceled).
locationType Enum **
locationDetails String Optional: Location address/details; editable after booking by either party.
sessionMode Enum Chosen delivery mode for this lesson. Set at booking time based on student choice or tutor's teachingMode. 'online' triggers Google Meet link generation, 'faceToFace' uses locationType/locationDetails.
meetLink String Google Meet URL for online lessons. Auto-populated when sessionMode is 'online'. Null for face-to-face sessions.

Enum Properties

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

status Enum Property

Property Definition : State of lesson slot (free, booked, completed, canceled).Enum Options

Name Value Index
free "free"" 0
booked "booked"" 1
completed "completed"" 2
canceled "canceled"" 3
locationType Enum Property

Enum Options

Name Value Index
online "online"" 0
studentHome "studentHome"" 1
tutorHome "tutorHome"" 2
other "other"" 3
sessionMode Enum Property

Property Definition : Chosen delivery mode for this lesson. Set at booking time based on student choice or tutor's teachingMode. 'online' triggers Google Meet link generation, 'faceToFace' uses locationType/locationDetails.Enum Options

Name Value Index
online "online"" 0
faceToFace "faceToFace"" 1

PreliminaryMeeting resource

Resource Definition : Request for a pre-enrollment screening meeting with a tutor, required for some advanced coursePacks. PreliminaryMeeting Resource Properties

Name Type Required Default Definition
coursePackId ID FK to tutorCatalog:coursePack (the advanced course)
studentId ID FK to auth:user (student who requested).
scheduledDatetime Date Datetime for screening meeting; may be null until both parties agree.
tutorDecision Enum **
comments String Optional field for tutor to provide comments/notes about screening result.
meetingLink String Video call link (Google Meet, Zoom, etc.) for the screening interview. Set by the tutor when scheduling.

Enum Properties

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

tutorDecision Enum Property

Enum Options

Name Value Index
pending "pending"" 0
approved "approved"" 1
rejected "rejected"" 2

Business Api

Create Availability API

[Default create API] — This is the designated default create API for the availability data object. Frontend generators and AI agents should use this API for standard CRUD operations. Tutor creates available time window for teaching. Only owner tutor or admin.

Rest Route

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

/v1/availabilities

Rest Request Parameters

The createAvailability api has got 7 regular request parameters

Parameter Type Required Population
tutorProfileId ID true request.body?.[“tutorProfileId”]
dayOfWeek Enum true request.body?.[“dayOfWeek”]
startTime String true request.body?.[“startTime”]
endTime String true request.body?.[“endTime”]
isRecurring Boolean true request.body?.[“isRecurring”]
specificDate Date false request.body?.[“specificDate”]
teachingMode Enum true request.body?.[“teachingMode”]
tutorProfileId : FK to tutorCatalog:tutorProfile. Only owner tutor or admin can edit.
dayOfWeek : Day of week: sunday-saturday.
startTime : Start time of window (HH:mm, 24h).
endTime : End time of window (HH:mm, 24h).
isRecurring : If true, this slot recurs weekly.
specificDate : Specific date (YYYY-MM-DD) for non-recurring availability. Null for recurring slots.
teachingMode :

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

  axios({
    method: 'POST',
    url: '/v1/availabilities',
    data: {
            tutorProfileId:"ID",  
            dayOfWeek:"Enum",  
            startTime:"String",  
            endTime:"String",  
            isRecurring:"Boolean",  
            specificDate:"Date",  
            teachingMode:"Enum",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "availability",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"availability": {
		"id": "ID",
		"tutorProfileId": "ID",
		"dayOfWeek": "Enum",
		"dayOfWeek_idx": "Integer",
		"startTime": "String",
		"endTime": "String",
		"isRecurring": "Boolean",
		"specificDate": "Date",
		"teachingMode": "Enum",
		"teachingMode_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Availability API

[Default update API] — This is the designated default update API for the availability data object. Frontend generators and AI agents should use this API for standard CRUD operations. Tutor updates an availability record (only own, or admin).

Rest Route

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

/v1/availabilities/:availabilityId

Rest Request Parameters

The updateAvailability api has got 7 regular request parameters

Parameter Type Required Population
availabilityId ID true request.params?.[“availabilityId”]
dayOfWeek Enum false request.body?.[“dayOfWeek”]
startTime String false request.body?.[“startTime”]
endTime String false request.body?.[“endTime”]
isRecurring Boolean false request.body?.[“isRecurring”]
specificDate Date false request.body?.[“specificDate”]
teachingMode Enum false request.body?.[“teachingMode”]
availabilityId : This id paremeter is used to select the required data object that will be updated
dayOfWeek : Day of week: sunday-saturday.
startTime : Start time of window (HH:mm, 24h).
endTime : End time of window (HH:mm, 24h).
isRecurring : If true, this slot recurs weekly.
specificDate : Specific date (YYYY-MM-DD) for non-recurring availability. Null for recurring slots.
teachingMode :

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

  axios({
    method: 'PATCH',
    url: `/v1/availabilities/${availabilityId}`,
    data: {
            dayOfWeek:"Enum",  
            startTime:"String",  
            endTime:"String",  
            isRecurring:"Boolean",  
            specificDate:"Date",  
            teachingMode:"Enum",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "availability",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"availability": {
		"id": "ID",
		"tutorProfileId": "ID",
		"dayOfWeek": "Enum",
		"dayOfWeek_idx": "Integer",
		"startTime": "String",
		"endTime": "String",
		"isRecurring": "Boolean",
		"specificDate": "Date",
		"teachingMode": "Enum",
		"teachingMode_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Availability API

[Default delete API] — This is the designated default delete API for the availability data object. Frontend generators and AI agents should use this API for standard CRUD operations. Tutor deletes an availability record (only own, or admin).

Rest Route

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

/v1/availabilities/:availabilityId

Rest Request Parameters

The deleteAvailability api has got 1 regular request parameter

Parameter Type Required Population
availabilityId ID true request.params?.[“availabilityId”]
availabilityId : This id paremeter is used to select the required data object that will be deleted

REST Request To access the api you can use the REST controller with the path DELETE /v1/availabilities/:availabilityId

  axios({
    method: 'DELETE',
    url: `/v1/availabilities/${availabilityId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "availability",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"availability": {
		"id": "ID",
		"tutorProfileId": "ID",
		"dayOfWeek": "Enum",
		"dayOfWeek_idx": "Integer",
		"startTime": "String",
		"endTime": "String",
		"isRecurring": "Boolean",
		"specificDate": "Date",
		"teachingMode": "Enum",
		"teachingMode_idx": "Integer",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Availability API

[Default get API] — This is the designated default get API for the availability data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get one availability by id (tutor/owner or admin only).

Rest Route

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

/v1/availabilities/:availabilityId

Rest Request Parameters

The getAvailability api has got 1 regular request parameter

Parameter Type Required Population
availabilityId ID true request.params?.[“availabilityId”]
availabilityId : 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/availabilities/:availabilityId

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "availability",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"availability": {
		"id": "ID",
		"tutorProfileId": "ID",
		"dayOfWeek": "Enum",
		"dayOfWeek_idx": "Integer",
		"startTime": "String",
		"endTime": "String",
		"isRecurring": "Boolean",
		"specificDate": "Date",
		"teachingMode": "Enum",
		"teachingMode_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Availabilities API

Rest Route

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

/v1/listavailabilities/:tutorProfileId

Rest Request Parameters

The listAvailabilities api has got 1 regular request parameter

Parameter Type Required Population
tutorProfileId ID true request.params?.[“tutorProfileId”]
tutorProfileId : FK to tutorCatalog:tutorProfile. Only owner tutor or admin can edit… The parameter is used to query data.

Filter Parameters

The listAvailabilities api supports 1 optional filter parameter for filtering list results:

teachingMode (Enum): Filter by teachingMode

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

  axios({
    method: 'GET',
    url: `/v1/listavailabilities/${tutorProfileId}`,
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // teachingMode: '<value>' // Filter by teachingMode
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "availabilities",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"availabilities": [
		{
			"id": "ID",
			"tutorProfileId": "ID",
			"dayOfWeek": "Enum",
			"dayOfWeek_idx": "Integer",
			"startTime": "String",
			"endTime": "String",
			"isRecurring": "Boolean",
			"specificDate": "Date",
			"teachingMode": "Enum",
			"teachingMode_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Lessonslot API

Rest Route

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

/v1/lessonslots

Rest Request Parameters

The createLessonSlot api has got 9 regular request parameters

Parameter Type Required Population
coursePackId ID true request.body?.[“coursePackId”]
studentId ID false request.body?.[“studentId”]
scheduledDate Date true request.body?.[“scheduledDate”]
scheduledTime String true request.body?.[“scheduledTime”]
status Enum true request.body?.[“status”]
locationType Enum false request.body?.[“locationType”]
locationDetails String false request.body?.[“locationDetails”]
sessionMode Enum true request.body?.[“sessionMode”]
meetLink String false request.body?.[“meetLink”]
coursePackId : FK to tutorCatalog:coursePack. Only tutors for the pack, enrolled student, or admin may update/view.
studentId : FK to auth:user (student). Set on booking. Nullable when open (free).
scheduledDate : Date for the lesson slot (yyyy-mm-dd).
scheduledTime : Start time of lesson (HH:mm 24h).
status : State of lesson slot (free, booked, completed, canceled).
locationType :
locationDetails : Optional: Location address/details; editable after booking by either party.
sessionMode : Chosen delivery mode for this lesson. Set at booking time based on student choice or tutor’s teachingMode. ‘online’ triggers Google Meet link generation, ‘faceToFace’ uses locationType/locationDetails.
meetLink : Google Meet URL for online lessons. Auto-populated when sessionMode is ‘online’. Null for face-to-face sessions.

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

  axios({
    method: 'POST',
    url: '/v1/lessonslots',
    data: {
            coursePackId:"ID",  
            studentId:"ID",  
            scheduledDate:"Date",  
            scheduledTime:"String",  
            status:"Enum",  
            locationType:"Enum",  
            locationDetails:"String",  
            sessionMode:"Enum",  
            meetLink:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lessonSlot",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"lessonSlot": {
		"id": "ID",
		"coursePackId": "ID",
		"studentId": "ID",
		"scheduledDate": "Date",
		"scheduledTime": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"locationType": "Enum",
		"locationType_idx": "Integer",
		"locationDetails": "String",
		"sessionMode": "Enum",
		"sessionMode_idx": "Integer",
		"meetLink": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Lessonslot API

[Default update API] — This is the designated default update API for the lessonSlot data object. Frontend generators and AI agents should use this API for standard CRUD operations. Update lesson slot status/location. Tutor can edit any of their coursePack’s slots; student can update their own booked slot location (if booked). Admin has override right.

Rest Route

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

/v1/lessonslots/:lessonSlotId

Rest Request Parameters

The updateLessonSlot api has got 7 regular request parameters

Parameter Type Required Population
lessonSlotId ID true request.params?.[“lessonSlotId”]
studentId ID false request.body?.[“studentId”]
status Enum false request.body?.[“status”]
locationType Enum false request.body?.[“locationType”]
locationDetails String false request.body?.[“locationDetails”]
sessionMode Enum false request.body?.[“sessionMode”]
meetLink String false request.body?.[“meetLink”]
lessonSlotId : This id paremeter is used to select the required data object that will be updated
studentId : FK to auth:user (student). Set on booking. Nullable when open (free).
status : State of lesson slot (free, booked, completed, canceled).
locationType :
locationDetails : Optional: Location address/details; editable after booking by either party.
sessionMode : Chosen delivery mode for this lesson. Set at booking time based on student choice or tutor’s teachingMode. ‘online’ triggers Google Meet link generation, ‘faceToFace’ uses locationType/locationDetails.
meetLink : Google Meet URL for online lessons. Auto-populated when sessionMode is ‘online’. Null for face-to-face sessions.

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

  axios({
    method: 'PATCH',
    url: `/v1/lessonslots/${lessonSlotId}`,
    data: {
            studentId:"ID",  
            status:"Enum",  
            locationType:"Enum",  
            locationDetails:"String",  
            sessionMode:"Enum",  
            meetLink:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lessonSlot",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"lessonSlot": {
		"id": "ID",
		"coursePackId": "ID",
		"studentId": "ID",
		"scheduledDate": "Date",
		"scheduledTime": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"locationType": "Enum",
		"locationType_idx": "Integer",
		"locationDetails": "String",
		"sessionMode": "Enum",
		"sessionMode_idx": "Integer",
		"meetLink": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Lessonslot API

[Default delete API] — This is the designated default delete API for the lessonSlot data object. Frontend generators and AI agents should use this API for standard CRUD operations. Tutor can remove their own slot if free/booked. Admin can remove any. (Student may not delete).

Rest Route

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

/v1/lessonslots/:lessonSlotId

Rest Request Parameters

The deleteLessonSlot api has got 1 regular request parameter

Parameter Type Required Population
lessonSlotId ID true request.params?.[“lessonSlotId”]
lessonSlotId : This id paremeter is used to select the required data object that will be deleted

REST Request To access the api you can use the REST controller with the path DELETE /v1/lessonslots/:lessonSlotId

  axios({
    method: 'DELETE',
    url: `/v1/lessonslots/${lessonSlotId}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lessonSlot",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"lessonSlot": {
		"id": "ID",
		"coursePackId": "ID",
		"studentId": "ID",
		"scheduledDate": "Date",
		"scheduledTime": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"locationType": "Enum",
		"locationType_idx": "Integer",
		"locationDetails": "String",
		"sessionMode": "Enum",
		"sessionMode_idx": "Integer",
		"meetLink": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Lessonslot API

Rest Route

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

/v1/lessonslots/:lessonSlotId

Rest Request Parameters

The getLessonSlot api has got 1 regular request parameter

Parameter Type Required Population
lessonSlotId ID true request.params?.[“lessonSlotId”]
lessonSlotId : 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/lessonslots/:lessonSlotId

  axios({
    method: 'GET',
    url: `/v1/lessonslots/${lessonSlotId}`,
    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": "lessonSlot",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"lessonSlot": {
		"isActive": true
	}
}

List Lessonslots API

Rest Route

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

/v1/lessonslots

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

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

  axios({
    method: 'GET',
    url: '/v1/lessonslots',
    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": "lessonSlots",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"lessonSlots": [
		{
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Preliminarymeeting API

[Default create API] — This is the designated default create API for the preliminaryMeeting data object. Frontend generators and AI agents should use this API for standard CRUD operations. Student requests a screening meeting; only created if related coursePack requires screening.

Rest Route

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

/v1/preliminarymeetings

Rest Request Parameters

The createPreliminaryMeeting api has got 6 regular request parameters

Parameter Type Required Population
coursePackId ID true request.body?.[“coursePackId”]
studentId ID true request.body?.[“studentId”]
scheduledDatetime Date false request.body?.[“scheduledDatetime”]
tutorDecision Enum true request.body?.[“tutorDecision”]
comments String false request.body?.[“comments”]
meetingLink String false request.body?.[“meetingLink”]
coursePackId : FK to tutorCatalog:coursePack (the advanced course)
studentId : FK to auth:user (student who requested).
scheduledDatetime : Datetime for screening meeting; may be null until both parties agree.
tutorDecision :
comments : Optional field for tutor to provide comments/notes about screening result.
meetingLink : Video call link (Google Meet, Zoom, etc.) for the screening interview. Set by the tutor when scheduling.

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

  axios({
    method: 'POST',
    url: '/v1/preliminarymeetings',
    data: {
            coursePackId:"ID",  
            studentId:"ID",  
            scheduledDatetime:"Date",  
            tutorDecision:"Enum",  
            comments:"String",  
            meetingLink:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "preliminaryMeeting",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"preliminaryMeeting": {
		"id": "ID",
		"coursePackId": "ID",
		"studentId": "ID",
		"scheduledDatetime": "Date",
		"tutorDecision": "Enum",
		"tutorDecision_idx": "Integer",
		"comments": "String",
		"meetingLink": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"coursePack": {},
	"tutorProfile": {},
	"tutorUser": {},
	"student": {}
}

Update Preliminarymeeting API

[Default update API] — This is the designated default update API for the preliminaryMeeting data object. Frontend generators and AI agents should use this API for standard CRUD operations. Tutor updates scheduled date/time, decision, or comments for screening meeting. Only tutor of coursePack or admin can approve/reject/set date; student can only propose initial.

Rest Route

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

/v1/preliminarymeetings/:preliminaryMeetingId

Rest Request Parameters

The updatePreliminaryMeeting api has got 5 regular request parameters

Parameter Type Required Population
preliminaryMeetingId ID true request.params?.[“preliminaryMeetingId”]
scheduledDatetime Date false request.body?.[“scheduledDatetime”]
tutorDecision Enum false request.body?.[“tutorDecision”]
comments String false request.body?.[“comments”]
meetingLink String false request.body?.[“meetingLink”]
preliminaryMeetingId : This id paremeter is used to select the required data object that will be updated
scheduledDatetime : Datetime for screening meeting; may be null until both parties agree.
tutorDecision :
comments : Optional field for tutor to provide comments/notes about screening result.
meetingLink : Video call link (Google Meet, Zoom, etc.) for the screening interview. Set by the tutor when scheduling.

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

  axios({
    method: 'PATCH',
    url: `/v1/preliminarymeetings/${preliminaryMeetingId}`,
    data: {
            scheduledDatetime:"Date",  
            tutorDecision:"Enum",  
            comments:"String",  
            meetingLink:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "preliminaryMeeting",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"preliminaryMeeting": {
		"id": "ID",
		"coursePackId": "ID",
		"studentId": "ID",
		"scheduledDatetime": "Date",
		"tutorDecision": "Enum",
		"tutorDecision_idx": "Integer",
		"comments": "String",
		"meetingLink": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"student": {},
	"coursePack": {}
}

Get Preliminarymeeting API

[Default get API] — This is the designated default get API for the preliminaryMeeting data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a single meeting by id: only tutor, student, or admin can access.

Rest Route

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

/v1/preliminarymeetings/:preliminaryMeetingId

Rest Request Parameters

The getPreliminaryMeeting api has got 1 regular request parameter

Parameter Type Required Population
preliminaryMeetingId ID true request.params?.[“preliminaryMeetingId”]
preliminaryMeetingId : 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/preliminarymeetings/:preliminaryMeetingId

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "preliminaryMeeting",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"preliminaryMeeting": {
		"id": "ID",
		"coursePackId": "ID",
		"studentId": "ID",
		"scheduledDatetime": "Date",
		"tutorDecision": "Enum",
		"tutorDecision_idx": "Integer",
		"comments": "String",
		"meetingLink": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Preliminarymeetings API

[Default list API] — This is the designated default list API for the preliminaryMeeting data object. Frontend generators and AI agents should use this API for standard CRUD operations. Tutor can list all meetings for their courses; students see their own; admin sees all.

Rest Route

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

/v1/preliminarymeetings

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

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "preliminaryMeetings",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"preliminaryMeetings": [
		{
			"id": "ID",
			"coursePackId": "ID",
			"studentId": "ID",
			"scheduledDatetime": "Date",
			"tutorDecision": "Enum",
			"tutorDecision_idx": "Integer",
			"comments": "String",
			"meetingLink": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"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: .

. .