Client Management/Get department balance
Try it now
Test
RAM authorization
Request syntax
GET /api/v1/modelRouter/open/clients/{id}/balance HTTP/1.1
Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| id |
integer |
No |
The ID of the department. |
1 |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
No parameters required.
Response elements
|
Element |
Type |
Description |
Example |
|
object |
OpenApiSingleResponse |
{ "success": true, "data": {"id": 1, "client_id": 1, "balance": 100.00, "balance_type": "amount", "enable_balance": true}, "requestId": "592A27EF-26D3-1434-98C1-97AD63337852" } |
|
| requestId |
string |
The request ID. |
xxxx-xxxx-xxxx-xxxxxxxx |
| success |
boolean |
Specifies if the request was successful. |
true |
| errCode |
string |
The error code. |
UNKNOWN_ERROR |
| errMessage |
string |
The error message. |
未知错误 |
| httpStatusCode |
integer |
The HTTP status code. |
200 |
| data | ClientBalanceDTO |
The data object. |
{} |
Examples
Success response
JSON format
{
"requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
"success": true,
"errCode": "UNKNOWN_ERROR",
"errMessage": "未知错误",
"httpStatusCode": 200,
"data": {
"id": 1,
"clientId": 1,
"balance": 100,
"balanceType": "amount",
"enableBalance": true,
"gmtCreate": "2024-01-01T00:00:00Z",
"gmtModified": "2024-01-01T00:00:00Z"
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 500 | Server.Internal.UnknownError | The request processing has failed due to some unknown error. | |
| 403 | B.Permission.DeniedException | 鉴权失败或权限不足 | |
| 403 | B.Permission.OrgNoExistException | 组织不存在,请主账号开通权限后再试,或联系管理员 |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.