GET api/{idcompany}/chats/{idchat}?iduser={iduser}&idlanguage={idlanguage}&loadMessages={loadMessages}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| idcompany | integer |
Required |
|
| idchat | integer |
Required |
|
| iduser | integer |
Required |
|
| idlanguage | integer |
Default value is 1 |
|
| loadMessages | boolean |
Default value is True |
Body Parameters
None.
Response Information
Resource Description
SBI_BLL_Chat| Name | Description | Type | Additional information |
|---|---|---|---|
| IDChat | integer |
None. |
|
| IDObjectType | integer |
None. |
|
| ObjectTypeField | string |
None. |
|
| IDObjectTypeField | integer |
None. |
|
| IDTranslation | integer |
None. |
|
| ChatDescription | string |
None. |
|
| CreatedBy | integer |
None. |
|
| UpdatedBy | integer |
None. |
|
| ChatMessages | Collection of SBI_BLL_ChatMessage |
None. |
|
| ChatUsers | Collection of SBI_BLL_ChatUser |
None. |
|
| UsersList | Collection of integer |
None. |
|
| UsersCount | integer |
None. |
|
| ObjectField | string |
None. |
|
| IDPageDefault | integer |
None. |
|
| IDApplication | integer |
None. |
|
| ApplicationPath | string |
None. |
|
| PageURL | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"IDChat": 1,
"IDObjectType": 2,
"ObjectTypeField": "sample string 3",
"IDObjectTypeField": 4,
"IDTranslation": 5,
"ChatDescription": "sample string 6",
"CreatedBy": 7,
"UpdatedBy": 8,
"ChatMessages": [
{
"IDChatMessage": 1,
"IDChat": 2,
"Message": "sample string 3",
"Read": true,
"ReadOn": "2025-10-27T18:43:56.8855411+01:00",
"IDFileObject": 5,
"CreatedOn": "2025-10-27T18:43:56.8855411+01:00",
"CreatedBy": 6,
"UpdatedBy": 7,
"UserName": "sample string 8",
"UserImage": "sample string 9",
"Mentions": [
"sample string 1",
"sample string 2"
]
},
{
"IDChatMessage": 1,
"IDChat": 2,
"Message": "sample string 3",
"Read": true,
"ReadOn": "2025-10-27T18:43:56.8855411+01:00",
"IDFileObject": 5,
"CreatedOn": "2025-10-27T18:43:56.8855411+01:00",
"CreatedBy": 6,
"UpdatedBy": 7,
"UserName": "sample string 8",
"UserImage": "sample string 9",
"Mentions": [
"sample string 1",
"sample string 2"
]
}
],
"ChatUsers": [
{
"IDChat": 1,
"IDUser": 2,
"UserName": "sample string 3",
"UserImage": "sample string 4",
"UpdatedBy": 5,
"Updated": true,
"Deleted": true,
"ConnectionId": "sample string 8"
},
{
"IDChat": 1,
"IDUser": 2,
"UserName": "sample string 3",
"UserImage": "sample string 4",
"UpdatedBy": 5,
"Updated": true,
"Deleted": true,
"ConnectionId": "sample string 8"
}
],
"UsersList": [
1,
2
],
"UsersCount": 9,
"ObjectField": "sample string 10",
"IDPageDefault": 11,
"IDApplication": 12,
"ApplicationPath": "sample string 13",
"PageURL": "sample string 14"
}