MyApp

<back to all web services

QueryPlayer

Game

// @DataContract
export class QueryBase
{
    // @DataMember(Order=1)
    public skip?: number;

    // @DataMember(Order=2)
    public take?: number;

    // @DataMember(Order=3)
    public orderBy: string;

    // @DataMember(Order=4)
    public orderByDesc: string;

    // @DataMember(Order=5)
    public include: string;

    // @DataMember(Order=6)
    public fields: string;

    // @DataMember(Order=7)
    public meta: { [index: string]: string; };

    public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}

export class QueryDb<T> extends QueryBase
{

    public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class AuditBase
{
    // @DataMember(Order=1)
    public createdDate: string;

    // @DataMember(Order=2)
    // @Required()
    public createdBy: string;

    // @DataMember(Order=3)
    public modifiedDate: string;

    // @DataMember(Order=4)
    // @Required()
    public modifiedBy: string;

    // @DataMember(Order=5)
    public deletedDate?: string;

    // @DataMember(Order=6)
    public deletedBy: string;

    public constructor(init?: Partial<AuditBase>) { (Object as any).assign(this, init); }
}

export enum PhoneKind
{
    Home = 'Home',
    Mobile = 'Mobile',
    Work = 'Work',
}

export class Phone
{
    public kind: PhoneKind;
    public number: string;
    public ext: string;

    public constructor(init?: Partial<Phone>) { (Object as any).assign(this, init); }
}

export class PlayerGameItem
{
    public id: number;
    // @References("typeof(MyApp.ServiceModel.Player)")
    public playerId: number;

    // @References("typeof(MyApp.ServiceModel.GameItem)")
    public gameItemName: string;

    public constructor(init?: Partial<PlayerGameItem>) { (Object as any).assign(this, init); }
}

export enum PlayerRole
{
    Leader = 'Leader',
    Player = 'Player',
    NonPlayer = 'NonPlayer',
}

export enum PlayerRegion
{
    Africa = 1,
    Americas = 2,
    Asia = 3,
    Australasia = 4,
    Europe = 5,
}

export class Profile extends AuditBase
{
    public id: number;
    public role: PlayerRole;
    public region: PlayerRegion;
    public username?: string;
    public highScore: number;
    public gamesPlayed: number;
    public energy: number;
    public profileUrl?: string;
    public coverUrl?: string;
    public meta?: { [index: string]: string; };

    public constructor(init?: Partial<Profile>) { super(init); (Object as any).assign(this, init); }
}

export class Player extends AuditBase
{
    public id: number;
    // @Required()
    public firstName: string;

    public lastName: string;
    public email: string;
    public phoneNumbers: Phone[];
    public gameItems: PlayerGameItem[];
    public profile: Profile;
    public profileId: number;
    public savedLevelId: string;
    public rowVersion: number;

    public constructor(init?: Partial<Player>) { super(init); (Object as any).assign(this, init); }
}

export class QueryPlayer extends QueryDb<Player>
{

    public constructor(init?: Partial<QueryPlayer>) { super(init); (Object as any).assign(this, init); }
}

export class Todo
{
    public id: number;
    public text: string;
    public isFinished: boolean;

    public constructor(init?: Partial<Todo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<Todo>
{
    // @DataMember(Order=1)
    public offset: number;

    // @DataMember(Order=2)
    public total: number;

    // @DataMember(Order=3)
    public results: Todo[];

    // @DataMember(Order=4)
    public meta: { [index: string]: string; };

    // @DataMember(Order=5)
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<Todo>>) { (Object as any).assign(this, init); }
}

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

<QueryPlayer 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>
</QueryPlayer>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfPlayertlJ4_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:Player>
      <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:Email>String</d2p1:Email>
      <d2p1:FirstName>String</d2p1:FirstName>
      <d2p1:GameItems>
        <d2p1:PlayerGameItem>
          <d2p1:GameItemName>String</d2p1:GameItemName>
          <d2p1:Id>0</d2p1:Id>
          <d2p1:PlayerId>0</d2p1:PlayerId>
        </d2p1:PlayerGameItem>
      </d2p1:GameItems>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:LastName>String</d2p1:LastName>
      <d2p1:PhoneNumbers>
        <d2p1:Phone>
          <d2p1:Ext>String</d2p1:Ext>
          <d2p1:Kind>Home</d2p1:Kind>
          <d2p1:Number>String</d2p1:Number>
        </d2p1:Phone>
      </d2p1:PhoneNumbers>
      <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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1: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>
      <d2p1:ProfileId>0</d2p1:ProfileId>
      <d2p1:RowVersion>0</d2p1:RowVersion>
      <d2p1:SavedLevelId>00000000-0000-0000-0000-000000000000</d2p1:SavedLevelId>
    </d2p1:Player>
  </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>
</QueryResponseOfPlayertlJ4_P31p>