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

Swiper Type Management

Retrieve Single Swiper Type

get

Function Description

  • API for retrieving a single swiper type.

Detailed Description

  • Retrieves swiper type details by swiper type number.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
swiperTypNostringRequired

Swiper Type No.

Example: 11
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v1/display/swiperType/{swiperTypNo}
GET /api/bo/v1/display/swiperType/{swiperTypNo} HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "swiperTypNo": 11,
    "swiperTypId": "IMG_A",
    "swiperTypNm": "이미지A",
    "swiperTypDesc": "이미지 상하 노출, 텍스트 하단 노출",
    "useYn": "Y",
    "swiperTypeTargetList": [
      {
        "swiperTypNo": 11,
        "swiperTgtCd": 22,
        "dispSeq": 1,
        "swiperTgtCnt": 2
      }
    ],
    "swiperTypeTgtNmStr": "이미지+TEXT"
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Modify Single Swiper Type

put

Function Description

  • API for modifying a swiper type.

Detailed Description

  • List of required values

    • Swiper Type No.

    • Swiper Type ID

    • Swiper Type Name

    • Swiper Type Description

    • Usage Status

    • Swiper Type Target Information List

    • Registrant ID

    • Modifier ID

Code Reference

  • Usage Status : Y, N

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
swiperTypNostringRequired

Swiper Type No.

Body

Swiper Type Basic

swiperTypNostringOptional

Swiper Type No.

Example: 11
swiperTypIdstringOptional

Swiper Type ID

Example: IMG_A
swiperTypNmstringOptional

Swiper Type Name

Example: 이미지A
swiperTypDescstringOptional

Swiper Type Description

Example: 이미지 상하 노출, 텍스트 하단 노출
useYnstringOptional

Usage Status

Example: Y
swiperTypeTgtNmStrstringOptional

Swiper Type Target Information String

Example: 이미지+TEXT
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

put/v1/display/swiperType/{swiperTypNo}
PUT /api/bo/v1/display/swiperType/{swiperTypNo} HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "swiperTypNo": 11,
  "swiperTypId": "IMG_A",
  "swiperTypNm": "이미지A",
  "swiperTypDesc": "이미지 상하 노출, 텍스트 하단 노출",
  "useYn": "Y",
  "swiperTypeTargetList": [
    {
      "swiperTypNo": 11,
      "swiperTgtCd": 22,
      "dispSeq": 1,
      "swiperTgtCnt": 2
    }
  ],
  "swiperTypeTgtNmStr": "이미지+TEXT"
}
200

OK

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

Retrieve Swiper Type List

get

Function Description

  • API for retrieving the swiper type list.

Detailed Description

  • Retrieves the swiper type list according to the conditions.

Code Reference

  • Usage Status : Y, N

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

Swiper Type No.

Example: 11
swiperTypNmstringOptional

Swiper Type Name

Example: 이미지
swiperTypIdstringOptional

Swiper Type ID

Example: IMG
useYnstringOptional

Usage Status

Example: Y
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v1/display/swiperType
GET /api/bo/v1/display/swiperType HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": {
    "totalCount": 1,
    "payloads": [
      {
        "swiperTypNo": 11,
        "swiperTypId": "IMG_A",
        "swiperTypNm": "이미지A",
        "swiperTypDesc": "이미지 상하 노출, 텍스트 하단 노출",
        "useYn": "Y",
        "swiperTypeTargetList": [
          {
            "swiperTypNo": 11,
            "swiperTgtCd": 22,
            "dispSeq": 1,
            "swiperTgtCnt": 2
          }
        ],
        "swiperTypeTgtNmStr": "이미지+TEXT"
      }
    ]
  },
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Register Single Swiper Type

post

Function Description

  • API for registering a swiper type.

Detailed Description

  • List of required values

    • Swiper Type ID

    • Swiper Type Name

    • Swiper Type Description

    • Usage Status

    • Swiper Type Target Information List

    • Registrant ID

    • Modifier ID

Code Reference

  • Usage Status : Y, N

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

Swiper Type Basic

swiperTypNostringOptional

Swiper Type No.

Example: 11
swiperTypIdstringOptional

Swiper Type ID

Example: IMG_A
swiperTypNmstringOptional

Swiper Type Name

Example: 이미지A
swiperTypDescstringOptional

Swiper Type Description

Example: 이미지 상하 노출, 텍스트 하단 노출
useYnstringOptional

Usage Status

Example: Y
swiperTypeTgtNmStrstringOptional

Swiper Type Target Information String

Example: 이미지+TEXT
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

post/v1/display/swiperType
POST /api/bo/v1/display/swiperType HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 274

{
  "swiperTypNo": 11,
  "swiperTypId": "IMG_A",
  "swiperTypNm": "이미지A",
  "swiperTypDesc": "이미지 상하 노출, 텍스트 하단 노출",
  "useYn": "Y",
  "swiperTypeTargetList": [
    {
      "swiperTypNo": 11,
      "swiperTgtCd": 22,
      "dispSeq": 1,
      "swiperTgtCnt": 2
    }
  ],
  "swiperTypeTgtNmStr": "이미지+TEXT"
}
200

OK

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

Delete Swiper Type List

delete

Function Description

  • API for deleting the swiper type list.

Detailed Description

  • List of required values

    • Swiper Type No.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Bodyobject · SwiperType[]

Swiper Type Basic

swiperTypNostringOptional

Swiper Type No.

Example: 11
swiperTypIdstringOptional

Swiper Type ID

Example: IMG_A
swiperTypNmstringOptional

Swiper Type Name

Example: 이미지A
swiperTypDescstringOptional

Swiper Type Description

Example: 이미지 상하 노출, 텍스트 하단 노출
useYnstringOptional

Usage Status

Example: Y
swiperTypeTgtNmStrstringOptional

Swiper Type Target Information String

Example: 이미지+TEXT
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

delete/v1/display/swiperType
DELETE /api/bo/v1/display/swiperType HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 276

[
  {
    "swiperTypNo": 11,
    "swiperTypId": "IMG_A",
    "swiperTypNm": "이미지A",
    "swiperTypDesc": "이미지 상하 노출, 텍스트 하단 노출",
    "useYn": "Y",
    "swiperTypeTargetList": [
      {
        "swiperTypNo": 11,
        "swiperTgtCd": 22,
        "dispSeq": 1,
        "swiperTgtCnt": 2
      }
    ],
    "swiperTypeTgtNmStr": "이미지+TEXT"
  }
]
200

OK

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

Retrieve Mapped Swiper Type List

get

Function Description

  • API for retrieving the mapped swiper type list.

Detailed Description

  • List of required values

    • Swiper Type No. List

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

Swiper Type No. List

Example: ["11","21"]
Responses
200

OK

*/*
timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

errorbooleanOptional

is error

get/v1/display/swiperType/swiperTypNo
GET /api/bo/v1/display/swiperType/swiperTypNo?swiperTypNoList=undefined HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200

OK

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": [
    {
      "swiperTypNo": 11,
      "swiperTypId": "IMG_A",
      "swiperTypNm": "이미지A",
      "swiperTypDesc": "이미지 상하 노출, 텍스트 하단 노출",
      "useYn": "Y",
      "swiperTypeTargetList": [
        {
          "swiperTypNo": 11,
          "swiperTgtCd": 22,
          "dispSeq": 1,
          "swiperTgtCnt": 2
        }
      ],
      "swiperTypeTgtNmStr": "이미지+TEXT"
    }
  ],
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}
PreviousDisplay Category Management
NextTerms And Usage Guide Management

Last updated