MyApp

<back to all web services

QueryInvoices

Media Store
The following routes are available for this service:
GET/invoices
GET/invoices/{InvoiceId}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Chinook.ServiceModel
Imports Chinook.ServiceModel.Types
Imports MyApp.ServiceModel

Namespace Global

    Namespace Chinook.ServiceModel

        Public Partial Class QueryInvoices
            Inherits QueryDb(Of Invoices)
            Implements IGet
            Public Overridable Property InvoiceId As Long?
        End Class
    End Namespace

    Namespace Chinook.ServiceModel.Types

        Public Partial Class Invoices
            Public Overridable Property InvoiceId As Long
            Public Overridable Property CustomerId As Long
            Public Overridable Property InvoiceDate As Date
            Public Overridable Property BillingAddress As String
            Public Overridable Property BillingCity As String
            Public Overridable Property BillingState As String
            Public Overridable Property BillingCountry As String
            Public Overridable Property BillingPostalCode As String
            Public Overridable Property Total As Decimal
        End Class
    End Namespace

    Namespace MyApp.ServiceModel

        Public Partial Class Todo
            Public Overridable Property Id As Long
            Public Overridable Property Text As String
            Public Overridable Property IsFinished As Boolean
        End Class
    End Namespace

    Namespace ServiceStack

        <DataContract>
        Public Partial Class QueryBase
            <DataMember(Order:=1)>
            Public Overridable Property Skip As Integer?

            <DataMember(Order:=2)>
            Public Overridable Property Take As Integer?

            <DataMember(Order:=3)>
            Public Overridable Property OrderBy As String

            <DataMember(Order:=4)>
            Public Overridable Property OrderByDesc As String

            <DataMember(Order:=5)>
            Public Overridable Property Include As String

            <DataMember(Order:=6)>
            Public Overridable Property Fields As String

            <DataMember(Order:=7)>
            Public Overridable Property Meta As Dictionary(Of String, String)
        End Class

        Public Partial Class QueryDb(Of T)
            Inherits QueryBase
        End Class

        <DataContract>
        Public Partial Class QueryResponse(Of T)
            <DataMember(Order:=1)>
            Public Overridable Property Offset As Integer

            <DataMember(Order:=2)>
            Public Overridable Property Total As Integer

            <DataMember(Order:=3)>
            Public Overridable Property Results As List(Of Todo)

            <DataMember(Order:=4)>
            Public Overridable Property Meta As Dictionary(Of String, String)

            <DataMember(Order:=5)>
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET QueryInvoices 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 /invoices 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: 
	[
		{
			invoiceId: 0,
			customerId: 0,
			invoiceDate: 0001-01-01,
			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
		}
	}
}