REST API GUIDE

wechess-lobbychat-service

Version: 1.0.24

Public lobby chat microservice. Manages create, list, reporting, moderation, and 24-hour message expiry for guest/registered users.

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

Intended Audience

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

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

The following routes are available by default:

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

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

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

Path Parameters: Embedded within the URL’s path.

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

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

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

By adhering to the specified parameter inclusion methods, you can effectively utilize the LobbyChat 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 LobbyChat service’s business API support several common parameters designed to modify and enhance the behavior of API requests. These parameters are not individually listed in the API route definitions to avoid repetition. Instead, refer to this section to understand how to leverage these common behaviors across different routes. Note that all common parameters should be included in the query part of the URL.

Supported Common Parameters:

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

Error Response

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

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

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

Object Structure of a Successfull Response

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

Key Characteristics of the Response Envelope:

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

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

API Response Structure

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

HTTP Status Codes:

Success Response Format:

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

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

Handling Errors:

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

Resources

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

LobbyMessage resource

Resource Definition : A single lobby/public chat message between any logged-in user (guest, registered, admin). Ephemeral (24h retention), with reporting and moderation support. Muting is tracked by senderId+mutedUntil for punishment management. LobbyMessage Resource Properties

Name Type Required Default Definition
senderId ID User ID (guest or registered) who sent the message. References auth:user.id.
senderDisplayName String Display name (from user fullname at send time; allows historical display even if name changes).
content String Chat message body (limited at UI, backend-enforces not empty; max 500 chars).
sentAt Date UTC timestamp when message was sent. Used to enforce 24h retention and sorting.
reportStatus Enum Moderation/report workflow state: none (default), reported (user), underReview (admin).
mutedUntil Date If set, the message sender is muted in the lobby until this timestamp. Only admins may set. Used with senderId for lookup on enforcement.
removed Boolean If true, message is hidden/removed by admin moderation (soft-remove).
roomId String Daily room identifier (lobby-YYYY-MM-DD). Scopes message to that day.

Enum Properties

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

reportStatus Enum Property

Property Definition : Moderation/report workflow state: none (default), reported (user), underReview (admin).Enum Options

Name Value Index
none "none"" 0
reported "reported"" 1
underReview "underReview"" 2

LobbyRoom resource

Resource Definition : Daily lobby chat room. One record per day (roomId format: lobby-YYYY-MM-DD). Older rooms kept as history. LobbyRoom Resource Properties

Name Type Required Default Definition
roomId String Room identifier, e.g. lobby-2026-03-10

LobbyChatHubMessage resource

Resource Definition : Auto-generated message DataObject for the lobbyChatHub RealtimeHub. Stores all messages with typed content payloads. LobbyChatHubMessage Resource Properties

Name Type Required Default Definition
roomId ID Reference to the room this message belongs to
senderId ID Reference to the user who sent this message
senderName String Display name of the sender (denormalized from user profile at send time)
senderAvatar String Avatar URL of the sender (denormalized from user profile at send time)
messageType Enum Content type discriminator for this message
content Object Type-specific content payload (structure depends on messageType)
timestamp Message creation time
status Enum Message moderation status
reaction Object Emoji reactions [{ emoji, userId, timestamp }]

Enum Properties

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

messageType Enum Property

Property Definition : Content type discriminator for this messageEnum Options

Name Value Index
text "text"" 0
system "system"" 1
status Enum Property

Property Definition : Message moderation statusEnum Options

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

LobbyChatHubModeration resource

Resource Definition : Auto-generated moderation DataObject for the lobbyChatHub RealtimeHub. Stores block and silence actions for room-level user moderation. LobbyChatHubModeration Resource Properties

Name Type Required Default Definition
roomId ID Reference to the room where the moderation action applies
userId ID The user who is blocked or silenced
action Enum Moderation action type
reason Text Optional reason for the moderation action
duration Integer Duration in seconds. 0 means permanent
expiresAt Expiry timestamp. Null means permanent
issuedBy ID The moderator who issued the action

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 typeEnum Options

Name Value Index
blocked "blocked"" 0
silenced "silenced"" 1

Business Api

Create Lobbymessage API

[Default create API] — This is the designated default create API for the lobbyMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Post a new lobby chat message. Enforces mute (mutedUntil > now), ensures message is not empty and under 500 chars. SenderId and senderDisplayName are populated from session.

API Frontend Description By The Backend Architect

Rest Route

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

/v1/lobbymessages

Rest Request Parameters

The createLobbyMessage api has got 8 regular request parameters

Parameter Type Required Population
senderId ID true request.body?.[“senderId”]
senderDisplayName String true request.body?.[“senderDisplayName”]
content String true request.body?.[“content”]
sentAt Date true request.body?.[“sentAt”]
reportStatus Enum true request.body?.[“reportStatus”]
mutedUntil Date false request.body?.[“mutedUntil”]
removed Boolean true request.body?.[“removed”]
roomId String true request.body?.[“roomId”]
senderId : User ID (guest or registered) who sent the message. References auth:user.id.
senderDisplayName : Display name (from user fullname at send time; allows historical display even if name changes).
content : Chat message body (limited at UI, backend-enforces not empty; max 500 chars).
sentAt : UTC timestamp when message was sent. Used to enforce 24h retention and sorting.
reportStatus : Moderation/report workflow state: none (default), reported (user), underReview (admin).
mutedUntil : If set, the message sender is muted in the lobby until this timestamp. Only admins may set. Used with senderId for lookup on enforcement.
removed : If true, message is hidden/removed by admin moderation (soft-remove).
roomId : Daily room identifier (lobby-YYYY-MM-DD). Scopes message to that day.

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

  axios({
    method: 'POST',
    url: '/v1/lobbymessages',
    data: {
            senderId:"ID",  
            senderDisplayName:"String",  
            content:"String",  
            sentAt:"Date",  
            reportStatus:"Enum",  
            mutedUntil:"Date",  
            removed:"Boolean",  
            roomId:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "201",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lobbyMessage",
	"method": "POST",
	"action": "create",
	"appVersion": "Version",
	"rowCount": 1,
	"lobbyMessage": {
		"id": "ID",
		"senderId": "ID",
		"senderDisplayName": "String",
		"content": "String",
		"sentAt": "Date",
		"reportStatus": "Enum",
		"reportStatus_idx": "Integer",
		"mutedUntil": "Date",
		"removed": "Boolean",
		"roomId": "String",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

List Lobbymessages API

[Default list API] — This is the designated default list API for the lobbyMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Fetch latest lobby chat messages from the last 24 hours (not removed). Sorted sentAt desc. Paginated by default (50 per page).

API Frontend Description By The Backend Architect

Rest Route

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

/v1/listlobbymessages/:roomId

Rest Request Parameters

The listLobbyMessages api has got 1 regular request parameter

Parameter Type Required Population
roomId String true request.params?.[“roomId”]
roomId : Daily room identifier (lobby-YYYY-MM-DD). Scopes message to that day… The parameter is used to query data.

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

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

REST Response

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

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

Update Lobbymessagemoderation API

[Default update API] — This is the designated default update API for the lobbyMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Update message for moderation: only admins may set removed (true), mutedUntil, or set reportStatus to underReview. All users may set reportStatus to reported on a message they wish to report. Message owner may not update content or displayName.

API Frontend Description By The Backend Architect

Rest Route

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

/v1/lobbymessagemoderation/:lobbyMessageId

Rest Request Parameters

The updateLobbyMessageModeration api has got 5 regular request parameters

Parameter Type Required Population
lobbyMessageId ID true request.params?.[“lobbyMessageId”]
reportStatus Enum false request.body?.[“reportStatus”]
mutedUntil Date false request.body?.[“mutedUntil”]
removed Boolean false request.body?.[“removed”]
roomId String false request.body?.[“roomId”]
lobbyMessageId : This id paremeter is used to select the required data object that will be updated
reportStatus : Moderation/report workflow state: none (default), reported (user), underReview (admin).
mutedUntil : If set, the message sender is muted in the lobby until this timestamp. Only admins may set. Used with senderId for lookup on enforcement.
removed : If true, message is hidden/removed by admin moderation (soft-remove).
roomId : Daily room identifier (lobby-YYYY-MM-DD). Scopes message to that day.

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

  axios({
    method: 'PATCH',
    url: `/v1/lobbymessagemoderation/${lobbyMessageId}`,
    data: {
            reportStatus:"Enum",  
            mutedUntil:"Date",  
            removed:"Boolean",  
            roomId:"String",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lobbyMessage",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"lobbyMessage": {
		"id": "ID",
		"senderId": "ID",
		"senderDisplayName": "String",
		"content": "String",
		"sentAt": "Date",
		"reportStatus": "Enum",
		"reportStatus_idx": "Integer",
		"mutedUntil": "Date",
		"removed": "Boolean",
		"roomId": "String",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": true
	}
}

Delete Lobbymessage API

[Default delete API] — This is the designated default delete API for the lobbyMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Physical delete of a lobby message (should only be possible for admin batch/cleanup or hard moderation). In practice, most moderation is via removed:true.

API Frontend Description By The Backend Architect

Rest Route

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

/v1/lobbymessages/:lobbyMessageId

Rest Request Parameters

The deleteLobbyMessage api has got 1 regular request parameter

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

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

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lobbyMessage",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"lobbyMessage": {
		"id": "ID",
		"senderId": "ID",
		"senderDisplayName": "String",
		"content": "String",
		"sentAt": "Date",
		"reportStatus": "Enum",
		"reportStatus_idx": "Integer",
		"mutedUntil": "Date",
		"removed": "Boolean",
		"roomId": "String",
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID",
		"isActive": false
	}
}

Ensure Lobbyroom API

Rest Route

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

/v1/ensurelobbyroom

Rest Request Parameters

The ensureLobbyRoom api has got 1 regular request parameter

Parameter Type Required Population
roomId String true request.body?.[“roomId”]
roomId : Room identifier, e.g. lobby-2026-03-10

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

  axios({
    method: 'POST',
    url: '/v1/ensurelobbyroom',
    data: {
            roomId:"String",  
    
    },
    params: {
    
        }
  });

REST Response

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

List Lobbyrooms API

Rest Route

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

/v1/listlobbyrooms/:roomId

Rest Request Parameters

The listLobbyRooms api has got 1 regular request parameter

Parameter Type Required Population
roomId String true request.params?.[“roomId”]
roomId : Room identifier, e.g. lobby-2026-03-10. The parameter is used to query data.

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

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

REST Response

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

List Lobbychathubmessages API

[Default list API] — This is the designated default list API for the lobbyChatHubMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. List messages in a lobbyChatHub hub room. Accessible by admins and room participants.

Rest Route

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

/v1/v1/lobbyChatHub-messages

Rest Request Parameters

Filter Parameters

The listLobbyChatHubMessages api supports 9 optional filter parameters for filtering list results:

roomId (ID): Reference to the room this message belongs to

senderId (ID): Reference to the user who sent this message

senderName (String): Display name of the sender (denormalized from user profile at send time)

senderAvatar (String): Avatar URL of the sender (denormalized from user profile at send time)

messageType (Enum): Content type discriminator for this message

content (Object): Type-specific content payload (structure depends on messageType)

timestamp (String): Message creation time

status (Enum): Message moderation status

reaction (Object): Emoji reactions [{ emoji, userId, timestamp }]

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

  axios({
    method: 'GET',
    url: '/v1/v1/lobbyChatHub-messages',
    data: {
    
    },
    params: {
    
        // Filter parameters (see Filter Parameters section above)
        // roomId: '<value>' // Filter by roomId
        // senderId: '<value>' // Filter by senderId
        // senderName: '<value>' // Filter by senderName
        // senderAvatar: '<value>' // Filter by senderAvatar
        // messageType: '<value>' // Filter by messageType
        // content: '<value>' // Filter by content
        // timestamp: '<value>' // Filter by timestamp
        // status: '<value>' // Filter by status
        // reaction: '<value>' // Filter by reaction
            }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lobbyChatHubMessages",
	"method": "GET",
	"action": "list",
	"appVersion": "Version",
	"rowCount": "\"Number\"",
	"lobbyChatHubMessages": [
		{
			"id": "ID",
			"roomId": "ID",
			"senderId": "ID",
			"senderName": "String",
			"senderAvatar": "String",
			"messageType": "Enum",
			"messageType_idx": "Integer",
			"content": "Object",
			"timestamp": null,
			"status": "Enum",
			"status_idx": "Integer",
			"reaction": "Object",
			"isActive": true,
			"recordVersion": "Integer",
			"createdAt": "Date",
			"updatedAt": "Date",
			"_owner": "ID"
		},
		{},
		{}
	],
	"paging": {
		"pageNumber": "Number",
		"pageRowCount": "NUmber",
		"totalRowCount": "Number",
		"pageCount": "Number"
	},
	"filters": [],
	"uiPermissions": []
}

Get Lobbychathubmessage API

[Default get API] — This is the designated default get API for the lobbyChatHubMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Get a single lobbyChatHub hub message by ID.

Rest Route

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

/v1/v1/lobbyChatHub-messages/:id

Rest Request Parameters

The getLobbyChatHubMessage api has got 2 regular request parameters

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

REST Request To access the api you can use the REST controller with the path GET /v1/v1/lobbyChatHub-messages/:id

  axios({
    method: 'GET',
    url: `/v1/v1/lobbyChatHub-messages/${id}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lobbyChatHubMessage",
	"method": "GET",
	"action": "get",
	"appVersion": "Version",
	"rowCount": 1,
	"lobbyChatHubMessage": {
		"id": "ID",
		"roomId": "ID",
		"senderId": "ID",
		"senderName": "String",
		"senderAvatar": "String",
		"messageType": "Enum",
		"messageType_idx": "Integer",
		"content": "Object",
		"timestamp": null,
		"status": "Enum",
		"status_idx": "Integer",
		"reaction": "Object",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Delete Lobbychathubmessage API

[Default delete API] — This is the designated default delete API for the lobbyChatHubMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Delete a lobbyChatHub hub message. Admins can delete any message; users can delete their own.

Rest Route

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

/v1/v1/lobbyChatHub-messages/:id

Rest Request Parameters

The deleteLobbyChatHubMessage api has got 2 regular request parameters

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

REST Request To access the api you can use the REST controller with the path DELETE /v1/v1/lobbyChatHub-messages/:id

  axios({
    method: 'DELETE',
    url: `/v1/v1/lobbyChatHub-messages/${id}`,
    data: {
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lobbyChatHubMessage",
	"method": "DELETE",
	"action": "delete",
	"appVersion": "Version",
	"rowCount": 1,
	"lobbyChatHubMessage": {
		"id": "ID",
		"roomId": "ID",
		"senderId": "ID",
		"senderName": "String",
		"senderAvatar": "String",
		"messageType": "Enum",
		"messageType_idx": "Integer",
		"content": "Object",
		"timestamp": null,
		"status": "Enum",
		"status_idx": "Integer",
		"reaction": "Object",
		"isActive": false,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Update Lobbychathubmessage API

[Default update API] — This is the designated default update API for the lobbyChatHubMessage data object. Frontend generators and AI agents should use this API for standard CRUD operations. Update a lobbyChatHub hub message content. Only the message sender or admins can edit.

Rest Route

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

/v1/v1/lobbyChatHub-messages/:id

Rest Request Parameters

The updateLobbyChatHubMessage api has got 5 regular request parameters

Parameter Type Required Population
lobbyChatHubMessageId ID true request.params?.[“lobbyChatHubMessageId”]
content Object false request.body?.[“content”]
status Enum false request.body?.[“status”]
reaction Object false request.body?.[“reaction”]
id String true request.params?.[“id”]
lobbyChatHubMessageId : This id paremeter is used to select the required data object that will be updated
content : Type-specific content payload (structure depends on messageType)
status : Message moderation status
reaction : Emoji reactions [{ emoji, userId, timestamp }]
id : This parameter will be used to select the data object that want to be updated

REST Request To access the api you can use the REST controller with the path PATCH /v1/v1/lobbyChatHub-messages/:id

  axios({
    method: 'PATCH',
    url: `/v1/v1/lobbyChatHub-messages/${id}`,
    data: {
            content:"Object",  
            status:"Enum",  
            reaction:"Object",  
    
    },
    params: {
    
        }
  });

REST Response

{
	"status": "OK",
	"statusCode": "200",
	"elapsedMs": 126,
	"ssoTime": 120,
	"source": "db",
	"cacheKey": "hexCode",
	"userId": "ID",
	"sessionId": "ID",
	"requestId": "ID",
	"dataName": "lobbyChatHubMessage",
	"method": "PATCH",
	"action": "update",
	"appVersion": "Version",
	"rowCount": 1,
	"lobbyChatHubMessage": {
		"id": "ID",
		"roomId": "ID",
		"senderId": "ID",
		"senderName": "String",
		"senderAvatar": "String",
		"messageType": "Enum",
		"messageType_idx": "Integer",
		"content": "Object",
		"timestamp": null,
		"status": "Enum",
		"status_idx": "Integer",
		"reaction": "Object",
		"isActive": true,
		"recordVersion": "Integer",
		"createdAt": "Date",
		"updatedAt": "Date",
		"_owner": "ID"
	}
}

Authentication Specific Routes

Common Routes

Route: currentuser

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

Route Type: sessionInfo

Access Route: GET /currentuser

Parameters

This route does not require any request parameters.

Behavior

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

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

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

Error Response 401 Unauthorized: No active session found.

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

Notes

Route: permissions

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

*Route Type*: permissionFetch

Access Route: GET /permissions

Parameters

This route does not require any request parameters.

Behavior

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

Success Response

Returns an array of permission objects.

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

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

Error Responses

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

Notes

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

Route: permissions/:permissionName

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

Route Type: permissionScopeCheck

Access Route: GET /permissions/:permissionName

Parameters

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

Behavior

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

Success Response

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

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

About Us

For more information please visit our website: .

. .