| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfCustomersERq9_SyN2 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/Chinook.ServiceModel.Types">
<d2p1:Customers>
<d2p1:Address>String</d2p1:Address>
<d2p1:City>String</d2p1:City>
<d2p1:Company>String</d2p1:Company>
<d2p1:Country>String</d2p1:Country>
<d2p1:CustomerId>0</d2p1:CustomerId>
<d2p1:Email>String</d2p1:Email>
<d2p1:Fax>String</d2p1:Fax>
<d2p1:FirstName>String</d2p1:FirstName>
<d2p1:LastName>String</d2p1:LastName>
<d2p1:Phone>String</d2p1:Phone>
<d2p1:PostalCode>String</d2p1:PostalCode>
<d2p1:State>String</d2p1:State>
<d2p1:SupportRepId>0</d2p1:SupportRepId>
</d2p1:Customers>
</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>
</QueryResponseOfCustomersERq9_SyN2>