FRONTEND GUIDE FOR AI CODING AGENTS - PART 6 - Networking Service
This document is a part of a REST API guide for the linkedin project. It is designed for AI agents that will generate frontend code to consume the project’s backend.
This document provides extensive instruction for the usage of networking
Service Access
Networking service management is handled through service specific base urls.
Networking service may be deployed to the preview server, staging server, or production server. Therefore,it has 3 access URLs. The frontend application must support all deployment environments during development, and the user should be able to select the target API server on the login page (already handled in first part.).
For the networking service, the base URLs are:
-
Preview:
https://linkedin.prw.mindbricks.com/networking-api -
Staging:
https://linkedin-stage.mindbricks.co/networking-api -
Production:
https://linkedin.mindbricks.co/networking-api
Scope
Networking Service Description
Handles professional networking logic for user-to-user connections: manages connection requests, accepted relationships, listing/removal, permissions, and state transitions. Publishes connection lifecycle events for notification...
Networking service provides apis and business logic for following data objects in linkedin application. Each data object may be either a central domain of the application data structure or a related helper data object for a central concept. Note that data object concept is equal to table concept in the database, in the service database each data object is represented as a db table scheme and the object instances as table rows.
connection
Data Object: Represents a single established user-to-user professional
relationship (mutual connection). One record per unordered user
pair, deleted on disconnect..
connectionRequest
Data Object: Tracks a user's request to connect with another user,
supporting request/accept/reject/cancel, with audit timestamps.
API Structure
Object Structure of a Successful Response
When the service processes requests successfully, it wraps the requested resource(s) within a JSON envelope. This envelope includes the data and essential metadata such as configuration details and pagination information, providing context to the client.
HTTP Status Codes:
- 200 OK: Returned for successful GET, LIST, UPDATE, or DELETE operations, indicating that the request was processed successfully.
- 201 Created: Returned for CREATE operations, indicating that the resource was created successfully.
Success Response Format:
For successful operations, the response includes a
"status": "OK"
property, signaling that the request executed successfully. 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.
Additional Data
Each API may include additional data besides the main data object, depending on the business logic of the API. These will be provided in each API’s response signature.
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 indicates the nature of the error, using commonly recognized codes for clarity:
- 400 Bad Request: The request was improperly formatted or contained invalid parameters.
- 401 Unauthorized: The request lacked a valid authentication token; login is required.
- 403 Forbidden: The current token does 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.
Each error response is structured to provide meaningful insight into the problem, assisting in efficient diagnosis and resolution.
{
"result": "ERR",
"status": 400,
"message": "errMsg_organizationIdisNotAValidID",
"errCode": 400,
"date": "2024-03-19T12:13:54.124Z",
"detail": "String"
}
Bucket Management
(This information is also given in PART 1 prompt.)
This application has a bucket service used to store user files and other object-related files. The bucket service is login-agnostic, so for write operations or private reads, include a bucket token (provided by services) in the request’s Authorization header as a Bearer token.
Please note that all other business services require the access token in the Bearer header, while the bucket service expects a bucket token because it is login-agnostic. Ensure you manage the required token injection properly; any auth interceptor should not replace the bucket token with the access token.
User Bucket This bucket stores public user files for each user.
When a user logs in—or in the
/currentuser
response—there is a
userBucketToken
to use when sending user-related public files to the bucket
service.
{
//...
"userBucketToken": "e56d...."
}
To upload a file
POST {baseUrl}/bucket/upload
The request body is form-data which includes the
bucketId
and the file binary in the
files
field.
{
bucketId: "{userId}-public-user-bucket",
files: {binary}
}
Response status is 200 on success, e.g., body:
{
"success": true,
"data": [
{
"fileId": "9da03f6d-0409-41ad-bb06-225a244ae408",
"originalName": "test (10).png",
"mimeType": "image/png",
"size": 604063,
"status": "uploaded",
"bucketName": "f7103b85-fcda-4dec-92c6-c336f71fd3a2-public-user-bucket",
"isPublic": true,
"downloadUrl": "https://babilcom.mindbricks.co/bucket/download/9da03f6d-0409-41ad-bb06-225a244ae408"
}
]
}
To download a file from the bucket, you need its
fileId. If you upload an avatar or other asset, ensure the download URL
or the
fileId
is stored in the backend.
Buckets are mostly used in object creations that require an additional file, such as a product image or user avatar. After uploading your image to the bucket, insert the returned download URL into the related property of the target object record.
Application Bucket
This Linkedin application also includes a common public bucket
that anyone can read, but only users with the
superAdmin,
admin, or
saasAdmin
roles can write (upload) to it.
When a user with one of these admin roles is logged in, the
/login
response or the
/currentuser
response also returns an
applicationBucketToken
field, which is used when uploading any file to the application
bucket.
{
//...
"applicationBucketToken": "e23fd...."
}
The common public application bucket ID is
"linkedin-public-common-bucket"
In certain admin areas—such as product management pages—since the user already has the application bucket token, they will be able to upload related object images.
Please configure your UI to upload files to the application bucket using this bucket token whenever needed.
Object Buckets Some objects may also return a bucket token for uploading or accessing files related to that object. For example, in a project management application, when you fetch a project’s data, a public or private bucket token may be provided to upload or download project-related files.
These buckets will be used as described in the relevant object definitions.
Connection Data Object
Represents a single established user-to-user professional relationship (mutual connection). One record per unordered user pair, deleted on disconnect..
Connection Data Object Properties
Connection data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.
| Property | Type | IsArray | Required | Description |
|---|---|---|---|---|
connectedSince
|
Date | false | Yes | Timestamp when connection was established. |
userId1
|
ID | false | Yes | FK to auth:user.id. First user of the connection. Value must be lower of both user IDs lexically to ensure uniqueness regardless of order. |
userId2
|
ID | false | Yes | FK to auth:user.id. Second user of the connection. Value must be higher of both user IDs lexically. Together with userId1 ensures uniqueness of unordered pair. |
- Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.
Relation Properties
userId1
userId2
Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.
In frontend, please ensure that,
1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.
-
userId1: ID Relation to
user.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
Required: Yes
-
userId2: ID Relation to
user.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
Required: Yes
ConnectionRequest Data Object
Tracks a user's request to connect with another user, supporting request/accept/reject/cancel, with audit timestamps.
ConnectionRequest Data Object Properties
ConnectionRequest data object has got following properties that are represented as table fields in the database scheme. These properties don't stand just for data storage, but each may have different settings to manage the business logic.
| Property | Type | IsArray | Required | Description |
|---|---|---|---|---|
receiverUserId
|
ID | false | Yes | FK to auth:user.id — target of the request. |
senderUserId
|
ID | false | Yes | FK to auth:user.id — user sending the connection request. |
sentAt
|
Date | false | Yes | Timestamp when request was sent. |
status
|
Enum | false | Yes | Request status: pending/accepted/rejected. |
respondedAt
|
Date | false | No | Timestamp when receiver accepted/rejected. |
message
|
String | false | No | Optional introductory message from sender to receiver. |
- Required properties are mandatory for creating objects and must be provided in the request body if no default value, formula or session bind is set.
Enum Properties
Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an additional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the {fieldName_idx} property to sort by the enum value or when your enum options represent a hiyerarchy of values. In the frontend input components, enum type properties should only accept values from an option component that lists the enum options.
- status: [pending, accepted, rejected]
Relation Properties
receiverUserId
senderUserId
Mindbricks supports relations between data objects, allowing you to define how objects are linked together. The relations may reference to a data object either in this service or in another service. Id the reference is remote, backend handles the relations through service communication or elastic search. These relations should be respected in the frontend so that instaead of showing the related objects id, the frontend should list human readable values from other data objects. If the relation points to another service, frontend should use the referenced service api in case it needs related data. The relation logic is montly handled in backend so the api responses feeds the frontend about the relational data. In mmost cases the api response will provide the relational data as well as the main one.
In frontend, please ensure that,
1- instaead of these relational ids you show the main human readable field of the related target data (like name), 2- if this data object needs a user input of these relational ids, you should provide a combobox with the list of possible records or (a searchbox) to select with the realted target data object main human readable field.
-
receiverUserId: ID Relation to
user.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
Required: Yes
-
senderUserId: ID Relation to
user.id
The target object is a parent object, meaning that the relation is a one-to-many relationship from target to this object.
Required: Yes
Filter Properties
status
Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API's.
-
status: Enum has a filter named
status
API Reference
Create Connection
API
Create Connection
Rest Route
The
createConnection
API REST controller can be triggered via the following route:
/v1/connections
Rest Request Parameters
The
createConnection
api has got 2 request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| userId1 | ID | true | request.body?.userId1 |
| userId2 | ID | true | request.body?.userId2 |
| userId1 : FK to auth:user.id. First user of the connection. Value must be lower of both user IDs lexically to ensure uniqueness regardless of order. | |||
| userId2 : FK to auth:user.id. Second user of the connection. Value must be higher of both user IDs lexically. Together with userId1 ensures uniqueness of unordered pair. |
REST Request To access the api you can use the REST controller with the path POST /v1/connections
axios({
method: 'POST',
url: '/v1/connections',
data: {
userId1:"ID",
userId2:"ID",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "201",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connection",
"method": "POST",
"action": "create",
"appVersion": "Version",
"rowCount": 1,
"connection": {
"id": "ID",
"connectedSince": "Date",
"userId1": "ID",
"userId2": "ID",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Delete Connectionrequest
API
Sender or receiver may cancel/delete a connection request (soft-delete).
Rest Route
The
deleteConnectionRequest
API REST controller can be triggered via the following route:
/v1/connectionrequests/:connectionRequestId
Rest Request Parameters
The
deleteConnectionRequest
api has got 1 request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| connectionRequestId | ID | true | request.params?.connectionRequestId |
| connectionRequestId : 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/connectionrequests/:connectionRequestId
axios({
method: 'DELETE',
url: `/v1/connectionrequests/${connectionRequestId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connectionRequest",
"method": "DELETE",
"action": "delete",
"appVersion": "Version",
"rowCount": 1,
"connectionRequest": {
"id": "ID",
"receiverUserId": "ID",
"senderUserId": "ID",
"sentAt": "Date",
"status": "Enum",
"status_idx": "Integer",
"respondedAt": "Date",
"message": "String",
"isActive": false,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Update Connectionrequest
API
Allows receiver of a pending connection request to accept or reject request.
Rest Route
The
updateConnectionRequest
API REST controller can be triggered via the following route:
/v1/connectionrequests/:connectionRequestId
Rest Request Parameters
The
updateConnectionRequest
api has got 3 request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| connectionRequestId | ID | true | request.params?.connectionRequestId |
| status | Enum | true | request.body?.status |
| respondedAt | Date | false | request.body?.respondedAt |
| connectionRequestId : This id paremeter is used to select the required data object that will be updated | |||
| status : Request status: pending/accepted/rejected. | |||
| respondedAt : Timestamp when receiver accepted/rejected. |
REST Request To access the api you can use the REST controller with the path PATCH /v1/connectionrequests/:connectionRequestId
axios({
method: 'PATCH',
url: `/v1/connectionrequests/${connectionRequestId}`,
data: {
status:"Enum",
respondedAt:"Date",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connectionRequest",
"method": "PATCH",
"action": "update",
"appVersion": "Version",
"rowCount": 1,
"connectionRequest": {
"id": "ID",
"receiverUserId": "ID",
"senderUserId": "ID",
"sentAt": "Date",
"status": "Enum",
"status_idx": "Integer",
"respondedAt": "Date",
"message": "String",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
List Connections
API
List all active connections where session user is a participant.
Rest Route
The
listConnections
API REST controller can be triggered via the following route:
/v1/connections
Rest Request Parameters The
listConnections
api has got no request parameters.
REST Request To access the api you can use the REST controller with the path GET /v1/connections
axios({
method: 'GET',
url: '/v1/connections',
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connections",
"method": "GET",
"action": "list",
"appVersion": "Version",
"rowCount": "\"Number\"",
"connections": [
{
"id": "ID",
"connectedSince": "Date",
"userId1": "ID",
"userId2": "ID",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
},
{},
{}
],
"paging": {
"pageNumber": "Number",
"pageRowCount": "NUmber",
"totalRowCount": "Number",
"pageCount": "Number"
},
"filters": [],
"uiPermissions": []
}
List Connectionrequests
API
List connection requests involving current user, filterable by status (pending, accepted, rejected).
Rest Route
The
listConnectionRequests
API REST controller can be triggered via the following route:
/v1/connectionrequests
Rest Request Parameters The
listConnectionRequests
api has got no request parameters.
REST Request To access the api you can use the REST controller with the path GET /v1/connectionrequests
axios({
method: 'GET',
url: '/v1/connectionrequests',
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connectionRequests",
"method": "GET",
"action": "list",
"appVersion": "Version",
"rowCount": "\"Number\"",
"connectionRequests": [
{
"id": "ID",
"receiverUserId": "ID",
"senderUserId": "ID",
"sentAt": "Date",
"status": "Enum",
"status_idx": "Integer",
"respondedAt": "Date",
"message": "String",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
},
{},
{}
],
"paging": {
"pageNumber": "Number",
"pageRowCount": "NUmber",
"totalRowCount": "Number",
"pageCount": "Number"
},
"filters": [],
"uiPermissions": []
}
Create Connectionrequest
API
Send a new connection request from logged-in user to another user.
Rest Route
The
createConnectionRequest
API REST controller can be triggered via the following route:
/v1/connectionrequests
Rest Request Parameters
The
createConnectionRequest
api has got 4 request parameters
| Parameter | Type | Required | Population |
|---|---|---|---|
| receiverUserId | ID | true | request.body?.receiverUserId |
| status | Enum | true | request.body?.status |
| respondedAt | Date | false | request.body?.respondedAt |
| message | String | false | request.body?.message |
| receiverUserId : FK to auth:user.id — target of the request. | |||
| status : Request status: pending/accepted/rejected. | |||
| respondedAt : Timestamp when receiver accepted/rejected. | |||
| message : Optional introductory message from sender to receiver. |
REST Request To access the api you can use the REST controller with the path POST /v1/connectionrequests
axios({
method: 'POST',
url: '/v1/connectionrequests',
data: {
receiverUserId:"ID",
status:"Enum",
respondedAt:"Date",
message:"String",
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "201",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connectionRequest",
"method": "POST",
"action": "create",
"appVersion": "Version",
"rowCount": 1,
"connectionRequest": {
"id": "ID",
"receiverUserId": "ID",
"senderUserId": "ID",
"sentAt": "Date",
"status": "Enum",
"status_idx": "Integer",
"respondedAt": "Date",
"message": "String",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Delete Connection
API
Break (delete) the connection between two users. Either user may disconnect.
Rest Route
The
deleteConnection
API REST controller can be triggered via the following route:
/v1/connections/:connectionId
Rest Request Parameters
The
deleteConnection
api has got 1 request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| connectionId | ID | true | request.params?.connectionId |
| connectionId : 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/connections/:connectionId
axios({
method: 'DELETE',
url: `/v1/connections/${connectionId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connection",
"method": "DELETE",
"action": "delete",
"appVersion": "Version",
"rowCount": 1,
"connection": {
"id": "ID",
"connectedSince": "Date",
"userId1": "ID",
"userId2": "ID",
"isActive": false,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Get Connectionrequest
API
Get a specific connection request by ID if sender/receiver.
Rest Route
The
getConnectionRequest
API REST controller can be triggered via the following route:
/v1/connectionrequests/:connectionRequestId
Rest Request Parameters
The
getConnectionRequest
api has got 1 request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| connectionRequestId | ID | true | request.params?.connectionRequestId |
| connectionRequestId : 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/connectionrequests/:connectionRequestId
axios({
method: 'GET',
url: `/v1/connectionrequests/${connectionRequestId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connectionRequest",
"method": "GET",
"action": "get",
"appVersion": "Version",
"rowCount": 1,
"connectionRequest": {
"id": "ID",
"receiverUserId": "ID",
"senderUserId": "ID",
"sentAt": "Date",
"status": "Enum",
"status_idx": "Integer",
"respondedAt": "Date",
"message": "String",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
Get Connection
API
Get connection between session user and another user (if exists, not soft-deleted).
Rest Route
The
getConnection
API REST controller can be triggered via the following route:
/v1/connections/:connectionId
Rest Request Parameters
The
getConnection
api has got 1 request parameter
| Parameter | Type | Required | Population |
|---|---|---|---|
| connectionId | ID | true | request.params?.connectionId |
| connectionId : 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/connections/:connectionId
axios({
method: 'GET',
url: `/v1/connections/${connectionId}`,
data: {
},
params: {
}
});
REST Response
{
"status": "OK",
"statusCode": "200",
"elapsedMs": 126,
"ssoTime": 120,
"source": "db",
"cacheKey": "hexCode",
"userId": "ID",
"sessionId": "ID",
"requestId": "ID",
"dataName": "connection",
"method": "GET",
"action": "get",
"appVersion": "Version",
"rowCount": 1,
"connection": {
"id": "ID",
"connectedSince": "Date",
"userId1": "ID",
"userId2": "ID",
"isActive": true,
"recordVersion": "Integer",
"createdAt": "Date",
"updatedAt": "Date",
"_owner": "ID"
}
}
After this prompt, the user may give you new instructions to update the output of this prompt or provide subsequent prompts about the project.