POST AdminApi/CodeMaster/GetCodeMasterByKey
Request Information
URI Parameters
None.
Body Parameters
CodeMasterCondition| Name | Description | Type | Additional information |
|---|---|---|---|
| PageInfo | PageInfo |
None. |
|
| ClientId | globally unique identifier |
None. |
|
| Module | string |
None. |
|
| Function | string |
None. |
|
| Key | string |
None. |
|
| Value | string |
None. |
|
| IsActive | integer |
None. |
|
| IsDeleted | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"PageInfo": {
"Page": 1,
"PageSize": 2,
"Offset": 0,
"SortName": "sample string 3",
"SortOrder": "sample string 4"
},
"ClientId": "862cab1e-8e8d-439a-9470-46a12a1b1af1",
"Module": "sample string 2",
"Function": "sample string 3",
"Key": "sample string 4",
"Value": "sample string 5",
"IsActive": 6,
"IsDeleted": 7
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
CodeMaster| Name | Description | Type | Additional information |
|---|---|---|---|
| Module | string |
String length: inclusive between 0 and 20 |
|
| Function | string |
String length: inclusive between 0 and 20 |
|
| Key | string |
String length: inclusive between 0 and 20 |
|
| Value | string |
Required String length: inclusive between 0 and 200 |
|
| DescTransId | globally unique identifier |
None. |
|
| Remark | string |
None. |
|
| Description | string |
None. |
|
| Descriptions | Collection of MutiLanguage |
None. |
|
| Id | integer |
None. |
|
| ClientId | globally unique identifier |
None. |
|
| IsActive | boolean |
Required |
|
| IsDeleted | boolean |
Required |
|
| CreateDate | date |
Required |
|
| UpdateDate | date |
None. |
|
| CreateBy | globally unique identifier |
Required |
|
| UpdateBy | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"Module": "sample string 1",
"Function": "sample string 2",
"Key": "sample string 3",
"Value": "sample string 4",
"DescTransId": "c1326761-062c-4618-a969-e307a156e179",
"Remark": "sample string 6",
"Description": "sample string 7",
"Descriptions": [
{
"Lang": {
"Text": "sample string 1",
"Code": "sample string 2",
"Id": 3
},
"Language": 0,
"Desc": "sample string 1"
},
{
"Lang": {
"Text": "sample string 1",
"Code": "sample string 2",
"Id": 3
},
"Language": 0,
"Desc": "sample string 1"
}
],
"Id": 8,
"ClientId": "d8709eaf-ee6b-4292-910d-319dcee69a76",
"IsActive": true,
"IsDeleted": true,
"CreateDate": "2025-10-28 19:11:26",
"UpdateDate": "2025-10-28 19:11:26",
"CreateBy": "83ae37af-460d-4fd4-a313-2f070bb6626b",
"UpdateBy": "72d28c1c-e874-4ac3-a7fd-58354110ee2c"
}