> 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/display-bo-api/undefined-13.md).

# 사이트 정보 관리

## 사이트관리 등록 및 수정

> \## 기능설명\
> \* 사이트 정보를 등록 및 수정하는 API 입니다.\
> \---\
> \## 상세설명\
> \* realGrid를 통해 해당 사이트 정보를 등록 및 수정합니다.\
> \
> \* 입력 파라미터( \* : 필수)\
> &#x20;   \* create : siteNm \*, trdStrtDt \*, trdEndDt \*, siteDom \*\
> &#x20;   \* update : siteNo \*, siteNm \*, trdStrtDt \*, trdEndDt \*, siteDom \*<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":{"RealGridCUDRequestCcSiteBase":{"type":"object","properties":{"all":{"type":"array","items":{"$ref":"#/components/schemas/CcSiteBase"}},"create":{"type":"array","items":{"$ref":"#/components/schemas/CcSiteBase"}},"update":{"type":"array","items":{"$ref":"#/components/schemas/CcSiteBase"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/CcSiteBase"}}}},"CcSiteBase":{"type":"object","description":"사이트관리 기본","properties":{"siteNm":{"type":"string","description":"사이트명"},"trdStrtDt":{"type":"string","description":"거래시작일자"},"trdEndDt":{"type":"string","description":"거래종료일자"},"siteDom":{"type":"string","description":"사이트도메인"},"siteEmail":{"type":"string","description":"사이트이메일"},"siteEmailNm":{"type":"string","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"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/siteMgmt/saveSiteBase":{"post":{"tags":["사이트 정보 관리"],"summary":"사이트관리 등록 및 수정","description":"## 기능설명\n* 사이트 정보를 등록 및 수정하는 API 입니다.\n---\n## 상세설명\n* realGrid를 통해 해당 사이트 정보를 등록 및 수정합니다.\n\n* 입력 파라미터( * : 필수)\n    * create : siteNm *, trdStrtDt *, trdEndDt *, siteDom *\n    * update : siteNo *, siteNm *, trdStrtDt *, trdEndDt *, siteDom *\n","operationId":"saveSiteBase","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RealGridCUDRequestCcSiteBase"}}},"required":true},"responses":{"200":{"description":"사이트 정보 등록/수정 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"사이트 정보 등록/수정 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## 사이트 url 조회

> \## 기능설명\
> 사이트번호(siteNo)값으로 사이트 url을 조회\
> \---\
> \## 상세설명\
> BO 내에서 preview 형태로 사이트를 보여주기 위해 사이트 URL 조회하여 반환<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":{"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/display/siteMgmt/getSiteUrl":{"get":{"tags":["사이트 정보 관리"],"summary":"사이트 url 조회","description":"## 기능설명\n사이트번호(siteNo)값으로 사이트 url을 조회\n---\n## 상세설명\nBO 내에서 preview 형태로 사이트를 보여주기 위해 사이트 URL 조회하여 반환\n","operationId":"getSiteUrl","parameters":[{"name":"siteNo","in":"query","description":"사이트번호","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"업무처리 오류 내용","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```

## 사이트 명 목록 조회

> \## 기능설명\
> \* 사이트 명 목록을 조회하는 API 입니다.\
> \---\
> \## 상세설명\
> \* 사이트 명 목록을 조회합니다.\
> \* 사이트 명 목록은 사이트번호 오름차순으로 노출됩니다.<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":{"CcSiteBase":{"type":"object","description":"사이트관리 기본","properties":{"siteNm":{"type":"string","description":"사이트명"},"trdStrtDt":{"type":"string","description":"거래시작일자"},"trdEndDt":{"type":"string","description":"거래종료일자"},"siteDom":{"type":"string","description":"사이트도메인"},"siteEmail":{"type":"string","description":"사이트이메일"},"siteEmailNm":{"type":"string","description":"사이트이메일명"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/siteMgmt/getSiteNmList":{"get":{"tags":["사이트 정보 관리"],"summary":"사이트 명 목록 조회","description":"## 기능설명\n* 사이트 명 목록을 조회하는 API 입니다.\n---\n## 상세설명\n* 사이트 명 목록을 조회합니다.\n* 사이트 명 목록은 사이트번호 오름차순으로 노출됩니다.\n","operationId":"getSiteNmList","responses":{"200":{"description":"사이트 명 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CcSiteBase"}}}},"900":{"description":"사이트 명 조회 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```

## 사이트 정보 목록 조회

> \## 기능설명\
> \* 사이트 정보 목록을 조회하는 API 입니다.\
> \---\
> \## 상세설명\
> \* 사이트 번호가 없을 경우 등록된 전체 사이트 정보를 조회합니다.\
> \* 샤이트 정보 목록은 사이트번호 오름차순으로 노출됩니다.\
> \---\
> \## 수정번호\
> \`\`\`Release v1.02\_231023\`\`\` : 스프린트2 PO1 결함/개선<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":{"CcSiteBase":{"type":"object","description":"사이트관리 기본","properties":{"siteNm":{"type":"string","description":"사이트명"},"trdStrtDt":{"type":"string","description":"거래시작일자"},"trdEndDt":{"type":"string","description":"거래종료일자"},"siteDom":{"type":"string","description":"사이트도메인"},"siteEmail":{"type":"string","description":"사이트이메일"},"siteEmailNm":{"type":"string","description":"사이트이메일명"}}},"ErrorCode":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"httpStatus":{"type":"integer","format":"int32"},"isProcess":{"type":"boolean"}}}}},"paths":{"/v1/display/siteMgmt/getSiteBaseList":{"get":{"tags":["사이트 정보 관리"],"summary":"사이트 정보 목록 조회","description":"## 기능설명\n* 사이트 정보 목록을 조회하는 API 입니다.\n---\n## 상세설명\n* 사이트 번호가 없을 경우 등록된 전체 사이트 정보를 조회합니다.\n* 샤이트 정보 목록은 사이트번호 오름차순으로 노출됩니다.\n---\n## 수정번호\n```Release v1.02_231023``` : 스프린트2 PO1 결함/개선\n","operationId":"getSiteBaseList","parameters":[{"name":"siteNo","in":"query","description":"사이트번호","schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"페이지 당 row","required":true,"schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"현재 페이지","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"사이트 정보 조회 성공","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CcSiteBase"}}}},"900":{"description":"사이트 정보 조회 실패","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````
