Save Branch User
This API function creates or updates a branch user account (employee) on the server.
It includes required user credentials, branch info, authority, and status.
Endpoint
POST /saveBhfUser
Request Object: BhfUserSaveReq
Request Fields
| Field | Description | Type | Required | Length |
|---|---|---|---|---|
userId | User ID | CHAR | ✅ Yes | 20 |
userNm | User Name | CHAR | ✅ Yes | 60 |
pwd | Password | CHAR | ✅ Yes | 255 |
adrs | Address | CHAR | ❌ No | 200 |
cntc | Contact Number | CHAR | ❌ No | 20 |
authCd | Authority Code | CHAR | ❌ No | 100 |
remark | Remarks | CHAR | ❌ No | 2000 |
useYn | Active Status (Y/N) | CHAR | ✅ Yes | 1 |
regrId | Registration ID | CHAR | ✅ Yes | 20 |
regrNm | Registration Name | CHAR | ✅ Yes | 60 |
modrId | Modifier ID | CHAR | ✅ Yes | 20 |
modrNm | Modifier Name | CHAR | ✅ Yes | 60 |
JSON Request Example
{
"userId": "userId3",
"userNm": "User Name3",
"pwd": "12341234",
"adrs": null,
"cntc": null,
"authCd": null,
"remark": null,
"useYn": "Y",
"regrId": "Test",
"regrNm": "Test",
"modrId": "Test",
"modrNm": "Test"
}
Response Object: BhfUserSaveRes
Response Fields
| Field | Description | Type | Length |
|---|---|---|---|
resultCd | Result Code (000 = success) | CHAR(3) | 3 |
resultMsg | Result Message | CHAR | - |
resultDt | Response Timestamp | CHAR(14) | 14 |
data | Always null | - | - |
JSON Response Example
{
"resultCd": "000",
"resultMsg": "It is succeeded",
"resultDt": "20200226192427",
"data": null
}
SDK Usage Examples
- Python
- JavaScript / TypeScript
- PHP
user_data = {
'userId': 'userId3',
'userNm': 'User Name3',
'pwd': '12341234',
'adrs': None,
'cntc': None,
'authCd': None,
'remark': None,
'useYn': 'Y',
'regrId': 'Test',
'regrNm': 'Test',
'modrId': 'Test',
'modrNm': 'Test',
}
response = etims.save_branch_user(user_data)
if response.get('resultCd') == '000':
print("✅ Branch user saved successfully")
else:
abort(f"Failed to save branch user: {response.get('resultMsg', 'Unknown error')}")
const response = await client.saveBranchUser({
userId: `user_${Date.now()}`,
userNm: `Test User ${Date.now()}`,
pwd: 'SecurePass123!',
useYn: 'Y',
regrId: 'Test',
regrNm: 'Test',
modrId: 'Test',
modrNm: 'Test',
});
console.log(`✅ Branch user saved: ${response.resultMsg}`);
$requestData = [
'userId' => 'userId3',
'userNm' => 'User Name3',
'pwd' => '12341234',
'adrs' => null,
'cntc' => null,
'authCd' => null,
'remark' => null,
'useYn' => 'Y',
'regrId' => 'Test',
'regrNm' => 'Test',
'modrId' => 'Test',
'modrNm' => 'Test',
];
$response = $etims->saveBranchUser($requestData);
if (($response['resultCd'] ?? '') === '000') {
echo "✅ Branch user saved successfully\n";
} else {
abort("Failed to save branch user: " . ($response['resultMsg'] ?? 'Unknown error'));
}
Best Practices
- Always use a unique
userIdfor each branch user. - Ensure
useYnreflects whether the user is active. - Store
regrIdandmodrIdfor auditing. - Optional fields (
adrs,cntc,authCd,remark) can be left null.