| Required role: | Admin |
# frozen_string_literal: true
# encoding: utf-8
require 'json'
require 'servicestack'
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
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
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.
POST /jsv/reply/QueryUsers HTTP/1.1
Host: vue-spa.web-templates.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: String,
skip: 0,
take: 0,
orderBy: String,
orderByDesc: String,
include: String,
fields: String,
meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
id: String,
userName: String,
firstName: String,
lastName: String,
displayName: String,
profileUrl: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}