get_reservation detail design
- Operation:
getReservation - Endpoint:
GET /reservations/{reservationId}
1. 正常系入力
| Location | Name | Type | 説明 |
|---|---|---|---|
path |
reservationId |
ResourceId |
予約を一意に識別するIDです。 |
Request body はありません。
2. 正常系前提
- 条件分岐: 呼び出し元が予約者本人または管理者でない場合。: 不成立
- 例外処理: ROUTER_HANDLED_EXCEPTIONS: 発生しない
3. 正常系リソース変更
正常系で作成/更新/削除するリソースはありません。
4. 正常系レスポンス
- Response model:
GetReservationResponse
| 項目 | 説明 | 値の取得元 |
|---|---|---|
reservation |
予約の詳細です。 | reservation |
reservation.reservationId |
予約を一意に識別するIDです。 | reservation |
reservation.resourceId |
予約対象の資源を一意に識別するIDです。 | reservation |
reservation.ownerPrincipalId |
予約者を表す認証主体IDです。 | reservation |
reservation.startAt |
予約開始日時です。 | reservation |
reservation.endAt |
予約終了日時です。この時刻を含みません。 | reservation |
reservation.purpose |
予約目的です。本人と管理者だけに返します。 | reservation |
reservation.status |
予約の状態です。 | reservation |
reservation.version |
予約取消の楽観ロックに使う版です。 | reservation |
events |
作成と取消の履歴を発生順に並べた一覧です。 | events |
events.eventId |
履歴を一意に識別するIDです。 | events |
events.reservationId |
履歴の対象予約IDです。 | events |
events.actorPrincipalId |
操作した利用者の認証主体IDです。 | events |
events.action |
予約に対する操作種別です。 | events |
events.occurredAt |
操作日時です。 | events |