POST AdminApi/CodeMaster/GetCodeMasterByKey

Request Information

URI Parameters

None.

Body Parameters

Name	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": "a81eed12-f9ab-4be7-8a86-c05a154e4f57",
  "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:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'CodeMasterCondition'.

Response Information

Resource Description

CodeMaster

Name	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": "0f31406b-a942-46dd-af20-1d7aa6a4fcb4",
  "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": "61d7a1d5-c609-4eb5-8a11-20240ce44423",
  "IsActive": true,
  "IsDeleted": true,
  "CreateDate": "2026-04-20 09:56:55",
  "UpdateDate": "2026-04-20 09:56:55",
  "CreateBy": "f50eadeb-1021-4765-8a22-b56419cd367f",
  "UpdateBy": "2ad29dec-1735-45e3-a0e2-806e03ea496a"
}