Terms And Usage Guide Management

Retrieve Terms and Conditions/Usage Guide List

get

Function Description

API for retrieving Terms and Conditions/Usage Guide information.

Detailed Description

Retrieves Terms and Conditions/Usage Guide information according to the inquiry conditions of Common Terms Policy Type Code, Terms Policy Code, Site No., and Terms Title.
The Terms and Conditions/Usage Guide information list is displayed in descending order of modification date.

Revision History

Release v1.02_231023 : Sprint 2 PO1 defect/improvement
Release v1.05_231204 : Sprint 5 PO1 defect/improvement - Improved query WHERE clause

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cmAgmtPolcGbCdstringOptional

Common Terms Policy Type Code

Example: 10202

agmtPolcCdstringOptional

Terms Policy Code

Example: 300

siteNostringOptional

Site No.

Example: 1

titlestringOptional

Terms Title

Example: 개인정보처리방침

rowsPerPagestringRequired

Rows per Page

Example: 100

pageIdxstringRequired

Current Page

Example: 1

Responses

200

Terms and Conditions/Usage Guide Information Inquiry Successful

*/*

Common Terms & Policy Information

siteNostringOptional

Site No.

Example: 1

langCdstringOptional

Language Code (CM009)

Example: ko

cmAgmtSeqstringOptional

Common Terms Sequence No.

Example: 10202

siteNmstringOptional

Site Name

Example: x2bee

cmAgmtPolcGbCdstringOptional

Common Terms & Policy Type Code (CH010)

Example: 300

cmAgmtGbNmstringOptional

Terms & Policy Type Name

Example: 개인정보처리방침

agmtPolcCdstringOptional

Terms Policy Code (CH005)

Example: 300

agmtPolcNmstringOptional

Terms & Policy Code Name

Example: 개인정보처리방침

aplyStrDtstringOptional

Application Start Date

Example: 20230101

aplyEndDtstringOptional

Application End Date

Example: 20231231

titlestringOptional

Title

Example: 약관정책코드제목

wrdContstringOptional

Text Content

Example: 약관정책코드 문구내용

titleOtherstringOptional

Title

Example: 약관정책코드제목

wrdContOtherstringOptional

Text Content

Example: 약관정책코드 문구내용

900

Terms and Conditions/Usage Guide Information Inquiry Failed

*/*

get/v2/display/termsConditionsMgmt

GET /api/bo/v2/display/termsConditionsMgmt?rowsPerPage=text&pageIdx=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "langCd": "ko",
  "cmAgmtSeq": 10202,
  "siteNm": "x2bee",
  "cmAgmtPolcGbCd": 300,
  "cmAgmtGbNm": "개인정보처리방침",
  "agmtPolcCd": 300,
  "agmtPolcNm": "개인정보처리방침",
  "aplyStrDt": 20230101,
  "aplyEndDt": 20231231,
  "title": "약관정책코드제목",
  "wrdCont": "약관정책코드 문구내용",
  "titleOther": "약관정책코드제목",
  "wrdContOther": "약관정책코드 문구내용"
}

Register and Modify Terms and Conditions/Usage Guide

post

Function Description

API for registering and modifying Terms and Conditions/Usage Guide detail information by site.

Detailed Description

Input parameters (* : required)
- create : siteNo *, cmAgmtPolcGbCd *, agmtPolcCd *, aplyStrDt *, aplyEndDt *, langCd *, title *, wrdCont *
- update : siteNo *, cmAgmtSeq *, cmAgmtPolcGbCd *, agmtPolcCd *, aplyStrDt *, aplyEndDt *, langCd *, title *, wrdCont *

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Common Terms & Policy Information

siteNostringOptional

Site No.

Example: 1

langCdstringOptional

Language Code (CM009)

Example: ko

cmAgmtSeqstringOptional

Common Terms Sequence No.

Example: 10202

siteNmstringOptional

Site Name

Example: x2bee

cmAgmtPolcGbCdstringOptional

Common Terms & Policy Type Code (CH010)

Example: 300

cmAgmtGbNmstringOptional

Terms & Policy Type Name

Example: 개인정보처리방침

agmtPolcCdstringOptional

Terms Policy Code (CH005)

Example: 300

agmtPolcNmstringOptional

Terms & Policy Code Name

Example: 개인정보처리방침

aplyStrDtstringOptional

Application Start Date

Example: 20230101

aplyEndDtstringOptional

Application End Date

Example: 20231231

titlestringOptional

Title

Example: 약관정책코드제목

wrdContstringOptional

Text Content

Example: 약관정책코드 문구내용

titleOtherstringOptional

Title

Example: 약관정책코드제목

wrdContOtherstringOptional

Text Content

Example: 약관정책코드 문구내용

Responses

200

Terms and Conditions/Usage Guide Information Register/Modify Successful

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

Terms and Conditions/Usage Guide Information Register/Modify Failed

*/*

post/v2/display/termsConditionsMgmt

POST /api/bo/v2/display/termsConditionsMgmt HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 389

{
  "siteNo": 1,
  "langCd": "ko",
  "cmAgmtSeq": 10202,
  "siteNm": "x2bee",
  "cmAgmtPolcGbCd": 300,
  "cmAgmtGbNm": "개인정보처리방침",
  "agmtPolcCd": 300,
  "agmtPolcNm": "개인정보처리방침",
  "aplyStrDt": 20230101,
  "aplyEndDt": 20231231,
  "title": "약관정책코드제목",
  "wrdCont": "약관정책코드 문구내용",
  "titleOther": "약관정책코드제목",
  "wrdContOther": "약관정책코드 문구내용"
}

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Register and Modify Terms and Conditions/Usage Guide Multilingual Information

post

Function Description

API for registering and modifying Terms and Conditions/Usage Guide multilingual information by site.

Detailed Description

Input parameters (* : required)
- update : cmAgmtSeq *, langCd *, title *, wrdCont *

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Common Terms & Policy Information

siteNostringOptional

Site No.

Example: 1

langCdstringOptional

Language Code (CM009)

Example: ko

cmAgmtSeqstringOptional

Common Terms Sequence No.

Example: 10202

siteNmstringOptional

Site Name

Example: x2bee

cmAgmtPolcGbCdstringOptional

Common Terms & Policy Type Code (CH010)

Example: 300

cmAgmtGbNmstringOptional

Terms & Policy Type Name

Example: 개인정보처리방침

agmtPolcCdstringOptional

Terms Policy Code (CH005)

Example: 300

agmtPolcNmstringOptional

Terms & Policy Code Name

Example: 개인정보처리방침

aplyStrDtstringOptional

Application Start Date

Example: 20230101

aplyEndDtstringOptional

Application End Date

Example: 20231231

titlestringOptional

Title

Example: 약관정책코드제목

wrdContstringOptional

Text Content

Example: 약관정책코드 문구내용

titleOtherstringOptional

Title

Example: 약관정책코드제목

wrdContOtherstringOptional

Text Content

Example: 약관정책코드 문구내용

Responses

200

Terms and Conditions/Usage Guide Multilingual Information Register/Modify Successful

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

Terms and Conditions/Usage Guide Multilingual Information Register/Modify Failed

*/*

post/v2/display/termsConditionsMgmt/multiLang

POST /api/bo/v2/display/termsConditionsMgmt/multiLang HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 389

{
  "siteNo": 1,
  "langCd": "ko",
  "cmAgmtSeq": 10202,
  "siteNm": "x2bee",
  "cmAgmtPolcGbCd": 300,
  "cmAgmtGbNm": "개인정보처리방침",
  "agmtPolcCd": 300,
  "agmtPolcNm": "개인정보처리방침",
  "aplyStrDt": 20230101,
  "aplyEndDt": 20231231,
  "title": "약관정책코드제목",
  "wrdCont": "약관정책코드 문구내용",
  "titleOther": "약관정책코드제목",
  "wrdContOther": "약관정책코드 문구내용"
}

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Terms and Conditions/Usage Guide Detail Information

get

Function Description

API for retrieving Terms and Conditions/Usage Guide detail information.

Detailed Description

Retrieves the corresponding Terms and Conditions/Usage Guide detail information by common terms sequence number.

Revision History

Release v1.05_231204 : Sprint 5 PO1 defect/improvement - Improved query WHERE clause

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cmAgmtSeqstringRequired

Common Terms Sequence No.

Example: 10202

Responses

200

Terms and Conditions/Usage Guide Detail Information Inquiry Successful

*/*

Common Terms & Policy Information

siteNostringOptional

Site No.

Example: 1

langCdstringOptional

Language Code (CM009)

Example: ko

cmAgmtSeqstringOptional

Common Terms Sequence No.

Example: 10202

siteNmstringOptional

Site Name

Example: x2bee

cmAgmtPolcGbCdstringOptional

Common Terms & Policy Type Code (CH010)

Example: 300

cmAgmtGbNmstringOptional

Terms & Policy Type Name

Example: 개인정보처리방침

agmtPolcCdstringOptional

Terms Policy Code (CH005)

Example: 300

agmtPolcNmstringOptional

Terms & Policy Code Name

Example: 개인정보처리방침

aplyStrDtstringOptional

Application Start Date

Example: 20230101

aplyEndDtstringOptional

Application End Date

Example: 20231231

titlestringOptional

Title

Example: 약관정책코드제목

wrdContstringOptional

Text Content

Example: 약관정책코드 문구내용

titleOtherstringOptional

Title

Example: 약관정책코드제목

wrdContOtherstringOptional

Text Content

Example: 약관정책코드 문구내용

900

Terms and Conditions/Usage Guide Detail Information Inquiry Failed

*/*

get/v2/display/termsConditionsMgmt/{cmAgmtSeq}

GET /api/bo/v2/display/termsConditionsMgmt/{cmAgmtSeq}?cmAgmtSeq=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "langCd": "ko",
  "cmAgmtSeq": 10202,
  "siteNm": "x2bee",
  "cmAgmtPolcGbCd": 300,
  "cmAgmtGbNm": "개인정보처리방침",
  "agmtPolcCd": 300,
  "agmtPolcNm": "개인정보처리방침",
  "aplyStrDt": 20230101,
  "aplyEndDt": 20231231,
  "title": "약관정책코드제목",
  "wrdCont": "약관정책코드 문구내용",
  "titleOther": "약관정책코드제목",
  "wrdContOther": "약관정책코드 문구내용"
}

Retrieve Terms and Conditions/Usage Guide Multilingual Detail Information

get

Function Description

API for retrieving Terms and Conditions/Usage Guide multilingual detail information.

Detailed Description

Retrieves the corresponding Terms and Conditions/Usage Guide multilingual detail information by common terms sequence number.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

cmAgmtSeqstringRequired

Common Terms Sequence No.

Example: 10202

langCdstringRequired

Language Code

Example: en

Responses

200

Terms and Conditions/Usage Guide Multilingual Detail Information Inquiry Successful

*/*

Common Terms & Policy Information

siteNostringOptional

Site No.

Example: 1

langCdstringOptional

Language Code (CM009)

Example: ko

cmAgmtSeqstringOptional

Common Terms Sequence No.

Example: 10202

siteNmstringOptional

Site Name

Example: x2bee

cmAgmtPolcGbCdstringOptional

Common Terms & Policy Type Code (CH010)

Example: 300

cmAgmtGbNmstringOptional

Terms & Policy Type Name

Example: 개인정보처리방침

agmtPolcCdstringOptional

Terms Policy Code (CH005)

Example: 300

agmtPolcNmstringOptional

Terms & Policy Code Name

Example: 개인정보처리방침

aplyStrDtstringOptional

Application Start Date

Example: 20230101

aplyEndDtstringOptional

Application End Date

Example: 20231231

titlestringOptional

Title

Example: 약관정책코드제목

wrdContstringOptional

Text Content

Example: 약관정책코드 문구내용

titleOtherstringOptional

Title

Example: 약관정책코드제목

wrdContOtherstringOptional

Text Content

Example: 약관정책코드 문구내용

900

Terms and Conditions/Usage Guide Multilingual Detail Information Inquiry Failed

*/*

get/v2/display/termsConditionsMgmt/multiLang/{cmAgmtSeq}

GET /api/bo/v2/display/termsConditionsMgmt/multiLang/{cmAgmtSeq}?cmAgmtSeq=text&langCd=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNo": 1,
  "langCd": "ko",
  "cmAgmtSeq": 10202,
  "siteNm": "x2bee",
  "cmAgmtPolcGbCd": 300,
  "cmAgmtGbNm": "개인정보처리방침",
  "agmtPolcCd": 300,
  "agmtPolcNm": "개인정보처리방침",
  "aplyStrDt": 20230101,
  "aplyEndDt": 20231231,
  "title": "약관정책코드제목",
  "wrdCont": "약관정책코드 문구내용",
  "titleOther": "약관정책코드제목",
  "wrdContOther": "약관정책코드 문구내용"
}

PreviousSwiper Type Management

NextStandard Display Category Link

Last updated 1 month ago