REST API GUIDE

aifitapp-aicoach-service

Version: 1.0.116

AI-powered fitness coaching service that generates personalized evidence-based training programs and nutrition plans, manages chatbowt interactions with full validation chains, handles dynamic program modifications via AI tool calls, tracks weaight measurements, enforces moderation and quotas, and provides admin endpoints for moderation history and usage analytics.a

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

Intended Audience

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

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

The following routes are available by default:

• API Test Interface (API Face): /
• Swagger Documentation: /swagger
• Postman Collection Download: /getPostmanCollection
• Health Checks: /health and /admin/health
• Current Session Info: /currentuser
• Favicon: /favicon.ico

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

• Preview: https://appaili.prw.mindbricks.com/aicoach-api
• Staging: https://appaili-stage.mindbricks.co/aicoach-api
• Production: https://appaili.mindbricks.co/aicoach-api

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 AiCoach 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 AiCoach 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:

• getJoins (BOOLEAN): Controls whether to retrieve associated objects along with the main object. By default, getJoins is assumed to be true. Set it to false if you prefer to receive only the main fields of an object, excluding its associations.

• excludeCQRS (BOOLEAN): Applicable only when getJoins is true. By default, excludeCQRS is set to false. Enabling this parameter (true) omits non-local associations, which are typically more resource-intensive as they require querying external services like ElasticSearch for additional information. Use this to optimize response times and resource usage.

• requestId (String): Identifies a request to enable tracking through the service’s log chain. A random hex string of 32 characters is assigned by default. If you wish to use a custom requestId, simply include it in your query parameters.

• caching (BOOLEAN): Determines the use of caching for query API. By default, caching is enabled (true). To ensure the freshest data directly from the database, set this parameter to false, bypassing the cache.

• cacheTTL (Integer): Specifies the Time-To-Live (TTL) for query caching, in seconds. This is particularly useful for adjusting the default caching duration (5 minutes) for get list queries. Setting a custom cacheTTL allows you to fine-tune the cache lifespan to meet your needs.

• pageNumber (Integer): For paginated get list API’s, this parameter selects which page of results to retrieve. The default is 1, indicating the first page. To disable pagination and retrieve all results, set pageNumber to 0.

• pageRowCount (Integer): In conjunction with paginated API’s, this parameter defines the number of records per page. The default value is 25. Adjusting pageRowCount allows you to control the volume of data returned in a single request.

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 AiCoach 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:

• 400 Bad Request: The request was improperly formatted or contained invalid parameters, preventing the server from processing it.
• 401 Unauthorized: The request lacked valid authentication credentials or the credentials provided do not grant access to the requested resource.
• 404 Not Found: The requested resource was not found on the server.
• 500 Internal Server Error: The server encountered an unexpected condition that prevented it from fulfilling the request.

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 AiCoach 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:

• Data Presentation: Depending on the nature of the request, the service returns either a single data object or an array of objects encapsulated within the JSON envelope.

  • Creation and Update API: These API routes return the unmodified (pure) form of the data object(s), without any associations to other data objects.
  • Delete API: Even though the data is removed from the database, the last known state of the data object(s) is returned in its pure form.
  • Get Requests: A single data object is returned in JSON format.
  • Get List Requests: An array of data objects is provided, reflecting a collection of resources.

• Data Structure and Joins: The complexity of the data structure in the response can vary based on the API’s architectural design and the join options specified in the request. The architecture might inherently limit join operations, or they might be dynamically controlled through query parameters.

  • Pure Data Forms: In some cases, the response mirrors the exact structure found in the primary data table, without extensions.
  • Extended Data Forms: Alternatively, responses might include data extended through joins with tables within the same service or aggregated from external sources, such as ElasticSearch indices related to other services.
  • Join Varieties: The extensions might involve one-to-one joins, resulting in single object associations, or one-to-many joins, leading to an array of objects. In certain instances, the data might even feature nested inclusions from other data objects.

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:

• 200 OK: This status code is returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request has been processed successfully.
• 201 Created: This status code is specific to CREATE operations, signifying that the requested resource has been successfully created.

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": []
}

• products: In this example, this key contains the actual response content, which may be a single object or an array of objects depending on the operation performed.

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

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

ChatMessage resource

Resource Definition : Individual chat messages in coach conversations. Stores user, assistant, and system messages with content flagging status and tool call metadata. ChatMessage Resource Properties

Name	Type	Required	Default	Definition
content	Text			Message content
conversationId	ID			Reference to the parent conversation
flagged	Boolean			True if the message was detected as off-topic or abusive
role	Enum			Message sender role
toolCallData	Text			JSON string of tool call metadata from AI processing

Enum Properties

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

role Enum Property

Property Definition : Message sender roleEnum Options

Name	Value	Index
user	"user""	0
assistant	"assistant""	1
system	"system""	2

CoachConversation resource

Resource Definition : Chat conversation container per user for the AI fitness coach chatbot. CoachConversation Resource Properties

Name	Type	Required	Default	Definition
status	Enum			Conversation status
userId	ID			Reference to the user who owns this conversation

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 : Conversation statusEnum Options

Name	Value	Index
active	"active""	0
closed	"closed""	1

MealPlan resource

Resource Definition : Stores AI-generated meal plans per user including calorie targets, macro distribution, and training/rest day differentiation. Created and modified exclusively by AI tool calls. MealPlan Resource Properties

Name	Type	Required	Default	Definition
carbGrams	Float			Daily carbohydrate target in grams
dailyCalorieTarget	Integer			Daily calorie target in kcal
fatGrams	Float			Daily fat target in grams
notes	Text			Additional AI-generated nutritional guidance
proteinGrams	Float			Daily protein target in grams
restDayCalories	Integer			Calorie target on rest days
restDayCarbGrams	Float			Carb target on rest days
status	Enum			Meal plan status
trainingDayCalories	Integer			Calorie target on training days
trainingDayCarbGrams	Float			Carb target on training days
userId	ID			Reference to the user who owns this meal plan

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 : Meal plan statusEnum Options

Name	Value	Index
active	"active""	0
archived	"archived""	1

ModerationRecord resource

Resource Definition : Tracks user offenses and moderation actions for accurate progressive penalty escalation and admin review. ModerationRecord Resource Properties

Name	Type	Required	Default	Definition
action	Enum			Moderation action taken
offenseType	String			Description of the violation
reason	Text			Detailed reason for the moderation action
suspensionExpiresAt	Date			When a temporary suspension ends (null for lifetime bans and reversals)
userId	ID			Reference to the user who was moderated
content	String			**

Enum Properties

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

action Enum Property

Property Definition : Moderation action takenEnum Options

Name	Value	Index
suspension24h	"suspension24h""	0
suspension1week	"suspension1week""	1
lifetimeBan	"lifetimeBan""	2
banReversal	"banReversal""	3

PlanMeal resource

Resource Definition : Individual meals within a meal plan with food details and macro breakdown. Created and modified exclusively by AI tool calls. PlanMeal Resource Properties

Name	Type	Required	Default	Definition
carbs	Float			Carb grams for this meal
fat	Float			Fat grams for this meal
foods	Text			Food items and quantities description
mealLabel	String			Meal label (e.g. breakfast, lunch, dinner, snack)
mealPlanId	ID			Reference to the parent meal plan
protein	Float			Protein grams for this meal
sortOrder	Integer			Display sort order within the meal plan
totalCalories	Integer			Total calories for this meal

ProgramExercise resource

Resource Definition : Individual exercises within a training program with sets, reps, RIR targets, and progression rules. Created and modified exclusively by AI tool calls. ProgramExercise Resource Properties

Name	Type	Required	Default	Definition
dayLabel	String			Training day label (e.g. pushDay, upperA, legDay)
exerciseName	String			Name of the exercise
movementType	Enum			Movement type classification
muscleGroup	String			Target muscle group
progressionRule	Text			Progression instructions (e.g. double progression model)
repMax	Integer			Maximum rep target
repMin	Integer			Minimum rep target
rirTarget	Integer			Reps In Reserve target (0-3)
sets	Integer			Number of working sets
sortOrder	Integer			Display sort order within the training day
trainingProgramId	ID			Reference to the parent training program

Enum Properties

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

movementType Enum Property

Property Definition : Movement type classificationEnum Options

Name	Value	Index
lengthened	"lengthened""	0
shortened	"shortened""	1
compound	"compound""	2

QuotaConfig resource

Resource Definition : System-wide message quota configuration. Admin-managed single record that defines message limits per period. QuotaConfig Resource Properties

Name	Type	Required	Default	Definition
quotaLimit	Integer			Maximum messages allowed per period
quotaPeriod	Enum			Period over which the quota is measured

Enum Properties

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

quotaPeriod Enum Property

Property Definition : Period over which the quota is measuredEnum Options

Name	Value	Index
daily	"daily""	0
weekly	"weekly""	1
monthly	"monthly""	2

TrainingProgram resource

Resource Definition : Stores AI-generated training programs per user including split type, deload schedule, cardio guidelines, and step targets. Created and modified exclusively by AI tool calls. TrainingProgram Resource Properties

Name	Type	Required	Default	Definition
cardioDurationMinutes	Integer			Recommended cardio duration in minutes
cardioFrequencyPerWeek	Integer			Recommended cardio sessions per week
cardioType	String			Type of cardio recommended (e.g. zone2)
dailyStepTarget	Integer			Daily step target for NEAT (7000-12000)
deloadIntervalWeeks	Integer			Weeks between deload periods, typically 6-8
notes	Text			Additional AI-generated notes and guidance
splitType	String			Training split type (e.g. fullBody, upperLower, pushPullLegs)
status	Enum			Program status
userId	ID			Reference to the user who owns this training program

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 : Program statusEnum Options

Name	Value	Index
active	"active""	0
archived	"archived""	1

UserQuota resource

Resource Definition : Per-user message quota consumption tracking against the system-wide quota configuration. UserQuota Resource Properties

Name	Type	Required	Default	Definition
messageCount	Integer			Number of messages consumed in the current period
periodEnd	Date			End of the current quota period
periodStart	Date			Start of the current quota period
userId	ID			Reference to the user whose quota is being tracked

WeightLog resource

Resource Definition : User-reported weight measurements used for weekly average calculations and dynamic calorie adjustments by the AI coach. WeightLog Resource Properties

Name	Type	Required	Default	Definition
measuredAt	Date			Date and time of measurement
userId	ID			Reference to the user who recorded this weight
weightKg	Float			Body weight in kilograms

BanAppeals resource

BanAppeals Resource Properties

Name	Type	Required	Default	Definition
moderationRecordId	ID			id of the mod record
userId	ID			**
appealReason	String			**
status	Enum			**

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

Enum Options

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

AdditionalQuota resource

AdditionalQuota Resource Properties

Name	Type	Required	Default	Definition
userId	String			**
additionalMessage	Integer			**
status	Enum			**
currency	String			**
pricePaid	Integer			**
statusUpdatedAt	Date			**
activatedAt	Date			**
cancelledAt	Date			**
periodEnd	Date			**
periodStart	Date			**
paymentConfirmation	Enum			An automatic property that is used to check the confirmed status of the payment set by webhooks.

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

Enum Options

Name	Value	Index
pending	"pending""	0
cancelled	"cancelled""	1
failed	"failed""	2
active	"active""	3
expired	"expired""	4

paymentConfirmation Enum Property

Property Definition : An automatic property that is used to check the confirmed status of the payment set by webhooks.Enum Options

Name	Value	Index
pending	"pending""	0
processing	"processing""	1
paid	"paid""	2
canceled	"canceled""	3

Sys_additionalQuotaPayment resource

Resource Definition : A payment storage object to store the payment life cyle of orders based on additionalQuota object. It is autocreated based on the source object's checkout config Sys_additionalQuotaPayment Resource Properties

Name	Type	Required	Default	Definition
ownerId	ID			* An ID value to represent owner user who created the order*
orderId	ID			an ID value to represent the orderId which is the ID parameter of the source additionalQuota object
paymentId	String			A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type
paymentStatus	String			A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.
statusLiteral	String			A string value to represent the logical payment status which belongs to the application lifecycle itself.
redirectUrl	String			A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.

Sys_paymentCustomer resource

Resource Definition : A payment storage object to store the customer values of the payment platform Sys_paymentCustomer Resource Properties

Name	Type	Required	Default	Definition
userId	ID			* An ID value to represent the user who is created as a stripe customer*
customerId	String			A string value to represent the customer id which is generated on the Stripe gateway. This id is used to represent the customer in the Stripe gateway
platform	String			A String value to represent payment platform which is used to make the payment. It is stripe as default. It will be used to distinguesh the payment gateways in the future.

Sys_paymentMethod resource

Resource Definition : A payment storage object to store the payment methods of the platform customers Sys_paymentMethod Resource Properties

Name	Type	Required	Default	Definition
paymentMethodId	String			A string value to represent the id of the payment method on the payment platform.
userId	ID			* An ID value to represent the user who owns the payment method*
customerId	String			A string value to represent the customer id which is generated on the payment gateway.
cardHolderName	String			A string value to represent the name of the card holder. It can be different than the registered customer.
cardHolderZip	String			A string value to represent the zip code of the card holder. It is used for address verification in specific countries.
platform	String			A String value to represent payment platform which teh paymentMethod belongs. It is stripe as default. It will be used to distinguesh the payment gateways in the future.
cardInfo	Object			A Json value to store the card details of the payment method.

Business Api

Create Chatmessage API

[Default create API] — This is the designated default create API for the chatMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Send a message to the AI fitness coach. Enforces the full validation chain: subscription check → ban status check → quota check → content flagging → AI processing → tool call execution → quota increment. Returns both the user message and the AI response.

API Frontend Description By The Backend Architect

Chat Message Creation

• This is the primary interaction endpoint for the AI fitness coach.
• User sends a message and receives an AI response in the same call.
• The response includes the created user message and an aiResponse object containing the AI’s reply and any tool calls executed.
• If the message is flagged, aiResponse.flagged will be true.
• Handle quota exceeded (403) and suspension (403) errors gracefully.

Rest Route

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

/v1/chatmessages

Rest Request Parameters

The createChatMessage api has got 2 regular request parameters

Parameter	Type	Required	Population
conversationId	ID	true	request.body?.[“conversationId”]
content	Text	true	request.body?.[“content”]
conversationId : The conversation to send the message to
content : The message content

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

  axios({
    method: 'POST',
    url: '/v1/chatmessages',
    data: {
            conversationId:"ID",  
            content:"Text",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "chatMessage",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"chatMessage": {
		"id": "ID",
		"content": "Text",
		"conversationId": "ID",
		"flagged": "Boolean",
		"role": "Enum",
		"role_idx": "Integer",
		"toolCallData": "Text",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Coachconversation API

[Default create API] — This is the designated default create API for the coachConversation data object. Frontend generators and AI agents should use this API for standard CRUD operations. Create a new coach conversation. Requires active subscription and no active ban.

Rest Route

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

/v1/coachconversations

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

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

  axios({
    method: 'POST',
    url: '/v1/coachconversations',
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "coachConversation",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"coachConversation": {
		"id": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"userId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"activeSubscriptions": "Object"
}

Create Quotaconfig API

[Default create API] — This is the designated default create API for the quotaConfig data object. Frontend generators and AI agents should use this API for standard CRUD operations. Create a quota configuration record. Admin only.

Rest Route

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

/v1/quotaconfigs

Rest Request Parameters

The createQuotaConfig api has got 2 regular request parameters

Parameter	Type	Required	Population
quotaLimit	Integer	true	request.body?.[“quotaLimit”]
quotaPeriod	Enum	true	request.body?.[“quotaPeriod”]
quotaLimit : Maximum messages allowed per period
quotaPeriod : Period over which the quota is measured

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

  axios({
    method: 'POST',
    url: '/v1/quotaconfigs',
    data: {
            quotaLimit:"Integer",  
            quotaPeriod:"Enum",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "quotaConfig",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"quotaConfig": {
		"id": "ID",
		"quotaLimit": "Integer",
		"quotaPeriod": "Enum",
		"quotaPeriod_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Weightlog API

[Default create API] — This is the designated default create API for the weightLog data object. Frontend generators and AI agents should use this API for standard CRUD operations. Report a weight measurement. Requires active subscription and no active ban.

Rest Route

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

/v1/weightlogs

Rest Request Parameters

The createWeightLog api has got 2 regular request parameters

Parameter	Type	Required	Population
measuredAt	Date	true	request.body?.[“measuredAt”]
weightKg	Float	true	request.body?.[“weightKg”]
measuredAt : Date and time of measurement
weightKg : Body weight in kilograms

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

  axios({
    method: 'POST',
    url: '/v1/weightlogs',
    data: {
            measuredAt:"Date",  
            weightKg:"Float",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "weightLog",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"weightLog": {
		"id": "ID",
		"measuredAt": "Date",
		"userId": "ID",
		"weightKg": "Float",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Chatmessage API

[Default get API] — This is the designated default get API for the chatMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a chat message by ID with parent conversation ownership validation.

Rest Route

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

/v1/chatmessages/:chatMessageId

Rest Request Parameters

The getChatMessage api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "chatMessage",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"chatMessage": {
		"id": "ID",
		"content": "Text",
		"conversationId": "ID",
		"flagged": "Boolean",
		"role": "Enum",
		"role_idx": "Integer",
		"toolCallData": "Text",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Coachconversation API

[Default get API] — This is the designated default get API for the coachConversation data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a conversation by ID. Users see their own, admins can see any.

Rest Route

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

/v1/coachconversations/:coachConversationId

Rest Request Parameters

The getCoachConversation api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "coachConversation",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"coachConversation": {
		"id": "ID",
		"status": "Enum",
		"status_idx": "Integer",
		"userId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Mealplan API

[Default get API] — This is the designated default get API for the mealPlan data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a meal plan by ID with meals. Users see their own, admins can see any.

Rest Route

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

/v1/mealplans/:mealPlanId

Rest Request Parameters

The getMealPlan api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "mealPlan",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"mealPlan": {
		"id": "ID",
		"carbGrams": "Float",
		"dailyCalorieTarget": "Integer",
		"fatGrams": "Float",
		"notes": "Text",
		"proteinGrams": "Float",
		"restDayCalories": "Integer",
		"restDayCarbGrams": "Float",
		"status": "Enum",
		"status_idx": "Integer",
		"trainingDayCalories": "Integer",
		"trainingDayCarbGrams": "Float",
		"userId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"meals": [
			{
				"id": "ID",
				"carbs": "Float",
				"fat": "Float",
				"foods": "Text",
				"mealLabel": "String",
				"mealPlanId": "ID",
				"protein": "Float",
				"sortOrder": "Integer",
				"totalCalories": "Integer",
				"isActive": true,
				"recordVersion": "Integer",
				"createdAt": "Date",
				"updatedAt": "Date",
				"_owner": "ID"
			},
			{},
			{}
		]
	}
}

Get Moderationrecord API

[Default get API] — This is the designated default get API for the moderationRecord data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a moderation record by ID. Admin only.

Rest Route

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

/v1/moderationrecords/:moderationRecordId

Rest Request Parameters

The getModerationRecord api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationRecord",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"moderationRecord": {
		"id": "ID",
		"action": "Enum",
		"action_idx": "Integer",
		"offenseType": "String",
		"reason": "Text",
		"suspensionExpiresAt": "Date",
		"userId": "ID",
		"content": "String",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

Get Myquota API

Get the current user’s quota usage for the active period.

Rest Route

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

/v1/my-quota

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

REST Request To access the api you can use the REST controller with the path GET /v1/my-quota

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "userQuota",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"userQuota": {
		"id": "ID",
		"messageCount": "Integer",
		"periodEnd": "Date",
		"periodStart": "Date",
		"userId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Planmeal API

[Default get API] — This is the designated default get API for the planMeal data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a plan meal by ID with parent ownership validation.

Rest Route

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

/v1/planmeals/:planMealId

Rest Request Parameters

The getPlanMeal api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "planMeal",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"planMeal": {
		"id": "ID",
		"carbs": "Float",
		"fat": "Float",
		"foods": "Text",
		"mealLabel": "String",
		"mealPlanId": "ID",
		"protein": "Float",
		"sortOrder": "Integer",
		"totalCalories": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Programexercise API

[Default get API] — This is the designated default get API for the programExercise data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a program exercise by ID with parent ownership validation.

Rest Route

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

/v1/programexercises/:programExerciseId

Rest Request Parameters

The getProgramExercise api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "programExercise",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"programExercise": {
		"id": "ID",
		"dayLabel": "String",
		"exerciseName": "String",
		"movementType": "Enum",
		"movementType_idx": "Integer",
		"muscleGroup": "String",
		"progressionRule": "Text",
		"repMax": "Integer",
		"repMin": "Integer",
		"rirTarget": "Integer",
		"sets": "Integer",
		"sortOrder": "Integer",
		"trainingProgramId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Quotaconfig API

[Default get API] — This is the designated default get API for the quotaConfig data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a quota configuration record.

Rest Route

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

/v1/quotaconfigs/:quotaConfigId

Rest Request Parameters

The getQuotaConfig api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "quotaConfig",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"quotaConfig": {
		"id": "ID",
		"quotaLimit": "Integer",
		"quotaPeriod": "Enum",
		"quotaPeriod_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Trainingprogram API

[Default get API] — This is the designated default get API for the trainingProgram data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a training program by ID. Users see their own programs, admins can see any.

Rest Route

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

/v1/trainingprograms/:trainingProgramId

Rest Request Parameters

The getTrainingProgram api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "trainingProgram",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"trainingProgram": {
		"id": "ID",
		"cardioDurationMinutes": "Integer",
		"cardioFrequencyPerWeek": "Integer",
		"cardioType": "String",
		"dailyStepTarget": "Integer",
		"deloadIntervalWeeks": "Integer",
		"notes": "Text",
		"splitType": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"userId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"exercises": [
			{
				"id": "ID",
				"dayLabel": "String",
				"exerciseName": "String",
				"movementType": "Enum",
				"movementType_idx": "Integer",
				"muscleGroup": "String",
				"progressionRule": "Text",
				"repMax": "Integer",
				"repMin": "Integer",
				"rirTarget": "Integer",
				"sets": "Integer",
				"sortOrder": "Integer",
				"trainingProgramId": "ID",
				"isActive": true,
				"recordVersion": "Integer",
				"createdAt": "Date",
				"updatedAt": "Date",
				"_owner": "ID"
			},
			{},
			{}
		]
	}
}

Get Userquota API

[Default get API] — This is the designated default get API for the userQuota data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a user quota record. Users see their own, admins can see any.

Rest Route

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

/v1/userquotas/:userQuotaId

Rest Request Parameters

The getUserQuota api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "userQuota",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"userQuota": {
		"id": "ID",
		"messageCount": "Integer",
		"periodEnd": "Date",
		"periodStart": "Date",
		"userId": "ID",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"additionalQuota": "Object"
}

Get Weightlog API

[Default get API] — This is the designated default get API for the weightLog data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a weight log entry by ID.

Rest Route

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

/v1/weightlogs/:weightLogId

Rest Request Parameters

The getWeightLog api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "weightLog",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"weightLog": {
		"id": "ID",
		"measuredAt": "Date",
		"userId": "ID",
		"weightKg": "Float",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Chatmessages API

[Default list API] — This is the designated default list API for the chatMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. List chat messages for a conversation with parent ownership validation.

Rest Route

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

/v1/chatmessages

Rest Request Parameters

The listChatMessages api has got 1 regular request parameter

Parameter	Type	Required	Population
conversationId	ID	true	request.query?.[“conversationId”]
conversationId : The conversation to list messages for

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

  axios({
    method: 'GET',
    url: '/v1/chatmessages',
    data: {
    
    },
    params: {
             conversationId:'"ID"',  
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "chatMessages",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"chatMessages": [
		{
			"id": "ID",
			"content": "Text",
			"conversationId": "ID",
			"flagged": "Boolean",
			"role": "Enum",
			"role_idx": "Integer",
			"toolCallData": "Text",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Coachconversations API

[Default list API] — This is the designated default list API for the coachConversation data object. Frontend generators and AI agents should use this API for standard CRUD operations. List conversations. Users see their own, admins can see all.

Rest Route

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

/v1/coachconversations

Rest Request Parameters

Filter Parameters

The listCoachConversations api supports 2 optional filter parameters for filtering list results:

status (Enum): Conversation status

• Single: ?status=<value> (case-insensitive)
• Multiple: ?status=<value1>&status=<value2>
• Null: ?status=null

userId (ID): Reference to the user who owns this conversation

• Single: ?userId=<value>
• Multiple: ?userId=<value1>&userId=<value2>
• Null: ?userId=null

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

  axios({
    method: 'GET',
    url: '/v1/coachconversations',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // status: '<value>' // Filter by status
        // userId: '<value>' // Filter by userId
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "coachConversations",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"coachConversations": [
		{
			"id": "ID",
			"status": "Enum",
			"status_idx": "Integer",
			"userId": "ID",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Mealplans API

[Default list API] — This is the designated default list API for the mealPlan data object. Frontend generators and AI agents should use this API for standard CRUD operations. List meal plans. Users see their own, admins can see all.

Rest Route

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

/v1/mealplans

Rest Request Parameters

Filter Parameters

The listMealPlans api supports 2 optional filter parameters for filtering list results:

status (Enum): Meal plan status

• Single: ?status=<value> (case-insensitive)
• Multiple: ?status=<value1>&status=<value2>
• Null: ?status=null

userId (ID): Reference to the user who owns this meal plan

• Single: ?userId=<value>
• Multiple: ?userId=<value1>&userId=<value2>
• Null: ?userId=null

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

  axios({
    method: 'GET',
    url: '/v1/mealplans',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // status: '<value>' // Filter by status
        // userId: '<value>' // Filter by userId
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "mealPlans",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"mealPlans": [
		{
			"id": "ID",
			"carbGrams": "Float",
			"dailyCalorieTarget": "Integer",
			"fatGrams": "Float",
			"notes": "Text",
			"proteinGrams": "Float",
			"restDayCalories": "Integer",
			"restDayCarbGrams": "Float",
			"status": "Enum",
			"status_idx": "Integer",
			"trainingDayCalories": "Integer",
			"trainingDayCarbGrams": "Float",
			"userId": "ID",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Moderationrecords API

[Default list API] — This is the designated default list API for the moderationRecord data object. Frontend generators and AI agents should use this API for standard CRUD operations. List moderation records. Admin only. Supports filtering by userId and action.

Rest Route

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

/v1/moderationrecords

Rest Request Parameters

Filter Parameters

The listModerationRecords api supports 2 optional filter parameters for filtering list results:

action (Enum): Moderation action taken

• Single: ?action=<value> (case-insensitive)
• Multiple: ?action=<value1>&action=<value2>
• Null: ?action=null

userId (ID): Reference to the user who was moderated

• Single: ?userId=<value>
• Multiple: ?userId=<value1>&userId=<value2>
• Null: ?userId=null

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

  axios({
    method: 'GET',
    url: '/v1/moderationrecords',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // action: '<value>' // Filter by action
        // userId: '<value>' // Filter by userId
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationRecords",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"moderationRecords": [
		{
			"id": "ID",
			"action": "Enum",
			"action_idx": "Integer",
			"offenseType": "String",
			"reason": "Text",
			"suspensionExpiresAt": "Date",
			"userId": "ID",
			"content": "String",
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID",
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Planmeals API

[Default list API] — This is the designated default list API for the planMeal data object. Frontend generators and AI agents should use this API for standard CRUD operations. List meals for a meal plan with parent ownership validation.

Rest Route

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

/v1/planmeals

Rest Request Parameters

The listPlanMeals api has got 1 regular request parameter

Parameter	Type	Required	Population
mealPlanId	ID	true	request.query?.[“mealPlanId”]
mealPlanId : The meal plan ID to list meals for

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

  axios({
    method: 'GET',
    url: '/v1/planmeals',
    data: {
    
    },
    params: {
             mealPlanId:'"ID"',  
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "planMeals",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"planMeals": [
		{
			"id": "ID",
			"carbs": "Float",
			"fat": "Float",
			"foods": "Text",
			"mealLabel": "String",
			"mealPlanId": "ID",
			"protein": "Float",
			"sortOrder": "Integer",
			"totalCalories": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Programexercises API

[Default list API] — This is the designated default list API for the programExercise data object. Frontend generators and AI agents should use this API for standard CRUD operations. List exercises for a training program. Validates parent program ownership.

Rest Route

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

/v1/programexercises

Rest Request Parameters

The listProgramExercises api has got 1 regular request parameter

Parameter	Type	Required	Population
trainingProgramId	ID	true	request.query?.[“trainingProgramId”]
trainingProgramId : The training program ID to list exercises for

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

  axios({
    method: 'GET',
    url: '/v1/programexercises',
    data: {
    
    },
    params: {
             trainingProgramId:'"ID"',  
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "programExercises",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"programExercises": [
		{
			"id": "ID",
			"dayLabel": "String",
			"exerciseName": "String",
			"movementType": "Enum",
			"movementType_idx": "Integer",
			"muscleGroup": "String",
			"progressionRule": "Text",
			"repMax": "Integer",
			"repMin": "Integer",
			"rirTarget": "Integer",
			"sets": "Integer",
			"sortOrder": "Integer",
			"trainingProgramId": "ID",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Quotaconfigs API

[Default list API] — This is the designated default list API for the quotaConfig data object. Frontend generators and AI agents should use this API for standard CRUD operations. List quota configuration records.

Rest Route

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

/v1/quotaconfigs

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

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "quotaConfigs",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"quotaConfigs": [
		{
			"id": "ID",
			"quotaLimit": "Integer",
			"quotaPeriod": "Enum",
			"quotaPeriod_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Trainingprograms API

[Default list API] — This is the designated default list API for the trainingProgram data object. Frontend generators and AI agents should use this API for standard CRUD operations. List training programs. Users see their own programs, admins can see all.

Rest Route

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

/v1/trainingprograms

Rest Request Parameters

Filter Parameters

The listTrainingPrograms api supports 2 optional filter parameters for filtering list results:

status (Enum): Program status

• Single: ?status=<value> (case-insensitive)
• Multiple: ?status=<value1>&status=<value2>
• Null: ?status=null

userId (ID): Reference to the user who owns this training program

• Single: ?userId=<value>
• Multiple: ?userId=<value1>&userId=<value2>
• Null: ?userId=null

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

  axios({
    method: 'GET',
    url: '/v1/trainingprograms',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // status: '<value>' // Filter by status
        // userId: '<value>' // Filter by userId
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "trainingPrograms",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"trainingPrograms": [
		{
			"id": "ID",
			"cardioDurationMinutes": "Integer",
			"cardioFrequencyPerWeek": "Integer",
			"cardioType": "String",
			"dailyStepTarget": "Integer",
			"deloadIntervalWeeks": "Integer",
			"notes": "Text",
			"splitType": "String",
			"status": "Enum",
			"status_idx": "Integer",
			"userId": "ID",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Userquotas API

[Default list API] — This is the designated default list API for the userQuota data object. Frontend generators and AI agents should use this API for standard CRUD operations. List all user quotas. Admin only.

Rest Route

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

/v1/userquotas

Rest Request Parameters

Filter Parameters

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

userId (ID): Reference to the user whose quota is being tracked

• Single: ?userId=<value>
• Multiple: ?userId=<value1>&userId=<value2>
• Null: ?userId=null

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

  axios({
    method: 'GET',
    url: '/v1/userquotas',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // userId: '<value>' // Filter by userId
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "userQuotas",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"userQuotas": [
		{
			"id": "ID",
			"messageCount": "Integer",
			"periodEnd": "Date",
			"periodStart": "Date",
			"userId": "ID",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Weightlogs API

[Default list API] — This is the designated default list API for the weightLog data object. Frontend generators and AI agents should use this API for standard CRUD operations. List weight log entries. Users see their own, admins see all.

Rest Route

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

/v1/weightlogs

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

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "weightLogs",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"weightLogs": [
		{
			"id": "ID",
			"measuredAt": "Date",
			"userId": "ID",
			"weightKg": "Float",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Update Quotaconfig API

[Default update API] — This is the designated default update API for the quotaConfig data object. Frontend generators and AI agents should use this API for standard CRUD operations. Update a quota configuration record. Admin only.

Rest Route

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

/v1/quotaconfigs/:quotaConfigId

Rest Request Parameters

The updateQuotaConfig api has got 3 regular request parameters

Parameter	Type	Required	Population
quotaConfigId	ID	true	request.params?.[“quotaConfigId”]
quotaLimit	Integer	false	request.body?.[“quotaLimit”]
quotaPeriod	Enum	false	request.body?.[“quotaPeriod”]
quotaConfigId : This id paremeter is used to select the required data object that will be updated
quotaLimit : Maximum messages allowed per period
quotaPeriod : Period over which the quota is measured

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

  axios({
    method: 'PATCH',
    url: `/v1/quotaconfigs/${quotaConfigId}`,
    data: {
            quotaLimit:"Integer",  
            quotaPeriod:"Enum",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "quotaConfig",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"quotaConfig": {
		"id": "ID",
		"quotaLimit": "Integer",
		"quotaPeriod": "Enum",
		"quotaPeriod_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Moderationrecord API

Rest Route

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

/v1/moderationrecords/:moderationRecordId

Rest Request Parameters

The deleteModerationRecord api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationRecord",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"moderationRecord": {
		"id": "ID",
		"action": "Enum",
		"action_idx": "Integer",
		"offenseType": "String",
		"reason": "Text",
		"suspensionExpiresAt": "Date",
		"userId": "ID",
		"content": "String",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": false
	}
}

Do Deletemealplan API

Rest Route

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

/v1/deletemealplan/:mealPlanId

Rest Request Parameters

The deletemealplan api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "mealPlan",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"mealPlan": {
		"id": "ID",
		"carbGrams": "Float",
		"dailyCalorieTarget": "Integer",
		"fatGrams": "Float",
		"notes": "Text",
		"proteinGrams": "Float",
		"restDayCalories": "Integer",
		"restDayCarbGrams": "Float",
		"status": "Enum",
		"status_idx": "Integer",
		"trainingDayCalories": "Integer",
		"trainingDayCarbGrams": "Float",
		"userId": "ID",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Do Deletetrainingprogram API

Rest Route

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

/v1/deletetrainingprogram/:trainingProgramId

Rest Request Parameters

The deletetrainingprogram api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "trainingProgram",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"trainingProgram": {
		"id": "ID",
		"cardioDurationMinutes": "Integer",
		"cardioFrequencyPerWeek": "Integer",
		"cardioType": "String",
		"dailyStepTarget": "Integer",
		"deloadIntervalWeeks": "Integer",
		"notes": "Text",
		"splitType": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"userId": "ID",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Moderationrecord API

Rest Route

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

/v1/moderationrecords/:moderationRecordId

Rest Request Parameters

The updateModerationRecord api has got 3 regular request parameters

Parameter	Type	Required	Population
moderationRecordId	ID	true	request.params?.[“moderationRecordId”]
action	String	true	request.body?.[“action”]
content	String	false	request.body?.[“content”]
moderationRecordId : This id paremeter is used to select the required data object that will be updated
action :
content :

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

  axios({
    method: 'PATCH',
    url: `/v1/moderationrecords/${moderationRecordId}`,
    data: {
            action:"String",  
            content:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationRecord",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"moderationRecord": {
		"id": "ID",
		"action": "Enum",
		"action_idx": "Integer",
		"offenseType": "String",
		"reason": "Text",
		"suspensionExpiresAt": "Date",
		"userId": "ID",
		"content": "String",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

Do Listmymoderationrecords API

Rest Route

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

/v1/listmymoderationrecords

Rest Request Parameters

Filter Parameters

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

action (Enum): Moderation action taken

• Single: ?action=<value> (case-insensitive)
• Multiple: ?action=<value1>&action=<value2>
• Null: ?action=null

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

  axios({
    method: 'GET',
    url: '/v1/listmymoderationrecords',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // action: '<value>' // Filter by action
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "moderationRecords",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"moderationRecords": [
		{
			"id": "ID",
			"action": "Enum",
			"action_idx": "Integer",
			"offenseType": "String",
			"reason": "Text",
			"suspensionExpiresAt": "Date",
			"userId": "ID",
			"content": "String",
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID",
			"isActive": true
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Banappeals API

Rest Route

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

/v1/banappealses

Rest Request Parameters

The listBanAppeals api has got 2 regular request parameters

Parameter	Type	Required	Population
userId	ID	false	request.query?.[“userId”]
status	ID	false	request.query?.[“status”]
userId :
status :

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

  axios({
    method: 'GET',
    url: '/v1/banappealses',
    data: {
    
    },
    params: {
             userId:'"ID"',  
             status:'"ID"',  
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "banAppealses",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"banAppealses": [
		{
			"id": "ID",
			"moderationRecordId": "ID",
			"userId": "ID",
			"appealReason": "String",
			"status": "Enum",
			"status_idx": "Integer",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID",
			"showmoderationRecord": [
				{
					"offenseType": "String",
					"reason": "Text",
					"userId": "ID",
					"content": "String"
				},
				{},
				{}
			]
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Banappeal API

Rest Route

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

/v1/banappeal

Rest Request Parameters

The createBanAppeal api has got 3 regular request parameters

Parameter	Type	Required	Population
moderationRecordId	ID	true	request.body?.[“moderationRecordId”]
appealReason	String	true	request.body?.[“appealReason”]
status	Enum	true	request.body?.[“status”]
moderationRecordId : id of the mod record
appealReason :
status :

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

  axios({
    method: 'POST',
    url: '/v1/banappeal',
    data: {
            moderationRecordId:"ID",  
            appealReason:"String",  
            status:"Enum",  
    
    },
    params: {
    
        }
  });

REST Response

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

Update Banappeal API

Rest Route

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

/v1/banappeal/:banAppealsId

Rest Request Parameters

The updateBanAppeal api has got 4 regular request parameters

Parameter	Type	Required	Population
banAppealsId	ID	true	request.params?.[“banAppealsId”]
status	Enum	true	request.body?.[“status”]
moderationRecordId	ID	false	request.body?.[“moderationRecordId”]
appealReason	String	false	request.body?.[“appealReason”]
banAppealsId : This id paremeter is used to select the required data object that will be updated
status :
moderationRecordId : id of the mod record
appealReason :

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

  axios({
    method: 'PATCH',
    url: `/v1/banappeal/${banAppealsId}`,
    data: {
            status:"Enum",  
            moderationRecordId:"ID",  
            appealReason:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "banAppeals",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"banAppeals": {
		"id": "ID",
		"moderationRecordId": "ID",
		"userId": "ID",
		"appealReason": "String",
		"status": "Enum",
		"status_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Create Additionalquota API

Rest Route

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

/v1/additionalquotas

Rest Request Parameters

The createAdditionalQuota api has got 9 regular request parameters

Parameter	Type	Required	Population
additionalMessage	Integer	true	request.body?.[“additionalMessage”]
status	Enum	true	request.body?.[“status”]
currency	String	true	request.body?.[“currency”]
pricePaid	Integer	true	request.body?.[“pricePaid”]
statusUpdatedAt	Date	false	request.body?.[“statusUpdatedAt”]
activatedAt	Date	false	request.body?.[“activatedAt”]
cancelledAt	Date	false	request.body?.[“cancelledAt”]
periodEnd	Date	false	request.body?.[“periodEnd”]
periodStart	Date	false	request.body?.[“periodStart”]
additionalMessage :
status :
currency :
pricePaid :
statusUpdatedAt :
activatedAt :
cancelledAt :
periodEnd :
periodStart :

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

  axios({
    method: 'POST',
    url: '/v1/additionalquotas',
    data: {
            additionalMessage:"Integer",  
            status:"Enum",  
            currency:"String",  
            pricePaid:"Integer",  
            statusUpdatedAt:"Date",  
            activatedAt:"Date",  
            cancelledAt:"Date",  
            periodEnd:"Date",  
            periodStart:"Date",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "additionalQuota",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"additionalQuota": {
		"id": "ID",
		"userId": "String",
		"additionalMessage": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"currency": "String",
		"pricePaid": "Integer",
		"statusUpdatedAt": "Date",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"periodEnd": "Date",
		"periodStart": "Date",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Myadditionalquota API

Rest Route

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

/v1/myadditionalquota

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

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "additionalQuota",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"additionalQuota": {
		"id": "ID",
		"userId": "String",
		"additionalMessage": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"currency": "String",
		"pricePaid": "Integer",
		"statusUpdatedAt": "Date",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"periodEnd": "Date",
		"periodStart": "Date",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"myaddQuota": "Object"
}

Get Additionalquotapayment API

This route is used to get the payment information by ID.

Rest Route

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

/v1/additionalquotapayment/:sys_additionalQuotaPaymentId

Rest Request Parameters

The getAdditionalQuotaPayment api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_additionalQuotaPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_additionalQuotaPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Additionalquotapayments API

This route is used to list all payments.

Rest Route

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

/v1/additionalquotapayments

Rest Request Parameters

Filter Parameters

The listAdditionalQuotaPayments api supports 6 optional filter parameters for filtering list results:

ownerId (ID): An ID value to represent owner user who created the order

• Single: ?ownerId=<value>
• Multiple: ?ownerId=<value1>&ownerId=<value2>
• Null: ?ownerId=null

orderId (ID): an ID value to represent the orderId which is the ID parameter of the source additionalQuota object

• Single: ?orderId=<value>
• Multiple: ?orderId=<value1>&orderId=<value2>
• Null: ?orderId=null

paymentId (String): A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type

• Single (partial match, case-insensitive): ?paymentId=<value>
• Multiple: ?paymentId=<value1>&paymentId=<value2>
• Null: ?paymentId=null

paymentStatus (String): A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.

• Single (partial match, case-insensitive): ?paymentStatus=<value>
• Multiple: ?paymentStatus=<value1>&paymentStatus=<value2>
• Null: ?paymentStatus=null

statusLiteral (String): A string value to represent the logical payment status which belongs to the application lifecycle itself.

• Single (partial match, case-insensitive): ?statusLiteral=<value>
• Multiple: ?statusLiteral=<value1>&statusLiteral=<value2>
• Null: ?statusLiteral=null

redirectUrl (String): A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.

• Single (partial match, case-insensitive): ?redirectUrl=<value>
• Multiple: ?redirectUrl=<value1>&redirectUrl=<value2>
• Null: ?redirectUrl=null

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

  axios({
    method: 'GET',
    url: '/v1/additionalquotapayments',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // ownerId: '<value>' // Filter by ownerId
        // orderId: '<value>' // Filter by orderId
        // paymentId: '<value>' // Filter by paymentId
        // paymentStatus: '<value>' // Filter by paymentStatus
        // statusLiteral: '<value>' // Filter by statusLiteral
        // redirectUrl: '<value>' // Filter by redirectUrl
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_additionalQuotaPayments",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_additionalQuotaPayments": [
		{
			"id": "ID",
			"ownerId": "ID",
			"orderId": "ID",
			"paymentId": "String",
			"paymentStatus": "String",
			"statusLiteral": "String",
			"redirectUrl": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Create Additionalquotapayment API

This route is used to create a new payment.

Rest Route

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

/v1/additionalquotapayment

Rest Request Parameters

The createAdditionalQuotaPayment api has got 5 regular request parameters

Parameter	Type	Required	Population
orderId	ID	true	request.body?.[“orderId”]
paymentId	String	true	request.body?.[“paymentId”]
paymentStatus	String	true	request.body?.[“paymentStatus”]
statusLiteral	String	true	request.body?.[“statusLiteral”]
redirectUrl	String	false	request.body?.[“redirectUrl”]
orderId : an ID value to represent the orderId which is the ID parameter of the source additionalQuota object
paymentId : A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type
paymentStatus : A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.
statusLiteral : A string value to represent the logical payment status which belongs to the application lifecycle itself.
redirectUrl : A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.

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

  axios({
    method: 'POST',
    url: '/v1/additionalquotapayment',
    data: {
            orderId:"ID",  
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_additionalQuotaPayment",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_additionalQuotaPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Additionalquotapayment API

This route is used to update an existing payment.

Rest Route

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

/v1/additionalquotapayment/:sys_additionalQuotaPaymentId

Rest Request Parameters

The updateAdditionalQuotaPayment api has got 5 regular request parameters

Parameter	Type	Required	Population
sys_additionalQuotaPaymentId	ID	true	request.params?.[“sys_additionalQuotaPaymentId”]
paymentId	String	false	request.body?.[“paymentId”]
paymentStatus	String	false	request.body?.[“paymentStatus”]
statusLiteral	String	false	request.body?.[“statusLiteral”]
redirectUrl	String	false	request.body?.[“redirectUrl”]
sys_additionalQuotaPaymentId : This id paremeter is used to select the required data object that will be updated
paymentId : A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type
paymentStatus : A string value to represent the payment status which belongs to the lifecyle of a Stripe payment.
statusLiteral : A string value to represent the logical payment status which belongs to the application lifecycle itself.
redirectUrl : A string value to represent return page of the frontend to show the result of the payment, this is used when the callback is made to server not the client.

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

  axios({
    method: 'PATCH',
    url: `/v1/additionalquotapayment/${sys_additionalQuotaPaymentId}`,
    data: {
            paymentId:"String",  
            paymentStatus:"String",  
            statusLiteral:"String",  
            redirectUrl:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_additionalQuotaPayment",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_additionalQuotaPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Additionalquotapayment API

This route is used to delete a payment.

Rest Route

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

/v1/additionalquotapayment/:sys_additionalQuotaPaymentId

Rest Request Parameters

The deleteAdditionalQuotaPayment api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_additionalQuotaPayment",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_additionalQuotaPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Additionalquotapaymentbyorderid API

This route is used to get the payment information by order id.

Rest Route

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

/v1/additionalQuotapaymentbyorderid/:orderId

Rest Request Parameters

The getAdditionalQuotaPaymentByOrderId api has got 1 regular request parameter

Parameter	Type	Required	Population
orderId	ID	true	request.params?.[“orderId”]
orderId : an ID value to represent the orderId which is the ID parameter of the source additionalQuota object. The parameter is used to query data.

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_additionalQuotaPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_additionalQuotaPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Get Additionalquotapaymentbypaymentid API

This route is used to get the payment information by payment id.

Rest Route

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

/v1/additionalQuotapaymentbypaymentid/:paymentId

Rest Request Parameters

The getAdditionalQuotaPaymentByPaymentId api has got 1 regular request parameter

Parameter	Type	Required	Population
paymentId	String	true	request.params?.[“paymentId”]
paymentId : A String value to represent the paymentId which is generated on the Stripe gateway. This id may represent different objects due to the payment gateway and the chosen flow type. The parameter is used to query data.

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_additionalQuotaPayment",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_additionalQuotaPayment": {
		"id": "ID",
		"ownerId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "String",
		"statusLiteral": "String",
		"redirectUrl": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Start Additionalquotapayment API

Start payment for additionalQuota

Rest Route

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

/v1/startadditionalquotapayment/:additionalQuotaId

Rest Request Parameters

The startAdditionalQuotaPayment api has got 2 regular request parameters

Parameter	Type	Required	Population
additionalQuotaId	ID	true	request.params?.[“additionalQuotaId”]
paymentUserParams	Object	true	request.body?.[“paymentUserParams”]
additionalQuotaId : This id paremeter is used to select the required data object that will be updated
paymentUserParams : The user parameters that should be defined to start a stripe payment process. Must include paymentMethodId.

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

  axios({
    method: 'PATCH',
    url: `/v1/startadditionalquotapayment/${additionalQuotaId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "additionalQuota",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"additionalQuota": {
		"id": "ID",
		"userId": "String",
		"additionalMessage": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"currency": "String",
		"pricePaid": "Integer",
		"statusUpdatedAt": "Date",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"periodEnd": "Date",
		"periodStart": "Date",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}

Refresh Additionalquotapayment API

Refresh payment info for additionalQuota from Stripe

Rest Route

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

/v1/refreshadditionalquotapayment/:additionalQuotaId

Rest Request Parameters

The refreshAdditionalQuotaPayment api has got 2 regular request parameters

Parameter	Type	Required	Population
additionalQuotaId	ID	true	request.params?.[“additionalQuotaId”]
paymentUserParams	Object	false	request.body?.[“paymentUserParams”]
additionalQuotaId : This id paremeter is used to select the required data object that will be updated
paymentUserParams : The user parameters that should be defined to refresh a stripe payment process

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

  axios({
    method: 'PATCH',
    url: `/v1/refreshadditionalquotapayment/${additionalQuotaId}`,
    data: {
            paymentUserParams:"Object",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "additionalQuota",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"additionalQuota": {
		"id": "ID",
		"userId": "String",
		"additionalMessage": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"currency": "String",
		"pricePaid": "Integer",
		"statusUpdatedAt": "Date",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"periodEnd": "Date",
		"periodStart": "Date",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}

Callback Additionalquotapayment API

Refresh payment values by gateway webhook call for additionalQuota

Rest Route

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

/v1/callbackadditionalquotapayment

Rest Request Parameters

The callbackAdditionalQuotaPayment api has got 1 regular request parameter

Parameter	Type	Required	Population
additionalQuotaId	ID	false	request.body?.[“additionalQuotaId”]
additionalQuotaId : The order id parameter that will be read from webhook callback params

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

  axios({
    method: 'POST',
    url: '/v1/callbackadditionalquotapayment',
    data: {
            additionalQuotaId:"ID",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "additionalQuota",
	"method": "POST",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"additionalQuota": {
		"id": "ID",
		"userId": "String",
		"additionalMessage": "Integer",
		"status": "Enum",
		"status_idx": "Integer",
		"currency": "String",
		"pricePaid": "Integer",
		"statusUpdatedAt": "Date",
		"activatedAt": "Date",
		"cancelledAt": "Date",
		"periodEnd": "Date",
		"periodStart": "Date",
		"paymentConfirmation": "Enum",
		"paymentConfirmation_idx": "Integer",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	},
	"paymentResult": {
		"paymentTicketId": "ID",
		"orderId": "ID",
		"paymentId": "String",
		"paymentStatus": "Enum",
		"paymentIntentInfo": "Object",
		"statusLiteral": "String",
		"amount": "Double",
		"currency": "String",
		"success": true,
		"description": "String",
		"metadata": "Object",
		"paymentUserParams": "Object"
	}
}

Get Paymentcustomerbyuserid API

This route is used to get the payment customer information by user id.

Rest Route

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

/v1/paymentcustomers/:userId

Rest Request Parameters

The getPaymentCustomerByUserId api has got 1 regular request parameter

Parameter	Type	Required	Population
userId	ID	true	request.params?.[“userId”]
userId : An ID value to represent the user who is created as a stripe customer. The parameter is used to query data.

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_paymentCustomer",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"sys_paymentCustomer": {
		"id": "ID",
		"userId": "ID",
		"customerId": "String",
		"platform": "String",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

List Paymentcustomers API

This route is used to list all payment customers.

Rest Route

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

/v1/paymentcustomers

Rest Request Parameters

Filter Parameters

The listPaymentCustomers api supports 3 optional filter parameters for filtering list results:

userId (ID): An ID value to represent the user who is created as a stripe customer

• Single: ?userId=<value>
• Multiple: ?userId=<value1>&userId=<value2>
• Null: ?userId=null

customerId (String): A string value to represent the customer id which is generated on the Stripe gateway. This id is used to represent the customer in the Stripe gateway

• Single (partial match, case-insensitive): ?customerId=<value>
• Multiple: ?customerId=<value1>&customerId=<value2>
• Null: ?customerId=null

platform (String): A String value to represent payment platform which is used to make the payment. It is stripe as default. It will be used to distinguesh the payment gateways in the future.

• Single (partial match, case-insensitive): ?platform=<value>
• Multiple: ?platform=<value1>&platform=<value2>
• Null: ?platform=null

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

  axios({
    method: 'GET',
    url: '/v1/paymentcustomers',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // userId: '<value>' // Filter by userId
        // customerId: '<value>' // Filter by customerId
        // platform: '<value>' // Filter by platform
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_paymentCustomers",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_paymentCustomers": [
		{
			"id": "ID",
			"userId": "ID",
			"customerId": "String",
			"platform": "String",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

List Paymentcustomermethods API

This route is used to list all payment customer methods.

Rest Route

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

/v1/paymentcustomermethods/:userId

Rest Request Parameters

The listPaymentCustomerMethods api has got 1 regular request parameter

Parameter	Type	Required	Population
userId	ID	true	request.params?.[“userId”]
userId : An ID value to represent the user who owns the payment method. The parameter is used to query data.

Filter Parameters

The listPaymentCustomerMethods api supports 6 optional filter parameters for filtering list results:

paymentMethodId (String): A string value to represent the id of the payment method on the payment platform.

• Single (partial match, case-insensitive): ?paymentMethodId=<value>
• Multiple: ?paymentMethodId=<value1>&paymentMethodId=<value2>
• Null: ?paymentMethodId=null

customerId (String): A string value to represent the customer id which is generated on the payment gateway.

• Single (partial match, case-insensitive): ?customerId=<value>
• Multiple: ?customerId=<value1>&customerId=<value2>
• Null: ?customerId=null

cardHolderName (String): A string value to represent the name of the card holder. It can be different than the registered customer.

• Single (partial match, case-insensitive): ?cardHolderName=<value>
• Multiple: ?cardHolderName=<value1>&cardHolderName=<value2>
• Null: ?cardHolderName=null

cardHolderZip (String): A string value to represent the zip code of the card holder. It is used for address verification in specific countries.

• Single (partial match, case-insensitive): ?cardHolderZip=<value>
• Multiple: ?cardHolderZip=<value1>&cardHolderZip=<value2>
• Null: ?cardHolderZip=null

platform (String): A String value to represent payment platform which teh paymentMethod belongs. It is stripe as default. It will be used to distinguesh the payment gateways in the future.

• Single (partial match, case-insensitive): ?platform=<value>
• Multiple: ?platform=<value1>&platform=<value2>
• Null: ?platform=null

cardInfo (Object): A Json value to store the card details of the payment method.

• Single: ?cardInfo=<value>
• Multiple: ?cardInfo=<value1>&cardInfo=<value2>
• Null: ?cardInfo=null

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

  axios({
    method: 'GET',
    url: `/v1/paymentcustomermethods/${userId}`,
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // paymentMethodId: '<value>' // Filter by paymentMethodId
        // customerId: '<value>' // Filter by customerId
        // cardHolderName: '<value>' // Filter by cardHolderName
        // cardHolderZip: '<value>' // Filter by cardHolderZip
        // platform: '<value>' // Filter by platform
        // cardInfo: '<value>' // Filter by cardInfo
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "sys_paymentMethods",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"sys_paymentMethods": [
		{
			"id": "ID",
			"paymentMethodId": "String",
			"userId": "ID",
			"customerId": "String",
			"cardHolderName": "String",
			"cardHolderZip": "String",
			"platform": "String",
			"cardInfo": "Object",
			"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

• Returns the authenticated session object associated with the current access token.
• If no valid session exists, responds with a 401 Unauthorized.

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

• This route is typically used by frontend or mobile applications to fetch the current session state after login.
• The returned session includes key user identity fields, tenant information (if applicable), and the access token for further authenticated requests.
• Always ensure a valid access token is provided in the request to retrieve the session.

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

• Fetches all active permission records (givenPermissions entries) associated with the current user session.
• Returns a full array of permission objects.
• Requires a valid session (access token) to be available.

// 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:

• **permissionName**: The permission the user has.
• **roleId**: If the permission was granted through a role. - **subjectUserId**: If directly granted to the user.
• **subjectUserGroupId**: If granted through a group.
• **objectId**: If tied to a specific object (OBAC).
• **canDo**: True or false flag to represent if permission is active or restricted.

Error Responses

• 401 Unauthorized: No active session found.

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

• 500 Internal Server Error: Unexpected error fetching permissions.

Notes

• The /permissions route is available across all backend services generated by Mindbricks, not just the auth service.
• Auth service: Fetches permissions freshly from the live database (givenPermissions table).
• Other services: Typically use a cached or projected view of permissions stored in a common ElasticSearch store, optimized for faster authorization checks.

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

• Evaluates whether the current user has access to the given permissionName.
• Returns a structured object indicating:
  • Whether the permission is generally granted (canDo)
  • Which object IDs are explicitly included or excluded from access (exceptions)
• Requires a valid session (access token).

// 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"
  ]
}

• If canDo is true, the user generally has the permission, but not for the objects listed in exceptions (i.e., restrictions).
• If canDo is false, the user does not have the permission by default — but only for the objects in exceptions, they do have permission (i.e., selective overrides).
• The exceptions array contains valid UUID strings, each corresponding to an object ID (typically from the data model targeted by the permission).

Copyright

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

About Us

For more information please visit our website: .

. .