> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api/api-en/back-office-api-reference/display-bo-api/swiper-type-management.md). # Swiper Type Management ## Retrieve Single Swiper Type > \## Function Description\ > \* API for retrieving a single swiper type.\ > \---\ > \## Detailed Description\ > \* Retrieves swiper type details by swiper type number.
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseSwiperType":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/SwiperType","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"SwiperType":{"type":"object","description":"Swiper Type Basic","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTypId":{"type":"string","description":"Swiper Type ID"},"swiperTypNm":{"type":"string","description":"Swiper Type Name"},"swiperTypDesc":{"type":"string","description":"Swiper Type Description"},"useYn":{"type":"string","description":"Usage Status"},"swiperTypeTargetList":{"type":"array","description":"Swiper Type Target Information List","items":{"$ref":"#/components/schemas/SwiperTypeTarget"}},"swiperTypeTgtNmStr":{"type":"string","description":"Swiper Type Target Information String"}}},"SwiperTypeTarget":{"type":"object","description":"Swiper Type Target Information","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTgtCd":{"type":"string","description":"Swiper Target Code (DP005)"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order","minimum":1},"swiperTgtCnt":{"type":"integer","format":"int32","description":"Swiper Target Count","maximum":999,"minimum":1}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/display/swiperType/{swiperTypNo}":{"get":{"tags":["Swiper Type Management"],"summary":"Retrieve Single Swiper Type","description":"## Function Description\n* API for retrieving a single swiper type.\n---\n## Detailed Description\n* Retrieves swiper type details by swiper type number.\n","operationId":"getSwiperTypeList","parameters":[{"name":"swiperTypNo","in":"path","description":"Swiper Type No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseSwiperType"}}}}}}}}} ``` ## Modify Single Swiper Type > \## 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
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SwiperType":{"type":"object","description":"Swiper Type Basic","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTypId":{"type":"string","description":"Swiper Type ID"},"swiperTypNm":{"type":"string","description":"Swiper Type Name"},"swiperTypDesc":{"type":"string","description":"Swiper Type Description"},"useYn":{"type":"string","description":"Usage Status"},"swiperTypeTargetList":{"type":"array","description":"Swiper Type Target Information List","items":{"$ref":"#/components/schemas/SwiperTypeTarget"}},"swiperTypeTgtNmStr":{"type":"string","description":"Swiper Type Target Information String"}}},"SwiperTypeTarget":{"type":"object","description":"Swiper Type Target Information","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTgtCd":{"type":"string","description":"Swiper Target Code (DP005)"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order","minimum":1},"swiperTgtCnt":{"type":"integer","format":"int32","description":"Swiper Target Count","maximum":999,"minimum":1}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/display/swiperType/{swiperTypNo}":{"put":{"tags":["Swiper Type Management"],"summary":"Modify Single Swiper Type","description":"## Function Description\n* API for modifying a swiper type.\n---\n## Detailed Description\n* List of required values\n * Swiper Type No.\n * Swiper Type ID\n * Swiper Type Name\n * Swiper Type Description\n * Usage Status\n * Swiper Type Target Information List\n * Registrant ID\n * Modifier ID\n---\n## Code Reference\n* ``` Usage Status ``` : Y, N\n","operationId":"modifySwiperType","parameters":[{"name":"swiperTypNo","in":"path","description":"Swiper Type No.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiperType"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}}}}}}} ```` ## Retrieve Swiper Type List > \## 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
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseRealGridListResponseSwiperType":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"$ref":"#/components/schemas/RealGridListResponseSwiperType","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseSwiperType":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/SwiperType"}}}},"SwiperType":{"type":"object","description":"Swiper Type Basic","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTypId":{"type":"string","description":"Swiper Type ID"},"swiperTypNm":{"type":"string","description":"Swiper Type Name"},"swiperTypDesc":{"type":"string","description":"Swiper Type Description"},"useYn":{"type":"string","description":"Usage Status"},"swiperTypeTargetList":{"type":"array","description":"Swiper Type Target Information List","items":{"$ref":"#/components/schemas/SwiperTypeTarget"}},"swiperTypeTgtNmStr":{"type":"string","description":"Swiper Type Target Information String"}}},"SwiperTypeTarget":{"type":"object","description":"Swiper Type Target Information","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTgtCd":{"type":"string","description":"Swiper Target Code (DP005)"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order","minimum":1},"swiperTgtCnt":{"type":"integer","format":"int32","description":"Swiper Target Count","maximum":999,"minimum":1}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/display/swiperType":{"get":{"tags":["Swiper Type Management"],"summary":"Retrieve Swiper Type List","description":"## Function Description\n* API for retrieving the swiper type list.\n---\n## Detailed Description\n* Retrieves the swiper type list according to the conditions.\n---\n## Code Reference\n* ``` Usage Status ``` : Y, N\n","operationId":"getSwiperTypeList_1","parameters":[{"name":"swiperTypNo","in":"query","description":"Swiper Type No.","schema":{"type":"string"}},{"name":"swiperTypNm","in":"query","description":"Swiper Type Name","schema":{"type":"string"}},{"name":"swiperTypId","in":"query","description":"Swiper Type ID","schema":{"type":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseSwiperType"}}}}}}}}} ```` ## Register Single Swiper Type > \## 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
````json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SwiperType":{"type":"object","description":"Swiper Type Basic","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTypId":{"type":"string","description":"Swiper Type ID"},"swiperTypNm":{"type":"string","description":"Swiper Type Name"},"swiperTypDesc":{"type":"string","description":"Swiper Type Description"},"useYn":{"type":"string","description":"Usage Status"},"swiperTypeTargetList":{"type":"array","description":"Swiper Type Target Information List","items":{"$ref":"#/components/schemas/SwiperTypeTarget"}},"swiperTypeTgtNmStr":{"type":"string","description":"Swiper Type Target Information String"}}},"SwiperTypeTarget":{"type":"object","description":"Swiper Type Target Information","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTgtCd":{"type":"string","description":"Swiper Target Code (DP005)"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order","minimum":1},"swiperTgtCnt":{"type":"integer","format":"int32","description":"Swiper Target Count","maximum":999,"minimum":1}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/display/swiperType":{"post":{"tags":["Swiper Type Management"],"summary":"Register Single Swiper Type","description":"## Function Description\n* API for registering a swiper type.\n---\n## Detailed Description\n* List of required values\n * Swiper Type ID\n * Swiper Type Name\n * Swiper Type Description\n * Usage Status\n * Swiper Type Target Information List\n * Registrant ID\n * Modifier ID\n---\n## Code Reference\n* ``` Usage Status ``` : Y, N\n","operationId":"registerSwiperType","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwiperType"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}}}}}}} ```` ## Delete Swiper Type List > \## Function Description\ > \* API for deleting the swiper type list.\ > \---\ > \## Detailed Description\ > \* List of required values\ > \* Swiper Type No.
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"SwiperType":{"type":"object","description":"Swiper Type Basic","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTypId":{"type":"string","description":"Swiper Type ID"},"swiperTypNm":{"type":"string","description":"Swiper Type Name"},"swiperTypDesc":{"type":"string","description":"Swiper Type Description"},"useYn":{"type":"string","description":"Usage Status"},"swiperTypeTargetList":{"type":"array","description":"Swiper Type Target Information List","items":{"$ref":"#/components/schemas/SwiperTypeTarget"}},"swiperTypeTgtNmStr":{"type":"string","description":"Swiper Type Target Information String"}}},"SwiperTypeTarget":{"type":"object","description":"Swiper Type Target Information","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTgtCd":{"type":"string","description":"Swiper Target Code (DP005)"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order","minimum":1},"swiperTgtCnt":{"type":"integer","format":"int32","description":"Swiper Target Count","maximum":999,"minimum":1}}},"ResponseString":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"string","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/display/swiperType":{"delete":{"tags":["Swiper Type Management"],"summary":"Delete Swiper Type List","description":"## Function Description\n* API for deleting the swiper type list.\n---\n## Detailed Description\n* List of required values\n * Swiper Type No.\n","operationId":"deleteSwiperTypeList","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SwiperType"}}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}}}}}}} ``` ## Retrieve Mapped Swiper Type List > \## Function Description\ > \* API for retrieving the mapped swiper type list.\ > \---\ > \## Detailed Description\ > \* List of required values\ > \* Swiper Type No. List
```json {"openapi":"3.1.0","info":{"title":"X2BEE BO API","version":"v1"},"servers":[{"url":"https://api-bo.x2bee.com/api/bo/","description":"prd"}],"security":[{"accessToken":[]}],"components":{"securitySchemes":{"accessToken":{"type":"http","name":"accessToken","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"ResponseListSwiperType":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time","description":"result time"},"code":{"type":"string","description":"result code"},"message":{"type":"string","description":"result message"},"isProcess":{"type":"boolean","description":"process check"},"payload":{"type":"array","description":"payload","items":{"$ref":"#/components/schemas/SwiperType"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"SwiperType":{"type":"object","description":"Swiper Type Basic","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTypId":{"type":"string","description":"Swiper Type ID"},"swiperTypNm":{"type":"string","description":"Swiper Type Name"},"swiperTypDesc":{"type":"string","description":"Swiper Type Description"},"useYn":{"type":"string","description":"Usage Status"},"swiperTypeTargetList":{"type":"array","description":"Swiper Type Target Information List","items":{"$ref":"#/components/schemas/SwiperTypeTarget"}},"swiperTypeTgtNmStr":{"type":"string","description":"Swiper Type Target Information String"}}},"SwiperTypeTarget":{"type":"object","description":"Swiper Type Target Information","properties":{"swiperTypNo":{"type":"string","description":"Swiper Type No."},"swiperTgtCd":{"type":"string","description":"Swiper Target Code (DP005)"},"dispSeq":{"type":"integer","format":"int32","description":"Display Order","minimum":1},"swiperTgtCnt":{"type":"integer","format":"int32","description":"Swiper Target Count","maximum":999,"minimum":1}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}}}},"paths":{"/v1/display/swiperType/swiperTypNo":{"get":{"tags":["Swiper Type Management"],"summary":"Retrieve Mapped Swiper Type List","description":"## Function Description\n* API for retrieving the mapped swiper type list.\n---\n## Detailed Description\n* List of required values\n * Swiper Type No. List\n","operationId":"getMappedSwiperTypeList","parameters":[{"name":"swiperTypNoList","in":"query","description":"Swiper Type No. List","required":true,"schema":{"type":"array"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListSwiperType"}}}}}}}}} ```