> 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/cs-bo-api/ob-type-management.md).

# OB Type Management

## Register/Modify OB Type

> \## Function Description\
> \* Registers/modifies an OB type.\
> \---\
> \## Detailed Description\
> \* Registers a new OB type or modifies existing OB type information.<br>

```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":{"RealGridCUDRequestCsObTypCd":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/CsObTypCd"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/CsObTypCd"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/CsObTypCd"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/CsObTypCd"}}}},"CsObTypCd":{"type":"object","description":"OB Type Save Register/Modify Request DTO","properties":{"obTypNo":{"type":"string","description":"OB Type Number"},"obTypNm":{"type":"string","description":"OB Type Name"},"obTypDesc":{"type":"string","description":"OB Type Description"},"useYn":{"type":"string","description":"Usage Status"},"cnslTypNo":{"type":"string","description":"Consultation Type No."},"sortSeq":{"type":"integer","format":"int32","description":"Sort Order"}}},"Response":{"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":{"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":{"/v2/customerservice/outbound-types/saveList":{"post":{"tags":["OB Type Management"],"summary":"Register/Modify OB Type","description":"## Function Description\n* Registers/modifies an OB type.\n---\n## Detailed Description\n* Registers a new OB type or modifies existing OB type information.\n","operationId":"saveList","parameters":[{"name":"obTypNo","in":"query","description":"OB Type Number","schema":{"type":"String"}},{"name":"obTypNm","in":"query","description":"OB Type Name","schema":{"type":"String"}},{"name":"obTypDesc","in":"query","description":"OB Type Description","schema":{"type":"String"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"String"}},{"name":"cnslTypNo","in":"query","description":"Consultation Type No.","schema":{"type":"String"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestCsObTypCd"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve Full OB Type List

> \## Function Description\
> \* Retrieves the full list of OB types.\
> \* Can be used to display a select box in the search area.\
> \---\
> \## Detailed Description\
> \* Retrieves the full list of registered OB types.<br>

```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":{"ResponseListCsObTypCdResponse":{"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/CsObTypCdResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"CsObTypCdResponse":{"type":"object","properties":{"obTypNo":{"type":"string"},"obTypNm":{"type":"string"},"obTypDesc":{"type":"string"},"useYn":{"type":"string"},"cnslTypNo":{"type":"string"},"cnslTypNm":{"type":"string"},"useCnt":{"type":"integer","format":"int32"},"sortSeq":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"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":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/customerservice/outbound-types":{"get":{"tags":["OB Type Management"],"summary":"Retrieve Full OB Type List","description":"## Function Description\n* Retrieves the full list of OB types.\n* Can be used to display a select box in the search area.\n---\n## Detailed Description\n* Retrieves the full list of registered OB types.\n","operationId":"getAllObTypeList","parameters":[{"name":"useYn","in":"query","description":"Usage Status","required":false,"schema":{"type":"string","description":"Usage Status"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListCsObTypCdResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve All OB Types

> \## Function Description\
> \* Retrieves all registered OB type information.\
> \---\
> \## Detailed Description\
> \* Retrieves all registered OB type information.<br>

```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":{"ResponseListCsObTypCdResponse":{"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/CsObTypCdResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"CsObTypCdResponse":{"type":"object","properties":{"obTypNo":{"type":"string"},"obTypNm":{"type":"string"},"obTypDesc":{"type":"string"},"useYn":{"type":"string"},"cnslTypNo":{"type":"string"},"cnslTypNm":{"type":"string"},"useCnt":{"type":"integer","format":"int32"},"sortSeq":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"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":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/customerservice/outbound-types/getObTypeNoPagingList":{"get":{"tags":["OB Type Management"],"summary":"Retrieve All OB Types","description":"## Function Description\n* Retrieves all registered OB type information.\n---\n## Detailed Description\n* Retrieves all registered OB type information.\n","operationId":"getObTypeNoPagingList","parameters":[{"name":"useYn","in":"query","description":"Usage Status","required":false,"schema":{"type":"string","description":"Usage Status"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListCsObTypCdResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve OB Type List

> \## Function Description\
> \* Retrieves the OB type list.\
> \---\
> \## Detailed Description\
> \* Retrieves the list of registered OB types.<br>

```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":{"RealGridListResponseCsObTypCdResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CsObTypCdResponse"}}}},"CsObTypCdResponse":{"type":"object","properties":{"obTypNo":{"type":"string"},"obTypNm":{"type":"string"},"obTypDesc":{"type":"string"},"useYn":{"type":"string"},"cnslTypNo":{"type":"string"},"cnslTypNm":{"type":"string"},"useCnt":{"type":"integer","format":"int32"},"sortSeq":{"type":"integer","format":"int32"}}},"Response":{"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":{"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":{"/v2/customerservice/outbound-types/getObTypeList":{"get":{"tags":["OB Type Management"],"summary":"Retrieve OB Type List","description":"## Function Description\n* Retrieves the OB type list.\n---\n## Detailed Description\n* Retrieves the list of registered OB types.\n","operationId":"getObTypeList","parameters":[{"name":"useYn","in":"query","description":"Usage Status","required":false,"schema":{"type":"string","description":"Usage Status"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCsObTypCdResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Check OB Type Name Duplication

> \## Function Description\
> \* Checks whether the OB type name being registered is a duplicate.\
> \---\
> \## Detailed Description\
> \* Checks whether data identical to the OB type name being registered already exists.<br>

```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":{"ResponseBoolean":{"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":"boolean","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"}}},"Response":{"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":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v2/customerservice/outbound-types/checkObTypNm":{"get":{"tags":["OB Type Management"],"summary":"Check OB Type Name Duplication","description":"## Function Description\n* Checks whether the OB type name being registered is a duplicate.\n---\n## Detailed Description\n* Checks whether data identical to the OB type name being registered already exists.\n","operationId":"checkObTypNm","parameters":[{"name":"obTypNm","in":"query","description":"OB Type Name","required":false,"schema":{"type":"string","description":"OB Type Name"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseBoolean"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve OB Type List

> \## Function Description\
> \* Retrieves the OB type list.\
> \---\
> \## Detailed Description\
> \* Retrieves the list of registered OB types.<br>

```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":{"ResponseListCsObTypCdResponse":{"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/CsObTypCdResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"CsObTypCdResponse":{"type":"object","properties":{"obTypNo":{"type":"string"},"obTypNm":{"type":"string"},"obTypDesc":{"type":"string"},"useYn":{"type":"string"},"cnslTypNo":{"type":"string"},"cnslTypNm":{"type":"string"},"useCnt":{"type":"integer","format":"int32"},"sortSeq":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"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":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/customerservice/obTypeMgmt/getObTypeList":{"get":{"tags":["OB Type Management"],"summary":"Retrieve OB Type List","description":"## Function Description\n* Retrieves the OB type list.\n---\n## Detailed Description\n* Retrieves the list of registered OB types.\n","operationId":"getObTypeList_1","parameters":[{"name":"useYn","in":"query","description":"Usage Status","required":false,"schema":{"type":"string","description":"Usage Status"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListCsObTypCdResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Retrieve OB Type by Consultation Type

> \## Function Description\
> \* Retrieves the OB type according to the consultation type.\
> \---\
> \## Detailed Description\
> \* Retrieves the OB type according to the consultation type.<br>

```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":{"ResponseListCsObTypCdResponse":{"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/CsObTypCdResponse"}},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"CsObTypCdResponse":{"type":"object","properties":{"obTypNo":{"type":"string"},"obTypNm":{"type":"string"},"obTypDesc":{"type":"string"},"useYn":{"type":"string"},"cnslTypNo":{"type":"string"},"cnslTypNm":{"type":"string"},"useCnt":{"type":"integer","format":"int32"},"sortSeq":{"type":"integer","format":"int32"}}},"ValidationError":{"type":"object","properties":{"field":{"type":"string","description":"field"},"message":{"type":"string","description":"field message"}}},"Response":{"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":{"description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}}}},"paths":{"/v1/customerservice/obTypeMgmt/getObCnslTypeList":{"get":{"tags":["OB Type Management"],"summary":"Retrieve OB Type by Consultation Type","description":"## Function Description\n* Retrieves the OB type according to the consultation type.\n---\n## Detailed Description\n* Retrieves the OB type according to the consultation type.\n","operationId":"getObCnslTypeList","parameters":[{"name":"cnslTypNo","in":"query","description":"Consultation Type No.","required":false,"schema":{"type":"string","description":"Consultation Type No."}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListCsObTypCdResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```