Business API Design Specification - Create Preliminarymeeting

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 createPreliminaryMeeting 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 createPreliminaryMeeting Business API is designed to handle a create operation on the PreliminaryMeeting data object. This operation is performed under the specified conditions and may include additional, coordinated actions as part of the workflow.

API Description

Student requests a screening meeting; only created if related coursePack requires screening.

API Options

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 createPreliminaryMeeting Business API includes a REST controller that can be triggered via the following route:

/v1/preliminarymeetings

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 createPreliminaryMeeting Business API will be registered as a tool on the MCP server within the service binding.

API Parameters

The createPreliminaryMeeting Business API has 7 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:

Regular Parameters

Name Type Required Default Location Data Path
preliminaryMeetingId ID No - body preliminaryMeetingId
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 tutorCatalog:coursePack (the advanced course)
studentId ID Yes - body studentId
Description: FK to auth:user (student who requested).
scheduledDatetime Date No - body scheduledDatetime
Description: Datetime for screening meeting; may be null until both parties agree.
tutorDecision Enum Yes - body tutorDecision
Description: -
comments String No - body comments
Description: Optional field for tutor to provide comments/notes about screening result.
meetingLink String No - body meetingLink
Description: Video call link (Google Meet, Zoom, etc.) for the screening interview. Set by the tutor when scheduling.

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 createPreliminaryMeeting 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

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.preliminaryMeetingId,
  coursePackId: this.coursePackId,
  studentId: this.studentId,
  scheduledDatetime: this.scheduledDatetime,
  tutorDecision: this.tutorDecision,
  comments: this.comments,
  meetingLink: this.meetingLink,
  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] 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

[6] 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

[7] Step : mainCreateOperation

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

[8] Action : fetchCoursePack

Action Type: FetchObjectAction

Fetch course pack for notification

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

    const userQuery = {
      $and: [
        {
          id: runMScript(() => this.coursePackId, {
            path: "services[2].businessLogic[10].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);

    return data
      ? {
          title: data["title"],
          tutorProfileId: data["tutorProfileId"],
        }
      : null;
  }
}

[9] Action : fetchTutorProfile

Action Type: FetchObjectAction

Fetch tutor profile to get tutorId

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

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

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

    return data
      ? {
          tutorId: data["tutorId"],
        }
      : null;
  }
}

[10] Action : fetchTutorUser

Action Type: FetchObjectAction

Fetch tutor user for email notification

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

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

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

    return data
      ? {
          fullname: data["fullname"],
          email: data["email"],
        }
      : null;
  }
}

[11] Action : fetchStudent

Action Type: FetchObjectAction

Fetch student name for email

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

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

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

    return data
      ? {
          fullname: data["fullname"],
        }
      : null;
  }
}

[12] Step : buildOutput

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

[13] Step : sendResponse

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

[14] 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 createPreliminaryMeeting api has got 6 regular client 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”]

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

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 preliminaryMeeting 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": "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": {
		"tutorProfileId": "ID",
		"title": "String"
	},
	"tutorProfile": {
		"tutorId": "ID"
	},
	"tutorUser": {
		"email": "String",
		"fullname": "String"
	},
	"student": {
		"fullname": "String"
	}
}