> 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/site-information-management.md).
# Site Information Management
## Register and Modify Site Management
> \## Function Description\
> \* API for registering and modifying site information.\
> \---\
> \## Detailed Description\
> \* Registers and modifies the corresponding site information via realGrid.\
> \
> \* Input parameters (\* : required)\
> \* create : siteNm \*, trdStrtDt \*, trdEndDt \*, siteDom \*\
> \* update : siteNo \*, siteNm \*, trdStrtDt \*, trdEndDt \*, siteDom \*
```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":"Site Management Basic","properties":{"siteNm":{"type":"string","description":"Site Name"},"trdStrtDt":{"type":"string","description":"Transaction Start Date"},"trdEndDt":{"type":"string","description":"Transaction End Date"},"siteDom":{"type":"string","description":"Site Domain"},"siteEmail":{"type":"string","description":"Site Email"},"siteEmailNm":{"type":"string","description":"Site Email Name"}}},"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":["Site Information Management"],"summary":"Register and Modify Site Management","description":"## Function Description\n* API for registering and modifying site information.\n---\n## Detailed Description\n* Registers and modifies the corresponding site information via realGrid.\n\n* Input parameters (* : required)\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":"Site Information Register/Modify Successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Site Information Register/Modify Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Retrieve Site URL
> \## Function Description\
> Retrieves the site URL by site number (siteNo) value\
> \---\
> \## Detailed Description\
> Retrieves and returns the site URL to display the site in preview form within BO
```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":["Site Information Management"],"summary":"Retrieve Site URL","description":"## Function Description\nRetrieves the site URL by site number (siteNo) value\n---\n## Detailed Description\nRetrieves and returns the site URL to display the site in preview form within BO\n","operationId":"getSiteUrl","parameters":[{"name":"siteNo","in":"query","description":"Site No.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseString"}}}},"900":{"description":"Business processing error details","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Response"}}}}}}}}}
```
## Retrieve Site Name List
> \## Function Description\
> \* API for retrieving the site name list.\
> \---\
> \## Detailed Description\
> \* Retrieves the site name list.\
> \* The site name list is displayed in ascending order of site 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":{"CcSiteBase":{"type":"object","description":"Site Management Basic","properties":{"siteNm":{"type":"string","description":"Site Name"},"trdStrtDt":{"type":"string","description":"Transaction Start Date"},"trdEndDt":{"type":"string","description":"Transaction End Date"},"siteDom":{"type":"string","description":"Site Domain"},"siteEmail":{"type":"string","description":"Site Email"},"siteEmailNm":{"type":"string","description":"Site Email Name"}}},"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":["Site Information Management"],"summary":"Retrieve Site Name List","description":"## Function Description\n* API for retrieving the site name list.\n---\n## Detailed Description\n* Retrieves the site name list.\n* The site name list is displayed in ascending order of site number.\n","operationId":"getSiteNmList","responses":{"200":{"description":"Site Name Inquiry Successful","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CcSiteBase"}}}},"900":{"description":"Site Name Inquiry Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
```
## Retrieve Site Information List
> \## Function Description\
> \* API for retrieving the site information list.\
> \---\
> \## Detailed Description\
> \* If there is no site number, retrieves all registered site information.\
> \* The site information list is displayed in ascending order of site number.\
> \---\
> \## Revision History\
> \`\`\`Release v1.02\_231023\`\`\` : Sprint 2 PO1 defect/improvement
````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":"Site Management Basic","properties":{"siteNm":{"type":"string","description":"Site Name"},"trdStrtDt":{"type":"string","description":"Transaction Start Date"},"trdEndDt":{"type":"string","description":"Transaction End Date"},"siteDom":{"type":"string","description":"Site Domain"},"siteEmail":{"type":"string","description":"Site Email"},"siteEmailNm":{"type":"string","description":"Site Email Name"}}},"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":["Site Information Management"],"summary":"Retrieve Site Information List","description":"## Function Description\n* API for retrieving the site information list.\n---\n## Detailed Description\n* If there is no site number, retrieves all registered site information.\n* The site information list is displayed in ascending order of site number.\n---\n## Revision History\n```Release v1.02_231023``` : Sprint 2 PO1 defect/improvement\n","operationId":"getSiteBaseList","parameters":[{"name":"siteNo","in":"query","description":"Site No.","schema":{"type":"string"}},{"name":"rowsPerPage","in":"query","description":"Rows per Page","required":true,"schema":{"type":"string"}},{"name":"pageIdx","in":"query","description":"Current Page","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Retrieve Site Information Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/CcSiteBase"}}}},"900":{"description":"Retrieve Site Information Failure","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ErrorCode"}}}}}}}}}
````