MyApp

<back to all web services

QueryBookings

Find Bookings

# 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

class User
    include ServiceStack::DTO

    # @return [String]
    attr_accessor :id
    # @return [String]
    attr_accessor :user_name
    # @return [String]
    attr_accessor :first_name
    # @return [String]
    attr_accessor :last_name
    # @return [String]
    attr_accessor :display_name
    # @return [String]
    attr_accessor :profile_url

    def self.properties
        {
            id: { name: 'id' },
            user_name: { name: 'userName' },
            first_name: { name: 'firstName' },
            last_name: { name: 'lastName' },
            display_name: { name: 'displayName' },
            profile_url: { name: 'profileUrl' },
        }
    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
    # @return [User]
    attr_accessor :employee

    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' },
            employee: { name: 'employee', type: User },
        }
    end

end

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

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

end

Ruby QueryBookings DTOs

GET /bookings HTTP/1.1 
Host: blazor-vue.web-templates.io 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 0,
			name: String,
			roomType: Single,
			roomNumber: 0,
			bookingStartDate: 0001-01-01,
			bookingEndDate: 0001-01-01,
			cost: 0,
			couponId: String,
			discount: 
			{
				id: String,
				description: String,
				discount: 0,
				expiryDate: 0001-01-01
			},
			notes: String,
			cancelled: False,
			employee: 
			{
				id: String,
				userName: String,
				firstName: String,
				lastName: String,
				displayName: String,
				profileUrl: String
			},
			createdDate: 0001-01-01,
			createdBy: String,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			deletedDate: 0001-01-01,
			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
		}
	}
}