MyApp

<back to all web services

QueryProfile

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 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 QueryProfile < 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 QueryProfile 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/QueryProfile HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryProfile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyApp.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
</QueryProfile>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfProfiletlJ4_P31p 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/MyApp.ServiceModel">
    <d2p1:Profile>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <CreatedBy>String</CreatedBy>
      <ModifiedDate>0001-01-01T00:00:00</ModifiedDate>
      <ModifiedBy>String</ModifiedBy>
      <DeletedDate>0001-01-01T00:00:00</DeletedDate>
      <DeletedBy>String</DeletedBy>
      <d2p1:CoverUrl>String</d2p1:CoverUrl>
      <d2p1:Energy>0</d2p1:Energy>
      <d2p1:GamesPlayed>0</d2p1:GamesPlayed>
      <d2p1:HighScore>0</d2p1:HighScore>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Meta xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:Meta>
      <d2p1:ProfileUrl>String</d2p1:ProfileUrl>
      <d2p1:Region>Africa</d2p1:Region>
      <d2p1:Role>Leader</d2p1:Role>
      <d2p1:Username>String</d2p1:Username>
    </d2p1:Profile>
  </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>
</QueryResponseOfProfiletlJ4_P31p>