MyApp

<back to all web services

QueryInvoices

Media Store
The following routes are available for this service:
GET/invoices
GET/invoices/{InvoiceId}
# frozen_string_literal: true
# encoding: utf-8


require 'json'
require 'servicestack'


class Invoices
    include ServiceStack::DTO

    # @return [Integer]
    attr_accessor :invoice_id
    # @return [Integer]
    attr_accessor :customer_id
    # @return [DateTime]
    attr_accessor :invoice_date
    # @return [String]
    attr_accessor :billing_address
    # @return [String]
    attr_accessor :billing_city
    # @return [String]
    attr_accessor :billing_state
    # @return [String]
    attr_accessor :billing_country
    # @return [String]
    attr_accessor :billing_postal_code
    # @return [BigDecimal]
    attr_accessor :total

    def self.properties
        {
            invoice_id: { name: 'invoiceId' },
            customer_id: { name: 'customerId' },
            invoice_date: { name: 'invoiceDate', type: DateTime },
            billing_address: { name: 'billingAddress' },
            billing_city: { name: 'billingCity' },
            billing_state: { name: 'billingState' },
            billing_country: { name: 'billingCountry' },
            billing_postal_code: { name: 'billingPostalCode' },
            total: { name: 'total' },
        }
    end

end

class QueryInvoices < ServiceStack::QueryDb
    # @return [Integer]
    attr_accessor :invoice_id

    def self.properties
        {
            invoice_id: { name: 'invoiceId' },
        }
    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 QueryInvoices DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /invoices 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":[{"invoiceId":0,"customerId":0,"invoiceDate":"0001-01-01T00:00:00","billingAddress":"String","billingCity":"String","billingState":"String","billingCountry":"String","billingPostalCode":"String","total":0}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}