GET | /albums | ||
---|---|---|---|
GET | /albums/{AlbumId} |
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Chinook.ServiceModel;
using Chinook.ServiceModel.Types;
using MyApp.ServiceModel;
namespace Chinook.ServiceModel
{
public partial class QueryAlbums
: QueryDb<Albums>, IGet
{
public virtual long? AlbumId { get; set; }
}
}
namespace Chinook.ServiceModel.Types
{
public partial class Albums
{
public virtual long AlbumId { get; set; }
[Required]
public virtual string Title { get; set; }
public virtual long ArtistId { get; set; }
}
}
namespace MyApp.ServiceModel
{
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 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /albums HTTP/1.1 Host: blazor-gallery.servicestack.net Accept: text/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"offset":0,"total":0,"results":[{"albumId":0,"title":"String","artistId":0}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}