본문으로 건너뛰기

예약 그룹으로 예약 슬롯 조회

POST 

/schedule/open/v1/queries/get-reservation-slots-by-group

예약 그룹을 기준으로 예약 슬롯을 조회합니다.

에러 응답

timezone 이 잘못되었을 경우
{
status: 400,
message: "InvalidRequestException",
className: "InvalidRequestException",
errorProperties: [
{
key: "timezone",
reason: "NotAvailable"
},
],
}
reservationGroup 이 조회되지 않았을 경우
{
status: 400,
message: "NotFoundException",
className: "NotFoundException",
errorProperties: [
{
key: "id",
reason: "NotFound"
},
],
}
reservationGroup 의 포맷이 잘못되었을 경우
{
status: 400,
message: "InvalidRequestException",
className: "InvalidRequestException",
errorProperties: [
{
key: "id",
reason: "NotAvailable"
},
],
}

Request

### Content-Type별 요청의 JSON Schema

{
"application/json": {
"schema": {
"required": [
"reservationGroupId",
"startDate",
"endDate",
"timezone"
],
"type": "object",
"properties": {
"reservationGroupId": {
"type": "string",
"description": "예약 그룹 ID",
"format": "object-id"
},
"startDate": {
"type": "string",
"description": "조회 범위 시작 시각",
"format": "date-time"
},
"endDate": {
"type": "string",
"description": "조회 범위 끝 시각",
"format": "date-time"
},
"timezone": {
"type": "string",
"description": "시간대n ex) Asia/Seoul [참고](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#:~:text=Asia/Seoul)"
}
},
"title": "protos.open.GetReservationSlotsByGroupQuery"
}
}
}

Responses

OK

### Status Code별 응답의 JSON Schema

{
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"required": [
"data"
],
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"required": [
"reservationGroupId",
"zone",
"startDateTimeUtc",
"endDateTimeUtc",
"capacity",
"reservationCount"
],
"type": "object",
"properties": {
"reservationGroupId": {
"type": "string",
"description": "예약 그룹 ID"
},
"zone": {
"allOf": [
{
"required": [
"id",
"name"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "구역 ID",
"format": "object-id"
},
"name": {
"type": "string",
"description": "구역 이름"
}
},
"title": "protos.open.ReservationSlotZoneConfiguration"
}
],
"description": "구역 정보"
},
"startDateTimeUtc": {
"type": "string",
"description": "예약 시작 시각 (ISO 8601)",
"format": "date-time"
},
"endDateTimeUtc": {
"type": "string",
"description": "예약 종료 시각 (ISO 8601)",
"format": "date-time"
},
"capacity": {
"type": "integer",
"description": "해당 슬롯의 최대 예약 가능 인원",
"format": "int32"
},
"reservationCount": {
"type": "integer",
"description": "현재 예약된 인원 수",
"format": "int32"
}
},
"title": "protos.open.ReservationSlot"
}
}
},
"title": "protos.open.GetReservationSlotsQueryResponse"
}
}
}
}
}