MyApp

<back to all web services

QueryBookings

Bookings
Requires Authentication
Required role:Employee
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


module RoomType
    SINGLE = 'Single'
    DOUBLE = 'Double'
    QUEEN = 'Queen'
    TWIN = 'Twin'
    SUITE = 'Suite'
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
    # @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' },
            notes: { name: 'notes' },
            cancelled: { name: 'cancelled' },
            employee: { name: 'employee', type: User },
        }
    end

end

# @ValidateRequest(Validator: "HasRole(`Employee`)")
class QueryBookings < ServiceStack::QueryDb
    # @return [Integer]
    attr_accessor :id
    # @return [List]
    attr_accessor :ids

    def self.properties
        {
            id: { name: 'id' },
            ids: { name: 'ids' },
        }
    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 .csv suffix or ?format=csv

HTTP + CSV

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

POST /csv/reply/QueryBookings HTTP/1.1 
Host: vue-spa.web-templates.io 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"id":0,"ids":[0],"skip":0,"take":0,"orderBy":"String","orderByDesc":"String","include":"String","fields":"String","meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
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,"notes":"String","cancelled":false,"employee":{"id":"String","userName":"String","firstName":"String","lastName":"String","displayName":"String","profileUrl":"String"},"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"}}}