MyApp

<back to all web services

UpdateProfile

Game
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


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

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

class UpdateProfile
    include ServiceStack::DTO

    # @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
    # @Validate(Validator: "InclusiveBetween(0,100)")
    # @return [Integer]
    attr_accessor :energy

    # @return [String]
    attr_accessor :profile_url
    # @return [String]
    attr_accessor :cover_url

    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' },
        }
    end

    def response_type() = ServiceStack::IdResponse
    def get_type_name() = 'UpdateProfile'
end

Ruby UpdateProfile 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/UpdateProfile HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	id: 0,
	role: Leader,
	region: 0,
	username: String,
	highScore: 0,
	gamesPlayed: 0,
	energy: 0,
	profileUrl: String,
	coverUrl: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	id: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}