Site Information Management

Register and Modify Site Management

post

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 *

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Responses

200

Site Information Register/Modify Successful

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

Site Information Register/Modify Failed

*/*

post/v1/display/siteMgmt/saveSiteBase

POST /api/bo/v1/display/siteMgmt/saveSiteBase HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 634

{
  "all": [
    {
      "siteNm": "x2bee",
      "trdStrtDt": 20230101,
      "trdEndDt": 20991231,
      "siteDom": "x2bee.com",
      "siteEmail": "x2bee@plateer.com",
      "siteEmailNm": "PLATEER-채용팀"
    }
  ],
  "create": [
    {
      "siteNm": "x2bee",
      "trdStrtDt": 20230101,
      "trdEndDt": 20991231,
      "siteDom": "x2bee.com",
      "siteEmail": "x2bee@plateer.com",
      "siteEmailNm": "PLATEER-채용팀"
    }
  ],
  "update": [
    {
      "siteNm": "x2bee",
      "trdStrtDt": 20230101,
      "trdEndDt": 20991231,
      "siteDom": "x2bee.com",
      "siteEmail": "x2bee@plateer.com",
      "siteEmailNm": "PLATEER-채용팀"
    }
  ],
  "delete": [
    {
      "siteNm": "x2bee",
      "trdStrtDt": 20230101,
      "trdEndDt": 20991231,
      "siteDom": "x2bee.com",
      "siteEmail": "x2bee@plateer.com",
      "siteEmailNm": "PLATEER-채용팀"
    }
  ]
}

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Site URL

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

siteNostringRequired

Site No.

Example: 1

Responses

200

Success

*/*

timestampstring · date-timeOptional

result time

codestringOptional

result code

messagestringOptional

result message

isProcessbooleanOptional

process check

payloadstringOptional

payload

errorbooleanOptional

is error

900

Business processing error details

*/*

get/v1/display/siteMgmt/getSiteUrl

GET /api/bo/v1/display/siteMgmt/getSiteUrl?siteNo=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "timestamp": "2026-01-01T00:00:00.000Z",
  "code": "text",
  "message": "text",
  "isProcess": true,
  "payload": "text",
  "error": true,
  "errors": [
    {
      "field": "text",
      "message": "text"
    }
  ]
}

Retrieve Site Name List

get

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.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Site Name Inquiry Successful

*/*

Site Management Basic

siteNmstringOptional

Site Name

Example: x2bee

trdStrtDtstringOptional

Transaction Start Date

Example: 20230101

trdEndDtstringOptional

Transaction End Date

Example: 20991231

siteDomstringOptional

Site Domain

Example: x2bee.com

siteEmailstringOptional

Site Email

Example: x2bee@plateer.com

siteEmailNmstringOptional

Site Email Name

Example: PLATEER-채용팀

900

Site Name Inquiry Failed

*/*

get/v1/display/siteMgmt/getSiteNmList

GET /api/bo/v1/display/siteMgmt/getSiteNmList HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNm": "x2bee",
  "trdStrtDt": 20230101,
  "trdEndDt": 20991231,
  "siteDom": "x2bee.com",
  "siteEmail": "x2bee@plateer.com",
  "siteEmailNm": "PLATEER-채용팀"
}

Retrieve Site Information List

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

siteNostringOptional

Site No.

Example: 1

rowsPerPagestringRequired

Rows per Page

Example: 100

pageIdxstringRequired

Current Page

Example: 1

Responses

200

Retrieve Site Information Success

*/*

Site Management Basic

siteNmstringOptional

Site Name

Example: x2bee

trdStrtDtstringOptional

Transaction Start Date

Example: 20230101

trdEndDtstringOptional

Transaction End Date

Example: 20991231

siteDomstringOptional

Site Domain

Example: x2bee.com

siteEmailstringOptional

Site Email

Example: x2bee@plateer.com

siteEmailNmstringOptional

Site Email Name

Example: PLATEER-채용팀

900

Retrieve Site Information Failure

*/*

get/v1/display/siteMgmt/getSiteBaseList

GET /api/bo/v1/display/siteMgmt/getSiteBaseList?rowsPerPage=text&pageIdx=text HTTP/1.1
Host: api-bo.x2bee.com/
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "siteNm": "x2bee",
  "trdStrtDt": 20230101,
  "trdEndDt": 20991231,
  "siteDom": "x2bee.com",
  "siteEmail": "x2bee@plateer.com",
  "siteEmailNm": "PLATEER-채용팀"
}

PreviousSlot Management

NextSpecial Exhibition Information Management

Last updated 2 months ago