MyApp

<back to all web services

CreateProfile

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 CreateProfile
    include ServiceStack::DTO

    # @return [PlayerRole]
    attr_accessor :role
    # @return [PlayerRegion]
    attr_accessor :region
    # @Validate(Validator: "NotEmpty")
    # @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
        {
            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() = 'CreateProfile'
end

Ruby CreateProfile DTOs

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

HTTP + XML

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

POST /xml/reply/CreateProfile HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <CoverUrl>String</CoverUrl>
  <Energy>0</Energy>
  <GamesPlayed>0</GamesPlayed>
  <HighScore>0</HighScore>
  <ProfileUrl>String</ProfileUrl>
  <Region>Africa</Region>
  <Role>Leader</Role>
  <Username>String</Username>
</CreateProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<IdResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Id>String</Id>
  <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>
</IdResponse>