MyApp

<back to all web services

QueryPlayer

Game
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


module PhoneKind
    HOME = 'Home'
    MOBILE = 'Mobile'
    WORK = 'Work'
end

module PlayerRole
    LEADER = 'Leader'
    PLAYER = 'Player'
    NON_PLAYER = 'NonPlayer'
end

module PlayerRegion
    AFRICA = 'Africa'
    AMERICAS = 'Americas'
    ASIA = 'Asia'
    AUSTRALASIA = 'Australasia'
    EUROPE = 'Europe'
end

class Phone
    include ServiceStack::DTO

    # @return [PhoneKind]
    attr_accessor :kind
    # @return [String]
    attr_accessor :number
    # @return [String]
    attr_accessor :ext

    def self.properties
        {
            kind: { name: 'kind' },
            number: { name: 'number' },
            ext: { name: 'ext' },
        }
    end

end

class PlayerGameItem
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :id
    # @References('Player')
    # @return [Integer]
    attr_accessor :player_id

    # @References('GameItem')
    # @return [String]
    attr_accessor :game_item_name

    def self.properties
        {
            id: { name: 'id' },
            player_id: { name: 'playerId' },
            game_item_name: { name: 'gameItemName' },
        }
    end

end

class Profile < ServiceStack::AuditBase
    # @return [Integer]
    attr_accessor :id
    # @return [PlayerRole]
    attr_accessor :role
    # @return [PlayerRegion]
    attr_accessor :region
    # @return [String]
    attr_accessor :username
    # @return [Integer]
    attr_accessor :high_score
    # @return [Integer]
    attr_accessor :games_played
    # @return [Integer]
    attr_accessor :energy
    # @return [String]
    attr_accessor :profile_url
    # @return [String]
    attr_accessor :cover_url
    # @return [Dictionary]
    attr_accessor :meta

    def self.properties
        {
            id: { name: 'id' },
            role: { name: 'role' },
            region: { name: 'region' },
            username: { name: 'username' },
            high_score: { name: 'highScore' },
            games_played: { name: 'gamesPlayed' },
            energy: { name: 'energy' },
            profile_url: { name: 'profileUrl' },
            cover_url: { name: 'coverUrl' },
            meta: { name: 'meta' },
        }
    end

end

class Player < ServiceStack::AuditBase
    # @return [Integer]
    attr_accessor :id
    # @Required
    # @return [String]
    attr_accessor :first_name

    # @return [String]
    attr_accessor :last_name
    # @return [String]
    attr_accessor :email
    # @return [List]
    attr_accessor :phone_numbers
    # @return [List]
    attr_accessor :game_items
    # @return [Profile]
    attr_accessor :profile
    # @return [Integer]
    attr_accessor :profile_id
    # @return [String]
    attr_accessor :saved_level_id
    # @return [Integer]
    attr_accessor :row_version

    def self.properties
        {
            id: { name: 'id' },
            first_name: { name: 'firstName' },
            last_name: { name: 'lastName' },
            email: { name: 'email' },
            phone_numbers: { name: 'phoneNumbers', type: [Phone] },
            game_items: { name: 'gameItems', type: [PlayerGameItem] },
            profile: { name: 'profile', type: Profile },
            profile_id: { name: 'profileId' },
            saved_level_id: { name: 'savedLevelId' },
            row_version: { name: 'rowVersion' },
        }
    end

end

class QueryPlayer < ServiceStack::QueryDb
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 QueryPlayer DTOs

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

HTTP + JSV

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

POST /jsv/reply/QueryPlayer HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	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: 0,
			firstName: String,
			lastName: String,
			email: String,
			phoneNumbers: 
			[
				{
					kind: Home,
					number: String,
					ext: String
				}
			],
			gameItems: 
			[
				{
					id: 0,
					playerId: 0,
					gameItemName: String
				}
			],
			profile: 
			{
				id: 0,
				role: Leader,
				region: Africa,
				username: String,
				highScore: 0,
				gamesPlayed: 0,
				energy: 0,
				profileUrl: String,
				coverUrl: String,
				meta: 
				{
					String: String
				},
				createdDate: 0001-01-01,
				createdBy: String,
				modifiedDate: 0001-01-01,
				modifiedBy: String,
				deletedDate: 0001-01-01,
				deletedBy: String
			},
			profileId: 0,
			savedLevelId: 00000000-0000-0000-0000-000000000000,
			rowVersion: 0,
			createdDate: 0001-01-01,
			createdBy: String,
			modifiedDate: 0001-01-01,
			modifiedBy: String,
			deletedDate: 0001-01-01,
			deletedBy: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}