> 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/icon-management.md).

# Icon Management

## Register and Modify Icon Information

> \## Function Description\
> \* API for registering and modifying icon information.\
> \---\
> \## Detailed Description\
> \* For PC, the MO image path is left blank; for MO, the PC image path is left blank; for common, both PC and MO image paths are saved.\
> \* Input parameters (\* : required)\
>     \* create : siteNo \*, iconNm \*, useYn \*, dispMediaCd \*, iconTypCd \*, pcIconPathNm, pcIconFileNm, moIconPathNm, moIconFileNm\
>     \* update : dispIconNo \*, siteNo \*, iconNm \*, useYn \*, dispMediaCd \*, iconTypCd \*, pcIconPathNm, pcIconFileNm, moIconPathNm, moIconFileNm\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.03\_231106\`\`\` : Icon (badge) settings<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":{"PrDispIconInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"dispIconNo":{"type":"string","description":"Display Icon No."},"siteNm":{"type":"string","description":"Site Name"},"iconNm":{"type":"string","description":"Icon Name"},"useYn":{"type":"string","description":"Usage Status"},"dispMediaCd":{"type":"string","description":"Display Media Code"},"dispMediaCdNm":{"type":"string","description":"Display Media Code Name"},"iconTypCd":{"type":"string","description":"Icon Type Code"},"iconTypCdNm":{"type":"string","description":"Icon Type Code Name"},"iconPathNm":{"type":"string","description":"Icon Type Code Name"},"pcIconPathNm":{"type":"string","description":"PC Icon Path Name"},"pcIconFileNm":{"type":"string","description":"PC Icon File Name"},"moIconPathNm":{"type":"string","description":"MO Icon Path Name"},"moIconFileNm":{"type":"string","description":"MO Icon Path Name"},"commonIconPathNm":{"type":"string","description":"Common Icon Path"}}},"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"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/iconMgmt/saveIconInfoDetail":{"post":{"tags":["Icon Management"],"summary":"Register and Modify Icon Information","description":"## Function Description\n* API for registering and modifying icon information.\n---\n## Detailed Description\n* For PC, the MO image path is left blank; for MO, the PC image path is left blank; for common, both PC and MO image paths are saved.\n* Input parameters (* : required)\n    * create : siteNo *, iconNm *, useYn *, dispMediaCd *, iconTypCd *, pcIconPathNm, pcIconFileNm, moIconPathNm, moIconFileNm\n    * update : dispIconNo *, siteNo *, iconNm *, useYn *, dispMediaCd *, iconTypCd *, pcIconPathNm, pcIconFileNm, moIconPathNm, moIconFileNm\n---\n## Revision History\n* ```Release v1.03_231106``` : Icon (badge) settings\n","operationId":"saveIconInfoDetail","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"},"prDispIconInfo":{"$ref":"#/components/schemas/PrDispIconInfo"}},"required":["prDispIconInfo"]}}}},"responses":{"200":{"description":"Icon Information Register/Modify Successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Icon Information Register/Modify Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````

## Retrieve Icon Basic Information

> \## Function Description\
> \* This API retrieves basic icon information.\
> \---\
> \## Detailed Description\
> \* Retrieves basic icon information.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.03\_231106\`\`\` : Icon (badge) settings<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":{"PrDispIconInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"dispIconNo":{"type":"string","description":"Display Icon No."},"siteNm":{"type":"string","description":"Site Name"},"iconNm":{"type":"string","description":"Icon Name"},"useYn":{"type":"string","description":"Usage Status"},"dispMediaCd":{"type":"string","description":"Display Media Code"},"dispMediaCdNm":{"type":"string","description":"Display Media Code Name"},"iconTypCd":{"type":"string","description":"Icon Type Code"},"iconTypCdNm":{"type":"string","description":"Icon Type Code Name"},"iconPathNm":{"type":"string","description":"Icon Type Code Name"},"pcIconPathNm":{"type":"string","description":"PC Icon Path Name"},"pcIconFileNm":{"type":"string","description":"PC Icon File Name"},"moIconPathNm":{"type":"string","description":"MO Icon Path Name"},"moIconFileNm":{"type":"string","description":"MO Icon Path Name"},"commonIconPathNm":{"type":"string","description":"Common Icon Path"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/iconMgmt/getIconInfoDetail":{"get":{"tags":["Icon Management"],"summary":"Retrieve Icon Basic Information","description":"## Function Description\n* This API retrieves basic icon information.\n---\n## Detailed Description\n* Retrieves basic icon information.\n---\n## Revision History\n* ```Release v1.03_231106``` : Icon (badge) settings\n","operationId":"getIconInfoDetail","parameters":[{"name":"dispIconNo","in":"query","description":"Display Icon No.","required":true,"schema":{"type":"string","description":"string"}}],"responses":{"200":{"description":"Icon basic information retrieved successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PrDispIconInfo"}}}},"900":{"description":"Failed to retrieve icon basic information","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````

## Retrieve Icon List

> \## Function Description\
> \* This API retrieves the list of icons.\
> \---\
> \## Detailed Description\
> \* Retrieves the list of icons.\
> \* The icon list is displayed in ascending order of icon number.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.05\_231204\`\`\` : Sprint 5 PO1 defects/improvements - Fixed icon image query<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":{"PrDispIconInfo":{"type":"object","properties":{"siteNo":{"type":"string","description":"Site No."},"dispIconNo":{"type":"string","description":"Display Icon No."},"siteNm":{"type":"string","description":"Site Name"},"iconNm":{"type":"string","description":"Icon Name"},"useYn":{"type":"string","description":"Usage Status"},"dispMediaCd":{"type":"string","description":"Display Media Code"},"dispMediaCdNm":{"type":"string","description":"Display Media Code Name"},"iconTypCd":{"type":"string","description":"Icon Type Code"},"iconTypCdNm":{"type":"string","description":"Icon Type Code Name"},"iconPathNm":{"type":"string","description":"Icon Type Code Name"},"pcIconPathNm":{"type":"string","description":"PC Icon Path Name"},"pcIconFileNm":{"type":"string","description":"PC Icon File Name"},"moIconPathNm":{"type":"string","description":"MO Icon Path Name"},"moIconFileNm":{"type":"string","description":"MO Icon Path Name"},"commonIconPathNm":{"type":"string","description":"Common Icon Path"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/iconMgmt/getIconBaseList":{"get":{"tags":["Icon Management"],"summary":"Retrieve Icon List","description":"## Function Description\n* This API retrieves the list of icons.\n---\n## Detailed Description\n* Retrieves the list of icons.\n* The icon list is displayed in ascending order of icon number.\n---\n## Revision History\n* ```Release v1.05_231204``` : Sprint 5 PO1 defects/improvements - Fixed icon image query\n","operationId":"getIconList","parameters":[{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"string","description":"string"}},{"name":"dispIconNo","in":"query","description":"Display Icon No.","schema":{"type":"string","description":"string"}},{"name":"iconNm","in":"query","description":"Icon Name","schema":{"type":"string","description":"string"}},{"name":"useYn","in":"query","description":"Usage Status","schema":{"type":"string","description":"string"}},{"name":"pageIdx","in":"query","description":"Requested Page No.","required":true,"schema":{"type":"string","description":"integer"}},{"name":"rowsPerPage","in":"query","description":"Requested Page Size","required":true,"schema":{"type":"string","description":"integer"}}],"responses":{"200":{"description":"Icon list retrieved successfully","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PrDispIconInfo"}}}},"900":{"description":"Failed to retrieve icon list","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````