> 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/back-office-api/goods-bo-api/undefined-9.md).

# 랭킹 관리

## 랭킹 정보 등록 및 수정 및 삭제

> \## 기능설명\
> \* 랭킹 정보를 등록 및 수정 및 삭제하는 API 입니다.\
> \---\
> \## 상세설명\
> \* 입력 파라미터( \* : 필수)\
> &#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":"랭킹 기본 모델","properties":{"siteNo":{"type":"string","description":"사이트번호"},"rankModlSeq":{"type":"string","description":"랭킹모델순번"},"rankPolcNm":{"type":"string","description":"랭킹정책명"},"idxCd":{"type":"string","description":"색인코드"},"idxCdNm":{"type":"string","description":"색인코드명"},"attCd":{"type":"string","description":"속성코드"},"attCdNm":{"type":"string","description":"속성코드명"},"attType":{"type":"string","description":"속성타입"},"aplyCond1":{"type":"string","description":"적용조건1"},"aplyCond2":{"type":"string","description":"적용조건2"},"useYn":{"type":"string","description":"사용여부"},"aplyWght":{"type":"integer","format":"int32","description":"가중치"},"aplyStrDt":{"type":"string","format":"date","description":"적용시작일자"},"aplyEndDt":{"type":"string","format":"date","description":"적용종료일자"}}},"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":["랭킹 관리"],"summary":"랭킹 정보 등록 및 수정 및 삭제","description":"## 기능설명\n* 랭킹 정보를 등록 및 수정 및 삭제하는 API 입니다.\n---\n## 상세설명\n* 입력 파라미터( * : 필수)\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":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 랭킹 목록 조회

> \## 기능설명\
> \* 랭킹 정보 목록을 조회하는 API 입니다.\
> \---\
> \## 상세설명\
> \* 검색조건 : 색인코드, 시작날짜, 종료날짜, 사용여부\
> \* 랭킹 목록은 랭킹모델순번 내림차순으로 노출됩니다.\
> \---\
> \## 수정번호\
> \* \`\`\`Release v1.04\_231120\`\`\` : 랭킹 설정<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":"랭킹 기본 모델","properties":{"siteNo":{"type":"string","description":"사이트번호"},"rankModlSeq":{"type":"string","description":"랭킹모델순번"},"rankPolcNm":{"type":"string","description":"랭킹정책명"},"idxCd":{"type":"string","description":"색인코드"},"idxCdNm":{"type":"string","description":"색인코드명"},"attCd":{"type":"string","description":"속성코드"},"attCdNm":{"type":"string","description":"속성코드명"},"attType":{"type":"string","description":"속성타입"},"aplyCond1":{"type":"string","description":"적용조건1"},"aplyCond2":{"type":"string","description":"적용조건2"},"useYn":{"type":"string","description":"사용여부"},"aplyWght":{"type":"integer","format":"int32","description":"가중치"},"aplyStrDt":{"type":"string","format":"date","description":"적용시작일자"},"aplyEndDt":{"type":"string","format":"date","description":"적용종료일자"}}},"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":["랭킹 관리"],"summary":"랭킹 목록 조회","description":"## 기능설명\n* 랭킹 정보 목록을 조회하는 API 입니다.\n---\n## 상세설명\n* 검색조건 : 색인코드, 시작날짜, 종료날짜, 사용여부\n* 랭킹 목록은 랭킹모델순번 내림차순으로 노출됩니다.\n---\n## 수정번호\n* ```Release v1.04_231120``` : 랭킹 설정\n","operationId":"getRankList","parameters":[{"name":"idxCd","in":"query","description":"색인코드","schema":{"type":"string"}},{"name":"startDate","in":"query","description":"시작날짜","schema":{"type":"LocalDate"}},{"name":"endDate","in":"query","description":"종료날짜","schema":{"type":"LocalDate"}},{"name":"useYn","in":"query","description":"사용여부","schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"현재 페이지","required":true,"schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"페이지 당 row","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseRealGridListResponseRankBase"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
````

## 속성 중복 체크

> \## 기능설명\
> \* 동일 사이트에 동일 속성이 이미 등록되어 있는지 확인하는 API 입니다.\
> \---\
> \## 상세설명\
> \* siteNo와 attCd를 파라미터로 받아 중복 여부를 확인합니다.\
> \* 중복된 경우 1 이상의 숫자를, 중복되지 않은 경우 0을 반환합니다.\
> \---<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":["랭킹 관리"],"summary":"속성 중복 체크","description":"## 기능설명\n* 동일 사이트에 동일 속성이 이미 등록되어 있는지 확인하는 API 입니다.\n---\n## 상세설명\n* siteNo와 attCd를 파라미터로 받아 중복 여부를 확인합니다.\n* 중복된 경우 1 이상의 숫자를, 중복되지 않은 경우 0을 반환합니다.\n---\n","operationId":"checkDuplicatedAttribute","parameters":[{"name":"siteNo","in":"query","description":"사이트번호","required":true,"schema":{"type":"string"}},{"name":"attCd","in":"query","description":"속성코드","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseInteger"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```