MyApp

<back to all web services

QueryProfile

Game
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using MyApp.ServiceModel;

namespace MyApp.ServiceModel
{
    public enum PlayerRegion
    {
        Africa = 1,
        Americas = 2,
        Asia = 3,
        Australasia = 4,
        Europe = 5,
    }

    public enum PlayerRole
    {
        Leader,
        Player,
        NonPlayer,
    }

    public partial class Profile
        : AuditBase
    {
        public virtual int Id { get; set; }
        public virtual PlayerRole Role { get; set; }
        public virtual PlayerRegion Region { get; set; }
        public virtual string Username { get; set; }
        public virtual long HighScore { get; set; }
        public virtual long GamesPlayed { get; set; }
        public virtual int Energy { get; set; }
        public virtual string ProfileUrl { get; set; }
        public virtual string CoverUrl { get; set; }
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    public partial class QueryProfile
        : QueryDb<Profile>
    {
    }

    public partial class Todo
    {
        public virtual long Id { get; set; }
        public virtual string Text { get; set; }
        public virtual bool IsFinished { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class AuditBase
    {
        [DataMember(Order=1)]
        public virtual DateTime CreatedDate { get; set; }

        [DataMember(Order=2)]
        [Required]
        public virtual string CreatedBy { get; set; }

        [DataMember(Order=3)]
        public virtual DateTime ModifiedDate { get; set; }

        [DataMember(Order=4)]
        [Required]
        public virtual string ModifiedBy { get; set; }

        [DataMember(Order=5)]
        public virtual DateTime? DeletedDate { get; set; }

        [DataMember(Order=6)]
        public virtual string DeletedBy { get; set; }
    }

    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string Include { get; set; }

        [DataMember(Order=6)]
        public virtual string Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string> Meta { get; set; }
    }

    public partial class QueryDb<T>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<Todo> Results { get; set; }

        [DataMember(Order=4)]
        public virtual Dictionary<string, string> Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# QueryProfile 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/QueryProfile 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,
			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
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}