MyApp

<back to all web services

QueryUsers

Requires Authentication
Required role:Admin
# 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

# @ValidateRequest(Validator: "IsAdmin")
class QueryUsers < ServiceStack::QueryDb
    # @return [String]
    attr_accessor :id

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

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
    # @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

Ruby QueryUsers DTOs

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

HTTP + XML

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

POST /xml/reply/QueryUsers HTTP/1.1 
Host: blazor-vue.web-templates.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryUsers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <Id>String</Id>
</QueryUsers>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfUsertlJ4_P31p xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
    <d2p1:User>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:ProfileUrl>String</d2p1:ProfileUrl>
      <d2p1:UserName>String</d2p1:UserName>
    </d2p1:User>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfUsertlJ4_P31p>