MyApp

QueryAlbums

Media

The following routes are available for this service:
GET	/albums
GET	/albums/{AlbumId}

# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


class Albums
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :album_id
    # @Required
    # @return [String]
    attr_accessor :title

    # @return [Integer]
    attr_accessor :artist_id

    def self.properties
        {
            album_id: { name: 'albumId' },
            title: { name: 'title' },
            artist_id: { name: 'artistId' },
        }
    end

end

class QueryAlbums < ServiceStack::QueryDb
    # @return [Integer]
    attr_accessor :album_id

    def self.properties
        {
            album_id: { name: 'albumId' },
        }
    end

end

class Todo
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :id
    # @return [String]
    attr_accessor :text
    # @return [TrueClass]
    attr_accessor :is_finished

    def self.properties
        {
            id: { name: 'id' },
            text: { name: 'text' },
            is_finished: { name: 'isFinished' },
        }
    end

end

Ruby QueryAlbums DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}