Business API Design Specification - Create Enrollment

A Business API is a set of logical actions centered around a main data object. These actions can range from simple CRUD operations to complex workflows that implement intricate business logic.

While the term “API” traditionally refers to an interface that allows software systems to interact, in Mindbricks a Business API represents a broader concept. It encapsulates a business workflow around a data object, going beyond basic CRUD operations to include rich, internally coordinated actions that can be fully designed and customized.

This document provides an in-depth explanation of the architectural design of the createEnrollment Business API. It is intended to guide backend architects and developers in maintaining the current design. Additionally, frontend developers and frontend AI agents can use this document to understand how to properly consume this API on the client side.

Main Data Object and CRUD Operation

The createEnrollment Business API is designed to handle a create operation on the Enrollment data object. This operation is performed under the specified conditions and may include additional, coordinated actions as part of the workflow.

API Description

Creates a new enrollment for a student in a selected course pack and selected lesson slots. Enforces booking prerequisites (availability, non-duplication, preliminary meeting if flagged in coursePack), and triggers Stripe payment. Updates all associated lesson slot statuses to booked. Enrollment remains pending until payment confirmed by Stripe webhook.

API Frontend Description By The Backend Architect

Student chooses course pack, selects lesson slots, triggers enrollment and Stripe payment. If the course requires preliminary screening, checks that it was passed before proceeding. If payment fails, booking is not confirmed. Successful booking sets lesson slots status to ‘booked’ and opens enrollment. Student, tutor, and admin can see details.

API Options

• Auto Params : true Determines whether input parameters should be auto-generated from the schema of the associated data object. Set to false if you want to define all input parameters manually.

• Raise Api Event : true Indicates whether the Business API should emit an API-level event after successful execution. This is typically used for audit trails, analytics, or external integrations. The event will be emitted to the enrollment-created Kafka Topic Note that the DB-Level events for create, update and delete operations will always be raised for internal reasons.

• Active Check : `` Controls how the system checks if a record is active (not soft-deleted or inactive). Uses the ApiCheckOption to determine whether this is checked during the query or after fetching the instance.

• Read From Entity Cache : false If enabled, the API will attempt to read the target object from the Redis entity cache before querying the database. This can improve performance for frequently accessed records.

API Controllers

A Mindbricks Business API can be accessed through multiple interfaces, including REST, gRPC, WebSocket, Kafka, or Cron. The controllers listed below map the business workflow to a specific interface, enabling consistent interaction regardless of the communication channel.

REST Controller

The createEnrollment Business API includes a REST controller that can be triggered via the following route:

/v1/enrollments

By sending a request to this route using the service API address, you can execute this Business API. Parameters can be provided in multiple HTTP locations, including the URL path, URL query, request body, and request headers. Detailed information about these parameters is provided in the Parameters section.

MCP Tool

REST controllers also expose the Business API as a tool in the MCP, making it accessible to AI agents. This createEnrollment Business API will be registered as a tool on the MCP server within the service binding.

API Parameters

The createEnrollment Business API has 9 parameters that must be sent from the controller. Note that all parameters, except session and Redis parameters, should be provided by the client.

Business API parameters can be:

• Auto-generated by Mindbricks — inferred from the CRUD type and the property definitions of the main data object when the autoParameters option is enabled.
• Custom parameters added by the architect — these can supplement or override the auto-generated parameters.

Regular Parameters

Name	Type	Required	Default	Location	Data Path
enrollmentId	ID	No	-	body	enrollmentId
Description:	This id paremeter is used to create the data object with a given specific id. Leave null for automatic id.
coursePackId	ID	Yes	-	body	coursePackId
Description:	FK to purchased course pack.
studentId	ID	Yes	-	session	userId
Description:	FK to enrolling student (auth:user).
tutorProfileId	ID	Yes	-	body	tutorProfileId
Description:	FK to the course’s tutorProfile for admin/analytics.
lessonSlotIds	ID	Yes	-	body	lessonSlotIds
Description:	IDs for reserved lesson slots with this enrollment (must exist in courseScheduling:lessonSlot).
totalAmount	Double	Yes	-	body	totalAmount
Description:	Total amount paid for enrollment (for all slots/pack, pre-promotion/refund).
currency	String	Yes	-	body	currency
Description:	3-letter ISO currency code (e.g., ‘USD’, ‘EUR’).
refundStatus	Enum	Yes	-	body	refundStatus
Description:	Tracks refund state: notRequested, eligible, processed, ineligible. Managed by workflow.
enrolledAt	Date	No	-	body	enrolledAt
Description:	Datetime of completed enrollment (post-payment).

Parameter Transformations

Some parameters are post-processed using transform scripts after being read from the request but before validation or workflow execution. Only parameters with a transform script are listed below.

No parameters are transformed in this API.

AUTH Configuration

The authentication and authorization configuration defines the core access rules for the createEnrollment Business API. These checks are applied after parameter validation and before executing the main business logic.

While these settings cover the most common scenarios, more fine-grained or conditional access control—such as permissions based on object context, nested memberships, or custom workflows—should be implemented using explicit actions like PermissionCheckAction, MembershipCheckAction, or ObjectPermissionCheckAction.

Login Requirement

This API requires login (loginRequired = true). Requests from non-logged-in users will return a 401 Unauthorized error. Login is necessary but not sufficient, as additional role, permission, or other authorization checks may still apply.

---

Ownership Checks

---

Role and Permission Settings

• Absolute roles (bypass all auth checks):
  Users with any of the following roles will bypass all authentication and authorization checks, including ownership, membership, and standard role/permission checks:
  [user, student, admin, superAdmin]

---

Data Clause

Defines custom field-value assignments used to modify or augment the default payload for create and update operations. These settings override values derived from the session or parameters if explicitly provided.", Note that a default data clause is always prepared by Mindbricks using data property settings, however any property in the data clause can be override by Data Clause Settings.

Custom Data Clause Override No custom data clause override configured

Actual Data Clause

The business api will use the following data clause. Note that any calculated value will be added to the data clause in the api manager.

{
  id: this.enrollmentId,
  coursePackId: this.coursePackId,
  studentId: this.studentId,
  tutorProfileId: this.tutorProfileId,
  lessonSlotIds: this.lessonSlotIds,
  totalAmount: this.totalAmount,
  currency: this.currency,
  refundStatus: this.refundStatus,
  enrolledAt: this.enrolledAt,
  isActive: true,
  _archivedAt: null,
}

Business Logic Workflow

[1] Step : startBusinessApi

Manager initializes context, populates session and request objects, prepares internal structures for parameter handling and workflow execution.

You can use the following settings to change some behavior of this step. apiOptions, restSettings, grpcSettings, kafkaSettings, sseSettings, cronSettings

[2] Step : readParameters

Manager reads input parameters, normalizes missing values, applies default type casting, and stores them in the API context.

You can use the following settings to change some behavior of this step. customParameters, redisParameters

[3] Step : transposeParameters

Manager transforms parameters, computes derived values, flattens or remaps arrays/objects, and adjusts formats for downstream processing.

---

[4] Step : checkParameters

Manager executes built-in validations: required field checks, type enforcement, and basic business rules. Prevents operation if validation fails.

---

[5] Action : fetchCoursePack

Action Type: FetchObjectAction

Fetch the course pack to read scheduling constraints

class Api {
  async fetchCoursePack() {
    // Fetch Object on childObject coursePack

    const userQuery = {
      $and: [
        {
          id: runMScript(() => this.coursePackId, {
            path: "services[3].businessLogic[0].actions.fetchObjectActions[0].matchValue",
          }),
        },
        { isActive: true },
      ],
    };
    const { convertUserQueryToElasticQuery } = require("common");
    const scriptQuery = convertUserQueryToElasticQuery(userQuery);

    const elasticIndex = new ElasticIndexer("coursePack");
    const data = await elasticIndex.getOne(scriptQuery);

    if (!data) {
      throw new NotFoundError("errMsg_FethcedObjectNotFound:coursePack");
    }

    return data;
  }
}

---

[6] Action : fetchTutorProfile

Action Type: FetchObjectAction

Fetch tutor profile to get the tutor’s userId for account status check

class Api {
  async fetchTutorProfile() {
    // Fetch Object on childObject tutorProfile

    const userQuery = {
      $and: [
        {
          id: runMScript(() => this.tutorProfileId, {
            path: "services[3].businessLogic[0].actions.fetchObjectActions[3].matchValue",
          }),
        },
        { isActive: true },
      ],
    };
    const { convertUserQueryToElasticQuery } = require("common");
    const scriptQuery = convertUserQueryToElasticQuery(userQuery);

    const elasticIndex = new ElasticIndexer("tutorProfile");
    const data = await elasticIndex.getOne(scriptQuery);

    if (!data) {
      throw new NotFoundError("errMsg_FethcedObjectNotFound:tutorProfile");
    }

    return data;
  }
}

---

[7] Action : fetchTutorUser

Action Type: FetchObjectAction

Fetch tutor’s auth user record to check accountStatus (active/suspended/banned)

class Api {
  async fetchTutorUser() {
    // Fetch Object on childObject user

    const userQuery = {
      $and: [
        {
          id: runMScript(() => this.fetchedTutorProfile.tutorId, {
            path: "services[3].businessLogic[0].actions.fetchObjectActions[4].matchValue",
          }),
        },
        { isActive: true },
      ],
    };
    const { convertUserQueryToElasticQuery } = require("common");
    const scriptQuery = convertUserQueryToElasticQuery(userQuery);

    const elasticIndex = new ElasticIndexer("user");
    const data = await elasticIndex.getOne(scriptQuery);

    if (!data) {
      throw new NotFoundError("errMsg_FethcedObjectNotFound:user");
    }

    return data;
  }
}

---

[8] Action : fetchScreeningMeetings

Action Type: FetchObjectAction

Fetch screening meetings to verify approval status

class Api {
  async fetchScreeningMeetings() {
    // Fetch Object on childObject preliminaryMeeting

    const userQuery = {
      $and: [
        runMScript(() => ({ coursePackId: this.coursePackId }), {
          path: "services[3].businessLogic[0].actions.fetchObjectActions[1].whereClause",
        }),
        { isActive: true },
      ],
    };
    const { convertUserQueryToElasticQuery } = require("common");
    const scriptQuery = convertUserQueryToElasticQuery(userQuery);

    // get object list from elasticsearch index
    const elasticIndex = new ElasticIndexer("preliminaryMeeting");
    const dataList =
      (await elasticIndex.getDataByPage(0, 500, scriptQuery)) ?? [];

    return dataList;
  }
}

---

[9] Action : fetchEnrolledLessonSlots

Action Type: FetchObjectAction

Fetch actual lesson slot records to validate dates/times

class Api {
  async fetchEnrolledLessonSlots() {
    // Fetch Object on childObject lessonSlot

    const userQuery = {
      $and: [
        runMScript(
          () => ({
            $and: [
              { coursePackId: this.coursePackId },
              { studentId: this.session.userId },
            ],
          }),
          {
            path: "services[3].businessLogic[0].actions.fetchObjectActions[2].whereClause",
          },
        ),
        { isActive: true },
      ],
    };
    const { convertUserQueryToElasticQuery } = require("common");
    const scriptQuery = convertUserQueryToElasticQuery(userQuery);

    // get object list from elasticsearch index
    const elasticIndex = new ElasticIndexer("lessonSlot");
    const dataList =
      (await elasticIndex.getDataByPage(0, 500, scriptQuery)) ?? [];

    return dataList;
  }
}

---

[10] Action : runEnrollmentValidation

Action Type: FunctionCallAction

Run all enrollment constraint validations including tutor status and course moderation checks

class Api {
  async runEnrollmentValidation() {
    try {
      return runMScript(
        () =>
          LIB.validateEnrollmentConstraints(
            this.fetchedCoursePack,
            this.lessonSlotIds,
            this.screeningMeetings,
            this.session.userId,
            this.tutorUser,
          ),
        {
          path: "services[3].businessLogic[0].actions.functionCallActions[0].callScript",
        },
      );
    } catch (err) {
      console.error(
        "Error in FunctionCallAction runEnrollmentValidation:",
        err,
      );
      throw err;
    }
  }
}

---

[11] Action : enforceEnrollmentConstraints

Action Type: ValidationAction

Block enrollment if any constraint is violated

class Api {
  async enforceEnrollmentConstraints() {
    const isValid = runMScript(
      () =>
        this.enrollmentValidation && this.enrollmentValidation.valid === true,
      {
        path: "services[3].businessLogic[0].actions.validationActions[0].validationScript",
      },
    );

    if (!isValid) {
      throw new BadRequestError(
        "Enrollment validation failed. Please check course pack, lesson slots, and screening requirements.",
      );
    }
    return isValid;
  }
}

---

[12] Step : checkBasicAuth

Manager performs authentication and authorization checks: verifies session, user roles, permissions, and tenant restrictions.

You can use the following settings to change some behavior of this step. authOptions

[13] Step : buildDataClause

Manager constructs the final data object for creation, fills auto-generated fields (IDs, timestamps, owner fields), and ensures schema consistency.

You can use the following settings to change some behavior of this step. dataClause

[14] Step : mainCreateOperation

Manager executes the database insert operation, updates indexes/caches, and triggers internal post-processing like linked default records.

---

[15] Step : buildOutput

Manager shapes the response: masks sensitive fields, resolves linked references, and formats output according to API contract.

---

[16] Step : sendResponse

Manager sends the response to the client and finalizes internal tasks like flushing logs or updating session state.

---

[17] Step : raiseApiEvent

Manager triggers API-level events (Kafka, WebSocket, async workflows) as the final internal step.

---

Rest Usage

Rest Client Parameters

Client parameters are the api parameters that are visible to client and will be populated by the client. Note that some api parameters are not visible to client because they are populated by internal system, session, calculation or joint sources.

The createEnrollment api has got 7 regular client parameters

Parameter	Type	Required	Population
coursePackId	ID	true	request.body?.[“coursePackId”]
tutorProfileId	ID	true	request.body?.[“tutorProfileId”]
lessonSlotIds	ID	true	request.body?.[“lessonSlotIds”]
totalAmount	Double	true	request.body?.[“totalAmount”]
currency	String	true	request.body?.[“currency”]
refundStatus	Enum	true	request.body?.[“refundStatus”]
enrolledAt	Date	false	request.body?.[“enrolledAt”]

REST Request

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

  axios({
    method: 'POST',
    url: '/v1/enrollments',
    data: {
            coursePackId:"ID",  
            tutorProfileId:"ID",  
            lessonSlotIds:"ID",  
            totalAmount:"Double",  
            currency:"String",  
            refundStatus:"Enum",  
            enrolledAt:"Date",  
    
    },
    params: {
    
        }
  });

REST Response

The API response is encapsulated within a JSON envelope. Successful operations return an HTTP status code of 200 for get, list, update, or delete requests, and 201 for create requests. Each successful response includes a "status": "OK" property. For error handling, refer to the “Error Response” section.

Following JSON represents the most comprehensive form of the enrollment object in the respones. However, some properties may be omitted based on the object’s internal logic.

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "enrollment",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"enrollment": {
		"id": "ID",
		"coursePackId": "ID",
		"studentId": "ID",
		"tutorProfileId": "ID",
		"lessonSlotIds": "ID",
		"totalAmount": "Double",
		"currency": "String",
		"paymentStatus": "Enum",
		"paymentStatus_idx": "Integer",
		"refundStatus": "Enum",
		"refundStatus_idx": "Integer",
		"enrollmentStatus": "Enum",
		"enrollmentStatus_idx": "Integer",
		"enrolledAt": "Date",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}