package reservation

Get desktop application:
View/edit binary Protocol Buffers messages

Reservation service

• rpc reserve (ReserveRequest, ReserveResponse)

  reservation.proto:162

  make a reservation

  message ReserveRequest

  reservation.proto:44

  To make a reservation, send a ReservationRequest with Reservation object (id should be empty)

  • optional Reservation reservation = 1

  message ReserveResponse

  reservation.proto:49

  Created reservation will be returned in ReserveResponse

  • optional Reservation reservation = 1

• rpc confirm (ConfirmRequest, ConfirmResponse)

  reservation.proto:164

  confirm a pending reservation, if reservation is not pending, do nothing

  message ConfirmRequest

  reservation.proto:65

  To change a reservation from pending to confirmed, send a ConfirmRequest

  • int64 id = 1

  message ConfirmResponse

  reservation.proto:70

  Confirmed reservation will be returned in ConfirmResponse

  • optional Reservation reservation = 1

• rpc update (UpdateRequest, UpdateResponse)

  reservation.proto:166

  update the reservation note

  message UpdateRequest

  reservation.proto:54

  To update a reservation, send an UpdateRequest. Only note is updatable.

  • int64 id = 1

  • string note = 2

  message UpdateResponse

  reservation.proto:60

  Updated reservation will be returned in UpdateResponse

  • optional Reservation reservation = 1

• rpc cancel (CancelRequest, CancelResponse)

  reservation.proto:168

  cancel a reservation

  message CancelRequest

  reservation.proto:75

  To cancel a reservation, send a CancelRequest

  • int64 id = 1

  message CancelResponse

  reservation.proto:81

  Canceled reservation will be returned in CancelResponse

  • optional Reservation reservation = 1

• rpc get (GetRequest, GetResponse)

  reservation.proto:170

  get a reservation by id

  message GetRequest

  reservation.proto:86

  To get a reservation, send a GetRequest

  • int64 id = 1

  message GetResponse

  reservation.proto:91

  Reservation will be returned in GetResponse

  • optional Reservation reservation = 1

• rpc query (QueryRequest, stream Reservation)

  reservation.proto:172

  query reservations by resource id, user id, status, start time, end time

  message QueryRequest

  reservation.proto:112

  To query reservations, send a QueryRequest

  • optional ReservationQuery query = 1

• rpc filter (FilterRequest, FilterResponse)

  reservation.proto:174

  filter reservations, order by reservation id

  message FilterRequest

  reservation.proto:132

  To query reservations, send a QueryRequest

  • optional ReservationFilter filter = 1

  message FilterResponse

  reservation.proto:143

  • repeated Reservation reservations = 1

  • optional FilterPager pager = 2

• rpc listen (ListenRequest, stream Reservation)

  reservation.proto:176

  another system could monitor newly added/confirmed/cancelled reservations

  message ListenRequest

  reservation.proto:149

  Client can listen to reservation updates by sending a ListenRequest

  (message has no fields)

filter pager info

Used in: FilterResponse

• optional int64 prev = 1

• optional int64 next = 2

• optional int64 total = 3

Server will send ListenResponse to client in streaming response

• ReservationUpdateType op = 1

  update type

• optional Reservation reservation = 2

  id for updated reservation

Core reservation object. Contains all the information for a reservation if ListenResponse op is DELETE, only id will be populated

Used as response type in: ReservationService.listen, ReservationService.query

Used as field type in: CancelResponse, ConfirmResponse, FilterResponse, GetResponse, ListenResponse, ReserveRequest, ReserveResponse, UpdateResponse

• int64 id = 1

  unique id for the reservation, if put into ReservationRequest, id should be empty

• string user_id = 2

  user id for the reservation

• ReservationStatus status = 3

  reservation status, used for differentating purpose

• string resource_id = 4

  resource id for the reservation

• optional google.protobuf.Timestamp start = 5

  start time for the reservation

• optional google.protobuf.Timestamp end = 6

  end time for the reservation

• string note = 7

  extra note

query reservations, order by reservation id

Used in: FilterRequest

• string resource_id = 1

  resource id for the reservation query. If empty, query all resources

• string user_id = 2

  user id for the reservation query. If empty, query all users

• ReservationStatus status = 3

  use status to filter result. If UNKNOWN, return all reservations

• optional int64 cursor = 4

• int64 page_size = 5

  page size for the query

• bool desc = 6

  sort direction

query reservations with user id, resource id, start time, end time, and status

Used in: QueryRequest

• string resource_id = 1

  resource id for the reservation query. If empty, query all resources

• string user_id = 2

  user id for the reservation query. If empty, query all users

• ReservationStatus status = 3

  use status to filter result. If UNKNOWN, return all reservations

• optional google.protobuf.Timestamp start = 4

  start time for the reservation query, if 0, use Infinity for start time

• optional google.protobuf.Timestamp end = 5

  end time for the reservation query, if 0, use Infinity for end time

• bool desc = 6

  sort direction

reservation status for a given time period

Used in: Reservation, ReservationFilter, ReservationQuery

• RESERVATION_STATUS_UNKNOWN = 0

• RESERVATION_STATUS_PENDING = 1

• RESERVATION_STATUS_CONFIRMED = 2

• RESERVATION_STATUS_BLOCKED = 3

when reservation is updated, record the update type

Used in: ListenResponse

• RESERVATION_UPDATE_TYPE_UNKNOWN = 0

• RESERVATION_UPDATE_TYPE_CREATE = 1

• RESERVATION_UPDATE_TYPE_UPDATE = 2

• RESERVATION_UPDATE_TYPE_DELETE = 3