| GET | /employees | ||
|---|---|---|---|
| GET | /employees/{EmployeeId} |
# frozen_string_literal: true
# encoding: utf-8
require 'json'
require 'servicestack'
class Employees
include ServiceStack::DTO
# @return [Integer]
attr_accessor :employee_id
# @Required
# @return [String]
attr_accessor :last_name
# @Required
# @return [String]
attr_accessor :first_name
# @return [String]
attr_accessor :title
# @return [Integer]
attr_accessor :reports_to
# @return [DateTime]
attr_accessor :birth_date
# @return [DateTime]
attr_accessor :hire_date
# @return [String]
attr_accessor :address
# @return [String]
attr_accessor :city
# @return [String]
attr_accessor :state
# @return [String]
attr_accessor :country
# @return [String]
attr_accessor :postal_code
# @return [String]
attr_accessor :phone
# @return [String]
attr_accessor :fax
# @return [String]
attr_accessor :email
def self.properties
{
employee_id: { name: 'employeeId' },
last_name: { name: 'lastName' },
first_name: { name: 'firstName' },
title: { name: 'title' },
reports_to: { name: 'reportsTo' },
birth_date: { name: 'birthDate', type: DateTime },
hire_date: { name: 'hireDate', type: DateTime },
address: { name: 'address' },
city: { name: 'city' },
state: { name: 'state' },
country: { name: 'country' },
postal_code: { name: 'postalCode' },
phone: { name: 'phone' },
fax: { name: 'fax' },
email: { name: 'email' },
}
end
end
class QueryChinookEmployees < ServiceStack::QueryDb
# @return [Integer]
attr_accessor :employee_id
def self.properties
{
employee_id: { name: 'employeeId' },
}
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 QueryChinookEmployees DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /employees HTTP/1.1 Host: blazor-gallery.servicestack.net Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
employeeId: 0,
lastName: String,
firstName: String,
title: String,
reportsTo: 0,
birthDate: 0001-01-01,
hireDate: 0001-01-01,
address: String,
city: String,
state: String,
country: String,
postalCode: String,
phone: String,
fax: String,
email: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}