Common

Retrieve Common Code List

post

Function Description

• Retrieves multiple common codes.

---

Detailed Description

• Retrieved based on the langCd value in the cookie.

• Only codes with usage status Y are retrieved.

• Retrieved in sort order.

Header parameters

AuthorizationanyOptional

Access Token

Bodystring[]

string[]Optional

Responses

200

Success

*/*

Common Code Inquiry Response

grpCdstringOptional

Group Code

Example: ME001

grpCdNmstringOptional

Group Code Name

Example: 회원구분코드

900

Business processing error details

*/*

post/v1/common/getGrpCdList

POST /api/common/v1/common/getGrpCdList HTTP/1.1
Host: api-common.x2bee.com/
Content-Type: application/json
Accept: */*
Content-Length: 8

[
  "text"
]

[
  {
    "grpCd": "ME001",
    "grpCdNm": "회원구분코드",
    "codeInfo": [
      {
        "key": "text",
        "cd": "text",
        "cdNm": "text",
        "cdDesc": "text",
        "sortSeq": "text",
        "ref1Val": "text",
        "ref2Val": "text",
        "ref3Val": "text",
        "ref4Val": "text",
        "ref5Val": "text",
        "ref6Val": "text",
        "ref7Val": "text"
      }
    ]
  }
]

Retrieve Prohibited Word List

get

Function Description

• Retrieves the list of prohibited words.

---

Detailed Description

• If langCd is not sent, it is set from the cookie value.

• If usage status (useYn) is sent, records are retrieved with that usage status; if not sent, all prohibited words are retrieved.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

string[]Optional

900

Business processing error details

*/*

get/v1/system/getBadwordList

GET /api/common/v1/system/getBadwordList?badWordMgmtRequest=[object+Object] HTTP/1.1
Host: api-common.x2bee.com/
Accept: */*

[
  "text"
]

Retrieve Single Common Code

get

Function Description

• Retrieves a single common code.

---

Detailed Description

• Retrieved based on the langCd value in the cookie.

• Only codes with usage status Y are retrieved.

• Retrieved in sort order.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

Common Code Inquiry Response

grpCdstringOptional

Group Code

Example: ME001

grpCdNmstringOptional

Group Code Name

Example: 회원구분코드

900

Business processing error details

*/*

get/v1/common/getGrp

GET /api/common/v1/common/getGrp?stCdReq=[object+Object] HTTP/1.1
Host: api-common.x2bee.com/
Accept: */*

{
  "grpCd": "ME001",
  "grpCdNm": "회원구분코드",
  "codeInfo": [
    {
      "key": "text",
      "cd": "text",
      "cdNm": "text",
      "cdDesc": "text",
      "sortSeq": "text",
      "ref1Val": "text",
      "ref2Val": "text",
      "ref3Val": "text",
      "ref4Val": "text",
      "ref5Val": "text",
      "ref6Val": "text",
      "ref7Val": "text"
    }
  ]
}

Retrieve Common Code by Reference Value 1

get

Function Description

• Retrieves common codes using the group code and ref1Val.

---

Detailed Description

• Retrieved based on the langCd value in the cookie.

• Reference Value 1 (ref1Val) and Group Code (grpCd) are required.

• Only codes with usage status Y are retrieved.

• Retrieved in sort order.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

900

Business processing error details

*/*

get/v1/common/getForwardCdCdNmFromStStdCdByGrpCdRef1Val

GET /api/common/v1/common/getForwardCdCdNmFromStStdCdByGrpCdRef1Val?params=[object+Object] HTTP/1.1
Host: api-common.x2bee.com/
Accept: */*

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "ANY_ADDITIONAL_PROPERTY": [
      {
        "key": "text",
        "cd": "text",
        "cdNm": "text",
        "cdDesc": "text",
        "sortSeq": "text",
        "ref1Val": "text",
        "ref2Val": "text",
        "ref3Val": "text",
        "ref4Val": "text",
        "ref5Val": "text",
        "ref6Val": "text",
        "ref7Val": "text"
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Screen Customer Notifications

get

Function Description

• Retrieves the list of customer notifications to be displayed on the FO screen.

---

Detailed Description

• If siteNo (Site No.) and langCd (Language Code) are not sent, the values set in the cookie are used.

• Only notifications included between the posting start date/time and posting end date/time are retrieved.

• Large Category Code (scrnLgrpCd) and Medium Category Code (scrnMgrpCd) are required.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

Success

*/*

Customer Notification List Response

ntcContsstring[]Optional

Customer Notification List Content

900

Business processing error details

*/*

get/v1/common/getContsList

GET /api/common/v1/common/getContsList?screenNotiReq=[object+Object] HTTP/1.1
Host: api-common.x2bee.com/
Accept: */*

{
  "ntcConts": [
    "text"
  ]
}