MyApp

<back to all web services

QueryArtists

Media
The following routes are available for this service:
GET/artists
GET/artists/{ArtistId}
import Foundation
import ServiceStack

public class QueryArtists : QueryDb<Artists>, IGet
{
    public var artistId:Int?
    public var artistIdBetween:[Int] = []
    public var nameStartsWith:String

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

    private enum CodingKeys : String, CodingKey {
        case artistId
        case artistIdBetween
        case nameStartsWith
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        artistId = try container.decodeIfPresent(Int.self, forKey: .artistId)
        artistIdBetween = try container.decodeIfPresent([Int].self, forKey: .artistIdBetween) ?? []
        nameStartsWith = try container.decodeIfPresent(String.self, forKey: .nameStartsWith)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if artistId != nil { try container.encode(artistId, forKey: .artistId) }
        if artistIdBetween.count > 0 { try container.encode(artistIdBetween, forKey: .artistIdBetween) }
        if nameStartsWith != nil { try container.encode(nameStartsWith, forKey: .nameStartsWith) }
    }
}

public class Artists : Codable
{
    public var artistId:Int
    public var name:String

    required public init(){}
}

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

    required public init(){}
}


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

GET /artists HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			artistId: 0,
			name: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}