> 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/system-bo-api/customer-notification-management.md).
# Customer Notification Management
## Modify Customer Notification
> \## Function Description\
> \* Modifies customer notification information.\
> \---\
> \## Detailed Description\
> \* The registered customer notification can be viewed on the FO screen matching the large and medium categories of the notification screen for the registered notification.
```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":{"CustomerAlimRequest":{"type":"object","description":"Customer Alert Registration/Modification Request DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"ntcRegId":{"type":"string","description":"Registrant ID"},"bbStrStartDt":{"type":"string","format":"date","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","format":"date","description":"Post Start Period End Date"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"dataLangCd":{"type":"string","description":"Multilingual Language Code"},"scrnCustNotiSeqs":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"searchDateType":{"type":"string","description":"Search Period Condition"},"dateSelect":{"type":"string","description":"Selected Period"},"dispMediaCdList":{"type":"array","items":{"type":"string"}},"scrnCustNotiSeqList":{"type":"array","items":{"type":"string"}}},"required":["ntcConts"]},"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/system/customerAlimMgmt/modifyCustomerAlimInfo":{"put":{"tags":["Customer Notification Management"],"summary":"Modify Customer Notification","description":"## Function Description\n* Modifies customer notification information.\n---\n## Detailed Description\n* The registered customer notification can be viewed on the FO screen matching the large and medium categories of the notification screen for the registered notification.\n","operationId":"modifyCustomerAlimInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAlimRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Register/Modify Customer Notification Multilingual Information
> \## Function Description\
> \* Registers or modifies customer notification multilingual information.\
> \---\
> \## Detailed Description\
> \* Registers or modifies the multilingual information for the given langCd.\
> \* langCd and ntcMlConts are required when registering.\
> \* langCd, scrnCustNotiSeq, and ntcMlConts are required when modifying.
```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":{"CustomerAlimRequest":{"type":"object","description":"Customer Alert Registration/Modification Request DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"ntcRegId":{"type":"string","description":"Registrant ID"},"bbStrStartDt":{"type":"string","format":"date","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","format":"date","description":"Post Start Period End Date"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"dataLangCd":{"type":"string","description":"Multilingual Language Code"},"scrnCustNotiSeqs":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"searchDateType":{"type":"string","description":"Search Period Condition"},"dateSelect":{"type":"string","description":"Selected Period"},"dispMediaCdList":{"type":"array","items":{"type":"string"}},"scrnCustNotiSeqList":{"type":"array","items":{"type":"string"}}},"required":["ntcConts"]},"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/system/customerAlimMgmt/registCustomerAlimMultiLang":{"post":{"tags":["Customer Notification Management"],"summary":"Register/Modify Customer Notification Multilingual Information","description":"## Function Description\n* Registers or modifies customer notification multilingual information.\n---\n## Detailed Description\n* Registers or modifies the multilingual information for the given langCd.\n* langCd and ntcMlConts are required when registering.\n* langCd, scrnCustNotiSeq, and ntcMlConts are required when modifying.\n","operationId":"registCustomerAlimMultiLang","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAlimRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Register Customer Notification
> \## Function Description\
> \* Registers customer notification information.\
> \---\
> \## Detailed Description\
> \* The registered customer notification can be viewed on the FO screen matching the large and medium categories of the notification screen for the registered notification.
```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":{"CustomerAlimRequest":{"type":"object","description":"Customer Alert Registration/Modification Request DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"ntcRegId":{"type":"string","description":"Registrant ID"},"bbStrStartDt":{"type":"string","format":"date","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","format":"date","description":"Post Start Period End Date"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"dataLangCd":{"type":"string","description":"Multilingual Language Code"},"scrnCustNotiSeqs":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"searchDateType":{"type":"string","description":"Search Period Condition"},"dateSelect":{"type":"string","description":"Selected Period"},"dispMediaCdList":{"type":"array","items":{"type":"string"}},"scrnCustNotiSeqList":{"type":"array","items":{"type":"string"}}},"required":["ntcConts"]},"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/system/customerAlimMgmt/registCustomerAlimInfo":{"post":{"tags":["Customer Notification Management"],"summary":"Register Customer Notification","description":"## Function Description\n* Registers customer notification information.\n---\n## Detailed Description\n* The registered customer notification can be viewed on the FO screen matching the large and medium categories of the notification screen for the registered notification.\n","operationId":"registCustomerAlimInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAlimRequest"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Process Customer Notification Posting End
> \## Function Description\
> \* Processes the posting end for a customer notification.\
> \---\
> \## Detailed Description\
> \* Changes the posting end date to the current date.
```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":{"CustomerAlimPostingEndRequest":{"type":"object","properties":{"postingEndSaveInfoList":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAlimPostingEndInfo"},"minItems":1}},"required":["postingEndSaveInfoList"]},"CustomerAlimPostingEndInfo":{"type":"object","properties":{"scrnCustNotiSeq":{"type":"string"}}},"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/system/customerAlimMgmt/customerAlimPostingEndProcess":{"post":{"tags":["Customer Notification Management"],"summary":"Process Customer Notification Posting End","description":"## Function Description\n* Processes the posting end for a customer notification.\n---\n## Detailed Description\n* Changes the posting end date to the current date.\n","operationId":"customerAlimPostingEndProcess","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerAlimPostingEndRequest"}}},"required":true},"responses":{"200":{"description":"Success"},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Customer Alert Multilingual Information
> \## Function Description\
> \* Retrieves the customer alert multilingual information matching the customer alert notice number.\
> \---\
> \## Detailed Description\
> \* If dataLangCd is provided, retrieves the multilingual information for that language code.\
> \* If not provided, retrieves the multilingual information for the first language code excluding the current default language code.
```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":{"CustomerAlimRequest":{"type":"object","description":"Customer Alert Registration/Modification Request DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"ntcRegId":{"type":"string","description":"Registrant ID"},"bbStrStartDt":{"type":"string","format":"date","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","format":"date","description":"Post Start Period End Date"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"dataLangCd":{"type":"string","description":"Multilingual Language Code"},"scrnCustNotiSeqs":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"searchDateType":{"type":"string","description":"Search Period Condition"},"dateSelect":{"type":"string","description":"Selected Period"},"dispMediaCdList":{"type":"array","items":{"type":"string"}},"scrnCustNotiSeqList":{"type":"array","items":{"type":"string"}}},"required":["ntcConts"]},"CustomerAlimResponse":{"type":"object","description":"Customer Alert Retrieval Response DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"bbStrStartDt":{"type":"string","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","description":"Post Start Period End Date"},"siteNm":{"type":"string","description":"Site Name"}},"required":["ntcConts"]},"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/system/customerAlimMgmt/getCustomerAlimMultiLang":{"get":{"tags":["Customer Notification Management"],"summary":"Retrieve Customer Alert Multilingual Information","description":"## Function Description\n* Retrieves the customer alert multilingual information matching the customer alert notice number.\n---\n## Detailed Description\n* If dataLangCd is provided, retrieves the multilingual information for that language code.\n* If not provided, retrieves the multilingual information for the first language code excluding the current default language code.\n","operationId":"getCustomerAlimMultiLang","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CustomerAlimRequest"}},{"name":"scrnCustNotiSeq","in":"query","description":"Customer Notification Notice No.","required":true,"schema":{"type":"string"}},{"name":"dataLangCd","in":"query","description":"Multilingual Country Code","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomerAlimResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Customer Alert List
> \## Function Description\
> \* Retrieves the customer alert list matching the conditions selected on the screen.\
> \---\
> \## Detailed Description\
> \* Retrieves the customer alert list matching the conditions selected on the screen.\
> \* The list is retrieved based on the dataLangCd registered in the cookie value.\
> \---\
> \## Revision History\
> \* Release v2.00\_240425: Added site search condition and result column\
> \* Release v2.00\_240530: Changed date query
```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":{"CustomerAlimRequest":{"type":"object","description":"Customer Alert Registration/Modification Request DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"ntcRegId":{"type":"string","description":"Registrant ID"},"bbStrStartDt":{"type":"string","format":"date","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","format":"date","description":"Post Start Period End Date"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"dataLangCd":{"type":"string","description":"Multilingual Language Code"},"scrnCustNotiSeqs":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"searchDateType":{"type":"string","description":"Search Period Condition"},"dateSelect":{"type":"string","description":"Selected Period"},"dispMediaCdList":{"type":"array","items":{"type":"string"}},"scrnCustNotiSeqList":{"type":"array","items":{"type":"string"}}},"required":["ntcConts"]},"RealGridListResponseCustomerAlimResponse":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/CustomerAlimResponse"}}}},"CustomerAlimResponse":{"type":"object","description":"Customer Alert Retrieval Response DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"bbStrStartDt":{"type":"string","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","description":"Post Start Period End Date"},"siteNm":{"type":"string","description":"Site Name"}},"required":["ntcConts"]},"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/system/customerAlimMgmt/getCustomerAlimList":{"get":{"tags":["Customer Notification Management"],"summary":"Retrieve Customer Alert List","description":"## Function Description\n* Retrieves the customer alert list matching the conditions selected on the screen.\n---\n## Detailed Description\n* Retrieves the customer alert list matching the conditions selected on the screen.\n* The list is retrieved based on the dataLangCd registered in the cookie value.\n---\n## Revision History\n* Release v2.00_240425: Added site search condition and result column\n* Release v2.00_240530: Changed date query\n","operationId":"getCustomerAlimList","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CustomerAlimRequest"}},{"name":"bbStrStartDt","in":"query","description":"Posting Start Date and Time","required":true,"schema":{"type":"LocalDate"}},{"name":"bbStrEndDt","in":"query","description":"Posting End Date and Time","required":true,"schema":{"type":"LocalDate"}},{"name":"ntcRegId","in":"query","description":"Registrant ID","schema":{"type":"string"}},{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"string"}},{"name":"dispMediaCd","in":"query","description":"Display Media Code","schema":{"type":"string"}},{"name":"scrnLgrpCd","in":"query","description":"Notification Screen Major Category","schema":{"type":"string"}},{"name":"scrnMgrpCd","in":"query","description":"Notification Screen Middle Category","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}},{"name":"dateSelect","in":"query","description":"Selected Period","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealGridListResponseCustomerAlimResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Customer Alert Information
> \## Function Description\
> \* Retrieves the customer alert information matching the customer alert notice number.\
> \---\
> \## Detailed Description\
> \* Customer Alert Notice No. (scrnCustNotiSeq) is required.\
> \* Retrieves based on the dataLangCd cookie value.
```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":{"CustomerAlimResponse":{"type":"object","description":"Customer Alert Retrieval Response DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"bbStrStartDt":{"type":"string","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","description":"Post Start Period End Date"},"siteNm":{"type":"string","description":"Site Name"}},"required":["ntcConts"]},"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/system/customerAlimMgmt/getCustomerAlimInfo":{"get":{"tags":["Customer Notification Management"],"summary":"Retrieve Customer Alert Information","description":"## Function Description\n* Retrieves the customer alert information matching the customer alert notice number.\n---\n## Detailed Description\n* Customer Alert Notice No. (scrnCustNotiSeq) is required.\n* Retrieves based on the dataLangCd cookie value.\n","operationId":"getCustomerAlimInfo","parameters":[{"name":"scrnCustNotiSeq","in":"query","description":"Customer Notification Notice No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CustomerAlimResponse"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Check Customer Alert Registration/Modification Valid Period
> \## Function Description\
> \* Checks the valid period for customer alert registration/modification\
> \---\
> \## Detailed Description\
> \* Checks for overlapping periods by alert medium, alert major category, and sub category\
> \* Returns the existing alert 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":{"CustomerAlimRequest":{"type":"object","description":"Customer Alert Registration/Modification Request DTO","properties":{"scrnCustNotiSeq":{"type":"string","description":"Screen Customer Notification Sequence No."},"ntcRegId":{"type":"string","description":"Registrant ID"},"bbStrStartDt":{"type":"string","format":"date","description":"Post Start Period Start Date"},"bbStrEndDt":{"type":"string","format":"date","description":"Post Start Period End Date"},"dispMediaCd":{"type":"string","description":"Display Media Code (DP018)"},"scrnLgrpCd":{"type":"string","description":"Notification Screen Major Category (CM026)"},"scrnMgrpCd":{"type":"string","description":"Notification Screen Middle Category (CM027)"},"ntcConts":{"type":"string","description":"Notification Content"},"ntcMlConts":{"type":"string","description":"Multilingual Notification Content"},"dataLangCd":{"type":"string","description":"Multilingual Language Code"},"scrnCustNotiSeqs":{"type":"string","description":"Screen Customer Notification Sequence No."},"bbStrStartDtm":{"type":"string","format":"date-time","description":"Posting Start Period Start Date/Time"},"bbStrEndDtm":{"type":"string","format":"date-time","description":"Posting Start Period End Date/Time"},"searchDateType":{"type":"string","description":"Search Period Condition"},"dateSelect":{"type":"string","description":"Selected Period"},"dispMediaCdList":{"type":"array","items":{"type":"string"}},"scrnCustNotiSeqList":{"type":"array","items":{"type":"string"}}},"required":["ntcConts"]},"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/system/customerAlimMgmt/getCheckPostingPeriodScrnCustNotiSeq":{"get":{"tags":["Customer Notification Management"],"summary":"Check Customer Alert Registration/Modification Valid Period","description":"## Function Description\n* Checks the valid period for customer alert registration/modification\n---\n## Detailed Description\n* Checks for overlapping periods by alert medium, alert major category, and sub category\n* Returns the existing alert number\n","operationId":"getCheckPostingPeriodScrnCustNotiSeq","parameters":[{"name":"request","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CustomerAlimRequest"}},{"name":"scrnCustNotiSeq","in":"query","description":"Posting Start Date and Time","schema":{"type":"string"}},{"name":"bbStrStartDt","in":"query","description":"Posting Start Date and Time","required":true,"schema":{"type":"string"}},{"name":"bbStrEndDt","in":"query","description":"Posting End Date and Time","required":true,"schema":{"type":"string"}},{"name":"dispMediaCd","in":"query","description":"Display Media Code","schema":{"type":"string"}},{"name":"scrnLgrpCd","in":"query","description":"Notification Screen Major Category","schema":{"type":"string"}},{"name":"scrnMgrpCd","in":"query","description":"Notification Screen Middle Category","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"type":"string"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```