> 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/goods-bo-api/ranking-management.md).

# Ranking Management

## Register, Modify, and Delete Ranking Information

> \## Function Description\
> \* An API that registers, modifies, and deletes ranking information.\
> \---\
> \## Detailed Description\
> \* Input parameters ( \* : required)\
> &#x20;   \* create : idxCd \*, useYn \*, attCd \*, aplyWght \*\
> &#x20;   \* update : rankModlSeq \*,idxCd \*, useYn \*, attCd \*, aplyWght \*\
> &#x20;   \* delete : rankModlSeq \*\
> \---<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":{"RealGridCUDRequestRankBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/RankBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/RankBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/RankBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/RankBase"}}}},"RankBase":{"type":"object","description":"Ranking Base Model","properties":{"siteNo":{"type":"string","description":"Site No."},"rankModlSeq":{"type":"string","description":"Ranking Model Sequence No."},"rankPolcNm":{"type":"string","description":"Ranking Policy Name"},"idxCd":{"type":"string","description":"Index Code"},"idxCdNm":{"type":"string","description":"Index Code Name"},"attCd":{"type":"string","description":"Attribute Code"},"attCdNm":{"type":"string","description":"Attribute Code Name"},"attType":{"type":"string","description":"Attribute Type"},"aplyCond1":{"type":"string","description":"Applied Condition 1"},"aplyCond2":{"type":"string","description":"Applied Condition 2"},"useYn":{"type":"string","description":"Usage Status"},"aplyWght":{"type":"integer","format":"int32","description":"Weight"},"aplyStrDt":{"type":"string","format":"date","description":"Application Start Date"},"aplyEndDt":{"type":"string","format":"date","description":"Application End Date"}}},"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"}}},"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/search/rankMgmt/saveRankTypeList":{"post":{"tags":["Ranking Management"],"summary":"Register, Modify, and Delete Ranking Information","description":"## Function Description\n* An API that registers, modifies, and deletes ranking information.\n---\n## Detailed Description\n* Input parameters ( * : required)\n    * create : idxCd *, useYn *, attCd *, aplyWght *\n    * update : rankModlSeq *,idxCd *, useYn *, attCd *, aplyWght *\n    * delete : rankModlSeq *\n---\n","operationId":"saveRankTypeList","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestRankBase"}}},"required":true},"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## Search Ranking List

> \## Function Description\
> \* An API that searches the ranking information list.\
> \---\
> \## Detailed Description\
> \* Search conditions: index code, start date, end date, usage status\
> \* The ranking list is displayed in descending order of ranking model sequence number.\
> \---\
> \## Revision History\
> \* \`\`\`Release v1.04\_231120\`\`\` : Ranking 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":{"ResponseRealGridListResponseRankBase":{"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/RealGridListResponseRankBase","description":"payload"},"error":{"type":"boolean","description":"is error"},"errors":{"type":"array","description":"validation error list","items":{"$ref":"#/components/schemas/ValidationError"}}}},"RealGridListResponseRankBase":{"type":"object","properties":{"totalCount":{"type":"integer","format":"int32"},"payloads":{"type":"array","items":{"$ref":"#/components/schemas/RankBase"}}}},"RankBase":{"type":"object","description":"Ranking Base Model","properties":{"siteNo":{"type":"string","description":"Site No."},"rankModlSeq":{"type":"string","description":"Ranking Model Sequence No."},"rankPolcNm":{"type":"string","description":"Ranking Policy Name"},"idxCd":{"type":"string","description":"Index Code"},"idxCdNm":{"type":"string","description":"Index Code Name"},"attCd":{"type":"string","description":"Attribute Code"},"attCdNm":{"type":"string","description":"Attribute Code Name"},"attType":{"type":"string","description":"Attribute Type"},"aplyCond1":{"type":"string","description":"Applied Condition 1"},"aplyCond2":{"type":"string","description":"Applied Condition 2"},"useYn":{"type":"string","description":"Usage Status"},"aplyWght":{"type":"integer","format":"int32","description":"Weight"},"aplyStrDt":{"type":"string","format":"date","description":"Application Start Date"},"aplyEndDt":{"type":"string","format":"date","description":"Application End Date"}}},"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/search/rankMgmt/getRankList":{"get":{"tags":["Ranking Management"],"summary":"Search Ranking List","description":"## Function Description\n* An API that searches the ranking information list.\n---\n## Detailed Description\n* Search conditions: index code, start date, end date, usage status\n* The ranking list is displayed in descending order of ranking model sequence number.\n---\n## Revision History\n* ```Release v1.04_231120``` : Ranking settings\n","operationId":"getRankList","parameters":[{"name":"idxCd","in":"query","description":"Index Code","schema":{"type":"string"}},{"name":"startDate","in":"query","description":"Start Date","schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"End Date","schema":{"type":"LocalDate"}},{"name":"useYn","in":"query","description":"Usage Status","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"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseRankBase"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## Check Attribute Duplication

> \## Function Description\
> \* An API that checks whether the same attribute is already registered for the same site.\
> \---\
> \## Detailed Description\
> \* Checks for duplication by receiving siteNo and attCd as parameters.\
> \* Returns a number of 1 or more if duplicated, and 0 if not duplicated.\
> \---<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":{"ResponseInteger":{"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":"integer","format":"int32","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":{"/v1/search/rankMgmt/checkDuplicatedAttribute":{"get":{"tags":["Ranking Management"],"summary":"Check Attribute Duplication","description":"## Function Description\n* An API that checks whether the same attribute is already registered for the same site.\n---\n## Detailed Description\n* Checks for duplication by receiving siteNo and attCd as parameters.\n* Returns a number of 1 or more if duplicated, and 0 if not duplicated.\n---\n","operationId":"checkDuplicatedAttribute","parameters":[{"name":"siteNo","in":"query","description":"Site No.","required":true,"schema":{"type":"string"}},{"name":"attCd","in":"query","description":"Attribute Code","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseInteger"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```