| GET | /customers | ||
|---|---|---|---|
| GET | /customers/{CustomerId} |
# frozen_string_literal: true
# encoding: utf-8
require 'json'
require 'servicestack'
class Customers
include ServiceStack::DTO
# @return [Integer]
attr_accessor :customer_id
# @Required
# @return [String]
attr_accessor :first_name
# @Required
# @return [String]
attr_accessor :last_name
# @return [String]
attr_accessor :company
# @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
# @Required
# @return [String]
attr_accessor :email
# @return [Integer]
attr_accessor :support_rep_id
def self.properties
{
customer_id: { name: 'customerId' },
first_name: { name: 'firstName' },
last_name: { name: 'lastName' },
company: { name: 'company' },
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' },
support_rep_id: { name: 'supportRepId' },
}
end
end
class QueryChinookCustomers < ServiceStack::QueryDb
# @return [Integer]
attr_accessor :customer_id
def self.properties
{
customer_id: { name: 'customerId' },
}
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 QueryChinookCustomers DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /customers HTTP/1.1 Host: blazor-gallery.servicestack.net Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"offset":0,"total":0,"results":[{"customerId":0,"firstName":"String","lastName":"String","company":"String","address":"String","city":"String","state":"String","country":"String","postalCode":"String","phone":"String","fax":"String","email":"String","supportRepId":0}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}