MyApp

<back to all web services

QueryBookings

bookings

Find Bookings

The following routes are available for this service:
GET/bookings
GET/bookings/{Id}
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


module RoomType
    SINGLE = 'Single'
    DOUBLE = 'Double'
    QUEEN = 'Queen'
    TWIN = 'Twin'
    SUITE = 'Suite'
end

#
# Discount Coupons
#
class Coupon
    include ServiceStack::DTO

    # @return [String]
    attr_accessor :id
    # @return [String]
    attr_accessor :description
    # @return [Integer]
    attr_accessor :discount
    # @return [DateTime]
    attr_accessor :expiry_date

    def self.properties
        {
            id: { name: 'id' },
            description: { name: 'description' },
            discount: { name: 'discount' },
            expiry_date: { name: 'expiryDate', type: DateTime },
        }
    end

end

#
# Booking Details
#
class Booking < ServiceStack::AuditBase
    # @return [Integer]
    attr_accessor :id
    # @return [String]
    attr_accessor :name
    # @return [RoomType]
    attr_accessor :room_type
    # @return [Integer]
    attr_accessor :room_number
    # @return [DateTime]
    attr_accessor :booking_start_date
    # @return [DateTime]
    attr_accessor :booking_end_date
    # @return [BigDecimal]
    attr_accessor :cost
    # @References('Coupon')
    # @return [String]
    attr_accessor :coupon_id

    # @return [Coupon]
    attr_accessor :discount
    # @return [String]
    attr_accessor :notes
    # @return [TrueClass]
    attr_accessor :cancelled

    def self.properties
        {
            id: { name: 'id' },
            name: { name: 'name' },
            room_type: { name: 'roomType' },
            room_number: { name: 'roomNumber' },
            booking_start_date: { name: 'bookingStartDate', type: DateTime },
            booking_end_date: { name: 'bookingEndDate', type: DateTime },
            cost: { name: 'cost' },
            coupon_id: { name: 'couponId' },
            discount: { name: 'discount', type: Coupon },
            notes: { name: 'notes' },
            cancelled: { name: 'cancelled' },
        }
    end

end

#
# Find Bookings
#
class QueryBookings < ServiceStack::QueryDb
    # @return [Integer]
    attr_accessor :id

    def self.properties
        {
            id: { name: 'id' },
        }
    end

end

class Todo
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :id
    # @return [String]
    attr_accessor :text
    # @return [TrueClass]
    attr_accessor :is_finished

    def self.properties
        {
            id: { name: 'id' },
            text: { name: 'text' },
            is_finished: { name: 'isFinished' },
        }
    end

end

Ruby QueryBookings DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bookings HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"offset":0,"total":0,"results":[{"id":0,"name":"String","roomType":"Single","roomNumber":0,"bookingStartDate":"0001-01-01T00:00:00","bookingEndDate":"0001-01-01T00:00:00","cost":0,"couponId":"String","discount":{"id":"String","description":"String","discount":0,"expiryDate":"0001-01-01T00:00:00"},"notes":"String","cancelled":false,"createdDate":"0001-01-01T00:00:00","createdBy":"String","modifiedDate":"0001-01-01T00:00:00","modifiedBy":"String","deletedDate":"0001-01-01T00:00:00","deletedBy":"String"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}