공통

공통코드 목록 조회

post

기능설명

공통코드를 다건으로 조회합니다.

상세설명

쿠키 값의 langCd 기준으로 조회합니다.
사용여부가 Y인 코드들만 조회합니다.
정렬순서 순으로 조회합니다.

Header parameters

AuthorizationanyOptional

Access Token

Bodystring[]

string[]Optional

Responses

200

성공

*/*

공통코드 조회 Response

grpCdstringOptional

그룹코드

Example: ME001

grpCdNmstringOptional

그룹코드명

Example: 회원구분코드

900

업무처리 오류 내용

*/*

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"
      }
    ]
  }
]

금칙어 목록 조회

get

기능설명

금칙어 목록을 조회합니다.

상세설명

langCd를 보내지 않으면 쿠키 값으로 세팅합니다.
사용여부(useYn)를 보낼 시 해당 사용여부로 조회하고, 보내지 않을 시 전체 금칙어를 조회합니다.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

string[]Optional

900

업무처리 오류 내용

*/*

get/v1/system/getBadwordList

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

[
  "text"
]

공통코드 단건 조회

get

기능설명

공통코드를 단건으로 조회합니다.

상세설명

쿠키 값의 langCd 기준으로 조회합니다.
사용여부가 Y인 코드들만 조회합니다.
정렬순서 순으로 조회합니다.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

공통코드 조회 Response

grpCdstringOptional

그룹코드

Example: ME001

grpCdNmstringOptional

그룹코드명

Example: 회원구분코드

900

업무처리 오류 내용

*/*

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"
    }
  ]
}

공통코드 참조값1 조회

get

기능설명

그룹코드와 ref1Val을 이용해 공통코드를 조회한다.

상세설명

쿠키 값의 langCd 기준으로 조회합니다.
참조1값(ref1Val)과 그룹코드(grpCd)는 필수입니다.
사용여부가 Y인 코드들만 조회합니다.
정렬순서 순으로 조회합니다.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

900

업무처리 오류 내용

*/*

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"
    }
  ]
}

화면 고객알림 조회

get

기능설명

FO 화면에 표시될 고객알림 목록을 조회합니다.

상세설명

siteNo(사이트번호)와 langCd(언어코드)를 보내지 않을 시 쿠키에 세팅된 값으로 조회합니다.
게시시작일시, 게시종료일시 사이에 포함된 알림리스트만 조회합니다.
대분류코드(scrnLgrpCd), 중분류코드(scrnMgrpCd)는 필수입니다.

Query parameters

Header parameters

AuthorizationanyOptional

Access Token

Responses

200

성공

*/*

고객알림리스트 Response

ntcContsstring[]Optional

고객알림리스트 내용

900

업무처리 오류 내용

*/*

get/v1/common/getContsList

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

{
  "ntcConts": [
    "text"
  ]
}

이전알림메시지

다음하이브리드 앱

마지막 업데이트 6개월 전