MyApp

<back to all web services

QueryProfile

Game
import Foundation
import ServiceStack

public class QueryProfile : QueryDb<Profile>
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class Profile : AuditBase
{
    public var id:Int
    public var role:PlayerRole
    public var region:PlayerRegion
    public var username:String
    public var highScore:Int
    public var gamesPlayed:Int
    public var energy:Int
    public var profileUrl:String
    public var coverUrl:String
    public var meta:[String:String]

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case id
        case role
        case region
        case username
        case highScore
        case gamesPlayed
        case energy
        case profileUrl
        case coverUrl
        case meta
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        id = try container.decodeIfPresent(Int.self, forKey: .id)
        role = try container.decodeIfPresent(PlayerRole.self, forKey: .role)
        region = try container.decodeIfPresent(PlayerRegion.self, forKey: .region)
        username = try container.decodeIfPresent(String.self, forKey: .username)
        highScore = try container.decodeIfPresent(Int.self, forKey: .highScore)
        gamesPlayed = try container.decodeIfPresent(Int.self, forKey: .gamesPlayed)
        energy = try container.decodeIfPresent(Int.self, forKey: .energy)
        profileUrl = try container.decodeIfPresent(String.self, forKey: .profileUrl)
        coverUrl = try container.decodeIfPresent(String.self, forKey: .coverUrl)
        meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if id != nil { try container.encode(id, forKey: .id) }
        if role != nil { try container.encode(role, forKey: .role) }
        if region != nil { try container.encode(region, forKey: .region) }
        if username != nil { try container.encode(username, forKey: .username) }
        if highScore != nil { try container.encode(highScore, forKey: .highScore) }
        if gamesPlayed != nil { try container.encode(gamesPlayed, forKey: .gamesPlayed) }
        if energy != nil { try container.encode(energy, forKey: .energy) }
        if profileUrl != nil { try container.encode(profileUrl, forKey: .profileUrl) }
        if coverUrl != nil { try container.encode(coverUrl, forKey: .coverUrl) }
        if meta != nil { try container.encode(meta, forKey: .meta) }
    }
}

public enum PlayerRole : String, Codable
{
    case Leader
    case Player
    case NonPlayer
}

public enum PlayerRegion : Int, Codable
{
    case Africa = 1
    case Americas = 2
    case Asia = 3
    case Australasia = 4
    case Europe = 5
}

public class Todo : Codable
{
    public var id:Int
    public var text:String
    public var isFinished:Bool

    required public init(){}
}


Swift 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>