For the complete documentation index, see llms.txt. This page is also available as Markdown.

고객 공지사항 관리

고객공지사항 수정

put

기능설명

  • 고객공지사항 정보를 수정합니다.


상세설명

  • 게시시작일시, 게시종료일시, 게시여부, 상단고정여부, 공지제목명은 필수입니다.

  • 첨부파일 존재 시 첨부파일이 저장됩니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

고객공지사항 등록, 수정 요청 DTO

siteNostringOptional

사이트번호

Example: 1
dispMediaCdstringOptional

전시매체코드(DP018)

Example: 10
ntcTitleNmstringOptional

공지제목명

Example: 공지사항 최상단 고정 확인
bbYnstringOptional

게시여부

Example: Y
ntcRegIdstringOptional

공지등록자ID

Example: 1000181
ntcNostringOptional

공지번호

Example: x2bee
ntcClssCdstringOptional

공지분류코드(DP019)

Example: 10
bbStrDtstring · dateOptional

게시시작일시

Example: 2023-07-01
bbEndDtstring · dateOptional

게시종료일시

Example: 2023-09-07
uprFixYnstringOptional

상단고정여부

Example: Y
mainDispYnstringOptional

메인전시여부

Example: Y
pcNtcContstringOptional

PC공지내용

Example: 최상단 고정 공지
moNtcContstringOptional

MO공지내용

Example: 최상단 고정 공지
dateSelectstringOptional

조회기간선택

Example: all_day
Responses
200

성공

*/*
stringOptional
put/v1/system/customerNoticeMgmt/modifyCustomerNoticeInfo
PUT /api/bo/v1/system/customerNoticeMgmt/modifyCustomerNoticeInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 505

{
  "siteNo": 1,
  "dispMediaCd": 10,
  "ntcTitleNm": "공지사항 최상단 고정 확인",
  "bbYn": "Y",
  "ntcRegId": 1000181,
  "ntcNo": "x2bee",
  "ntcClssCd": 10,
  "bbStrDt": "2023-07-01",
  "bbEndDt": "2023-09-07",
  "uprFixYn": "Y",
  "mainDispYn": "Y",
  "pcNtcCont": "최상단 고정 공지",
  "moNtcCont": "최상단 고정 공지",
  "dateSelect": "all_day",
  "deleteFileList": [
    {
      "ntcNo": "text",
      "fileSeq": 1,
      "atchFileRouteNm": "text",
      "atchFileNm": "text"
    }
  ],
  "uploadFileList": [
    {
      "ntcNo": "text",
      "fileSeq": 1,
      "atchFileRouteNm": "text",
      "atchFileNm": "text"
    }
  ]
}
text

고객공지사항 다국어 등록/수정

post

기능설명

  • 고객공지사항 다국어를 조회합니다.


상세설명

  • 언어코드, 공지제목명은 필수입니다.

  • 넘어온 고객공지사항번호와 언어코드에 대한 데이터 존재 시 기존 다국어 정보를 수정합니다.

  • 넘어온 고객공지사항번호와 언어코드에 대한 데이터가 존재하지 않으면 신규 다국어 정보를 등록합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

고객 공지사항 등록, 수정 요청 DTO

langCdstringOptional

언어코드

Example: ko
ntcNostringOptional

공지번호

Example: 1
ntcTitleNmstringOptional

제목

Example: 고객 공지사항
pcNtcContstringOptional

PC공지내용

Example: 고객 공지사항 내용
moNtcContstringOptional

MO공지내용

Example: 고객 공지사항 내용
Responses
200

성공

*/*
stringOptional
post/v2/system/customerNoticeMgmt/saveCustomerNoticeMl
POST /api/bo/v2/system/customerNoticeMgmt/saveCustomerNoticeMl HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "langCd": "ko",
  "ntcNo": 1,
  "ntcTitleNm": "고객 공지사항",
  "pcNtcCont": "고객 공지사항 내용",
  "moNtcCont": "고객 공지사항 내용"
}
text

고객공지사항 등록

post

기능설명

  • 고객공지사항 정보를 등록합니다.


상세설명

  • 전시매체코드, 공지분류코드, 게시시작일시, 게시종료일시, 게시여부, 상단고정여부, 공지제목명은 필수입니다.

  • 공지분류코드가 일반공지가 아니면 메인전시여부는 N으로 들어갑니다.

  • 첨부파일 존재 시 첨부파일이 저장됩니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

고객공지사항 등록, 수정 요청 DTO

siteNostringOptional

사이트번호

Example: 1
dispMediaCdstringOptional

전시매체코드(DP018)

Example: 10
ntcTitleNmstringOptional

공지제목명

Example: 공지사항 최상단 고정 확인
bbYnstringOptional

게시여부

Example: Y
ntcRegIdstringOptional

공지등록자ID

Example: 1000181
ntcNostringOptional

공지번호

Example: x2bee
ntcClssCdstringOptional

공지분류코드(DP019)

Example: 10
bbStrDtstring · dateOptional

게시시작일시

Example: 2023-07-01
bbEndDtstring · dateOptional

게시종료일시

Example: 2023-09-07
uprFixYnstringOptional

상단고정여부

Example: Y
mainDispYnstringOptional

메인전시여부

Example: Y
pcNtcContstringOptional

PC공지내용

Example: 최상단 고정 공지
moNtcContstringOptional

MO공지내용

Example: 최상단 고정 공지
dateSelectstringOptional

조회기간선택

Example: all_day
Responses
200

성공

*/*
stringOptional
post/v1/system/customerNoticeMgmt/registCustomerNoticeInfo
POST /api/bo/v1/system/customerNoticeMgmt/registCustomerNoticeInfo HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 505

{
  "siteNo": 1,
  "dispMediaCd": 10,
  "ntcTitleNm": "공지사항 최상단 고정 확인",
  "bbYn": "Y",
  "ntcRegId": 1000181,
  "ntcNo": "x2bee",
  "ntcClssCd": 10,
  "bbStrDt": "2023-07-01",
  "bbEndDt": "2023-09-07",
  "uprFixYn": "Y",
  "mainDispYn": "Y",
  "pcNtcCont": "최상단 고정 공지",
  "moNtcCont": "최상단 고정 공지",
  "dateSelect": "all_day",
  "deleteFileList": [
    {
      "ntcNo": "text",
      "fileSeq": 1,
      "atchFileRouteNm": "text",
      "atchFileNm": "text"
    }
  ],
  "uploadFileList": [
    {
      "ntcNo": "text",
      "fileSeq": 1,
      "atchFileRouteNm": "text",
      "atchFileNm": "text"
    }
  ]
}
text

고객공지사항 첨부파일 목록 조회

get

기능설명

  • 공지 첨부파일 목록을 조회합니다.


상세설명

  • 고객공지사항 번호는 필수입니다.

  • 넘어온 고객공지사항 번호에 맞는 첨부파일 목록을 조회합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
ntcNostringRequired

고객공지사항 번호

Responses
200

성공

*/*

고객공지사항 첨부파일 응답 DTO

ntcNostringOptional

공지번호

Example: 1
fileSeqinteger · int32Optional

파일순번

Example: 1
atchFileRouteNmstringOptional

첨부파일경로명

atchFileNmstringOptional

첨부파일명

get/v2/system/customerNoticeMgmt/getNoticeAttachedFileList
GET /api/bo/v2/system/customerNoticeMgmt/getNoticeAttachedFileList?ntcNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
[
  {
    "ntcNo": 1,
    "fileSeq": 1,
    "atchFileRouteNm": "text",
    "atchFileNm": "text"
  }
]

고객공지사항 목록 조회

get

기능설명

  • 화면에서 선택한 조건에 맞는 고객 공지사항 목록을 조회합니다.


상세설명

  • 게시시작일시, 게시종료일시는 필수입니다.

  • 쿠키의 dataLangCd 값의 언어코드 기준으로 고객공지사항 목록을 조회합니다.


수정번호

  • Release v2.00_240530: 날짜조회 쿼리 변경

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
bbStrDtLocalDateRequired

게시시작일시

bbEndDtLocalDateRequired

게시종료일시

dispMediaCdstringOptional

전시매체코드

bbYnstringOptional

게시여부

ntcClssCdstringOptional

공지분류코드

uprFixYnstringOptional

상단고정여부

ntcTitleNmstringOptional

제목

pageIdxstringRequired

현재 페이지

Example: 1
rowsPerPagestringRequired

페이지 당 row

Example: 10
Responses
200

성공

*/*
totalCountinteger · int32Optional
get/v2/system/customerNoticeMgmt/getCustomerNoticeList
GET /api/bo/v2/system/customerNoticeMgmt/getCustomerNoticeList?customerNoticeRequest=[object+Object]&bbStrDt=null&bbEndDt=null&pageIdx=text&rowsPerPage=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "totalCount": 1,
  "payloads": [
    {
      "siteNo": 1,
      "siteNm": "플래티어닷컴",
      "dispMediaCd": 10,
      "dispMediaCdNm": "PC",
      "ntcClssCd": 10,
      "ntcClssCdNm": "일반공지",
      "ntcNo": 10,
      "ntcTitleNm": "공지사항 최상단 고정 확인",
      "ntcTitleNmMl": "공지사항 최상단 고정 확인",
      "bbYn": "Y",
      "bbStrDtm": "2023-07-01 00:00:00",
      "bbEndDtm": "2023-09-07 23:59:59",
      "qryCnt": 0,
      "uprFixYn": "Y",
      "pcNtcCont": "최상단 고정 공지",
      "moNtcCont": "최상단 고정 공지",
      "sysRegNm": 1000181,
      "mainDispYn": "Y",
      "bbStrDt": "2023-07-01",
      "bbEndDt": "2023-09-07"
    }
  ]
}

고객공지사항 단건 조회

get

기능설명

  • 공지사항 단건을 조회합니다.


상세설명

  • 고객공지사항 번호는 필수입니다.

  • 넘어온 고객공지사항 번호에 맞는 공지사항 정보를 조회합니다.

  • 조회 기준언어는 쿠키값의 dataLangCd 입니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
ntcNostringRequired

고객공지사항 번호

Responses
200

성공

*/*

고객공지사항 조회 응답 DTO

siteNostringOptional

사이트번호

Example: 1
siteNmstringOptional

사이트명

Example: 플래티어닷컴
dispMediaCdstringOptional

전시매체코드(DP018)

Example: 10
dispMediaCdNmstringOptional

전시매체

Example: PC
ntcClssCdstringOptional

공지분류코드(DP019)

Example: 10
ntcClssCdNmstringOptional

공지분류코드

Example: 일반공지
ntcNostringOptional

공지번호

Example: 10
ntcTitleNmstringOptional

공지제목명

Example: 공지사항 최상단 고정 확인
ntcTitleNmMlstringOptional

공지제목다국어명

Example: 공지사항 최상단 고정 확인
bbYnstring · enumOptional

게시여부

Example: YPossible values:
bbStrDtmstringOptional

게시시작일시

Example: 2023-07-01 00:00:00
bbEndDtmstringOptional

게시종료일시

Example: 2023-09-07 23:59:59
qryCntstringOptional

조회수

Example: 0
uprFixYnstring · enumOptional

상단고정여부

Example: YPossible values:
pcNtcContstringOptional

PC공지내용

Example: 최상단 고정 공지
moNtcContstringOptional

MO공지내용

Example: 최상단 고정 공지
sysRegNmstringOptional

공지등록자ID

Example: 1000181
mainDispYnstringOptional

메인전시여부

Example: Y
bbStrDtstringOptional

게시시작일자

Example: 2023-07-01
bbEndDtstringOptional

게시종료일자

Example: 2023-09-07
get/v2/system/customerNoticeMgmt/getCustomerNoticeInfo
GET /api/bo/v2/system/customerNoticeMgmt/getCustomerNoticeInfo?ntcNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "siteNo": 1,
  "siteNm": "플래티어닷컴",
  "dispMediaCd": 10,
  "dispMediaCdNm": "PC",
  "ntcClssCd": 10,
  "ntcClssCdNm": "일반공지",
  "ntcNo": 10,
  "ntcTitleNm": "공지사항 최상단 고정 확인",
  "ntcTitleNmMl": "공지사항 최상단 고정 확인",
  "bbYn": "Y",
  "bbStrDtm": "2023-07-01 00:00:00",
  "bbEndDtm": "2023-09-07 23:59:59",
  "qryCnt": 0,
  "uprFixYn": "Y",
  "pcNtcCont": "최상단 고정 공지",
  "moNtcCont": "최상단 고정 공지",
  "sysRegNm": 1000181,
  "mainDispYn": "Y",
  "bbStrDt": "2023-07-01",
  "bbEndDt": "2023-09-07"
}

고객공지사항 다국어 조회

get

기능설명

  • 고객공지사항 다국어를 조회합니다.


상세설명

  • 고객공지사항 번호는 필수입니다.

  • 넘어온 고객공지사항 번호에 맞는 공지사항의 다국어 정보를 조회합니다.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
ntcNostringRequired

고객공지사항 번호

Responses
200

성공

*/*
langCdstringOptional
ntcNostringOptional
ntcTitleNmstringOptional
ntcTitleNmMlstringOptional
pcNtcContstringOptional
pcNtcContMlstringOptional
moNtcContstringOptional
moNtcContMlstringOptional
dispMediaCdstringOptional
get/v2/system/customerNoticeMgmt/getCustomerNoticeInfoMl
GET /api/bo/v2/system/customerNoticeMgmt/getCustomerNoticeInfoMl?customerNoticeMlRequest=[object+Object]&ntcNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "langCd": "text",
  "ntcNo": "text",
  "ntcTitleNm": "text",
  "ntcTitleNmMl": "text",
  "pcNtcCont": "text",
  "pcNtcContMl": "text",
  "moNtcCont": "text",
  "moNtcContMl": "text",
  "dispMediaCd": "text"
}

마지막 업데이트